Render [NEW] on Skaffold

Raw YAML

Mon, 01 Jan 0001 00:00:00 +0000

Rendering with raw YAML

In the case that your project does not currently use a render engine (helm, kustomize, kpt, etc), the rawYaml renderer should be used. This instructs skaffold to only do it’s own yaml field replacement (image: and labels: modifications) and not to use any additional render engine.

Configuration

To use rawYaml, add render type rawYaml to the manifests section of skaffold.yaml.

The rawYaml configuration accepts a list of paths to your manifests with glob syntax supported.

Kpt [NEW]

Mon, 01 Jan 0001 00:00:00 +0000

Note

kpt CLI must be installed on your machine for the below functionality. Skaffold will not install it.

`manifests.transform` and `manifests.validate` functionality powered by kpt

With Skaffold V2, skaffold now has a new render phase and associated manifests top level config field. Along with these changes, a manifests.transform and a manifests.validate field were added which allows users to specify kpt manifest transformations and validations to be done in the render phase. manifests.transform allows users to create a pipeline of manifest transformations which transform manifests via the specified container. For more information on the manifests.transform functionality see, the docs for kpt mutators here. For a list of kpt supported containers to use in the manifests.transform schema see the list here with the tag mutator. manifests.validate allows users to create a pipeline of manifest validations that run serially, checking the yaml manifests for the specified validation test. For more information on the manifests.validate functionality, see the docs for kpt validators here. For a list of kpt supported containers to use in the manifests.validate schema see the list here with the tag validator.

Kustomize

Mon, 01 Jan 0001 00:00:00 +0000

Rendering with kustomize

kustomize allows Kubernetes developers to customize raw, template-free YAML files for multiple purposes. Skaffold can work with kustomize by calling its command-line interface.

Configuration

To use kustomize with Skaffold, add render type kustomize to the manifests section of skaffold.yaml.

The kustomize configuration accepts a list of paths to folders containing a kustomize.yaml file.

Example

The following manifests section instructs Skaffold to render artifacts using kustomize. Each entry should point to a folder with a kustomize.yaml file.

Helm [UPDATED]

Mon, 01 Jan 0001 00:00:00 +0000

helm is a package manager for Kubernetes that helps you manage Kubernetes applications. Skaffold natively supports iterative development for projects configured to use helm.

Note

To use helm with Skaffold, the helm binary must be installed on your machine. Skaffold will not install it for you.

Configuring your Helm Project with Skaffold

Skaffold supports projects set up to render and/or deploy with Helm, but certain aspects of the project need to be configured correctly in order for Skaffold to work properly. This guide should demystify some of the nuance around using Skaffold with Helm to help you get started quickly.

Render [NEW] on Skaffold

Raw YAML

Rendering with raw YAML

Configuration

Kpt [NEW]

Note

manifests.transform and manifests.validate functionality powered by kpt

Kustomize

Rendering with kustomize

Configuration

Example

Helm [UPDATED]

Note

Configuring your Helm Project with Skaffold

`manifests.transform` and `manifests.validate` functionality powered by kpt