github.com/GoogleContainerTools/skaffold@v1.39.18/pkg/skaffold/schema/v2beta4/config.go (about)

     1  /*
     2  Copyright 2019 The Skaffold Authors
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package v2beta4
    18  
    19  import (
    20  	v1 "k8s.io/api/core/v1"
    21  
    22  	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/util"
    23  )
    24  
    25  // !!! WARNING !!! This config version is already released, please DO NOT MODIFY the structs in this file.
    26  const Version string = "skaffold/v2beta4"
    27  
    28  // NewSkaffoldConfig creates a SkaffoldConfig
    29  func NewSkaffoldConfig() util.VersionedConfig {
    30  	return new(SkaffoldConfig)
    31  }
    32  
    33  // SkaffoldConfig holds the fields parsed from the Skaffold configuration file (skaffold.yaml).
    34  type SkaffoldConfig struct {
    35  	// APIVersion is the version of the configuration.
    36  	APIVersion string `yaml:"apiVersion" yamltags:"required"`
    37  
    38  	// Kind is always `Config`. Defaults to `Config`.
    39  	Kind string `yaml:"kind" yamltags:"required"`
    40  
    41  	// Metadata holds additional information about the config.
    42  	Metadata Metadata `yaml:"metadata,omitempty"`
    43  
    44  	// Pipeline defines the Build/Test/Deploy phases.
    45  	Pipeline `yaml:",inline"`
    46  
    47  	// Profiles *beta* can override be used to `build`, `test` or `deploy` configuration.
    48  	Profiles []Profile `yaml:"profiles,omitempty"`
    49  }
    50  
    51  // Metadata holds an optional name of the project.
    52  type Metadata struct {
    53  	// Name is an identifier for the project.
    54  	Name string `yaml:"name,omitempty"`
    55  }
    56  
    57  // Pipeline describes a Skaffold pipeline.
    58  type Pipeline struct {
    59  	// Build describes how images are built.
    60  	Build BuildConfig `yaml:"build,omitempty"`
    61  
    62  	// Test describes how images are tested.
    63  	Test []*TestCase `yaml:"test,omitempty"`
    64  
    65  	// Deploy describes how images are deployed.
    66  	Deploy DeployConfig `yaml:"deploy,omitempty"`
    67  
    68  	// PortForward describes user defined resources to port-forward.
    69  	PortForward []*PortForwardResource `yaml:"portForward,omitempty"`
    70  }
    71  
    72  func (c *SkaffoldConfig) GetVersion() string {
    73  	return c.APIVersion
    74  }
    75  
    76  // ResourceType describes the Kubernetes resource types used for port forwarding.
    77  type ResourceType string
    78  
    79  // PortForwardResource describes a resource to port forward.
    80  type PortForwardResource struct {
    81  	// Type is the Kubernetes type that should be port forwarded.
    82  	// Acceptable resource types include: `Service`, `Pod` and Controller resource type that has a pod spec: `ReplicaSet`, `ReplicationController`, `Deployment`, `StatefulSet`, `DaemonSet`, `Job`, `CronJob`.
    83  	Type ResourceType `yaml:"resourceType,omitempty"`
    84  
    85  	// Name is the name of the Kubernetes resource to port forward.
    86  	Name string `yaml:"resourceName,omitempty"`
    87  
    88  	// Namespace is the namespace of the resource to port forward.
    89  	Namespace string `yaml:"namespace,omitempty"`
    90  
    91  	// Port is the resource port that will be forwarded.
    92  	Port int `yaml:"port,omitempty"`
    93  
    94  	// Address is the local address to bind to. Defaults to the loopback address 127.0.0.1.
    95  	Address string `yaml:"address,omitempty"`
    96  
    97  	// LocalPort is the local port to forward to. If the port is unavailable, Skaffold will choose a random open port to forward to. *Optional*.
    98  	LocalPort int `yaml:"localPort,omitempty"`
    99  }
   100  
   101  // BuildConfig contains all the configuration for the build steps.
   102  type BuildConfig struct {
   103  	// Artifacts lists the images you're going to be building.
   104  	Artifacts []*Artifact `yaml:"artifacts,omitempty"`
   105  
   106  	// InsecureRegistries is a list of registries declared by the user to be insecure.
   107  	// These registries will be connected to via HTTP instead of HTTPS.
   108  	InsecureRegistries []string `yaml:"insecureRegistries,omitempty"`
   109  
   110  	// TagPolicy *beta* determines how images are tagged.
   111  	// A few strategies are provided here, although you most likely won't need to care!
   112  	// If not specified, it defaults to `gitCommit: {variant: Tags}`.
   113  	TagPolicy TagPolicy `yaml:"tagPolicy,omitempty"`
   114  
   115  	BuildType `yaml:",inline"`
   116  }
   117  
   118  // TagPolicy contains all the configuration for the tagging step.
   119  type TagPolicy struct {
   120  	// GitTagger *beta* tags images with the git tag or commit of the artifact's workspace.
   121  	GitTagger *GitTagger `yaml:"gitCommit,omitempty" yamltags:"oneOf=tag"`
   122  
   123  	// ShaTagger *beta* tags images with their sha256 digest.
   124  	ShaTagger *ShaTagger `yaml:"sha256,omitempty" yamltags:"oneOf=tag"`
   125  
   126  	// EnvTemplateTagger *beta* tags images with a configurable template string.
   127  	EnvTemplateTagger *EnvTemplateTagger `yaml:"envTemplate,omitempty" yamltags:"oneOf=tag"`
   128  
   129  	// DateTimeTagger *beta* tags images with the build timestamp.
   130  	DateTimeTagger *DateTimeTagger `yaml:"dateTime,omitempty" yamltags:"oneOf=tag"`
   131  }
   132  
   133  // ShaTagger *beta* tags images with their sha256 digest.
   134  type ShaTagger struct{}
   135  
   136  // GitTagger *beta* tags images with the git tag or commit of the artifact's workspace.
   137  type GitTagger struct {
   138  	// Variant determines the behavior of the git tagger. Valid variants are:
   139  	// `Tags` (default): use git tags or fall back to abbreviated commit hash.
   140  	// `CommitSha`: use the full git commit sha.
   141  	// `AbbrevCommitSha`: use the abbreviated git commit sha.
   142  	// `TreeSha`: use the full tree hash of the artifact workingdir.
   143  	// `AbbrevTreeSha`: use the abbreviated tree hash of the artifact workingdir.
   144  	Variant string `yaml:"variant,omitempty"`
   145  
   146  	// Prefix adds a fixed prefix to the tag.
   147  	Prefix string `yaml:"prefix,omitempty"`
   148  }
   149  
   150  // EnvTemplateTagger *beta* tags images with a configurable template string.
   151  type EnvTemplateTagger struct {
   152  	// Template used to produce the image name and tag.
   153  	// See golang [text/template](https://golang.org/pkg/text/template/).
   154  	// The template is executed against the current environment,
   155  	// with those variables injected:
   156  	//   IMAGE_NAME   |  Name of the image being built, as supplied in the artifacts section.
   157  	// For example: `{{.RELEASE}}-{{.IMAGE_NAME}}`.
   158  	Template string `yaml:"template,omitempty" yamltags:"required"`
   159  }
   160  
   161  // DateTimeTagger *beta* tags images with the build timestamp.
   162  type DateTimeTagger struct {
   163  	// Format formats the date and time.
   164  	// See [#Time.Format](https://golang.org/pkg/time/#Time.Format).
   165  	// Defaults to `2006-01-02_15-04-05.999_MST`.
   166  	Format string `yaml:"format,omitempty"`
   167  
   168  	// TimeZone sets the timezone for the date and time.
   169  	// See [Time.LoadLocation](https://golang.org/pkg/time/#Time.LoadLocation).
   170  	// Defaults to the local timezone.
   171  	TimeZone string `yaml:"timezone,omitempty"`
   172  }
   173  
   174  // BuildType contains the specific implementation and parameters needed
   175  // for the build step. Only one field should be populated.
   176  type BuildType struct {
   177  	// LocalBuild *beta* describes how to do a build on the local docker daemon
   178  	// and optionally push to a repository.
   179  	LocalBuild *LocalBuild `yaml:"local,omitempty" yamltags:"oneOf=build"`
   180  
   181  	// GoogleCloudBuild *beta* describes how to do a remote build on
   182  	// [Google Cloud Build](https://cloud.google.com/cloud-build/).
   183  	GoogleCloudBuild *GoogleCloudBuild `yaml:"googleCloudBuild,omitempty" yamltags:"oneOf=build"`
   184  
   185  	// Cluster *beta* describes how to do an on-cluster build.
   186  	Cluster *ClusterDetails `yaml:"cluster,omitempty" yamltags:"oneOf=build"`
   187  }
   188  
   189  // LocalBuild *beta* describes how to do a build on the local docker daemon
   190  // and optionally push to a repository.
   191  type LocalBuild struct {
   192  	// Push should images be pushed to a registry.
   193  	// If not specified, images are pushed only if the current Kubernetes context
   194  	// connects to a remote cluster.
   195  	Push *bool `yaml:"push,omitempty"`
   196  
   197  	// UseDockerCLI use `docker` command-line interface instead of Docker Engine APIs.
   198  	UseDockerCLI bool `yaml:"useDockerCLI,omitempty"`
   199  
   200  	// UseBuildkit use BuildKit to build Docker images. If unspecified, uses the Docker default.
   201  	UseBuildkit *bool `yaml:"useBuildkit,omitempty"`
   202  
   203  	// Concurrency is how many artifacts can be built concurrently. 0 means "no-limit".
   204  	// Defaults to `1`.
   205  	Concurrency *int `yaml:"concurrency,omitempty"`
   206  }
   207  
   208  // GoogleCloudBuild *beta* describes how to do a remote build on
   209  // [Google Cloud Build](https://cloud.google.com/cloud-build/docs/).
   210  // Docker and Jib artifacts can be built on Cloud Build. The `projectId` needs
   211  // to be provided and the currently logged in user should be given permissions to trigger
   212  // new builds.
   213  type GoogleCloudBuild struct {
   214  	// ProjectID is the ID of your Cloud Platform Project.
   215  	// If it is not provided, Skaffold will guess it from the image name.
   216  	// For example, given the artifact image name `gcr.io/myproject/image`, Skaffold
   217  	// will use the `myproject` GCP project.
   218  	ProjectID string `yaml:"projectId,omitempty"`
   219  
   220  	// DiskSizeGb is the disk size of the VM that runs the build.
   221  	// See [Cloud Build Reference](https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions).
   222  	DiskSizeGb int64 `yaml:"diskSizeGb,omitempty"`
   223  
   224  	// MachineType is the type of the VM that runs the build.
   225  	// See [Cloud Build Reference](https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#buildoptions).
   226  	MachineType string `yaml:"machineType,omitempty"`
   227  
   228  	// Timeout is the amount of time (in seconds) that this build should be allowed to run.
   229  	// See [Cloud Build Reference](https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#resource-build).
   230  	Timeout string `yaml:"timeout,omitempty"`
   231  
   232  	// Logging specifies the logging mode.
   233  	// Valid modes are:
   234  	// `LOGGING_UNSPECIFIED`: The service determines the logging mode.
   235  	// `LEGACY`: Stackdriver logging and Cloud Storage logging are enabled (default).
   236  	// `GCS_ONLY`: Only Cloud Storage logging is enabled.
   237  	// See [Cloud Build Reference](https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#loggingmode).
   238  	Logging string `yaml:"logging,omitempty"`
   239  
   240  	// LogStreamingOption specifies the behavior when writing build logs to Google Cloud Storage.
   241  	// Valid options are:
   242  	// `STREAM_DEFAULT`: Service may automatically determine build log streaming behavior.
   243  	// `STREAM_ON`:  Build logs should be streamed to Google Cloud Storage.
   244  	// `STREAM_OFF`: Build logs should not be streamed to Google Cloud Storage; they will be written when the build is completed.
   245  	// See [Cloud Build Reference](https://cloud.google.com/cloud-build/docs/api/reference/rest/v1/projects.builds#logstreamingoption).
   246  	LogStreamingOption string `yaml:"logStreamingOption,omitempty"`
   247  
   248  	// DockerImage is the image that runs a Docker build.
   249  	// See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders).
   250  	// Defaults to `gcr.io/cloud-builders/docker`.
   251  	DockerImage string `yaml:"dockerImage,omitempty"`
   252  
   253  	// KanikoImage is the image that runs a Kaniko build.
   254  	// See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders).
   255  	// Defaults to `gcr.io/kaniko-project/executor`.
   256  	KanikoImage string `yaml:"kanikoImage,omitempty"`
   257  
   258  	// MavenImage is the image that runs a Maven build.
   259  	// See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders).
   260  	// Defaults to `gcr.io/cloud-builders/mvn`.
   261  	MavenImage string `yaml:"mavenImage,omitempty"`
   262  
   263  	// GradleImage is the image that runs a Gradle build.
   264  	// See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders).
   265  	// Defaults to `gcr.io/cloud-builders/gradle`.
   266  	GradleImage string `yaml:"gradleImage,omitempty"`
   267  
   268  	// PackImage is the image that runs a Cloud Native Buildpacks build.
   269  	// See [Cloud Builders](https://cloud.google.com/cloud-build/docs/cloud-builders).
   270  	// Defaults to `gcr.io/k8s-skaffold/pack`.
   271  	PackImage string `yaml:"packImage,omitempty"`
   272  
   273  	// Concurrency is how many artifacts can be built concurrently. 0 means "no-limit".
   274  	// Defaults to `0`.
   275  	Concurrency int `yaml:"concurrency,omitempty"`
   276  }
   277  
   278  // KanikoCache configures Kaniko caching. If a cache is specified, Kaniko will
   279  // use a remote cache which will speed up builds.
   280  type KanikoCache struct {
   281  	// Repo is a remote repository to store cached layers. If none is specified, one will be
   282  	// inferred from the image name. See [Kaniko Caching](https://github.com/GoogleContainerTools/kaniko#caching).
   283  	Repo string `yaml:"repo,omitempty"`
   284  	// HostPath specifies a path on the host that is mounted to each pod as read only cache volume containing base images.
   285  	// If set, must exist on each node and prepopulated with kaniko-warmer.
   286  	HostPath string `yaml:"hostPath,omitempty"`
   287  }
   288  
   289  // ClusterDetails *beta* describes how to do an on-cluster build.
   290  type ClusterDetails struct {
   291  	// HTTPProxy for kaniko pod.
   292  	HTTPProxy string `yaml:"HTTP_PROXY,omitempty"`
   293  
   294  	// HTTPSProxy for kaniko pod.
   295  	HTTPSProxy string `yaml:"HTTPS_PROXY,omitempty"`
   296  
   297  	// PullSecret is the path to the Google Cloud service account secret key file.
   298  	PullSecret string `yaml:"pullSecret,omitempty"`
   299  
   300  	// PullSecretName is the name of the Kubernetes secret for pulling base images
   301  	// and pushing the final image. If given, the secret needs to contain the Google Cloud
   302  	// service account secret key under the key `kaniko-secret`.
   303  	// Defaults to `kaniko-secret`.
   304  	PullSecretName string `yaml:"pullSecretName,omitempty"`
   305  
   306  	// PullSecretMountPath is the path the pull secret will be mounted at within the running container.
   307  	PullSecretMountPath string `yaml:"pullSecretMountPath,omitempty"`
   308  
   309  	// Namespace is the Kubernetes namespace.
   310  	// Defaults to current namespace in Kubernetes configuration.
   311  	Namespace string `yaml:"namespace,omitempty"`
   312  
   313  	// Timeout is the amount of time (in seconds) that this build is allowed to run.
   314  	// Defaults to 20 minutes (`20m`).
   315  	Timeout string `yaml:"timeout,omitempty"`
   316  
   317  	// DockerConfig describes how to mount the local Docker configuration into a pod.
   318  	DockerConfig *DockerConfig `yaml:"dockerConfig,omitempty"`
   319  
   320  	// ServiceAccountName describes the Kubernetes service account to use for the pod.
   321  	// Defaults to 'default'.
   322  	ServiceAccountName string `yaml:"serviceAccount,omitempty"`
   323  
   324  	// RunAsUser defines the UID to request for running the container.
   325  	// If omitted, no SecurityContext will be specified for the pod and will therefore be inherited
   326  	// from the service account.
   327  	RunAsUser *int64 `yaml:"runAsUser,omitempty"`
   328  
   329  	// Resources define the resource requirements for the kaniko pod.
   330  	Resources *ResourceRequirements `yaml:"resources,omitempty"`
   331  
   332  	// Concurrency is how many artifacts can be built concurrently. 0 means "no-limit".
   333  	// Defaults to `0`.
   334  	Concurrency int `yaml:"concurrency,omitempty"`
   335  
   336  	// Volumes defines container mounts for ConfigMap and Secret resources.
   337  	Volumes []v1.Volume `yaml:"volumes,omitempty"`
   338  
   339  	// RandomPullSecret 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.
   340  	RandomPullSecret bool `yaml:"randomPullSecret,omitempty"`
   341  
   342  	// RandomDockerConfigSecret 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.
   343  	RandomDockerConfigSecret bool `yaml:"randomDockerConfigSecret,omitempty"`
   344  }
   345  
   346  // DockerConfig contains information about the docker `config.json` to mount.
   347  type DockerConfig struct {
   348  	// Path is the path to the docker `config.json`.
   349  	Path string `yaml:"path,omitempty"`
   350  
   351  	// SecretName is the Kubernetes secret that contains the `config.json` Docker configuration.
   352  	// Note that the expected secret type is not 'kubernetes.io/dockerconfigjson' but 'Opaque'.
   353  	SecretName string `yaml:"secretName,omitempty"`
   354  }
   355  
   356  // ResourceRequirements describes the resource requirements for the kaniko pod.
   357  type ResourceRequirements struct {
   358  	// Requests [resource requests](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container) for the Kaniko pod.
   359  	Requests *ResourceRequirement `yaml:"requests,omitempty"`
   360  
   361  	// Limits [resource limits](https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/#resource-requests-and-limits-of-pod-and-container) for the Kaniko pod.
   362  	Limits *ResourceRequirement `yaml:"limits,omitempty"`
   363  }
   364  
   365  // ResourceRequirement stores the CPU/Memory requirements for the pod.
   366  type ResourceRequirement struct {
   367  	// CPU the number cores to be used.
   368  	// For example: `2`, `2.0` or `200m`.
   369  	CPU string `yaml:"cpu,omitempty"`
   370  
   371  	// Memory the amount of memory to allocate to the pod.
   372  	// For example: `1Gi` or `1000Mi`.
   373  	Memory string `yaml:"memory,omitempty"`
   374  
   375  	// EphemeralStorage the amount of Ephemeral storage to allocate to the pod.
   376  	// For example: `1Gi` or `1000Mi`.
   377  	EphemeralStorage string `yaml:"ephemeralStorage,omitempty"`
   378  
   379  	// ResourceStorage the amount of resource storage to allocate to the pod.
   380  	// For example: `1Gi` or `1000Mi`.
   381  	ResourceStorage string `yaml:"resourceStorage,omitempty"`
   382  }
   383  
   384  // TestCase is a list of structure tests to run on images that Skaffold builds.
   385  type TestCase struct {
   386  	// ImageName is the artifact on which to run those tests.
   387  	// For example: `gcr.io/k8s-skaffold/example`.
   388  	ImageName string `yaml:"image" yamltags:"required"`
   389  
   390  	// StructureTests lists the [Container Structure Tests](https://github.com/GoogleContainerTools/container-structure-test)
   391  	// to run on that artifact.
   392  	// For example: `["./test/*"]`.
   393  	StructureTests []string `yaml:"structureTests,omitempty"`
   394  }
   395  
   396  // DeployConfig contains all the configuration needed by the deploy steps.
   397  type DeployConfig struct {
   398  	DeployType `yaml:",inline"`
   399  
   400  	// StatusCheckDeadlineSeconds *beta* is the deadline for deployments to stabilize in seconds.
   401  	StatusCheckDeadlineSeconds int `yaml:"statusCheckDeadlineSeconds,omitempty"`
   402  
   403  	// KubeContext is the Kubernetes context that Skaffold should deploy to.
   404  	// For example: `minikube`.
   405  	KubeContext string `yaml:"kubeContext,omitempty"`
   406  }
   407  
   408  // DeployType contains the specific implementation and parameters needed
   409  // for the deploy step. All three deployer types can be used at the same
   410  // time for hybrid workflows.
   411  type DeployType struct {
   412  	// HelmDeploy *beta* uses the `helm` CLI to apply the charts to the cluster.
   413  	HelmDeploy *HelmDeploy `yaml:"helm,omitempty"`
   414  
   415  	// KubectlDeploy *beta* uses a client side `kubectl apply` to deploy manifests.
   416  	// You'll need a `kubectl` CLI version installed that's compatible with your cluster.
   417  	KubectlDeploy *KubectlDeploy `yaml:"kubectl,omitempty"`
   418  
   419  	// KustomizeDeploy *beta* uses the `kustomize` CLI to "patch" a deployment for a target environment.
   420  	KustomizeDeploy *KustomizeDeploy `yaml:"kustomize,omitempty"`
   421  }
   422  
   423  // KubectlDeploy *beta* uses a client side `kubectl apply` to deploy manifests.
   424  // You'll need a `kubectl` CLI version installed that's compatible with your cluster.
   425  type KubectlDeploy struct {
   426  	// Manifests lists the Kubernetes yaml or json manifests.
   427  	// Defaults to `["k8s/*.yaml"]`.
   428  	Manifests []string `yaml:"manifests,omitempty"`
   429  
   430  	// RemoteManifests lists Kubernetes manifests in remote clusters.
   431  	RemoteManifests []string `yaml:"remoteManifests,omitempty"`
   432  
   433  	// Flags are additional flags passed to `kubectl`.
   434  	Flags KubectlFlags `yaml:"flags,omitempty"`
   435  }
   436  
   437  // KubectlFlags are additional flags passed on the command
   438  // line to kubectl either on every command (Global), on creations (Apply)
   439  // or deletions (Delete).
   440  type KubectlFlags struct {
   441  	// Global are additional flags passed on every command.
   442  	Global []string `yaml:"global,omitempty"`
   443  
   444  	// Apply are additional flags passed on creations (`kubectl apply`).
   445  	Apply []string `yaml:"apply,omitempty"`
   446  
   447  	// Delete are additional flags passed on deletions (`kubectl delete`).
   448  	Delete []string `yaml:"delete,omitempty"`
   449  
   450  	// DisableValidation passes the `--validate=false` flag to supported
   451  	// `kubectl` commands when enabled.
   452  	DisableValidation bool `yaml:"disableValidation,omitempty"`
   453  }
   454  
   455  // HelmDeploy *beta* uses the `helm` CLI to apply the charts to the cluster.
   456  type HelmDeploy struct {
   457  	// Releases is a list of Helm releases.
   458  	Releases []HelmRelease `yaml:"releases,omitempty" yamltags:"required"`
   459  
   460  	// Flags are additional option flags that are passed on the command
   461  	// line to `helm`.
   462  	Flags HelmDeployFlags `yaml:"flags,omitempty"`
   463  }
   464  
   465  // HelmDeployFlags are additional option flags that are passed on the command
   466  // line to `helm`.
   467  type HelmDeployFlags struct {
   468  	// Global are additional flags passed on every command.
   469  	Global []string `yaml:"global,omitempty"`
   470  
   471  	// Install are additional flags passed to (`helm install`).
   472  	Install []string `yaml:"install,omitempty"`
   473  
   474  	// Upgrade are additional flags passed to (`helm upgrade`).
   475  	Upgrade []string `yaml:"upgrade,omitempty"`
   476  }
   477  
   478  // KustomizeDeploy *beta* uses the `kustomize` CLI to "patch" a deployment for a target environment.
   479  type KustomizeDeploy struct {
   480  	// KustomizePaths is the path to Kustomization files.
   481  	// Defaults to `["."]`.
   482  	KustomizePaths []string `yaml:"paths,omitempty"`
   483  
   484  	// Flags are additional flags passed to `kubectl`.
   485  	Flags KubectlFlags `yaml:"flags,omitempty"`
   486  
   487  	// BuildArgs are additional args passed to `kustomize build`.
   488  	BuildArgs []string `yaml:"buildArgs,omitempty"`
   489  }
   490  
   491  // HelmRelease describes a helm release to be deployed.
   492  type HelmRelease struct {
   493  	// Name is the name of the Helm release.
   494  	Name string `yaml:"name,omitempty" yamltags:"required"`
   495  
   496  	// ChartPath is the path to the Helm chart.
   497  	ChartPath string `yaml:"chartPath,omitempty" yamltags:"required"`
   498  
   499  	// ValuesFiles are the paths to the Helm `values` files.
   500  	ValuesFiles []string `yaml:"valuesFiles,omitempty"`
   501  
   502  	// ArtifactOverrides are key value pairs where
   503  	// key represents the parameter used in `values` file to define a container image and
   504  	// value corresponds to artifact i.e. `ImageName` defined in `Build.Artifacts` section.
   505  	ArtifactOverrides map[string]string `yaml:"artifactOverrides,omitempty,omitempty"`
   506  
   507  	// Namespace is the Kubernetes namespace.
   508  	Namespace string `yaml:"namespace,omitempty"`
   509  
   510  	// Version is the version of the chart.
   511  	Version string `yaml:"version,omitempty"`
   512  
   513  	// SetValues are key-value pairs.
   514  	// If present, Skaffold will send `--set` flag to Helm CLI and append all pairs after the flag.
   515  	SetValues map[string]string `yaml:"setValues,omitempty"`
   516  
   517  	// SetValueTemplates are key-value pairs.
   518  	// If present, Skaffold will try to parse the value part of each key-value pair using
   519  	// environment variables in the system, then send `--set` flag to Helm CLI and append
   520  	// all parsed pairs after the flag.
   521  	SetValueTemplates map[string]string `yaml:"setValueTemplates,omitempty"`
   522  
   523  	// SetFiles are key-value pairs.
   524  	// If present, Skaffold will send `--set-file` flag to Helm CLI and append all pairs after the flag.
   525  	SetFiles map[string]string `yaml:"setFiles,omitempty"`
   526  
   527  	// Wait if `true`, Skaffold will send `--wait` flag to Helm CLI.
   528  	// Defaults to `false`.
   529  	Wait bool `yaml:"wait,omitempty"`
   530  
   531  	// RecreatePods if `true`, Skaffold will send `--recreate-pods` flag to Helm CLI
   532  	// when upgrading a new version of a chart in subsequent dev loop deploy.
   533  	// Defaults to `false`.
   534  	RecreatePods bool `yaml:"recreatePods,omitempty"`
   535  
   536  	// SkipBuildDependencies should build dependencies be skipped.
   537  	SkipBuildDependencies bool `yaml:"skipBuildDependencies,omitempty"`
   538  
   539  	// UseHelmSecrets instructs skaffold to use secrets plugin on deployment.
   540  	UseHelmSecrets bool `yaml:"useHelmSecrets,omitempty"`
   541  
   542  	// Remote specifies whether the chart path is remote, or exists on the host filesystem.
   543  	// `remote: true` implies `skipBuildDependencies: true`.
   544  	Remote bool `yaml:"remote,omitempty"`
   545  
   546  	// Overrides are key-value pairs.
   547  	// If present, Skaffold will build a Helm `values` file that overrides
   548  	// the original and use it to call Helm CLI (`--f` flag).
   549  	Overrides util.HelmOverrides `yaml:"overrides,omitempty"`
   550  
   551  	// Packaged parameters for packaging helm chart (`helm package`).
   552  	Packaged *HelmPackaged `yaml:"packaged,omitempty"`
   553  
   554  	// ImageStrategy adds image configurations to the Helm `values` file.
   555  	ImageStrategy HelmImageStrategy `yaml:"imageStrategy,omitempty"`
   556  }
   557  
   558  // HelmPackaged parameters for packaging helm chart (`helm package`).
   559  type HelmPackaged struct {
   560  	// Version sets the `version` on the chart to this semver version.
   561  	Version string `yaml:"version,omitempty"`
   562  
   563  	// AppVersion sets the `appVersion` on the chart to this version.
   564  	AppVersion string `yaml:"appVersion,omitempty"`
   565  }
   566  
   567  // HelmImageStrategy adds image configurations to the Helm `values` file.
   568  type HelmImageStrategy struct {
   569  	HelmImageConfig `yaml:",inline"`
   570  }
   571  
   572  // HelmImageConfig describes an image configuration.
   573  type HelmImageConfig struct {
   574  	// HelmFQNConfig is the image configuration uses the syntax `IMAGE-NAME=IMAGE-REPOSITORY:IMAGE-TAG`.
   575  	HelmFQNConfig *HelmFQNConfig `yaml:"fqn,omitempty" yamltags:"oneOf=helmImageStrategy"`
   576  
   577  	// HelmConventionConfig is the image configuration uses the syntax `IMAGE-NAME.repository=IMAGE-REPOSITORY, IMAGE-NAME.tag=IMAGE-TAG`.
   578  	HelmConventionConfig *HelmConventionConfig `yaml:"helm,omitempty" yamltags:"oneOf=helmImageStrategy"`
   579  }
   580  
   581  // HelmFQNConfig is the image config to use the FullyQualifiedImageName as param to set.
   582  type HelmFQNConfig struct {
   583  	// Property defines the image config.
   584  	Property string `yaml:"property,omitempty"`
   585  }
   586  
   587  // HelmConventionConfig is the image config in the syntax of image.repository and image.tag.
   588  type HelmConventionConfig struct {
   589  	// ExplicitRegistry separates `image.registry` to the image config syntax. Useful for some charts e.g. `postgresql`.
   590  	ExplicitRegistry bool `yaml:"explicitRegistry,omitempty"`
   591  }
   592  
   593  // Artifact are the items that need to be built, along with the context in which
   594  // they should be built.
   595  type Artifact struct {
   596  	// ImageName is the name of the image to be built.
   597  	// For example: `gcr.io/k8s-skaffold/example`.
   598  	ImageName string `yaml:"image,omitempty" yamltags:"required"`
   599  
   600  	// Workspace is the directory containing the artifact's sources.
   601  	// Defaults to `.`.
   602  	Workspace string `yaml:"context,omitempty"`
   603  
   604  	// Sync *beta* lists local files synced to pods instead
   605  	// of triggering an image build when modified.
   606  	// If no files are listed, sync all the files and infer the destination.
   607  	// Defaults to `infer: ["**/*"]`.
   608  	Sync *Sync `yaml:"sync,omitempty"`
   609  
   610  	// ArtifactType describes how to build an artifact.
   611  	ArtifactType `yaml:",inline"`
   612  }
   613  
   614  // Sync *beta* specifies what files to sync into the container.
   615  // This is a list of sync rules indicating the intent to sync for source files.
   616  // If no files are listed, sync all the files and infer the destination.
   617  // Defaults to `infer: ["**/*"]`.
   618  type Sync struct {
   619  	// Manual lists manual sync rules indicating the source and destination.
   620  	Manual []*SyncRule `yaml:"manual,omitempty" yamltags:"oneOf=sync"`
   621  
   622  	// Infer lists file patterns which may be synced into the container
   623  	// The container destination is inferred by the builder
   624  	// based on the instructions of a Dockerfile.
   625  	// Available for docker and kaniko artifacts and custom
   626  	// artifacts that declare dependencies on a dockerfile.
   627  	Infer []string `yaml:"infer,omitempty" yamltags:"oneOf=sync"`
   628  
   629  	// Auto delegates discovery of sync rules to the build system.
   630  	// Only available for jib and buildpacks.
   631  	Auto *Auto `yaml:"auto,omitempty" yamltags:"oneOf=sync"`
   632  }
   633  
   634  // SyncRule specifies which local files to sync to remote folders.
   635  type SyncRule struct {
   636  	// Src is a glob pattern to match local paths against.
   637  	// Directories should be delimited by `/` on all platforms.
   638  	// For example: `"css/**/*.css"`.
   639  	Src string `yaml:"src,omitempty" yamltags:"required"`
   640  
   641  	// Dest is the destination path in the container where the files should be synced to.
   642  	// For example: `"app/"`
   643  	Dest string `yaml:"dest,omitempty" yamltags:"required"`
   644  
   645  	// Strip specifies the path prefix to remove from the source path when
   646  	// transplanting the files into the destination folder.
   647  	// For example: `"css/"`
   648  	Strip string `yaml:"strip,omitempty"`
   649  }
   650  
   651  // Auto cannot be customized.
   652  type Auto struct{}
   653  
   654  // Profile is used to override any `build`, `test` or `deploy` configuration.
   655  type Profile struct {
   656  	// Name is a unique profile name.
   657  	// For example: `profile-prod`.
   658  	Name string `yaml:"name,omitempty" yamltags:"required"`
   659  
   660  	// Activation criteria by which a profile can be auto-activated.
   661  	// The profile is auto-activated if any one of the activations are triggered.
   662  	// An activation is triggered if all of the criteria (env, kubeContext, command) are triggered.
   663  	Activation []Activation `yaml:"activation,omitempty"`
   664  
   665  	// Patches lists patches applied to the configuration.
   666  	// Patches use the JSON patch notation.
   667  	Patches []JSONPatch `yaml:"patches,omitempty"`
   668  
   669  	// Pipeline contains the definitions to replace the default skaffold pipeline.
   670  	Pipeline `yaml:",inline"`
   671  }
   672  
   673  // JSONPatch patch to be applied by a profile.
   674  type JSONPatch struct {
   675  	// Op is the operation carried by the patch: `add`, `remove`, `replace`, `move`, `copy` or `test`.
   676  	// Defaults to `replace`.
   677  	Op string `yaml:"op,omitempty"`
   678  
   679  	// Path is the position in the yaml where the operation takes place.
   680  	// For example, this targets the `dockerfile` of the first artifact built.
   681  	// For example: `/build/artifacts/0/docker/dockerfile`.
   682  	Path string `yaml:"path,omitempty" yamltags:"required"`
   683  
   684  	// From is the source position in the yaml, used for `copy` or `move` operations.
   685  	From string `yaml:"from,omitempty"`
   686  
   687  	// Value is the value to apply. Can be any portion of yaml.
   688  	Value *util.YamlpatchNode `yaml:"value,omitempty"`
   689  }
   690  
   691  // Activation criteria by which a profile is auto-activated.
   692  type Activation struct {
   693  	// Env is a `key=pattern` pair. The profile is auto-activated if an Environment
   694  	// Variable `key` matches the pattern. If the pattern starts with `!`, activation
   695  	// happens if the remaining pattern is _not_ matched. The pattern matches if the
   696  	// Environment Variable value is exactly `pattern`, or the regex `pattern` is
   697  	// found in it. An empty `pattern` (e.g. `env: "key="`) always only matches if
   698  	// the Environment Variable is undefined or empty.
   699  	// For example: `ENV=production`
   700  	Env string `yaml:"env,omitempty"`
   701  
   702  	// KubeContext is a Kubernetes context for which the profile is auto-activated.
   703  	// For example: `minikube`.
   704  	KubeContext string `yaml:"kubeContext,omitempty"`
   705  
   706  	// Command is a Skaffold command for which the profile is auto-activated.
   707  	// For example: `dev`.
   708  	Command string `yaml:"command,omitempty"`
   709  }
   710  
   711  // ArtifactType describes how to build an artifact.
   712  type ArtifactType struct {
   713  	// DockerArtifact *beta* describes an artifact built from a Dockerfile.
   714  	DockerArtifact *DockerArtifact `yaml:"docker,omitempty" yamltags:"oneOf=artifact"`
   715  
   716  	// BazelArtifact *beta* requires bazel CLI to be installed and the sources to
   717  	// contain [Bazel](https://bazel.build/) configuration files.
   718  	BazelArtifact *BazelArtifact `yaml:"bazel,omitempty" yamltags:"oneOf=artifact"`
   719  
   720  	// JibArtifact builds images using the
   721  	// [Jib plugins for Maven or Gradle](https://github.com/GoogleContainerTools/jib/).
   722  	JibArtifact *JibArtifact `yaml:"jib,omitempty" yamltags:"oneOf=artifact"`
   723  
   724  	// KanikoArtifact builds images using [kaniko](https://github.com/GoogleContainerTools/kaniko).
   725  	KanikoArtifact *KanikoArtifact `yaml:"kaniko,omitempty" yamltags:"oneOf=artifact"`
   726  
   727  	// BuildpackArtifact builds images using [Cloud Native Buildpacks](https://buildpacks.io/).
   728  	BuildpackArtifact *BuildpackArtifact `yaml:"buildpack,omitempty" yamltags:"oneOf=artifact"`
   729  
   730  	// CustomArtifact *beta* builds images using a custom build script written by the user.
   731  	CustomArtifact *CustomArtifact `yaml:"custom,omitempty" yamltags:"oneOf=artifact"`
   732  }
   733  
   734  // BuildpackArtifact *alpha* describes an artifact built using [Cloud Native Buildpacks](https://buildpacks.io/).
   735  // It can be used to build images out of project's sources without any additional configuration.
   736  type BuildpackArtifact struct {
   737  	// Builder is the builder image used.
   738  	Builder string `yaml:"builder" yamltags:"required"`
   739  
   740  	// RunImage overrides the stack's default run image.
   741  	RunImage string `yaml:"runImage,omitempty"`
   742  
   743  	// Env are environment variables, in the `key=value` form,  passed to the build.
   744  	// Values can use the go template syntax.
   745  	// For example: `["key1=value1", "key2=value2", "key3={{.ENV_VARIABLE}}"]`.
   746  	Env []string `yaml:"env,omitempty"`
   747  
   748  	// Buildpacks is a list of strings, where each string is a specific buildpack to use with the builder.
   749  	// 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.
   750  	// Order matters.
   751  	Buildpacks []string `yaml:"buildpacks,omitempty"`
   752  
   753  	// Dependencies are the file dependencies that skaffold should watch for both rebuilding and file syncing for this artifact.
   754  	Dependencies *BuildpackDependencies `yaml:"dependencies,omitempty"`
   755  }
   756  
   757  // BuildpackDependencies *alpha* is used to specify dependencies for an artifact built by a buildpack.
   758  type BuildpackDependencies struct {
   759  	// 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.
   760  	Paths []string `yaml:"paths,omitempty" yamltags:"oneOf=dependency"`
   761  
   762  	// Ignore 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.
   763  	// Will only work in conjunction with `paths`.
   764  	Ignore []string `yaml:"ignore,omitempty"`
   765  }
   766  
   767  // CustomArtifact *beta* describes an artifact built from a custom build script
   768  // written by the user. It can be used to build images with builders that aren't directly integrated with skaffold.
   769  type CustomArtifact struct {
   770  	// BuildCommand is the command executed to build the image.
   771  	BuildCommand string `yaml:"buildCommand,omitempty"`
   772  	// Dependencies are the file dependencies that skaffold should watch for both rebuilding and file syncing for this artifact.
   773  	Dependencies *CustomDependencies `yaml:"dependencies,omitempty"`
   774  }
   775  
   776  // CustomDependencies *beta* is used to specify dependencies for an artifact built by a custom build script.
   777  // Either `dockerfile` or `paths` should be specified for file watching to work as expected.
   778  type CustomDependencies struct {
   779  	// Dockerfile should be set if the artifact is built from a Dockerfile, from which skaffold can determine dependencies.
   780  	Dockerfile *DockerfileDependency `yaml:"dockerfile,omitempty" yamltags:"oneOf=dependency"`
   781  
   782  	// Command represents a custom command that skaffold executes to obtain dependencies. The output of this command *must* be a valid JSON array.
   783  	Command string `yaml:"command,omitempty" yamltags:"oneOf=dependency"`
   784  
   785  	// 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.
   786  	Paths []string `yaml:"paths,omitempty" yamltags:"oneOf=dependency"`
   787  
   788  	// Ignore 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.
   789  	// Will only work in conjunction with `paths`.
   790  	Ignore []string `yaml:"ignore,omitempty"`
   791  }
   792  
   793  // DockerfileDependency *beta* is used to specify a custom build artifact that is built from a Dockerfile. This allows skaffold to determine dependencies from the Dockerfile.
   794  type DockerfileDependency struct {
   795  	// Path locates the Dockerfile relative to workspace.
   796  	Path string `yaml:"path,omitempty"`
   797  
   798  	// BuildArgs are key/value pairs used to resolve values of `ARG` instructions in a Dockerfile.
   799  	// Values can be constants or environment variables via the go template syntax.
   800  	// For example: `{"key1": "value1", "key2": "value2", "key3": "'{{.ENV_VARIABLE}}'"}`.
   801  	BuildArgs map[string]*string `yaml:"buildArgs,omitempty"`
   802  }
   803  
   804  // KanikoArtifact describes an artifact built from a Dockerfile,
   805  // with kaniko.
   806  type KanikoArtifact struct {
   807  	// AdditionalFlags are additional flags to be passed to Kaniko command line.
   808  	// See [Kaniko Additional Flags](https://github.com/GoogleContainerTools/kaniko#additional-flags).
   809  	// Deprecated - instead the named, unique fields should be used, e.g. `buildArgs`, `cache`, `target`.
   810  	AdditionalFlags []string `yaml:"flags,omitempty"`
   811  
   812  	// DockerfilePath locates the Dockerfile relative to workspace.
   813  	// Defaults to `Dockerfile`.
   814  	DockerfilePath string `yaml:"dockerfile,omitempty"`
   815  
   816  	// Target is the Dockerfile target name to build.
   817  	Target string `yaml:"target,omitempty"`
   818  
   819  	// BuildArgs are arguments passed to the docker build.
   820  	// It also accepts environment variables via the go template syntax.
   821  	// For example: `{"key1": "value1", "key2": "value2", "key3": "'{{.ENV_VARIABLE}}'"}`.
   822  	BuildArgs map[string]*string `yaml:"buildArgs,omitempty"`
   823  
   824  	// Env are environment variables passed to the kaniko pod.
   825  	Env []v1.EnvVar `yaml:"env,omitempty"`
   826  
   827  	// InitImage is the image used to run init container which mounts kaniko context.
   828  	InitImage string `yaml:"initImage,omitempty"`
   829  
   830  	// Image is the Docker image used by the Kaniko pod.
   831  	// Defaults to the latest released version of `gcr.io/kaniko-project/executor`.
   832  	Image string `yaml:"image,omitempty"`
   833  
   834  	// Cache configures Kaniko caching. If a cache is specified, Kaniko will
   835  	// use a remote cache which will speed up builds.
   836  	Cache *KanikoCache `yaml:"cache,omitempty"`
   837  
   838  	// Reproducible is used to strip timestamps out of the built image.
   839  	Reproducible bool `yaml:"reproducible,omitempty"`
   840  
   841  	// SkipTLS skips TLS verification when pulling and pushing the image.
   842  	SkipTLS bool `yaml:"skipTLS,omitempty"`
   843  
   844  	// VolumeMounts are volume mounts passed to kaniko pod.
   845  	VolumeMounts []v1.VolumeMount `yaml:"volumeMounts,omitempty"`
   846  }
   847  
   848  // DockerArtifact describes an artifact built from a Dockerfile,
   849  // usually using `docker build`.
   850  type DockerArtifact struct {
   851  	// DockerfilePath locates the Dockerfile relative to workspace.
   852  	// Defaults to `Dockerfile`.
   853  	DockerfilePath string `yaml:"dockerfile,omitempty"`
   854  
   855  	// Target is the Dockerfile target name to build.
   856  	Target string `yaml:"target,omitempty"`
   857  
   858  	// BuildArgs are arguments passed to the docker build.
   859  	// For example: `{"key1": "value1", "key2": "value2"}`.
   860  	BuildArgs map[string]*string `yaml:"buildArgs,omitempty"`
   861  
   862  	// NetworkMode is passed through to docker and overrides the
   863  	// network configuration of docker builder. If unset, use whatever
   864  	// is configured in the underlying docker daemon. Valid modes are
   865  	// `host`: use the host's networking stack.
   866  	// `bridge`: use the bridged network configuration.
   867  	// `none`: no networking in the container.
   868  	NetworkMode string `yaml:"network,omitempty"`
   869  
   870  	// CacheFrom lists the Docker images used as cache sources.
   871  	// For example: `["golang:1.10.1-alpine3.7", "alpine:3.7"]`.
   872  	CacheFrom []string `yaml:"cacheFrom,omitempty"`
   873  
   874  	// NoCache used to pass in --no-cache to docker build to prevent caching.
   875  	NoCache bool `yaml:"noCache,omitempty"`
   876  }
   877  
   878  // BazelArtifact describes an artifact built with [Bazel](https://bazel.build/).
   879  type BazelArtifact struct {
   880  	// BuildTarget is the `bazel build` target to run.
   881  	// For example: `//:skaffold_example.tar`.
   882  	BuildTarget string `yaml:"target,omitempty" yamltags:"required"`
   883  
   884  	// BuildArgs are additional args to pass to `bazel build`.
   885  	// For example: `["-flag", "--otherflag"]`.
   886  	BuildArgs []string `yaml:"args,omitempty"`
   887  }
   888  
   889  // JibArtifact builds images using the
   890  // [Jib plugins for Maven and Gradle](https://github.com/GoogleContainerTools/jib/).
   891  type JibArtifact struct {
   892  	// Project selects which sub-project to build for multi-module builds.
   893  	Project string `yaml:"project,omitempty"`
   894  
   895  	// Flags are additional build flags passed to the builder.
   896  	// For example: `["--no-build-cache"]`.
   897  	Flags []string `yaml:"args,omitempty"`
   898  
   899  	// Type the Jib builder type; normally determined automatically. Valid types are
   900  	// `maven`: for Maven.
   901  	// `gradle`: for Gradle.
   902  	Type string `yaml:"type,omitempty"`
   903  }