skaffold.yaml
v2beta25Schema URL
Any of
Definitions
criteria by which a profile is auto-activated.
a Skaffold command for which the profile is auto-activated.
a key=pattern pair. The profile is auto-activated if an Environment Variable key matches the pattern. If the pattern starts with !, activation happens if the remaining pattern is not matched. The pattern matches if the Environment Variable value is exactly pattern, or the regex pattern is found in it. An empty pattern (e.g. env: "key=") always only matches if the Environment Variable is undefined or empty.
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.
describes a specific build dependency for an artifact.
a reference to an artifact's image name.
a token that is replaced with the image reference in the builder definition files. For example, the docker builder will use the alias as a build-arg key. Defaults to the value of image.
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.
describes the list of lifecycle hooks to execute before and after each artifact build step.
describes the list of lifecycle hooks to execute after each artifact build step.
describes the list of lifecycle hooks to execute before each artifact build step.
alpha describes an artifact built using Cloud Native Buildpacks. It can be used to build images out of project's sources without any additional configuration.
builder image used.
a list of strings, where each string is a specific buildpack to use with the builder. If you specify buildpacks the builder image automatic detection will be ignored. These buildpacks will be used to build the Image from your source code. Order matters.
alpha used to specify dependencies for an artifact built by buildpacks.
2 nested properties
specifies the paths that should be ignored by skaffold's file watcher. If a file exists in both paths and in ignore, it will be ignored, and will be excluded from both rebuilds and file synchronization. Will only work in conjunction with paths.
should be set to the file dependencies for this artifact, so that the skaffold file watcher knows when to rebuild and perform file synchronization.
environment variables, in the key=value form, passed to the build. Values can use the go template syntax.
path to the project descriptor file.
overrides the stack's default run image.
indicates that the builder should be trusted.
support mounting host volumes into the container.
alpha used to specify dependencies for an artifact built by buildpacks.
specifies the paths that should be ignored by skaffold's file watcher. If a file exists in both paths and in ignore, it will be ignored, and will be excluded from both rebuilds and file synchronization. Will only work in conjunction with paths.
should be set to the file dependencies for this artifact, so that the skaffold file watcher knows when to rebuild and perform file synchronization.
alpha used to mount host volumes or directories in the build container.
local volume or absolute directory of the path to mount.
path where the file or directory is available in the container. It is strongly recommended to not specify locations under /cnb or /layers.
specify a list of comma-separated mount options. Valid options are: ro (default): volume contents are read-only. rw: volume contents are readable and writable. volume-opt=<key>=<value>: can be specified more than once, takes a key-value pair.
beta describes how to do an on-cluster build.
for kaniko pod.
for kaniko pod.
describes the Kubernetes annotations for the pod.
how many artifacts can be built concurrently. 0 means "no-limit".
contains information about the docker config.json to mount.
2 nested properties
path to the docker config.json.
Kubernetes secret that contains the config.json Docker configuration. Note that the expected secret type is not 'kubernetes.io/dockerconfigjson' but 'Opaque'.
Kubernetes namespace. Defaults to current namespace in Kubernetes configuration.
describes the Kubernetes node selector for the pod.
path the pull secret will be mounted at within the running container.
name of the Kubernetes secret for pulling base images and pushing the final image. If given, the secret needs to contain the Google Cloud service account secret key under the key kaniko-secret.
path to the Google Cloud service account secret key file.
adds a random UUID postfix to the default name of the docker secret to facilitate parallel builds, e.g. docker-cfgfd154022-c761-416f-8eb3-cf8258450b85.
adds a random UUID postfix to the default name of the pull secret to facilitate parallel builds, e.g. kaniko-secretdocker-cfgfd154022-c761-416f-8eb3-cf8258450b85.
describes the resource requirements for the kaniko pod.
2 nested properties
stores the CPU/Memory requirements for the pod.
4 nested properties
the number cores to be used.
the amount of Ephemeral storage to allocate to the pod.
the amount of memory to allocate to the pod.
the amount of resource storage to allocate to the pod.
stores the CPU/Memory requirements for the pod.
4 nested properties
the number cores to be used.
the amount of Ephemeral storage to allocate to the pod.
the amount of memory to allocate to the pod.
the amount of resource storage to allocate to the pod.
defines the UID to request for running the container. If omitted, no SecurityContext will be specified for the pod and will therefore be inherited from the service account.
describes the Kubernetes service account to use for the pod. Defaults to 'default'.
amount of time (in seconds) that this build is allowed to run. Defaults to 20 minutes (20m).
describes the Kubernetes tolerations for the pod.
defines container mounts for ConfigMap and Secret resources.
describes a dependency on another skaffold configuration.
describes the list of profiles to activate when resolving the required configs. These profiles must exist in the imported config.
includes specific named configs within the file path. If empty, then all configs in the file are included.
contains information on the origin of skaffold configurations cloned from a git repository.
4 nested properties
git repository the package should be cloned from. e.g. <https://github.com/GoogleContainerTools/skaffold.git>.
relative path from the repo root to the skaffold configuration file. eg. getting-started/skaffold.yaml.
git ref the package should be cloned from. eg. master or main.
when set to true will reset the cached repository to the latest commit from remote on every run. To use the cached repository with uncommitted changes or unpushed commits, it needs to be set to false.
describes the path to the file containing the required configs.
describes a lifecycle hook definition to execute on a container. The container name is inferred from the scope in which this hook is defined.
command to execute.
beta describes an artifact built from a custom build script written by the user. It can be used to build images with builders that aren't directly integrated with skaffold.
command executed to build the image.
beta used to specify dependencies for an artifact built by a custom build script. Either dockerfile or paths should be specified for file watching to work as expected.
4 nested properties
represents a custom command that skaffold executes to obtain dependencies. The output of this command must be a valid JSON array.
beta used to specify a custom build artifact that is built from a Dockerfile. This allows skaffold to determine dependencies from the Dockerfile.
2 nested properties
key/value pairs used to resolve values of ARG instructions in a Dockerfile. Values can be constants or environment variables via the go template syntax.
locates the Dockerfile relative to workspace.
specifies the paths that should be ignored by skaffold's file watcher. If a file exists in both paths and in ignore, it will be ignored, and will be excluded from both rebuilds and file synchronization. Will only work in conjunction with paths.
should be set to the file dependencies for this artifact, so that the skaffold file watcher knows when to rebuild and perform file synchronization.
beta used to specify dependencies for an artifact built by a custom build script. Either dockerfile or paths should be specified for file watching to work as expected.
represents a custom command that skaffold executes to obtain dependencies. The output of this command must be a valid JSON array.
beta used to specify a custom build artifact that is built from a Dockerfile. This allows skaffold to determine dependencies from the Dockerfile.
2 nested properties
key/value pairs used to resolve values of ARG instructions in a Dockerfile. Values can be constants or environment variables via the go template syntax.
locates the Dockerfile relative to workspace.
specifies the paths that should be ignored by skaffold's file watcher. If a file exists in both paths and in ignore, it will be ignored, and will be excluded from both rebuilds and file synchronization. Will only work in conjunction with paths.
should be set to the file dependencies for this artifact, so that the skaffold file watcher knows when to rebuild and perform file synchronization.
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 provided components with those variables injected.
TaggerComponents that the template (see field above) can be executed against.
describes the custom test command provided by the user. Custom tests are run after an image build whenever build or test dependencies are changed.
custom command to be executed. If the command exits with a non-zero return code, the test will be considered to have failed.
used to specify dependencies for custom test command. paths should be specified for file watching to work as expected.
3 nested properties
represents a command that skaffold executes to obtain dependencies. The output of this command must be a valid JSON array.
specifies the paths that should be ignored by skaffold's file watcher. If a file exists in both paths and in ignore, it will be ignored, and will be excluded from both retest and file synchronization. Will only work in conjunction with paths.
locates the file dependencies for the command relative to workspace. Paths should be set to the file dependencies for this command, so that the skaffold file watcher knows when to retest and perform file synchronization.
sets the wait time for skaffold for the command to complete. If unset or 0, Skaffold will wait until the command completes.
used to specify dependencies for custom test command. paths should be specified for file watching to work as expected.
represents a command that skaffold executes to obtain dependencies. The output of this command must be a valid JSON array.
specifies the paths that should be ignored by skaffold's file watcher. If a file exists in both paths and in ignore, it will be ignored, and will be excluded from both retest and file synchronization. Will only work in conjunction with paths.
locates the file dependencies for the command relative to workspace. Paths should be set to the file dependencies for this command, so that the skaffold file watcher knows when to retest and perform file synchronization.
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.
uses the docker CLI to create application containers in Docker.
2 nested properties
container images to run in Docker.
tells skaffold whether or not to deploy using docker-compose.
beta uses the helm CLI to apply the charts to the cluster.
3 nested properties
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).
describes the list of lifecycle hooks to execute before and after each deployer step.
2 nested properties
describes the list of lifecycle hooks to execute after each deployer step.
describes the list of lifecycle hooks to execute before each deployer step. Container hooks will only run if the container exists from a previous deployment step (for instance the successive iterations of a dev-loop during skaffold dev).
alpha uses the kpt CLI to manage and deploy manifests.
3 nested properties
path to the config directory (Required). By default, the Dir contains the application configurations, kustomize config files and declarative kpt functions.
adds additional configurations used when calling kpt fn.
7 nested properties
directory to discover the declarative kpt functions. If not provided, kpt deployer uses kpt.Dir.
sets the global scope for the kpt functions. see kpt help fn run.
a kpt function image to run the configs imperatively. If provided, kpt.fn.fnPath will be ignored.
a list of storage options to mount to the fn image.
enables network access for the kpt function containers.
docker network name to run the kpt function containers (default "bridge").
directory to where the manipulated resource output is stored.
Kubernetes context that Skaffold should deploy to.
beta uses a client side kubectl apply to deploy manifests. You'll need a kubectl CLI version installed that's compatible with your cluster.
5 nested properties
default namespace passed to kubectl on deployment if no other override is given.
additional flags passed on the command line to kubectl either on every command (Global), on creations (Apply) or deletions (Delete).
4 nested properties
additional flags passed on creations (kubectl apply).
additional flags passed on deletions (kubectl delete).
passes the --validate=false flag to supported kubectl commands when enabled.
additional flags passed on every command.
describes the list of lifecycle hooks to execute before and after each deployer step.
2 nested properties
describes the list of lifecycle hooks to execute after each deployer step.
describes the list of lifecycle hooks to execute before each deployer step. Container hooks will only run if the container exists from a previous deployment step (for instance the successive iterations of a dev-loop during skaffold dev).
the Kubernetes yaml or json manifests.
Kubernetes manifests in remote clusters.
beta uses the kustomize CLI to "patch" a deployment for a target environment.
5 nested properties
additional args passed to kustomize build.
default namespace passed to kubectl on deployment if no other override is given.
additional flags passed on the command line to kubectl either on every command (Global), on creations (Apply) or deletions (Delete).
4 nested properties
additional flags passed on creations (kubectl apply).
additional flags passed on deletions (kubectl delete).
passes the --validate=false flag to supported kubectl commands when enabled.
additional flags passed on every command.
describes the list of lifecycle hooks to execute before and after each deployer step.
2 nested properties
describes the list of lifecycle hooks to execute after each deployer step.
describes the list of lifecycle hooks to execute before each deployer step. Container hooks will only run if the container exists from a previous deployment step (for instance the successive iterations of a dev-loop during skaffold dev).
path to Kustomization files.
configures how container logs are printed as a result of a deployment.
1 nested properties
defines the prefix shown on each log line. Valid values are container: prefix logs lines with the name of the container. podAndContainer: prefix logs lines with the names of the pod and of the container. auto: same as podAndContainer except that the pod name is skipped if it's the same as the container name. none: don't add a prefix.
beta enables waiting for deployments to stabilize.
beta deadline for deployments to stabilize in seconds.
describes a single lifecycle hook to execute before or after each deployer step.
describes a lifecycle hook definition to execute on a named container.
3 nested properties
command to execute.
name of the pod to execute the command in.
name of the container to execute the command in.
describes a lifecycle hook definition to execute on the host machine.
2 nested properties
command to execute.
an optional slice of operating system names. If the host machine OS is different, then it skips execution.
describes the list of lifecycle hooks to execute before and after each deployer step.
describes the list of lifecycle hooks to execute after each deployer step.
describes the list of lifecycle hooks to execute before each deployer step. Container hooks will only run if the container exists from a previous deployment step (for instance the successive iterations of a dev-loop during skaffold dev).
describes an artifact built from a Dockerfile, usually using docker build.
add host.
arguments passed to the docker build.
the Docker images used as cache sources.
any additional flags to pass to the local daemon during a build. These flags are only used during a build through the Docker CLI.
locates the Dockerfile relative to workspace.
passed through to docker and overrides the network configuration of docker builder. If unset, use whatever is configured in the underlying docker daemon. Valid modes are host: use the host's networking stack. bridge: use the bridged network configuration. container:<name|id>: reuse another container's network stack. none: no networking in the container.
used to pass in --no-cache to docker build to prevent caching.
used to pass in --secret to docker build, useBuildKit: true is required.
used to pass in --squash to docker build to squash docker image layers into single layer.
used to pass in --ssh to docker build to use SSH agent. Format is "default|
Dockerfile target name to build.
contains information about the docker config.json to mount.
path to the docker config.json.
Kubernetes secret that contains the config.json Docker configuration. Note that the expected secret type is not 'kubernetes.io/dockerconfigjson' but 'Opaque'.
uses the docker CLI to create application containers in Docker.
container images to run in Docker.
tells skaffold whether or not to deploy using docker-compose.
used to pass in --secret to docker build, useBuildKit: true is required.
id of the secret.
environment variable name containing the secret value.
path to the secret on the host machine.
beta used to specify a custom build artifact that is built from a Dockerfile. This allows skaffold to determine dependencies from the Dockerfile.
key/value pairs used to resolve values of ARG instructions in a Dockerfile. Values can be constants or environment variables via the go template syntax.
locates the Dockerfile relative to workspace.
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.
contains information on the origin of skaffold configurations cloned from a git repository.
git repository the package should be cloned from. e.g. <https://github.com/GoogleContainerTools/skaffold.git>.
relative path from the repo root to the skaffold configuration file. eg. getting-started/skaffold.yaml.
git ref the package should be cloned from. eg. master or main.
when set to true will reset the cached repository to the latest commit from remote on every run. To use the cached repository with uncommitted changes or unpushed commits, it needs to be set to false.
beta tags images with the git tag or commit of the artifact's workspace.
specifies whether to omit the -dirty postfix if there are uncommitted changes.
adds a fixed prefix to the tag.
determines the behavior of the git tagger. Valid variants are: Tags (default): use git tags or fall back to abbreviated commit hash. CommitSha: use the full git commit sha. AbbrevCommitSha: use the abbreviated git commit sha. TreeSha: use the full tree hash of the artifact workingdir. AbbrevTreeSha: use the abbreviated tree hash of the artifact workingdir.
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.
how many artifacts can be built concurrently. 0 means "no-limit".
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.
image that runs a Kaniko build. See Cloud Builders.
specifies the behavior when writing build logs to Google Cloud Storage. Valid options are: STREAM_DEFAULT: Service may automatically determine build log streaming behavior. STREAM_ON: Build logs should be streamed to Google Cloud Storage. STREAM_OFF: Build logs should not be streamed to Google Cloud Storage; they will be written when the build is completed. See Cloud Build Reference.
specifies the logging mode. Valid modes are: LOGGING_UNSPECIFIED: The service determines the logging mode. LEGACY: Stackdriver logging and Cloud Storage logging are enabled (default). GCS_ONLY: Only Cloud Storage logging is enabled. See Cloud Build Reference.
type of the VM that runs the build. See Cloud Build Reference.
image that runs a Maven build. See Cloud Builders.
image that runs a Cloud Native Buildpacks 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.
configures a pool of workers to run the build.
image config in the syntax of image.repository and image.tag.
separates image.registry to the image config syntax. Useful for some charts e.g. postgresql.
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).
describes the list of lifecycle hooks to execute before and after each deployer step.
2 nested properties
describes the list of lifecycle hooks to execute after each deployer step.
describes the list of lifecycle hooks to execute before each deployer step. Container hooks will only run if the container exists from a previous deployment step (for instance the successive iterations of a dev-loop during skaffold dev).
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.
name of the Helm release. It accepts environment variables via the go template syntax.
key value pairs where the key represents the parameter used in the --set-string Helm CLI flag to define a container image and the value corresponds to artifact i.e. ImageName defined in Build.Artifacts section. The resulting command-line is controlled by ImageStrategy.
local path to a packaged Helm chart or an unpacked Helm chart directory.
if true, Skaffold will send --create-namespace flag to Helm CLI. --create-namespace flag is available in Helm since version 3.2. Defaults is false.
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 when upgrading a new version of a chart in subsequent dev loop deploy.
refers to a remote Helm chart reference or URL.
specifies the helm repository for remote charts. If present, Skaffold will send --repo Helm CLI flag or flags.
key-value pairs. If present, Skaffold will send --set-file flag to Helm CLI and append all pairs after the flag.
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. Ignored for remoteChart.
specifies whether to upgrade helm chart on code changes. Default is true when helm chart is local (has chartPath). Default is false when helm chart is remote (has remoteChart).
instructs skaffold to use secrets plugin on deployment.
paths to the Helm values files.
version of the chart.
if true, Skaffold will send --wait flag to Helm CLI.
describes a lifecycle hook definition to execute on the host machine.
command to execute.
an optional slice of operating system names. If the host machine OS is different, then it skips execution.
beta tags hashes the image content.
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.
builds images using the Jib plugins for Maven and Gradle.
additional build flags passed to the builder.
overrides the configured jib base image.
selects which sub-project to build for multi-module builds.
the Jib builder type; normally determined automatically. Valid types are maven: for Maven. gradle: for Gradle.
describes an artifact built from a Dockerfile, with kaniko.
arguments passed to the docker build. It also accepts environment variables and generated values via the go template syntax. Exposed generated values: IMAGE_REPO, IMAGE_NAME, IMAGE_TAG.
configures Kaniko caching. If a cache is specified, Kaniko will use a remote cache which will speed up builds.
4 nested properties
enables caching of copy layers.
specifies a path on the host that is mounted to each pod as read only cache volume containing base images. If set, must exist on each node and prepopulated with kaniko-warmer.
a remote repository to store cached layers. If none is specified, one will be inferred from the image name. See Kaniko Caching.
Cache timeout in hours.
to clean the filesystem at the end of the build.
to specify a file in the container. This file will receive the digest of a built image. This can be used to automatically track the exact image built by kaniko.
locates the Dockerfile relative to workspace.
environment variables passed to the kaniko pod. It also accepts environment variables via the go template syntax.
building outside of a container.
Docker image used by the Kaniko pod. Defaults to the latest released version of gcr.io/kaniko-project/executor.
number of retries that should happen for extracting an image filesystem.
specify a file to save the image name with digest of the built image to.
image used to run init container which mounts kaniko context.
if you want to push images to a plain HTTP registry.
if you want to pull images from a plain HTTP registry.
to use plain HTTP requests when accessing a registry.
key: value to set some metadata to the final image. This is equivalent as using the LABEL within the Dockerfile.
<text|color|json> to set the log format.
to add timestamps to log format.
if you only want to build the image, without pushing to a registry.
to specify a directory in the container where the OCI image layout of a built image will be placed. This can be used to automatically track the exact image built by kaniko.
Set this flag to the number of retries that should happen for the push of an image to a remote destination.
to provide a certificate for TLS communication with a given registry. my.registry.url: /path/to/the/certificate.cert is the expected format.
if you want to use a registry mirror instead of default index.docker.io.
used to strip timestamps out of the built image.
takes a single snapshot of the filesystem at the end of the build. So only one layer will be appended to the base image.
skips TLS certificate validation when pushing to a registry.
skips TLS certificate validation when pulling from a registry.
skips TLS certificate validation when accessing a registry.
builds only used stages if defined to true. Otherwise it builds by default all stages, even the unnecessaries ones until it reaches the target stage / end of Dockerfile.
how Kaniko will snapshot the filesystem.
path to save the image as a tarball at path instead of pushing the image.
to indicate which build stage is the target build stage.
to Use the experimental run implementation for detecting changes without requiring file system snapshots. In some cases, this may improve build performance by 75%.
<panic|fatal|error|warn|info|debug|trace> to set the logging level.
volume mounts passed to kaniko pod.
used to ignore /var/run when taking image snapshot. Set it to false to preserve /var/run/* in destination image.
configures Kaniko caching. If a cache is specified, Kaniko will use a remote cache which will speed up builds.
enables caching of copy layers.
specifies a path on the host that is mounted to each pod as read only cache volume containing base images. If set, must exist on each node and prepopulated with kaniko-warmer.
a remote repository to store cached layers. If none is specified, one will be inferred from the image name. See Kaniko Caching.
Cache timeout in hours.
builds images using ko.
additional build flags passed to the builder.
used to specify dependencies for an artifact built by ko.
2 nested properties
specifies the paths that should be ignored by Skaffold's file watcher. If a file exists in both paths and in ignore, it will be ignored, and will be excluded from both rebuilds and file synchronization.
should be set to the file dependencies for this artifact, so that the Skaffold file watcher knows when to rebuild and perform file synchronization.
directory where the go tool will be run. The value is a directory path relative to the context directory. If empty, the go tool will run in the context directory. Example: ./my-app-sources.
environment variables, in the key=value form, passed to the build. These environment variables are only used at build time. They are not set in the resulting container image.
overrides the default ko base image (gcr.io/distroless/static:nonroot). Corresponds to, and overrides, the defaultBaseImage in .ko.yaml.
key-value string pairs to add to the image config.
linker flags passed to the builder.
location of the main package. It is the pattern passed to go build. If main is specified as a relative path, it is relative to the context directory. If main is empty, the ko builder uses a default value of .. If main is a pattern with wildcards, such as ./..., the expansion must contain only one main package, otherwise ko fails. Main is ignored if the ImageName starts with ko://. Example: ./cmd/foo.
list of platforms to build images for. Each platform is of the format os[/arch[/variant]], e.g., linux/amd64. Use ["all"] to build for all platforms supported by the base image. If empty, the builder uses the ko default (["linux/amd64"]). Example: ["linux/amd64", "linux/arm64"].
used to specify dependencies for an artifact built by ko.
specifies the paths that should be ignored by Skaffold's file watcher. If a file exists in both paths and in ignore, it will be ignored, and will be excluded from both rebuilds and file synchronization.
should be set to the file dependencies for this artifact, so that the Skaffold file watcher knows when to rebuild and perform file synchronization.
sets the kpt inventory directory.
equivalent to the dir in kpt live apply <dir>. If not provided, kpt deployer will create a hidden directory .kpt-hydrated to store the manipulated resource output and the kpt inventory-template.yaml file.
alpha identifier for a group of applied resources. This value is only needed when the kpt live is working on a pre-applied cluster resources.
alpha sets the inventory namespace.
adds additional configurations used when calling kpt live apply.
sets for the polling period for resource statuses. Default to 2s.
sets the propagation policy for pruning. Possible settings are Background, Foreground, Orphan. Default to "Background".
sets the time threshold to wait for all pruned resources to be deleted.
sets the time threshold to wait for all resources to reach the current status.
alpha uses the kpt CLI to manage and deploy manifests.
path to the config directory (Required). By default, the Dir contains the application configurations, kustomize config files and declarative kpt functions.
adds additional configurations used when calling kpt fn.
7 nested properties
directory to discover the declarative kpt functions. If not provided, kpt deployer uses kpt.Dir.
sets the global scope for the kpt functions. see kpt help fn run.
a kpt function image to run the configs imperatively. If provided, kpt.fn.fnPath will be ignored.
a list of storage options to mount to the fn image.
enables network access for the kpt function containers.
docker network name to run the kpt function containers (default "bridge").
directory to where the manipulated resource output is stored.
adds additional configurations used when calling kpt live.
2 nested properties
sets the kpt inventory directory.
3 nested properties
equivalent to the dir in kpt live apply <dir>. If not provided, kpt deployer will create a hidden directory .kpt-hydrated to store the manipulated resource output and the kpt inventory-template.yaml file.
alpha identifier for a group of applied resources. This value is only needed when the kpt live is working on a pre-applied cluster resources.
alpha sets the inventory namespace.
adds additional configurations used when calling kpt live apply.
4 nested properties
sets for the polling period for resource statuses. Default to 2s.
sets the propagation policy for pruning. Possible settings are Background, Foreground, Orphan. Default to "Background".
sets the time threshold to wait for all pruned resources to be deleted.
sets the time threshold to wait for all resources to reach the current status.
adds additional configurations used when calling kpt fn.
directory to discover the declarative kpt functions. If not provided, kpt deployer uses kpt.Dir.
sets the global scope for the kpt functions. see kpt help fn run.
a kpt function image to run the configs imperatively. If provided, kpt.fn.fnPath will be ignored.
a list of storage options to mount to the fn image.
enables network access for the kpt function containers.
docker network name to run the kpt function containers (default "bridge").
directory to where the manipulated resource output is stored.
adds additional configurations used when calling kpt live.
sets the kpt inventory directory.
3 nested properties
equivalent to the dir in kpt live apply <dir>. If not provided, kpt deployer will create a hidden directory .kpt-hydrated to store the manipulated resource output and the kpt inventory-template.yaml file.
alpha identifier for a group of applied resources. This value is only needed when the kpt live is working on a pre-applied cluster resources.
alpha sets the inventory namespace.
adds additional configurations used when calling kpt live apply.
4 nested properties
sets for the polling period for resource statuses. Default to 2s.
sets the propagation policy for pruning. Possible settings are Background, Foreground, Orphan. Default to "Background".
sets the time threshold to wait for all pruned resources to be deleted.
sets the time threshold to wait for all resources to reach the current status.
beta uses a client side kubectl apply to deploy manifests. You'll need a kubectl CLI version installed that's compatible with your cluster.
default namespace passed to kubectl on deployment if no other override is given.
additional flags passed on the command line to kubectl either on every command (Global), on creations (Apply) or deletions (Delete).
4 nested properties
additional flags passed on creations (kubectl apply).
additional flags passed on deletions (kubectl delete).
passes the --validate=false flag to supported kubectl commands when enabled.
additional flags passed on every command.
describes the list of lifecycle hooks to execute before and after each deployer step.
2 nested properties
describes the list of lifecycle hooks to execute after each deployer step.
describes the list of lifecycle hooks to execute before each deployer step. Container hooks will only run if the container exists from a previous deployment step (for instance the successive iterations of a dev-loop during skaffold dev).
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).
passes the --validate=false flag to supported kubectl commands when enabled.
additional flags passed on every command.
beta uses the kustomize CLI to "patch" a deployment for a target environment.
additional args passed to kustomize build.
default namespace passed to kubectl on deployment if no other override is given.
additional flags passed on the command line to kubectl either on every command (Global), on creations (Apply) or deletions (Delete).
4 nested properties
additional flags passed on creations (kubectl apply).
additional flags passed on deletions (kubectl delete).
passes the --validate=false flag to supported kubectl commands when enabled.
additional flags passed on every command.
describes the list of lifecycle hooks to execute before and after each deployer step.
2 nested properties
describes the list of lifecycle hooks to execute after each deployer step.
describes the list of lifecycle hooks to execute before each deployer step. Container hooks will only run if the container exists from a previous deployment step (for instance the successive iterations of a dev-loop during skaffold dev).
path to Kustomization files.
beta describes how to do a build on the local docker daemon and optionally push to a repository.
how many artifacts can be built concurrently. 0 means "no-limit".
should images be pushed to a registry. If not specified, images are pushed only if the current Kubernetes context connects to a remote cluster.
whether to attempt to import artifacts from Docker (either a local or remote registry) if not in the cache.
use BuildKit to build Docker images. If unspecified, uses the Docker default.
use docker command-line interface instead of Docker Engine APIs.
configures how container logs are printed as a result of a deployment.
defines the prefix shown on each log line. Valid values are container: prefix logs lines with the name of the container. podAndContainer: prefix logs lines with the names of the pod and of the container. auto: same as podAndContainer except that the pod name is skipped if it's the same as the container name. none: don't add a prefix.
holds an optional name of the project.
an identifier for the project.
describes a lifecycle hook definition to execute on a named container.
command to execute.
name of the pod to execute the command in.
name of the container to execute the command in.
describes a resource to port forward.
local address to bind to. Defaults to the loopback address 127.0.0.1.
local port to forward to. If the port is unavailable, Skaffold will choose a random open port to forward to. Optional.
namespace of the resource to port forward. Does not apply to local containers.
resource port that will be forwarded.
name of the Kubernetes resource or local container to port forward.
resource type that should be port forwarded. Acceptable resource types include kubernetes types: Service, Pod and Controller resource type that has a pod spec: ReplicaSet, ReplicationController, Deployment, StatefulSet, DaemonSet, Job, CronJob. Standalone Container is also valid for Docker deployments.
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.
9 nested properties
uses the docker CLI to create application containers in Docker.
2 nested properties
container images to run in Docker.
tells skaffold whether or not to deploy using docker-compose.
beta uses the helm CLI to apply the charts to the cluster.
alpha uses the kpt CLI to manage and deploy manifests.
3 nested properties
path to the config directory (Required). By default, the Dir contains the application configurations, kustomize config files and declarative kpt functions.
adds additional configurations used when calling kpt fn.
adds additional configurations used when calling kpt live.
Kubernetes context that Skaffold should deploy to.
beta uses a client side kubectl apply to deploy manifests. You'll need a kubectl CLI version installed that's compatible with your cluster.
5 nested properties
default namespace passed to kubectl on deployment if no other override is given.
additional flags passed on the command line to kubectl either on every command (Global), on creations (Apply) or deletions (Delete).
describes the list of lifecycle hooks to execute before and after each deployer step.
the Kubernetes yaml or json manifests.
Kubernetes manifests in remote clusters.
beta uses the kustomize CLI to "patch" a deployment for a target environment.
5 nested properties
additional args passed to kustomize build.
default namespace passed to kubectl on deployment if no other override is given.
additional flags passed on the command line to kubectl either on every command (Global), on creations (Apply) or deletions (Delete).
describes the list of lifecycle hooks to execute before and after each deployer step.
path to Kustomization files.
configures how container logs are printed as a result of a deployment.
1 nested properties
defines the prefix shown on each log line. Valid values are container: prefix logs lines with the name of the container. podAndContainer: prefix logs lines with the names of the pod and of the container. auto: same as podAndContainer except that the pod name is skipped if it's the same as the container name. none: don't add a prefix.
beta enables waiting for deployments to stabilize.
beta deadline for deployments to stabilize in seconds.
patches applied to the configuration. Patches use the JSON patch notation.
describes user defined resources to port-forward.
describes how images are tested.
describes a mapping from referenced config profiles to the current config profiles. If the current config is activated with a profile in this mapping then the dependency configs are also activated with the corresponding mapped profiles.
describes name of the profile to activate in the dependency config. It should exist in the dependency config.
describes a list of profiles in the current config that when activated will also activate the named profile in the dependency config. If empty then the named profile is always activated.
contains definition to filter which resource to transform.
compact format of a resource type.
an optional slice of JSON-path-like paths of where to rewrite images.
an optional slide of JSON-path-like paths of where to add a labels block if missing.
stores the CPU/Memory requirements for the pod.
the number cores to be used.
the amount of Ephemeral storage to allocate to the pod.
the amount of memory to allocate to the pod.
the amount of resource storage to allocate to the pod.
describes the resource requirements for the kaniko pod.
stores the CPU/Memory requirements for the pod.
4 nested properties
the number cores to be used.
the amount of Ephemeral storage to allocate to the pod.
the amount of memory to allocate to the pod.
the amount of resource storage to allocate to the pod.
stores the CPU/Memory requirements for the pod.
4 nested properties
the number cores to be used.
the amount of Ephemeral storage to allocate to the pod.
the amount of memory to allocate to the pod.
the amount of resource storage to allocate to the pod.
describes the Kubernetes resource types used for port forwarding.
beta tags images with their sha256 digest.
holds the fields parsed from the Skaffold configuration file (skaffold.yaml).
version of the configuration.
always Config.
contains all the configuration for the build steps.
contains all the configuration needed by the deploy steps.
9 nested properties
uses the docker CLI to create application containers in Docker.
2 nested properties
container images to run in Docker.
tells skaffold whether or not to deploy using docker-compose.
beta uses the helm CLI to apply the charts to the cluster.
alpha uses the kpt CLI to manage and deploy manifests.
3 nested properties
path to the config directory (Required). By default, the Dir contains the application configurations, kustomize config files and declarative kpt functions.
adds additional configurations used when calling kpt fn.
adds additional configurations used when calling kpt live.
Kubernetes context that Skaffold should deploy to.
beta uses a client side kubectl apply to deploy manifests. You'll need a kubectl CLI version installed that's compatible with your cluster.
5 nested properties
default namespace passed to kubectl on deployment if no other override is given.
additional flags passed on the command line to kubectl either on every command (Global), on creations (Apply) or deletions (Delete).
describes the list of lifecycle hooks to execute before and after each deployer step.
the Kubernetes yaml or json manifests.
Kubernetes manifests in remote clusters.
beta uses the kustomize CLI to "patch" a deployment for a target environment.
5 nested properties
additional args passed to kustomize build.
default namespace passed to kubectl on deployment if no other override is given.
additional flags passed on the command line to kubectl either on every command (Global), on creations (Apply) or deletions (Delete).
describes the list of lifecycle hooks to execute before and after each deployer step.
path to Kustomization files.
configures how container logs are printed as a result of a deployment.
1 nested properties
defines the prefix shown on each log line. Valid values are container: prefix logs lines with the name of the container. podAndContainer: prefix logs lines with the names of the pod and of the container. auto: same as podAndContainer except that the pod name is skipped if it's the same as the container name. none: don't add a prefix.
beta enables waiting for deployments to stabilize.
beta deadline for deployments to stabilize in seconds.
holds an optional name of the project.
1 nested properties
an identifier for the project.
describes user defined resources to port-forward.
beta can override be used to build, test or deploy configuration.
describes a list of other required configs for the current config.
describes how images are tested.
beta specifies what files to sync into the container. This is a list of sync rules indicating the intent to sync for source files. If no files are listed, sync all the files and infer the destination.
delegates discovery of sync rules to the build system. Only available for jib and buildpacks.
describes the list of lifecycle hooks to execute before and after each artifact sync step.
2 nested properties
describes the list of lifecycle hooks to execute after each artifact sync step.
describes the list of lifecycle hooks to execute before each artifact sync step.
file patterns which may be synced into the container The container destination is inferred by the builder based on the instructions of a Dockerfile. Available for docker and kaniko artifacts and custom artifacts that declare dependencies on a dockerfile.
manual sync rules indicating the source and destination.
describes a single lifecycle hook to execute before or after each artifact sync step.
describes a lifecycle hook definition to execute on a container. The container name is inferred from the scope in which this hook is defined.
1 nested properties
command to execute.
describes a lifecycle hook definition to execute on the host machine.
2 nested properties
command to execute.
an optional slice of operating system names. If the host machine OS is different, then it skips execution.
describes the list of lifecycle hooks to execute before and after each artifact sync step.
describes the list of lifecycle hooks to execute after each artifact sync step.
describes the list of lifecycle hooks to execute before each artifact sync step.
specifies which local files to sync to remote folders.
destination path in the container where the files should be synced to.
a glob pattern to match local paths against. Directories should be delimited by / on all platforms.
specifies the path prefix to remove from the source path when transplanting the files into the destination folder.
contains all the configuration for the tagging step.
beta tags images with a configurable template string.
2 nested properties
used to produce the image name and tag. See golang text/template. The template is executed against the provided components with those variables injected.
TaggerComponents that the template (see field above) can be executed against.
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.
beta tags images with the git tag or commit of the artifact's workspace.
3 nested properties
specifies whether to omit the -dirty postfix if there are uncommitted changes.
adds a fixed prefix to the tag.
determines the behavior of the git tagger. Valid variants are: Tags (default): use git tags or fall back to abbreviated commit hash. CommitSha: use the full git commit sha. AbbrevCommitSha: use the abbreviated git commit sha. TreeSha: use the full tree hash of the artifact workingdir. AbbrevTreeSha: use the abbreviated tree hash of the artifact workingdir.
beta tags hashes the image content.
beta tags images with their sha256 digest.
beta a component of CustomTemplateTagger.
a list of tests to run on images that Skaffold builds.
artifact on which to run those tests.
directory containing the test sources.
the set of custom tests to run after an artifact is built.
the Container Structure Tests to run on that artifact.
additional configuration arguments passed to container-structure-test binary.