container Deploy
Last updated
Was this helpful?
Last updated
Was this helpful?
Deploy a container image, e.g. in a Kubernetes namespace (when used with the kubernetes provider).
This is a simplified abstraction, which can be convenient for simple deployments, but has limited features compared to more platform-specific types. For example, you cannot specify replicas for redundancy, and various platform-specific options are not included. For more flexibility, please look at other Deploy types like or .
Below is the full schema reference for the action.
container actions also export values that are available in template strings. See the section below for details.
typeThe type of action, e.g. exec, container or kubernetes. Some are built into Garden but mostly these will be defined by your configured providers.
string
Yes
nameA valid name for the action. Must be unique across all actions of the same kind in your project.
string
Yes
descriptionA description of the action.
string
No
sourceBy default, the directory where the action is defined is used as the source for the build context.
You can override the directory that is used for the build context by setting source.path.
object
No
source.pathA relative POSIX-style path to the source directory for this action.
If specified together with source.repository, the path will be relative to the repository root.
Otherwise, the path will be relative to the directory containing the Garden configuration file.
posixPath
No
source.repositoryWhen set, Garden will import the action source from this repository, but use this action configuration (and not scan for configs in the separate repository).
object
No
source.repository.urlA 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>
gitUrl | string
Yes
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.
array[actionReference]
[]
No
Example:
disabledSet 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.
boolean
false
No
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"}.
array[string]
No
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.
array[posixPath]
No
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.
array[posixPath]
No
Example:
variablesA 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.
object
No
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.
array[alternatives]
[]
No
Example:
varfiles[].pathPath to a file containing a path.
posixPath
Yes
varfiles[].optionalWhether the varfile is optional.
boolean
No
buildSpecify 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.
string
No
kindstring
"Deploy"
Yes
timeoutTimeout for the deploy to complete, in seconds.
number
300
No
specobject
No
spec.command[]The command/entrypoint to run the container with.
array[string]
No
Example:
spec.args[]The arguments (on top of the command, i.e. entrypoint) to run the container with.
array[string]
No
Example:
spec.envKey/value map of environment variables. Keys must be valid POSIX environment variable names (must not start with GARDEN) and values must be primitives or references to secrets.
object
{}
No
Example:
spec.cpuobject
{"min":10,"max":1000}
No
spec.cpu.minThe minimum amount of CPU the container needs to be available for it to be deployed, in millicpus (i.e. 1000 = 1 CPU)
number
10
No
spec.cpu.maxThe maximum amount of CPU the container can use, in millicpus (i.e. 1000 = 1 CPU). If set to null will result in no limit being set.
number
1000
No
spec.memoryobject
{"min":90,"max":1024}
No
spec.memory.minThe minimum amount of RAM the container needs to be available for it to be deployed, in megabytes (i.e. 1024 = 1 GB)
number
90
No
spec.memory.maxThe maximum amount of RAM the container can use, in megabytes (i.e. 1024 = 1 GB) If set to null will result in no limit being set.
number
1024
No
spec.volumes[]List of volumes that should be mounted when starting the container.
Note: If neither hostPath nor action is specified,
an empty ephemeral volume is created and mounted when deploying the container.
array[object]
[]
No
spec.volumes[].nameThe name of the allocated volume.
string
Yes
spec.volumes[].containerPathThe path where the volume should be mounted in the container.
posixPath
Yes
spec.volumes[].hostPathNOTE: Usage of hostPath is generally discouraged, since it doesn't work reliably across different platforms and providers. Some providers may not support it at all.
A local path or path on the node that's running the container, to mount in the container, relative to the config source directory (or absolute).
posixPath
No
Example:
spec.privilegedIf true, run the main container in privileged mode. Processes in privileged containers are essentially equivalent to root on the host. Defaults to false.
boolean
No
spec.addCapabilities[]POSIX capabilities to add when running the container.
array[string]
No
spec.dropCapabilities[]POSIX capabilities to remove when running the container.
array[string]
No
spec.ttySpecify if containers in this action have TTY support enabled (which implies having stdin support enabled).
boolean
false
No
spec.deploymentStrategySpecifies the container's deployment strategy.
string
"RollingUpdate", "Recreate"
"RollingUpdate"
Yes
spec.annotationsAnnotations to attach to the service (note: May not be applicable to all providers).
When using the Kubernetes provider, these annotations are applied to both Service and Pod resources. You can generally specify the annotations intended for both Pods or Services here, and the ones that don't apply on either side will be ignored (i.e. if you put a Service annotation here, it'll also appear on Pod specs but will be safely ignored there, and vice versa).
object
{}
No
Example:
spec.daemonWhether to run the service as a daemon (to ensure exactly one instance runs per node). May not be supported by all providers.
boolean
false
No
spec.syncSpecifies which files or directories to sync to which paths inside the running containers of the service when it's in sync mode, and overrides for the container command and/or arguments.
Sync is enabled e.g. by setting the --sync flag on the garden deploy command.
object
No
spec.sync.args[]Override the default container arguments when in sync mode.
array[string]
No
spec.sync.command[]Override the default container command (i.e. entrypoint) when in sync mode.
array[string]
No
spec.sync.paths[]Specify one or more source files or directories to automatically sync with the running container.
array[object]
No
spec.sync.paths[].sourcePath 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.
string
"."
No
Example:
spec.sync.paths[].targetPOSIX-style absolute path to sync to inside the container. The root path (i.e. "/") is not allowed.
posixPath
Yes
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.
array[posixPath]
No
Example:
spec.sync.paths[].modestring
"one-way", "one-way-safe", "one-way-replica", "one-way-reverse", "one-way-replica-reverse", "two-way", "two-way-safe", "two-way-resolved"
"one-way-safe"
Yes
spec.sync.paths[].defaultFileModenumber
0o644
No
spec.sync.paths[].defaultDirectoryModenumber
0o755
No
spec.sync.paths[].defaultOwnernumber | string
No
spec.sync.paths[].defaultGroupnumber | string
No
spec.imageSpecify an image ID to deploy. Should be a valid Docker image identifier. Required.
string
Yes
spec.ingresses[]List of ingress endpoints that the service exposes.
array[object]
[]
No
Example:
spec.ingresses[].annotationsAnnotations to attach to the ingress (Note: May not be applicable to all providers)
object
{}
No
Example:
spec.ingresses[].hostnameThe hostname that should route to this service. Defaults to the default hostname configured in the provider configuration.
Note that if you're developing locally you may need to add this hostname to your hosts file.
hostname
No
spec.ingresses[].linkUrlThe link URL for the ingress to show in the console and in dashboards. Also used when calling the service with the call command.
Use this if the actual URL is different from what's specified in the ingress, e.g. because there's a load balancer in front of the service that rewrites the paths.
Otherwise Garden will construct the link URL from the ingress spec.
string
No
spec.ingresses[].pathThe path which should be routed to the service.
string
"/"
No
spec.ingresses[].portThe name of the container port where the specified paths should be routed.
string
Yes
spec.healthCheckSpecify how the service's health should be checked after deploying.
object
No
spec.healthCheck.httpGetSet this to check the service's health by making an HTTP request.
object
No
spec.healthCheck.httpGet.pathThe path of the service's health check endpoint.
string
Yes
spec.healthCheck.httpGet.portThe name of the port where the service's health check endpoint should be available.
string
Yes
spec.healthCheck.httpGet.schemestring
"HTTP"
No
spec.healthCheck.command[]Set this to check the service's health by running a command in its container.
array[string]
No
spec.healthCheck.tcpPortSet this to check the service's health by checking if this TCP port is accepting connections.
string
No
spec.healthCheck.readinessTimeoutSecondsThe maximum number of seconds to wait until the readiness check counts as failed.
number
3
No
spec.healthCheck.livenessTimeoutSecondsThe maximum number of seconds to wait until the liveness check counts as failed.
number
3
No
spec.timeoutThe maximum duration (in seconds) to wait for resources to deploy and become healthy.
number
300
No
spec.limitsDeprecated: Please use the cpu and memory fields instead.
Specify resource limits for the service.
object
No
spec.limits.cpuDeprecated: This field will be removed in a future release.
The maximum amount of CPU the service can use, in millicpus (i.e. 1000 = 1 CPU)
number
No
spec.limits.memoryDeprecated: This field will be removed in a future release.
The maximum amount of RAM the service can use, in megabytes (i.e. 1024 = 1 GB)
number
No
spec.ports[]List of ports that the service container exposes.
array[object]
[]
No
spec.ports[].nameThe name of the port (used when referencing the port elsewhere in the service configuration).
string
Yes
spec.ports[].protocolThe protocol of the port.
string
"TCP"
No
spec.ports[].containerPortThe port exposed on the container by the running process. This will also be the default value for servicePort.
This is the port you would expose in your Dockerfile and that your process listens on. This is commonly a non-privileged port like 8080 for security reasons.
The service port maps to the container port:servicePort:80 -> containerPort:8080 -> process:8080
number
Yes
Example:
spec.ports[].localPortSpecify a preferred local port to attach to when creating a port-forward to the service port. If this port is busy, a warning will be shown and an alternative port chosen.
number
No
Example:
spec.ports[].servicePortThe port exposed on the service. Defaults to containerPort if not specified.
This is the port you use when calling a service from another service within the cluster. For example, if your service name is my-service and the service port is 8090, you would call it with: http://my-service:8090/some-endpoint.
It is common to use port 80, the default port number, so that you can call the service directly with http://my-service/some-endpoint.
The service port maps to the container port:servicePort:80 -> containerPort:8080 -> process:8080
number
No
Example:
spec.ports[].hostPortDeprecated: This field will be removed in a future release.
number
No
spec.ports[].nodePortSet this to expose the service on the specified port on the host node (may not be supported by all providers). Set to true to have the cluster pick a port automatically, which is most often advisable if the cluster is shared by multiple users.
This allows you to call the service from the outside by the node's IP address and the port number set in this field.
number
No
spec.replicasThe number of instances of the service to deploy. Defaults to 3 for environments configured with production: true, otherwise 1.
Note: This setting may be overridden or ignored in some cases. For example, when running with daemon: true or if the provider doesn't support multiple replicas.
number
No
The following keys are available via the ${actions.deploy.<name>} template string key for container
action.
${actions.deploy.<name>.name}The name of the action.
string
${actions.deploy.<name>.disabled}Whether the action is disabled.
boolean
Example:
${actions.deploy.<name>.buildPath}The local path to the action build directory.
string
Example:
${actions.deploy.<name>.sourcePath}The local path to the action source directory.
string
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.
string
"default"
Example:
${actions.deploy.<name>.var.*}The variables configured on the action.
object
{}
${actions.deploy.<name>.var.<name>}string | number | boolean | link | array[link]
${actions.deploy.<name>.outputs.deployedImageId}The ID of the image that was deployed.
string
You can use source.repository to get the source from an external repository. For more information on remote actions, please refer to the .
> path
> repository
> > url
Note that you can also exclude files using the exclude field or by placing .gardenignore files in your source tree, which use the same format as .gitignore files. See the for details.
For actions other than Build actions, this is usually not necessary to specify, or is implicitly inferred. For Deploy, Run and Test actions, the exclusions specified here only applied on top of explicitly set include paths, or such paths inferred by providers. See the for details.
.env - Standard "dotenv" format, as defined by .
> path
> optional
> command
> args
> env
> cpu
> > min
> > max
> memory
> > min
> > max
> volumes
> > name
> > containerPath
> > hostPath
> privileged
> addCapabilities
> dropCapabilities
> tty
> deploymentStrategy
> annotations
> daemon
> sync
See the for more information.
> > args
> > command
> > paths
> > > source
> > > target
> > > exclude
> > > mode
The sync mode to use for the given paths. See the for details.
> > > defaultFileMode
The default permission bits, specified as an octal, to set on files at the sync target. Defaults to 0o644 (user can read/write, everyone else can read). See the for more information.
> > > defaultDirectoryMode
The default permission bits, specified as an octal, to set on directories at the sync target. Defaults to 0o755 (user can read/write, everyone else can read). See the for more information.
> > > defaultOwner
Set the default owner of files and directories at the target. Specify either an integer ID or a string name. See the for more information.
> > > defaultGroup
Set the default group on files and directories at the target. Specify either an integer ID or a string name. See the for more information.
> image
> ingresses
> > annotations
> > hostname
> > linkUrl
> > path
> > port
> healthCheck
> > httpGet
> > > path
> > > port
> > > scheme
> > command
> > tcpPort
> > readinessTimeoutSeconds
> > livenessTimeoutSeconds
> timeout
> limits
> > cpu
> > memory
> ports
> > name
> > protocol
> > containerPort
> > localPort
> > servicePort
> > hostPort
> > nodePort
> replicas