kubernetes Deploy

Description

Specify one or more Kubernetes manifests to deploy.

You can either (or both) specify the manifests as part of the garden.yml configuration, or you can refer to one or more files with existing manifests.

Note that if you include the manifests in the garden.yml file, you can use to interpolate values into the manifests.

If you need more advanced templating features you can use the Deploy type.

Below is the full schema reference for the action. For an introduction to configuring Garden, please look at our .

kubernetes actions also export values that are available in template strings. See the section below for details.

Configuration Keys

`type`

The type of action, e.g. exec, container or kubernetes. Some are built into Garden but mostly these will be defined by your configured providers.

Type

Required

`name`

A valid name for the action. Must be unique across all actions of the same kind in your project.

Type

Required

`description`

A description of the action.

`source`

By default, the directory where the action is defined is used as the source for the build context.

You can override this by setting either source.path to another (POSIX-style) path relative to the action source directory, or source.repository to get the source from an external repository.

If using source.path, you must make sure the target path is in a git repository.

`source.path`

A relative POSIX-style path to the source directory for this action. You must make sure this path exists and is in a git repository!

`source.repository`

When set, Garden will import the action source from this repository, but use this action configuration (and not scan for configs in the separate repository).

`source.repository.url`

A remote repository URL. Currently only supports git servers. Must contain a hash suffix pointing to a specific branch or tag, with the format: #<branch|tag>

Example:

`dependencies[]`

A list of other actions that this action depends on, and should be built, deployed or run (depending on the action type) before processing this action.

Each dependency should generally be expressed as a "<kind>.<name>" string, where is one of build, deploy, run or test, and is the name of the action to depend on.

You may also optionally specify a dependency as an object, e.g. { kind: "Build", name: "some-image" }.

Any empty values (i.e. null or empty strings) are ignored, so that you can conditionally add in a dependency via template expressions.

Example:

`disabled`

Set this to true to disable the action. You can use this with conditional template strings to disable actions based on, for example, the current environment or other variables (e.g. disabled: ${environment.name == "prod"}). This can be handy when you only need certain actions for specific environments, e.g. only for development.

For Build actions, this means the build is not performed unless it is declared as a dependency by another enabled action (in which case the Build is assumed to be necessary for the dependant action to be run or built).

For other action kinds, the action is skipped in all scenarios, and dependency declarations to it are ignored. Note however that template strings referencing outputs (i.e. runtime outputs) will fail to resolve when the action is disabled, so you need to make sure to provide alternate values for those if you're using them, using conditional expressions.

`environments[]`

If set, the action is only enabled for the listed environment types. This is effectively a cleaner shorthand for the disabled field with an expression for environments. For example, environments: ["prod"] is equivalent to disabled: ${environment.name != "prod"}.

`include[]`

Specify a list of POSIX-style paths or globs that should be regarded as source files for this action, and thus will affect the computed version of the action.

For actions other than Build actions, this is usually not necessary to specify, or is implicitly inferred. An exception would be e.g. an exec action without a build reference, where the relevant files cannot be inferred and you want to define which files should affect the version of the action, e.g. to make sure a Test action is run when certain files are modified.

Build actions have a different behavior, since they generally are based on some files in the source tree, so please reference the docs for more information on those.

Example:

`exclude[]`

Specify a list of POSIX-style paths or glob patterns that should be explicitly excluded from the action's version.

Unlike the scan.exclude field in the project config, the filters here have no effect on which files and directories are watched for changes when watching is enabled. Use the project scan.exclude field to affect those, if you have large directories that should not be watched for changes.

Example:

`variables`

A map of variables scoped to this particular action. These are resolved before any other parts of the action configuration and take precedence over group-scoped variables (if applicable) and project-scoped variables, in that order. They may reference group-scoped and project-scoped variables, and generally can use any template strings normally allowed when resolving the action.

`varfiles[]`

Specify a list of paths (relative to the directory where the action is defined) to a file containing variables, that we apply on top of the action-level variables field, and take precedence over group-level variables (if applicable) and project-level variables, in that order.

If you specify multiple paths, they are merged in the order specified, i.e. the last one takes precedence over the previous ones.

The format of the files is determined by the configured file's extension:

.yaml/.yml - YAML. The file must consist of a YAML document, which must be a map (dictionary). Keys may contain any value type. YAML format is used by default.
.json - JSON. Must contain a single JSON object (not an array).

NOTE: The default varfile format was changed to YAML in Garden v0.13, since YAML allows for definition of nested objects and arrays.

To use different varfiles in different environments, you can template in the environment name to the varfile name, e.g. varfile: "my-action.${environment.name}.env" (this assumes that the corresponding varfiles exist).

If a listed varfile cannot be found, throwing an error. To add optional varfiles, you can use a list item object with a path and an optional optional boolean field.

Example:

`varfiles[].path`

Path to a file containing a path.

`varfiles[].optional`

Whether the varfile is optional.

`build`

Specify a Build action, and resolve this action from the context of that Build.

For example, you might create an exec Build which prepares some manifests, and then reference that in a kubernetes Deploy action, and the resulting manifests from the Build.

This would mean that instead of looking for manifest files relative to this action's location in your project structure, the output directory for the referenced exec Build would be the source.

`kind`

`timeout`

Timeout for the deploy to complete, in seconds.

`spec`

`spec.files[]`

POSIX-style paths to YAML files to load manifests from. Each can contain multiple manifests, and can include any Garden template strings, which will be resolved before applying the manifests.

`spec.kustomize`

Resolve the specified kustomization and include the resulting resources. Note that if you specify files or manifests as well, these are also included.

`spec.kustomize.path`

The directory path where the desired kustomization.yaml is, or a git repository URL. This could be the path to an overlay directory, for example. If it's a path, must be a relative POSIX-style path and must be within the action root. Defaults to the action root. If you set this to null, kustomize will not be run.

`spec.kustomize.version`

The Kustomize version to use.

`spec.kustomize.extraArgs[]`

A list of additional arguments to pass to the kustomize build command. Note that specifying '-o' or '--output' is not allowed.

`spec.manifests[]`

List of Kubernetes resource manifests to deploy. If files is also specified, this is combined with the manifests read from the files.

`spec.manifests[].apiVersion`

The API version of the resource.

`spec.manifests[].kind`

The kind of the resource.

`spec.manifests[].metadata`

`spec.manifests[].metadata.name`

The name of the resource.

`spec.patchResources[]`

A list of resources to patch using Kubernetes' patch strategies. This is useful for e.g. overwriting a given container image name with an image built by Garden without having to actually modify the underlying Kubernetes manifest in your source code. Another common example is to use this to change the number of replicas for a given Kubernetes Deployment.

Under the hood, Garden just applies the kubectl patch command to the resource that matches the specified kind and name.

Patches are applied to file manifests, inline manifests, and kustomize files.

You can learn more about patching Kubernetes resources here: https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/

`spec.patchResources[].kind`

The kind of the resource to patch.

`spec.patchResources[].name`

The name of the resource to patch.

`spec.patchResources[].strategy`

The patch strategy to use. One of 'json', 'merge', or 'strategic'. Defaults to 'strategic'.

You can read more about the different strategies in the offical Kubernetes documentation at: https://kubernetes.io/docs/tasks/manage-kubernetes-objects/update-api-object-kubectl-patch/

`spec.patchResources[].patch`

The patch to apply.

`spec.namespace`

A valid Kubernetes namespace name. Must be a valid RFC1035/RFC1123 (DNS) label (may contain lowercase letters, numbers and dashes, must start with a letter, and cannot end with a dash) and must not be longer than 63 characters.

`spec.portForwards[]`

Manually specify port forwards that Garden should set up when deploying in dev or watch mode. If specified, these override the auto-detection of forwardable ports, so you'll need to specify the full list of port forwards to create.

`spec.portForwards[].name`

An identifier to describe the port forward.

`spec.portForwards[].resource`

The full resource kind and name to forward to, e.g. Service/my-service or Deployment/my-deployment. Note that Garden will not validate this ahead of attempting to start the port forward, so you need to make sure this is correctly set. The types of resources supported will match that of the kubectl port-forward CLI command.

`spec.portForwards[].targetPort`

The port number on the remote resource to forward to.

`spec.portForwards[].localPort`

The preferred local port to forward from. If none is set, a random port is chosen. If the specified port is not available, a warning is shown and a random port chosen instead.

`spec.timeout`

The maximum duration (in seconds) to wait for resources to deploy and become healthy.

`spec.applyArgs[]`

Additional arguments to pass to kubectl apply.

`spec.waitForJobs`

Wait until the jobs have been completed. Garden will wait for as long as timeout.

`spec.defaultTarget`

Specify a default resource in the deployment to use for syncs, local mode, and for the garden exec command.

Specify either kind and name, or a podSelector. The resource should be one of the resources deployed by this action (otherwise the target is not guaranteed to be deployed with adjustments required for syncing or local mode).

Set containerName to specify a container to connect to in the remote Pod. By default the first container in the Pod is used.

Note that if you specify podSelector here, it is not validated to be a selector matching one of the resources deployed by the action.

`spec.defaultTarget.kind`

The kind of Kubernetes resource to find.

`spec.defaultTarget.name`

The name of the resource, of the specified kind. If specified, you must also specify kind.

`spec.defaultTarget.podSelector`

A map of string key/value labels to match on any Pods in the namespace. When specified, a random ready Pod with matching labels will be picked as a target, so make sure the labels will always match a specific Pod type.

`spec.defaultTarget.containerName`

The name of a container in the target. Specify this if the target contains more than one container and the main container is not the first container in the spec.

`spec.sync`

Configure path syncs for the resources in this Deploy.

If you have multiple syncs for the Deploy, you can use the defaults field to set common configuration for every individual sync.

`spec.sync.defaults`

Defaults to set across every sync for this Deploy. If you use the exclude field here, it will be merged with any excludes set in individual syncs. These are applied on top of any defaults set in the provider configuration.

`spec.sync.defaults.exclude[]`

Specify a list of POSIX-style paths or glob patterns that should be excluded from the sync.

Any exclusion patterns defined in individual sync specs will be applied in addition to these patterns.

.git directories and .garden directories are always ignored.

Example:

`spec.sync.defaults.fileMode`

`spec.sync.defaults.directoryMode`

`spec.sync.defaults.owner`

`spec.sync.defaults.group`

`spec.sync.paths[]`

A list of syncs to start once the Deploy is successfully started.

`spec.sync.paths[].target`

The Kubernetes resource to sync to. If specified, this is used instead of spec.defaultTarget.

`spec.sync.paths[].target.kind`

The kind of Kubernetes resource to find.

`spec.sync.paths[].target.name`

The name of the resource, of the specified kind. If specified, you must also specify kind.

`spec.sync.paths[].target.podSelector`

`spec.sync.paths[].target.containerName`

The name of a container in the target. Specify this if the target contains more than one container and the main container is not the first container in the spec.

`spec.sync.paths[].sourcePath`

Path to a local directory to be synchronized with the target. This should generally be a templated path to another action's source path (e.g. ${actions.build.my-container-image.sourcePath}), or a relative path. If a path is hard-coded, we recommend sticking with relative paths here, and using forward slashes (/) as a delimiter, as Windows-style paths with back slashes (\) and absolute paths will work on some platforms, but they are not portable and will not work for users on other platforms. Defaults to the Deploy action's config's directory if no value is provided.

Example:

`spec.sync.paths[].containerPath`

POSIX-style absolute path to sync to inside the container. The root path (i.e. "/") is not allowed.

Example:

`spec.sync.paths[].exclude[]`

Specify a list of POSIX-style paths or glob patterns that should be excluded from the sync.

.git directories and .garden directories are always ignored.

Example:

`spec.sync.paths[].mode`

`spec.sync.paths[].defaultFileMode`

`spec.sync.paths[].defaultDirectoryMode`

`spec.sync.paths[].defaultOwner`

`spec.sync.paths[].defaultGroup`

`spec.sync.overrides[]`

Overrides for the container command and/or arguments for when in sync mode.

`spec.sync.overrides[].target`

The Kubernetes resources to override. If specified, this is used instead of spec.defaultTarget.

`spec.sync.overrides[].target.kind`

The kind of Kubernetes resource to find.

`spec.sync.overrides[].target.name`

The name of the resource, of the specified kind. If specified, you must also specify kind.

`spec.sync.overrides[].target.podSelector`

`spec.sync.overrides[].target.containerName`

The name of a container in the target. Specify this if the target contains more than one container and the main container is not the first container in the spec.

`spec.sync.overrides[].command[]`

Override the command/entrypoint in the matched container.

`spec.sync.overrides[].args[]`

Override the args in the matched container.

`spec.sync.overrides[].image`

Override the image of the matched container.

`spec.localMode`

[EXPERIMENTAL] Configures the local application which will send and receive network requests instead of the target resource specified by localMode.target or defaultTarget. One of those fields must be specified to enable local mode for the action.

The selected container of the target Kubernetes resource will be replaced by a proxy container which runs an SSH server to proxy requests. Reverse port-forwarding will be automatically configured to route traffic to the locally run application and back.

Local mode is enabled by setting the --local option on the garden deploy command. Local mode always takes the precedence over sync mode if there are any conflicting service names.

Health checks are disabled for services running in local mode.

Note! This feature is still experimental. Some incompatible changes can be made until the first non-experimental release.

`spec.localMode.ports[]`

The reverse port-forwards configuration for the local application.

`spec.localMode.ports[].local`

The local port to be used for reverse port-forward.

`spec.localMode.ports[].remote`

The remote port to be used for reverse port-forward.

`spec.localMode.command[]`

The command to run the local application. If not present, then the local application should be started manually.

`spec.localMode.restart`

Specifies restarting policy for the local application. By default, the local application will be restarting infinitely with 1000ms between attempts.

`spec.localMode.restart.delayMsec`

Delay in milliseconds between the local application restart attempts. The default value is 1000ms.

`spec.localMode.restart.max`

Max number of the local application restarts. Unlimited by default.

`spec.localMode.target`

The remote Kubernetes resource to proxy traffic from. If specified, this is used instead of defaultTarget.

`spec.localMode.target.kind`

The kind of Kubernetes resource to find.

`spec.localMode.target.name`

The name of the resource, of the specified kind. If specified, you must also specify kind.

`spec.localMode.target.podSelector`

`spec.localMode.target.containerName`

The name of a container in the target. Specify this if the target contains more than one container and the main container is not the first container in the spec.

Outputs

The following keys are available via the ${actions.deploy.<name>} template string key for kubernetes action.

`${actions.deploy.<name>.name}`

The name of the action.

`${actions.deploy.<name>.disabled}`

Whether the action is disabled.

Example:

`${actions.deploy.<name>.buildPath}`

The local path to the action build directory.

Example:

`${actions.deploy.<name>.sourcePath}`

The local path to the action source directory.

Example:

`${actions.deploy.<name>.mode}`

The mode that the action should be executed in (e.g. 'sync' or 'local' for Deploy actions). Set to 'default' if no special mode is being used.

Build actions inherit the mode from Deploy actions that depend on them. E.g. If a Deploy action is in 'sync' mode and depends on a Build action, the Build action will inherit the 'sync' mode setting from the Deploy action. This enables installing different tools that may be necessary for different development modes.

Example:

`${actions.deploy.<name>.var.*}`

The variables configured on the action.

`${actions.deploy.<name>.var.<name>}`

Previoushelm Deploy Nextpersistentvolumeclaim Deploy

Last updated 4 months ago