kubecfg

Documentation

Index

• Constants
• Variables
• type DeleteCmd
  • func (c DeleteCmd) Run(ctx context.Context, apiObjects []*unstructured.Unstructured) error
• type DiffCmd
  • func (c DiffCmd) Run(ctx context.Context, apiObjects []*unstructured.Unstructured, out io.Writer) error
• type ShowCmd
  • func (c ShowCmd) Run(apiObjects []*unstructured.Unstructured, out io.Writer) error
• type UpdateCmd
  • func (c UpdateCmd) Run(ctx context.Context, apiObjects []*unstructured.Unstructured) error
• type ValidateCmd
  • func (c ValidateCmd) Run(apiObjects []*unstructured.Unstructured, out io.Writer) error

Constants

const (
	// AnnotationOrigObject annotation records the resource as it
	// was most recently specified by kubecfg (serialised to
	// JSON).  This is used as input to the strategic-merge-patch
	// 3-way merge when performing updates.
	AnnotationOrigObject = "kubecfg.ksonnet.io/last-applied-configuration"

	// AnnotationGcTag annotation that triggers
	// garbage collection. Objects with value equal to
	// command-line flag that are *not* in config will be deleted.
	//
	// NB: this is in phase1 of a migration to use a label instead.
	// At this stage, both label+migration are written, but the
	// annotation (only) is still used to trigger GC. [gctag-migration]
	AnnotationGcTag = LabelGcTag

	// LabelGcTag label that triggers garbage collection. Objects
	// with value equal to command-line flag that are *not* in
	// config will be deleted.
	//
	// NB: this is in phase1 of a migration from an annotation.
	// At this stage, both label+migration are written, but the
	// annotation (only) is still used to trigger GC. [gctag-migration]
	LabelGcTag = "kubecfg.ksonnet.io/garbage-collect-tag"

	// AnnotationGcStrategy controls gc logic.  Current values:
	// `auto` (default if absent) - do garbage collection
	// `ignore` - never garbage collect this object
	AnnotationGcStrategy = "kubecfg.ksonnet.io/garbage-collect-strategy"

	// GcStrategyAuto is the default automatic gc logic
	GcStrategyAuto = "auto"
	// GcStrategyIgnore means this object should be ignored by garbage collection
	GcStrategyIgnore = "ignore"
)

Variables

var DiffKeyValue = regexp.MustCompile(`"([-._a-zA-Z0-9]+)":\s"([[:alnum:]=+]+)",?`)

var DiffLineStart = regexp.MustCompile("(^|\n)(.)")

Matches all the line starts on a diff text, which is where we put diff markers and indent

var ErrDiffFound = fmt.Errorf("Differences found.")

Types

type DeleteCmd

type DeleteCmd struct {
	Client           dynamic.Interface
	Mapper           meta.RESTMapper
	Discovery        discovery.DiscoveryInterface
	DefaultNamespace string

	GracePeriod int64
}

DeleteCmd represents the delete subcommand

func (DeleteCmd) Run

func (c DeleteCmd) Run(ctx context.Context, apiObjects []*unstructured.Unstructured) error

type DiffCmd

type DiffCmd struct {
	Client           dynamic.Interface
	Mapper           meta.RESTMapper
	DefaultNamespace string
	OmitSecrets      bool

	DiffStrategy string
}

DiffCmd represents the diff subcommand

func (DiffCmd) Run

func (c DiffCmd) Run(ctx context.Context, apiObjects []*unstructured.Unstructured, out io.Writer) error

type ShowCmd

type ShowCmd struct {
	Format string
}

ShowCmd represents the show subcommand

func (ShowCmd) Run

func (c ShowCmd) Run(apiObjects []*unstructured.Unstructured, out io.Writer) error

type UpdateCmd

type UpdateCmd struct {
	Client           dynamic.Interface
	Mapper           meta.RESTMapper
	Discovery        discovery.DiscoveryInterface
	DefaultNamespace string

	Create bool
	GcTag  string
	SkipGc bool
	DryRun bool
}

UpdateCmd represents the update subcommand

func (UpdateCmd) Run

func (c UpdateCmd) Run(ctx context.Context, apiObjects []*unstructured.Unstructured) error

Run executes the update command

type ValidateCmd

type ValidateCmd struct {
	Mapper        meta.RESTMapper
	Discovery     discovery.DiscoveryInterface
	IgnoreUnknown bool
}

ValidateCmd represents the validate subcommand

func (ValidateCmd) Run

func (c ValidateCmd) Run(apiObjects []*unstructured.Unstructured, out io.Writer) error