kubernetes

Documentation

Index

• Constants
• type ApplyOpts
• type DeleteOpts
• type DiffOpts
• type Differ
  • func StaticDiffer(create bool) Differ
  • func SubsetDiffer(c client.Client) Differ
• type ErrorDiffStrategyUnknown
  • func (e ErrorDiffStrategyUnknown) Error() string
• type Kubernetes
  • func New(env v1alpha1.Environment) (*Kubernetes, error)
  • func (k *Kubernetes) Apply(state manifest.List, opts ApplyOpts) error
  • func (k *Kubernetes) Close() error
  • func (k *Kubernetes) Delete(state manifest.List, opts DeleteOpts) error
  • func (k *Kubernetes) Diff(state manifest.List, opts DiffOpts) (*string, error)
  • func (k *Kubernetes) Info() client.Info
  • func (k *Kubernetes) Orphaned(state manifest.List) (manifest.List, error)

Constants

const AnnotationLastApplied = "kubectl.kubernetes.io/last-applied-configuration"

AnnoationLastApplied is the last-applied-configuration annotation used by kubectl

Types

type ApplyOpts

type ApplyOpts client.ApplyOpts

ApplyOpts allow set additional parameters for the apply operation

type DeleteOpts

type DeleteOpts client.DeleteOpts

type DiffOpts

type DiffOpts struct {
	// Create a histogram of the changes instead
	Summarize bool
	// Find orphaned resources and include them in the diff
	WithPrune bool

	// Set the diff-strategy. If unset, the value set in the spec is used
	Strategy string
}

DiffOpts allow to specify additional parameters for diff operations

type Differ

type Differ func(manifest.List) (*string, error)

Differ is responsible for comparing the given manifests to the cluster and returning differences (if any) in `diff(1)` format.

func StaticDiffer

func StaticDiffer(create bool) Differ

StaticDiffer returns a differ that reports all resources as either created or deleted.

func SubsetDiffer

func SubsetDiffer(c client.Client) Differ

SubsetDiffer returns a implementation of Differ that computes the diff by comparing only the fields present in the desired state. This algorithm might miss information, but is all that's possible on cluster versions lower than 1.13.

type ErrorDiffStrategyUnknown

type ErrorDiffStrategyUnknown struct {
	Requested string
	// contains filtered or unexported fields
}

ErrorDiffStrategyUnknown occurs when a diff-strategy is requested that does not exist.

func (ErrorDiffStrategyUnknown) Error

func (e ErrorDiffStrategyUnknown) Error() string

type Kubernetes

type Kubernetes struct {
	Env v1alpha1.Environment
	// contains filtered or unexported fields
}

Kubernetes exposes methods to work with the Kubernetes orchestrator

func New

func New(env v1alpha1.Environment) (*Kubernetes, error)

New creates a new Kubernetes with an initialized client

func (*Kubernetes) Apply

func (k *Kubernetes) Apply(state manifest.List, opts ApplyOpts) error

Apply receives a state object generated using `Reconcile()` and may apply it to the target system

func (*Kubernetes) Close

func (k *Kubernetes) Close() error

Close runs final cleanup

func (*Kubernetes) Delete

func (k *Kubernetes) Delete(state manifest.List, opts DeleteOpts) error

func (*Kubernetes) Diff

func (k *Kubernetes) Diff(state manifest.List, opts DiffOpts) (*string, error)

Diff takes the desired state and returns the differences from the cluster

func (*Kubernetes) Info

func (k *Kubernetes) Info() client.Info

Info about the client, etc.

func (*Kubernetes) Orphaned

func (k *Kubernetes) Orphaned(state manifest.List) (manifest.List, error)

Orphaned returns previously created resources that are missing from the local state. It uses UIDs to safely identify objects.