kubectl

Documentation

Index

• Variables
• type Client
• type Kubectl
  • func New() *Kubectl
  • func (k *Kubectl) AddNodeSelectorsToDeployment(ctx context.Context, selectors map[string]string, name string, ...) error
  • func (k *Kubectl) AddTolerationsToDeployment(ctx context.Context, tolerations []corev1.Toleration, name string, ...) error
  • func (k *Kubectl) Apply(resources kubernetes.Marshaler, forceConflicts bool) error
  • func (k *Kubectl) CreateConfigMap(ctx context.Context, configMap corev1.ConfigMap) error
  • func (k *Kubectl) SetKubeconfig(kubeconfig []byte)
  • func (k *Kubectl) WaitForCRDs(ctx context.Context, crds []string) error

Variables

var ErrKubeconfigNotSet = errors.New("kubeconfig not set")

ErrKubeconfigNotSet is the error value returned by Kubectl.Apply when SetKubeconfig was not called first.

Types

type Client

type Client interface {
	// ApplyOneObject applies a k8s resource similar to kubectl apply.
	ApplyOneObject(info *resource.Info, forceConflicts bool) error
	// GetObjects converts resources into prepared info fields for use in ApplyOneObject.
	GetObjects(resources kubernetes.Marshaler) ([]*resource.Info, error)
	CreateConfigMap(ctx context.Context, configMap corev1.ConfigMap) error
	AddTolerationsToDeployment(ctx context.Context, tolerations []corev1.Toleration, name string, namespace string) error
	AddNodeSelectorsToDeployment(ctx context.Context, selectors map[string]string, name string, namespace string) error
	// WaitForCRD waits for the given CRD to be established.
	WaitForCRD(ctx context.Context, crd string) error
}

Client wraps marshable k8s resources into resource.Info fields and applies them in a cluster.

type Kubectl

type Kubectl struct {
	// contains filtered or unexported fields
}

Kubectl implements kubernetes.Apply interface and acts like the Kubernetes "kubectl" tool.

func New

func New() *Kubectl

New creates a new kubectl using the real clientGenerator.

func (*Kubectl) AddNodeSelectorsToDeployment

func (k *Kubectl) AddNodeSelectorsToDeployment(ctx context.Context, selectors map[string]string, name string, namespace string) error

func (*Kubectl) AddTolerationsToDeployment

func (k *Kubectl) AddTolerationsToDeployment(ctx context.Context, tolerations []corev1.Toleration, name string, namespace string) error

func (*Kubectl) Apply

func (k *Kubectl) Apply(resources kubernetes.Marshaler, forceConflicts bool) error

Apply will apply the given resources using server-side-apply.

func (*Kubectl) CreateConfigMap

func (k *Kubectl) CreateConfigMap(ctx context.Context, configMap corev1.ConfigMap) error

func (*Kubectl) SetKubeconfig

func (k *Kubectl) SetKubeconfig(kubeconfig []byte)

SetKubeconfig will store the kubeconfig to generate Clients using the clientGenerator later.

func (*Kubectl) WaitForCRDs

func (k *Kubectl) WaitForCRDs(ctx context.Context, crds []string) error

WaitForCRD waits for a list of CRDs to be established.