skaffold.yaml
v1beta7Schema URL
Any of
Definitions
criteria by which a profile is auto-activated.
a Skaffold command for which the profile is auto-activated.
a key=value pair. The profile is auto-activated if an Environment Variable key has value value.
a Kubernetes context for which the profile is auto-activated.
items that need to be built, along with the context in which they should be built.
beta describes an artifact built with Bazel.
bazel build target to run.
additional args to pass to bazel build.
contains all the configuration for the build steps.
contains all fields necessary for specifying a build plugin.
name of the build plugin.
key-value pairs passed to the plugin.
beta describes how to do an on-cluster build.
contains information about the docker config.json to mount.
2 nested properties
path to the docker config.json.
Kubernetes secret that will hold the Docker configuration.
Kubernetes namespace. Defaults to current namespace in Kubernetes configuration.
path to the secret key file.
name of the Kubernetes secret for pulling the files from the build context and pushing the final image.
amount of time (in seconds) that this build is allowed to run. Defaults to 20 minutes (20m).
beta tags images with the build timestamp.
formats the date and time. See #Time.Format.
sets the timezone for the date and time. See Time.LoadLocation. Defaults to the local timezone.
contains all the configuration needed by the deploy steps.
beta describes an artifact built from a Dockerfile, usually using docker build.
arguments passed to the docker build.
the Docker images used as cache sources.
locates the Dockerfile relative to workspace.
Dockerfile target name to build.
contains information about the docker config.json to mount.
path to the docker config.json.
Kubernetes secret that will hold the Docker configuration.
beta tags images with a configurable template string.
used to produce the image name and tag. See golang text/template. The template is executed against the current environment, with those variables injected: IMAGE_NAME | Name of the image being built, as supplied in the artifacts section.
name of an execution environment.
environment in which the build should run (ex. local or in-cluster, etc.).
name of an execution environment.
key-value pairs passed to the environment.
beta tags images with the git tag or commit of the artifact's workspace.
beta describes how to do a remote build on Google Cloud Build. Docker and Jib artifacts can be built on Cloud Build. The projectId needs to be provided and the currently logged in user should be given permissions to trigger new builds.
disk size of the VM that runs the build. See Cloud Build Reference.
image that runs a Docker build. See Cloud Builders.
image that runs a Gradle build. See Cloud Builders.
type of the VM that runs the build. See Cloud Build Reference.
image that runs a Maven build. See Cloud Builders.
ID of your Cloud Platform Project. If it is not provided, Skaffold will guess it from the image name. For example, given the artifact image name gcr.io/myproject/image, Skaffold will use the myproject GCP project.
amount of time (in seconds) that this build should be allowed to run. See Cloud Build Reference.
image config in the syntax of image.repository and image.tag.
beta uses the helm CLI to apply the charts to the cluster.
a list of Helm releases.
additional option flags that are passed on the command line to helm.
3 nested properties
additional flags passed on every command.
additional flags passed to (helm install).
additional flags passed to (helm upgrade).
additional option flags that are passed on the command line to helm.
additional flags passed on every command.
additional flags passed to (helm install).
additional flags passed to (helm upgrade).
image config to use the FullyQualifiedImageName as param to set.
defines the image config.
adds image configurations to the Helm values file.
parameters for packaging helm chart (helm package).
sets the appVersion on the chart to this version.
sets the version on the chart to this semver version.
describes a helm release to be deployed.
path to the Helm chart.
name of the Helm release.
adds image configurations to the Helm values file.
Kubernetes namespace.
key-value pairs. If present, Skaffold will build a Helm values file that overrides the original and use it to call Helm CLI (--f flag).
parameters for packaging helm chart (helm package).
2 nested properties
sets the appVersion on the chart to this version.
sets the version on the chart to this semver version.
if true, Skaffold will send --recreate-pods flag to Helm CLI.
key-value pairs. If present, Skaffold will try to parse the value part of each key-value pair using environment variables in the system, then send --set flag to Helm CLI and append all parsed pairs after the flag.
key-value pairs. If present, Skaffold will send --set flag to Helm CLI and append all pairs after the flag.
should build dependencies be skipped.
instructs skaffold to use secrets plugin on deployment.
key-value pairs supplementing the Helm values file.
paths to the Helm values files.
version of the chart.
if true, Skaffold will send --wait flag to Helm CLI.
patch to be applied by a profile.
position in the yaml where the operation takes place. For example, this targets the dockerfile of the first artifact built.
source position in the yaml, used for copy or move operations.
operation carried by the patch: add, remove, replace, move, copy or test.
value to apply. Can be any portion of yaml.
alpha builds images using the Jib plugin for Gradle.
additional build flags passed to Gradle.
selects which Gradle project to build.
alpha builds images using the Jib plugin for Maven.
additional build flags passed to Maven.
selects which Maven module to build, for a multi module project.
selects which Maven profile to activate.
alpha describes an artifact built from a Dockerfile, with kaniko.
arguments passed to the docker build.
contains the different fields available to specify a Kaniko build context.
2 nested properties
CGS bucket to which sources are uploaded. Kaniko will need access to that bucket to download the sources.
configures how Kaniko mounts sources directly via an emptyDir volume.
1 nested properties
image used to run init container which mounts kaniko context.
configures Kaniko caching. If a cache is specified, Kaniko will use a remote cache which will speed up builds.
1 nested properties
a remote repository to store cached layers. If none is specified, one will be inferred from the image name. See Kaniko Caching.
locates the Dockerfile relative to workspace.
additional flags to be passed to Kaniko command line. See Kaniko Additional Flags. Deprecated - instead the named, unique fields should be used, e.g. buildArgs, cache, target.
Docker image used by the Kaniko pod. Defaults to the latest released version of gcr.io/kaniko-project/executor.
Dockerfile target name to build.
contains the different fields available to specify a Kaniko build context.
CGS bucket to which sources are uploaded. Kaniko will need access to that bucket to download the sources.
configures how Kaniko mounts sources directly via an emptyDir volume.
1 nested properties
image used to run init container which mounts kaniko context.
configures Kaniko caching. If a cache is specified, Kaniko will use a remote cache which will speed up builds.
a remote repository to store cached layers. If none is specified, one will be inferred from the image name. See Kaniko Caching.
beta uses a client side kubectl apply to deploy manifests. You'll need a kubectl CLI version installed that's compatible with your cluster.
additional flags passed on the command line to kubectl either on every command (Global), on creations (Apply) or deletions (Delete).
3 nested properties
additional flags passed on creations (kubectl apply).
additional flags passed on deletions (kubectl delete).
additional flags passed on every command.
the Kubernetes yaml or json manifests.
Kubernetes manifests in remote clusters.
additional flags passed on the command line to kubectl either on every command (Global), on creations (Apply) or deletions (Delete).
additional flags passed on creations (kubectl apply).
additional flags passed on deletions (kubectl delete).
additional flags passed on every command.
beta uses the kustomize CLI to "patch" a deployment for a target environment.
additional flags passed on the command line to kubectl either on every command (Global), on creations (Apply) or deletions (Delete).
3 nested properties
additional flags passed on creations (kubectl apply).
additional flags passed on deletions (kubectl delete).
additional flags passed on every command.
path to Kustomization files.
beta describes how to do a build on the local docker daemon and optionally push to a repository.
should images be pushed to a registry. If not specified, images are pushed only if the current Kubernetes context connects to a remote cluster.
use BuildKit to build Docker images. If unspecified, uses the Docker default.
use docker command-line interface instead of Docker Engine APIs.
configures how Kaniko mounts sources directly via an emptyDir volume.
image used to run init container which mounts kaniko context.
beta profiles are used to override any build, test or deploy configuration.
a unique profile name.
criteria by which a profile can be auto-activated. The profile is auto-activated if any one of the activations are triggered. An activation is triggered if all of the criteria (env, kubeContext, command) are triggered.
contains all the configuration for the build steps.
contains all the configuration needed by the deploy steps.
patches applied to the configuration. Patches use the JSON patch notation.
replaces the main test configuration.
beta tags images with their sha256 digest.
describes a Skaffold pipeline.
version of the configuration.
contains all the configuration for the build steps.
contains all the configuration needed by the deploy steps.
always Config.
beta can override be used to build, test or deploy configuration.
describes how images are tested.
contains all the configuration for the tagging step.
beta tags images with the build timestamp.
2 nested properties
formats the date and time. See #Time.Format.
sets the timezone for the date and time. See Time.LoadLocation. Defaults to the local timezone.
beta tags images with a configurable template string.
1 nested properties
used to produce the image name and tag. See golang text/template. The template is executed against the current environment, with those variables injected: IMAGE_NAME | Name of the image being built, as supplied in the artifacts section.
beta tags images with the git tag or commit of the artifact's workspace.
beta tags images with their sha256 digest.
a list of structure tests to run on images that Skaffold builds.
artifact on which to run those tests.
the Container Structure Tests to run on that artifact.