Documentation
¶
Index ¶
- Constants
- func AddManifestTransform(newTransform ManifestTransform)
- func StatusCheck(ctx context.Context, defaultLabeller *DefaultLabeller, ...) error
- type Artifact
- type DefaultLabeller
- type Deployer
- type HelmDeployer
- type KubectlDeployer
- type 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, ...) error
- func (k *KustomizeDeployer) Labels() map[string]string
- type Labeller
- type ManifestTransform
Constants ¶
const ( K8ManagedByLabelKey = "app.kubernetes.io/managed-by" UnknownVersion = "unknown" Empty = "" )
Variables ¶
This section is empty.
Functions ¶
func AddManifestTransform ¶ added in v0.26.0
func AddManifestTransform(newTransform ManifestTransform)
AddManifestTransform adds a transform to be applied when deploying.
func StatusCheck ¶ added in v0.34.0
func StatusCheck(ctx context.Context, defaultLabeller *DefaultLabeller, runCtx *runcontext.RunContext) error
Types ¶
type DefaultLabeller ¶ added in v0.33.0
type DefaultLabeller struct {
// contains filtered or unexported fields
}
DefaultLabeller adds K9 style managed-by label
func NewLabeller ¶ added in v0.33.0
func NewLabeller(verStr string) *DefaultLabeller
func (*DefaultLabeller) K8sManagedByLabelKeyValueString ¶ added in v0.33.0
func (d *DefaultLabeller) K8sManagedByLabelKeyValueString() string
func (*DefaultLabeller) Labels ¶ added in v0.33.0
func (d *DefaultLabeller) Labels() map[string]string
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, []Labeller) 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
type HelmDeployer ¶
type HelmDeployer struct {
*latest.HelmDeploy
// contains filtered or unexported fields
}
func NewHelmDeployer ¶
func NewHelmDeployer(runCtx *runcontext.RunContext) *HelmDeployer
NewHelmDeployer returns a new HelmDeployer for a DeployConfig filled with the needed configuration for `helm`
func (*HelmDeployer) Dependencies ¶ added in v0.5.0
func (h *HelmDeployer) Dependencies() ([]string, error)
func (*HelmDeployer) Labels ¶ added in v0.8.0
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(runCtx *runcontext.RunContext) *KubectlDeployer
NewKubectlDeployer returns a new KubectlDeployer for a DeployConfig filled with the needed configuration for `kubectl apply`
func (*KubectlDeployer) Cleanup ¶ added in v0.5.0
Cleanup deletes what was deployed by calling Deploy.
func (*KubectlDeployer) Dependencies ¶ added in v0.5.0
func (k *KubectlDeployer) Dependencies() ([]string, error)
func (*KubectlDeployer) Deploy ¶ added in v0.3.0
func (k *KubectlDeployer) Deploy(ctx context.Context, out io.Writer, builds []build.Artifact, labellers []Labeller) error
Deploy templates the provided manifests with a simple `find and replace` and runs `kubectl apply` on those manifests
func (*KubectlDeployer) Labels ¶ added in v0.8.0
func (k *KubectlDeployer) Labels() map[string]string
type KustomizeDeployer ¶ added in v0.7.0
type KustomizeDeployer struct {
*latest.KustomizeDeploy
// contains filtered or unexported fields
}
KustomizeDeployer deploys workflows using kustomize CLI.
func NewKustomizeDeployer ¶ added in v0.7.0
func NewKustomizeDeployer(runCtx *runcontext.RunContext) *KustomizeDeployer
func (*KustomizeDeployer) Cleanup ¶ added in v0.7.0
Cleanup deletes what was deployed by calling Deploy.
func (*KustomizeDeployer) Dependencies ¶ added in v0.7.0
func (k *KustomizeDeployer) Dependencies() ([]string, error)
Dependencies lists all the files that can change what needs to be deployed.
func (*KustomizeDeployer) Deploy ¶ added in v0.7.0
func (k *KustomizeDeployer) Deploy(ctx context.Context, out io.Writer, builds []build.Artifact, labellers []Labeller) error
Deploy runs `kubectl apply` on the manifest generated by kustomize.
func (*KustomizeDeployer) Labels ¶ added in v0.8.0
func (k *KustomizeDeployer) Labels() map[string]string
Labels returns the labels specific to kustomize.
type Labeller ¶ added in v0.9.0
type Labeller interface {
// Labels keys must be prefixed with "skaffold.dev/"
Labels() map[string]string
}
Labeller can give key/value labels to set on deployed resources.
type ManifestTransform ¶ added in v0.27.0
type ManifestTransform func(l kubectl.ManifestList, builds []build.Artifact, insecureRegistries map[string]bool) (kubectl.ManifestList, error)
Source Files
Directories