deploy

Documentation

Index

• type Artifact
• type Deployer
  • func WithLabels(d Deployer, labellers ...Labeller) Deployer
• type HelmDeployer
  • func NewHelmDeployer(cfg *latest.HelmDeploy, kubeContext string, namespace string, ...) *HelmDeployer
  • func (h *HelmDeployer) Cleanup(ctx context.Context, out io.Writer) error
  • func (h *HelmDeployer) Dependencies() ([]string, error)
  • func (h *HelmDeployer) Deploy(ctx context.Context, out io.Writer, builds []build.Artifact) ([]Artifact, error)
  • func (h *HelmDeployer) Labels() map[string]string
• type KubectlDeployer
  • func NewKubectlDeployer(workingDir string, cfg *latest.KubectlDeploy, kubeContext string, ...) *KubectlDeployer
  • func (k *KubectlDeployer) Cleanup(ctx context.Context, out io.Writer) error
  • func (k *KubectlDeployer) Dependencies() ([]string, error)
  • func (k *KubectlDeployer) Deploy(ctx context.Context, out io.Writer, builds []build.Artifact) ([]Artifact, error)
  • func (k *KubectlDeployer) Labels() map[string]string
• type KustomizeDeployer
  • func NewKustomizeDeployer(cfg *latest.KustomizeDeploy, kubeContext string, namespace string, ...) *KustomizeDeployer
  • func (k *KustomizeDeployer) Cleanup(ctx context.Context, out io.Writer) error
  • func (k *KustomizeDeployer) Dependencies() ([]string, error)
  • func (k *KustomizeDeployer) Deploy(ctx context.Context, out io.Writer, builds []build.Artifact) ([]Artifact, error)
  • func (k *KustomizeDeployer) Labels() map[string]string
• type Labeller

Types

type Artifact

type Artifact struct {
	Obj       runtime.Object
	Namespace string
}

Artifact contains all information about a completed deployment

type Deployer

type Deployer interface {
	Labels() map[string]string

	// Deploy should ensure that the build results are deployed to the Kubernetes
	// cluster.
	Deploy(context.Context, io.Writer, []build.Artifact) ([]Artifact, error)

	// Dependencies returns a list of files that the deployer depends on.
	// In dev mode, a redeploy will be triggered
	Dependencies() ([]string, error)

	// Cleanup deletes what was deployed by calling Deploy.
	Cleanup(context.Context, io.Writer) error
}

Deployer is the Deploy API of skaffold and responsible for deploying the build results to a Kubernetes cluster

func WithLabels

func WithLabels(d Deployer, labellers ...Labeller) Deployer

WithLabels creates a deployer that sets labels on deployed resources.

type HelmDeployer

type HelmDeployer struct {
	*latest.HelmDeploy
	// contains filtered or unexported fields
}

func NewHelmDeployer

func NewHelmDeployer(cfg *latest.HelmDeploy, kubeContext string, namespace string, defaultRepo string) *HelmDeployer

NewHelmDeployer returns a new HelmDeployer for a DeployConfig filled with the needed configuration for `helm`

func (*HelmDeployer) Cleanup

func (h *HelmDeployer) Cleanup(ctx context.Context, out io.Writer) error

Cleanup deletes what was deployed by calling Deploy.

func (*HelmDeployer) Dependencies

func (h *HelmDeployer) Dependencies() ([]string, error)

func (*HelmDeployer) Deploy

func (h *HelmDeployer) Deploy(ctx context.Context, out io.Writer, builds []build.Artifact) ([]Artifact, error)

func (*HelmDeployer) Labels

func (h *HelmDeployer) Labels() map[string]string

type KubectlDeployer

type KubectlDeployer struct {
	*latest.KubectlDeploy
	// contains filtered or unexported fields
}

KubectlDeployer deploys workflows using kubectl CLI.

func NewKubectlDeployer

func NewKubectlDeployer(workingDir string, cfg *latest.KubectlDeploy, kubeContext string, namespace string, defaultRepo string) *KubectlDeployer

NewKubectlDeployer returns a new KubectlDeployer for a DeployConfig filled with the needed configuration for `kubectl apply`

func (*KubectlDeployer) Cleanup

func (k *KubectlDeployer) Cleanup(ctx context.Context, out io.Writer) error

Cleanup deletes what was deployed by calling Deploy.

func (*KubectlDeployer) Dependencies

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

func (*KubectlDeployer) Deploy

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

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

func (*KubectlDeployer) Labels

func (k *KubectlDeployer) Labels() map[string]string

type KustomizeDeployer

type KustomizeDeployer struct {
	*latest.KustomizeDeploy
	// contains filtered or unexported fields
}

KustomizeDeployer deploys workflows using kustomize CLI.

func NewKustomizeDeployer

func NewKustomizeDeployer(cfg *latest.KustomizeDeploy, kubeContext string, namespace string, defaultRepo string) *KustomizeDeployer

func (*KustomizeDeployer) Cleanup

func (k *KustomizeDeployer) Cleanup(ctx context.Context, out io.Writer) error

Cleanup deletes what was deployed by calling Deploy.

func (*KustomizeDeployer) Dependencies

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

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

func (*KustomizeDeployer) Deploy

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

Deploy runs `kubectl apply` on the manifest generated by kustomize.

func (*KustomizeDeployer) Labels

func (k *KustomizeDeployer) Labels() map[string]string

Labels returns the labels specific to kustomize.

type Labeller

type Labeller interface {
	Labels() map[string]string
}

Labeller can give key/value labels to set on deployed resources.