Architecture and Design on Skaffold

Skaffold Pipeline

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

You can configure Skaffold with the Skaffold configuration file, skaffold.yaml. A single configuration consists of several different components:

Component	Description
`apiVersion`	The Skaffold API version you would like to use. The current API version is skaffold/v4beta14 .
`kind`	The Skaffold configuration file has the kind `Config`.
`metadata`	Holds additional properties like the `name` of this configuration.
`build`	Specifies how Skaffold builds artifacts. You have control over what tool Skaffold can use, how Skaffold tags artifacts and how Skaffold pushes artifacts. Skaffold supports using local Docker daemon, Google Cloud Build, Kaniko, or Bazel to build artifacts. See Builders and Taggers for more information.
`test`	Specifies how Skaffold tests artifacts. Skaffold supports container-structure-tests to test built artifacts and custom tests to run custom commands as part of the development pipeline. See Testers for more information.
`deploy`	Specifies how Skaffold deploys artifacts. Skaffold supports using `kubectl`, `helm`, or `kustomize` to deploy artifacts. See Deployers for more information.
`profiles`	Profile is a set of settings that, when activated, overrides the current configuration. You can use Profile to override the `build`, `test` and `deploy` sections.
`requires`	Specifies a list of other skaffold configurations to import into the current config

You can learn more about the syntax of skaffold.yaml.

Global Configuration

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

Some context specific settings can be configured in a global configuration file, which defaults to ~/.skaffold/config. Options can be configured globally or for specific Kubernetes contexts. Context name matching supports regex, e.g.: .*-cluster.*-regex.*-test.*

The options are:

Option	Type	Description
`default-repo`	string	The image registry where built artifact images are published (see image name rewriting).
`multi-level-repo`	boolean	If true, do not replace ‘.’ and ‘/’ with ‘_’ in image name.
`debug-helpers-registry`	string	The image registry where debug support images are retrieved (see debugging).
`insecure-registries`	list of strings	A list of image registries that may be accessed without TLS.
`k3d-disable-load`	boolean	If true, do not use `k3d import image` to load images locally.
`kind-disable-load`	boolean	If true, do not use `kind load` to load images locally.
`local-cluster`	boolean	If true, do not try to push images after building. By default, contexts with names `docker-for-desktop`, `docker-desktop`, or `minikube` are treated as local.
`update-check`	boolean	Check for a more recent version of Skaffold.
`collect-metrics`	boolean	Collect anonymized usage data.

For example, to treat any context as local by default:

Skaffold API

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

When running skaffold dev or skaffold debug, Skaffold starts a server that exposes an API over the lifetime of the Skaffold process. Besides the CLI, this API is the primary way tools like IDEs integrate with Skaffold for retrieving information about the pipeline and for controlling the phases in the pipeline.

To retrieve information about the Skaffold pipeline, the Skaffold API provides two main functionalities:

A streaming event log created from the different phases in a pipeline run, and