kubectl

Documentation

Index

• Constants
• Variables
• type CLI
  • func NewCLI(cfg Config, flags latestV1.KubectlFlags, defaultNamespace string) CLI
  • func (c *CLI) Apply(ctx context.Context, out io.Writer, manifests manifest.ManifestList) error
  • func (c *CLI) Delete(ctx context.Context, out io.Writer, manifests manifest.ManifestList) error
  • func (c *CLI) Kustomize(ctx context.Context, args []string) ([]byte, error)
  • func (c *CLI) ReadManifests(ctx context.Context, manifests []string) (manifest.ManifestList, error)
  • func (c *CLI) WaitForDeletions(ctx context.Context, out io.Writer, manifests manifest.ManifestList) error
• type Config
• type Deployer
  • func NewDeployer(cfg Config, labeller *label.DefaultLabeller, d *latestV1.KubectlDeploy) (*Deployer, error)
  • func (k *Deployer) Cleanup(ctx context.Context, out io.Writer, dryRun bool) error
  • func (k *Deployer) Dependencies() ([]string, error)
  • func (k *Deployer) Deploy(ctx context.Context, out io.Writer, builds []graph.Artifact) error
  • func (k *Deployer) GetAccessor() access.Accessor
  • func (k *Deployer) GetDebugger() debug.Debugger
  • func (k *Deployer) GetLogger() log.Logger
  • func (k *Deployer) GetStatusMonitor() status.Monitor
  • func (k *Deployer) GetSyncer() sync.Syncer
  • func (k *Deployer) HasRunnableHooks() bool
  • func (k *Deployer) PostDeployHooks(ctx context.Context, out io.Writer) error
  • func (k *Deployer) PreDeployHooks(ctx context.Context, out io.Writer) error
  • func (k *Deployer) RegisterLocalImages(images []graph.Artifact)
  • func (k *Deployer) Render(ctx context.Context, out io.Writer, builds []graph.Artifact, offline bool, ...) error
  • func (k *Deployer) TrackBuildArtifacts(artifacts []graph.Artifact)

Constants

const (
	KubectlVersion112 = `{"clientVersion":{"major":"1","minor":"12"}}`
	KubectlVersion118 = `{"clientVersion":{"major":"1","minor":"18"}}`
)

const DeploymentAppYAML = `apiVersion: v1
kind: Pod
metadata:
  name: leeroy-app
spec:
  containers:
  - name: leeroy-app
    image: leeroy-app`

const DeploymentAppYAMLv1 = `apiVersion: v1
kind: Pod
metadata:
  name: leeroy-app
spec:
  containers:
  - image: leeroy-app:v1
    name: leeroy-app`

const DeploymentAppYAMLv2 = `apiVersion: v1
kind: Pod
metadata:
  name: leeroy-app
spec:
  containers:
  - image: leeroy-app:v2
    name: leeroy-app`

const DeploymentWebYAML = `apiVersion: v1
kind: Pod
metadata:
  name: leeroy-web
spec:
  containers:
  - name: leeroy-web
    image: leeroy-web`

const DeploymentWebYAMLv1 = `apiVersion: v1
kind: Pod
metadata:
  name: leeroy-web
spec:
  containers:
  - image: leeroy-web:v1
    name: leeroy-web`

Variables

var TestKubeConfig = "kubeconfig"

var TestKubeContext = "kubecontext"

var TestNamespace = "testNamespace"

var TestNamespace2 = "testNamespace2"

var TestNamespace2FromEnvTemplate = "test{{.MYENV}}ace2" // needs `MYENV=Namesp` environment variable

Types

type CLI

type CLI struct {
	*kubectl.CLI
	Flags latestV1.KubectlFlags
	// contains filtered or unexported fields
}

CLI holds parameters to run kubectl.

func NewCLI

func NewCLI(cfg Config, flags latestV1.KubectlFlags, defaultNamespace string) CLI

func (*CLI) Apply

func (c *CLI) Apply(ctx context.Context, out io.Writer, manifests manifest.ManifestList) error

Apply runs `kubectl apply` on a list of manifests.

func (*CLI) Delete

func (c *CLI) Delete(ctx context.Context, out io.Writer, manifests manifest.ManifestList) error

Delete runs `kubectl delete` on a list of manifests.

func (*CLI) Kustomize

func (c *CLI) Kustomize(ctx context.Context, args []string) ([]byte, error)

Kustomize runs `kubectl kustomize` with the provided args

func (*CLI) ReadManifests

func (c *CLI) ReadManifests(ctx context.Context, manifests []string) (manifest.ManifestList, error)

ReadManifests reads a list of manifests in yaml format.

func (*CLI) WaitForDeletions

func (c *CLI) WaitForDeletions(ctx context.Context, out io.Writer, manifests manifest.ManifestList) error

WaitForDeletions waits for resource marked for deletion to complete their deletion.

type Config

type Config interface {
	kubectl.Config
	kstatus.Config
	kloader.Config
	portforward.Config
	deploy.Config
	ForceDeploy() bool
	WaitForDeletions() config.WaitForDeletions
	Mode() config.RunMode
	HydratedManifests() []string
	DefaultPipeline() latestV1.Pipeline
	Tail() bool
	PipelineForImage(imageName string) (latestV1.Pipeline, bool)
}

type Deployer

type Deployer struct {
	*latestV1.KubectlDeploy
	// contains filtered or unexported fields
}

Deployer deploys workflows using kubectl CLI.

func NewDeployer

func NewDeployer(cfg Config, labeller *label.DefaultLabeller, d *latestV1.KubectlDeploy) (*Deployer, error)

NewDeployer returns a new Deployer for a DeployConfig filled with the needed configuration for `kubectl apply`

func (*Deployer) Cleanup

func (k *Deployer) Cleanup(ctx context.Context, out io.Writer, dryRun bool) error

Cleanup deletes what was deployed by calling Deploy.

func (*Deployer) Dependencies

func (k *Deployer) Dependencies() ([]string, error)

Dependencies lists all the files that describe what needs to be deployed.

func (*Deployer) Deploy

func (k *Deployer) Deploy(ctx context.Context, out io.Writer, builds []graph.Artifact) error

Deploy templates the provided manifests with a simple `find and replace` and runs `kubectl apply` on those manifests

func (*Deployer) GetAccessor

func (k *Deployer) GetAccessor() access.Accessor

func (*Deployer) GetDebugger

func (k *Deployer) GetDebugger() debug.Debugger

func (*Deployer) GetLogger

func (k *Deployer) GetLogger() log.Logger

func (*Deployer) GetStatusMonitor

func (k *Deployer) GetStatusMonitor() status.Monitor

func (*Deployer) GetSyncer

func (k *Deployer) GetSyncer() sync.Syncer

func (*Deployer) HasRunnableHooks

func (k *Deployer) HasRunnableHooks() bool

func (*Deployer) PostDeployHooks

func (k *Deployer) PostDeployHooks(ctx context.Context, out io.Writer) error

func (*Deployer) PreDeployHooks

func (k *Deployer) PreDeployHooks(ctx context.Context, out io.Writer) error

func (*Deployer) RegisterLocalImages

func (k *Deployer) RegisterLocalImages(images []graph.Artifact)

func (*Deployer) Render

func (k *Deployer) Render(ctx context.Context, out io.Writer, builds []graph.Artifact, offline bool, filepath string) error

func (*Deployer) TrackBuildArtifacts

func (k *Deployer) TrackBuildArtifacts(artifacts []graph.Artifact)