Container

Specify a container image to build or pull from a remote registry. You may also optionally specify services to deploy, tasks or tests to run inside the container.
Note that the runtime services have somewhat limited features in this module type. For example, you cannot specify replicas for redundancy, and various platform-specific options are not included. For those, look at other module types like helm or kubernetes.
Below is the schema reference. For an introduction to configuring Garden modules, please look at our Configuration guide. The first section lists and describes the available schema keys. The second section contains the complete YAML schema.
container modules also export values that are available in template strings under ${modules.<module-name>.outputs}. See the Outputs section below for details.
Configuration keys
apiVersion
The schema version of this module's config (currently not used).
Type
Required
Allowed Values
Default
string
Yes
"garden.io/v0"
"garden.io/v0"
kind
Type
Required
Allowed Values
Default
string
Yes
"Module"
"Module"
type
The type of this module.
Type
Required
string
Yes
Example:
type: "container"
name
The name of this module.
Type
Required
string
Yes
Example:
name: "my-sweet-module"
description
Type
Required
string
No
include
Specify a list of POSIX-style paths or globs that should be regarded as the source files for this module. Files that do not match these paths or globs are excluded when computing the version of the module, when responding to filesystem watch events, and when staging builds.
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 Configuration Files guide for details.
Also note that specifying an empty list here means no sources should be included.
Type
Required
array[string]
No
Example:
include:
  - Dockerfile
  - my-app.js
exclude
Specify a list of POSIX-style paths or glob patterns that should be excluded from the module. Files that match these paths or globs are excluded when computing the version of the module, when responding to filesystem watch events, and when staging builds.
Note that you can also explicitly include files using the include field. If you also specify the include field, the files/patterns specified here are filtered from the files matched by include. See the Configuration Files guidefor details.
Type
Required
array[string]
No
Example:
exclude:
  - tmp/**/*
  - '*.log'
repositoryUrl
A remote repository URL. Currently only supports git servers. Must contain a hash suffix pointing to a specific branch or tag, with the format: #
Garden will import the repository source code into this module, but read the module's config from the local garden.yml file.
Type
Required
string
No
Example:
repositoryUrl: "git+https://github.com/org/repo.git#v2.0"
allowPublish
When false, disables pushing this module to remote registries.
Type
Required
Default
boolean
No
true
build
Specify how to build the module. Note that plugins may define additional keys on this object.
Type
Required
Default
object
No
{"dependencies":[]}
build.dependencies[]
​build > dependencies
A list of modules that must be built before this module is built.
Type
Required
Default
array[object]
No
[]
Example:
build:
  ...
  dependencies:
    - name: some-other-module-name
build.dependencies[].name
​build > dependencies > name
Module name to build ahead of this module.
Type
Required
string
Yes
build.dependencies[].copy[]
​build > dependencies > copy
Specify one or more files or directories to copy from the built dependency to this module.
Type
Required
Default
array[object]
No
[]
build.dependencies[].copy[].source
​build > dependencies > copy > source
POSIX-style path or filename of the directory or file(s) to copy to the target.
Type
Required
string
Yes
build.dependencies[].copy[].target
​build > dependencies > copy > target
POSIX-style path or filename to copy the directory or file(s).
Type
Required
Default
string
No
"<same as source path>"
build.targetImage
​build > targetImage
For multi-stage Dockerfiles, specify which image to build (see https://docs.docker.com/engine/reference/commandline/build/#specifying-target-build-stage---target for details).
Type
Required
string
No
build.timeout
​build > timeout
Maximum time in seconds to wait for build to finish.
Type
Required
Default
number
No
1200
buildArgs
Specify build arguments to use when building the container image.
Type
Required
Default
object
No
{}
extraFlags
Specify extra flags to use when building the container image. Note that arguments may not be portable across implementations.
Type
Required
array[string]
No
image
Specify the image name for the container. Should be a valid Docker image identifier. If specified and the module does not contain a Dockerfile, this image will be used to deploy services for this module. If specified and the module does contain a Dockerfile, this identifier is used when pushing the built image.
Type
Required
string
No
hotReload
Specifies which files or directories to sync to which paths inside the running containers of hot reload-enabled services when those files or directories are modified. Applies to this module's services, and to services with this module as their sourceModule.
Type
Required
object
No
hotReload.sync[]
​hotReload > sync
Specify one or more source files or directories to automatically sync into the running container.
Type
Required
array[object]
Yes
hotReload.sync[].source
​hotReload > sync > source
POSIX-style path of the directory to sync to the target, relative to the module's top-level directory. Must be a relative path if provided. Defaults to the module's top-level directory if no value is provided.
Type
Required
Default
string
No
"."
Example:
hotReload:
  ...
  sync:
    - source: "src"
hotReload.sync[].target
​hotReload > sync > target
POSIX-style absolute path to sync the directory to inside the container. The root path (i.e. "/") is not allowed.
Type
Required
string
Yes
Example:
hotReload:
  ...
  sync:
    - target: "/app/src"
dockerfile
POSIX-style name of Dockerfile, relative to module root.
Type
Required
string
No
services
The list of services to deploy from this container module.
Type
Required
Default
array[object]
No
[]
services[].name
​services > name
Valid RFC1035/RFC1123 (DNS) label (may contain lowercase letters, numbers and dashes, must start with a letter, and cannot end with a dash), cannot contain consecutive dashes or start with garden, or be longer than 63 characters.
Type
Required
string
Yes
services[].dependencies[]
​services > dependencies
The names of any services that this service depends on at runtime, and the names of any tasks that should be executed before this service is deployed.
Type
Required
Default
array[string]
No
[]
services[].annotations
​services > annotations
Annotations to attach to the service (Note: May not be applicable to all providers).
Type
Required
Default
object
No
{}
services[].command[]
​services > command
The command/entrypoint to run the container with when starting the service.
Type
Required
array[string]
No
Example:
services:
  - command:
    - /bin/sh
    - '-c'
services[].args[]
​services > args
The arguments to run the container with when starting the service.
Type
Required
array[string]
No
Example:
services:
  - args:
    - npm
    - start
services[].daemon
​services > daemon
Whether to run the service as a daemon (to ensure exactly one instance runs per node). May not be supported by all providers.
Type
Required
Default
boolean
No
false
services[].ingresses[]
​services > ingresses
List of ingress endpoints that the service exposes.
Type
Required
Default
array[object]
No
[]
Example:
services:
  - ingresses:
    - path: /api
      port: http
services[].ingresses[].annotations
​services > ingresses > annotations
Annotations to attach to the ingress (Note: May not be applicable to all providers)
Type
Required
Default
object
No
{}
services[].ingresses[].hostname
​services > ingresses > hostname
The 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.
Type
Required
string
No
services[].ingresses[].path
​services > ingresses > path
The path which should be routed to the service.
Type
Required
Default
string
No
"/"
services[].ingresses[].port
​services > ingresses > port
The name of the container port where the specified paths should be routed.
Type
Required
string
Yes
services[].env
​services > env
Key/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.
Type
Required
Default
object
No
{}
Example:
services:
  - env:
      MY_VAR: some-value
      MY_SECRET_VAR:
        secretRef:
          name: my-secret
          key: some-key
services[].healthCheck
​services > healthCheck
Specify how the service's health should be checked after deploying.
Type
Required
object
No
services[].healthCheck.httpGet
​services > healthCheck > httpGet
Set this to check the service's health by making an HTTP request.
Type
Required
object
No
services[].healthCheck.httpGet.path
​services > healthCheck > httpGet > path
The path of the service's health check endpoint.
Type
Required
string
Yes
services[].healthCheck.httpGet.port
​services > healthCheck > httpGet > port
The name of the port where the service's health check endpoint should be available.
Type
Required
string
Yes
services[].healthCheck.httpGet.scheme
​services > healthCheck > httpGet > scheme
Type
Required
Default
string
No
"HTTP"
services[].healthCheck.command[]
​services > healthCheck > command
Set this to check the service's health by running a command in its container.
Type
Required
array[string]
No
services[].healthCheck.tcpPort
​services > healthCheck > tcpPort
Set this to check the service's health by checking if this TCP port is accepting connections.
Type
Required
string
No
services[].hotReloadCommand[]
​services > hotReloadCommand
If this module uses the hotReload field, the container will be run with this command/entrypoint when the service is deployed with hot reloading enabled.
Type
Required
array[string]
No
Example:
services:
  - hotReloadCommand:
    - /bin/sh
    - '-c'
services[].hotReloadArgs[]
​services > hotReloadArgs
If this module uses the hotReload field, the container will be run with these arguments when the service is deployed with hot reloading enabled.
Type
Required
array[string]
No
Example:
services:
  - hotReloadArgs:
    - npm
    - run
    - dev
services[].limits
​services > limits
Specify resource limits for the service.
Type
Required
Default
object
No
{"cpu":1000,"memory":1024}
services[].limits.cpu
​services > limits > cpu
The maximum amount of CPU the service can use, in millicpus (i.e. 1000 = 1 CPU)
Type
Required
Default
number
No
1000
services[].limits.memory
​services > limits > memory
The maximum amount of RAM the service can use, in megabytes (i.e. 1024 = 1 GB)
Type
Required
Default
number
No
1024
services[].ports[]
​services > ports
List of ports that the service container exposes.
Type
Required
Default
array[object]
No
[]
services[].ports[].name
​services > ports > name
The name of the port (used when referencing the port elsewhere in the service configuration).
Type
Required
string
Yes
services[].ports[].protocol
​services > ports > protocol
The protocol of the port.
Type
Required
Default
string
No
"TCP"
services[].ports[].containerPort
​services > ports > containerPort
The port exposed on the container by the running process. This will also be the default value for servicePort. servicePort:80 -> containerPort:8080 -> process:8080
Type
Required
number
Yes
Example:
services:
  - ports:
      - containerPort: "8080"
services[].ports[].servicePort
​services > ports > servicePort
The port exposed on the service. Defaults to containerPort if not specified. servicePort:80 -> containerPort:8080 -> process:8080
Type
Required
Default
number
No
"<same as containerPort>"
Example:
services:
  - ports:
      - servicePort: "80"
services[].ports[].hostPort
​services > ports > hostPort
Type
Required
number
No
services[].ports[].nodePort
​services > ports > nodePort
Set 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.
Type
Required
number
No
services[].replicas
​services > replicas
The number of instances of the service to deploy. Note: This setting may be overridden or ignored in some cases. For example, when running with daemon: true, with hot-reloading enabled, or if the provider doesn't support multiple replicas.
Type
Required
Default
number
No
1
services[].volumes[]
​services > volumes
List of volumes that should be mounted when deploying the container.
Type
Required
Default
array[object]
No
[]
services[].volumes[].name
​services > volumes > name
The name of the allocated volume.
Type
Required
string
Yes
services[].volumes[].containerPath
​services > volumes > containerPath
The path where the volume should be mounted in the container.
Type
Required
string
Yes
services[].volumes[].hostPath
​services > volumes > hostPath
Type
Required
string
No
tests
A list of tests to run in the module.
Type
Required
Default
array[object]
No
[]
tests[].name
​tests > name
The name of the test.
Type
Required
string
Yes
tests[].dependencies[]
​tests > dependencies
The names of any services that must be running, and the names of any tasks that must be executed, before the test is run.
Type
Required
Default
array[string]
No
[]
tests[].timeout
​tests > timeout
Maximum duration (in seconds) of the test run.
Type
Required
Default
number
No
null
tests[].command[]
​tests > command
The command/entrypoint used to run the test inside the container.
Type
Required
array[string]
No
Example:
tests:
  - command:
    - /bin/sh
    - '-c'
tests[].args[]
​tests > args
The arguments used to run the test inside the container.
Type
Required
array[string]
No
Example:
tests:
  - args:
    - npm
    - test
tests[].env
​tests > env
Key/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.
Type
Required
Default
object
No
{}
Example:
tests:
  - env:
      MY_VAR: some-value
      MY_SECRET_VAR:
        secretRef:
          name: my-secret
          key: some-key
tasks
A list of tasks that can be run from this container module. These can be used as dependencies for services (executed before the service is deployed) or for other tasks.
Type
Required
Default
array[object]
No
[]
tasks[].name
​tasks > name
The name of the task.
Type
Required
string
Yes
tasks[].description
​tasks > description
A description of the task.
Type
Required
string
No
tasks[].dependencies[]
​tasks > dependencies
The names of any tasks that must be executed, and the names of any services that must be running, before this task is executed.
Type
Required
Default
array[string]
No
[]
tasks[].timeout
​tasks > timeout
Maximum duration (in seconds) of the task's execution.
Type
Required
Default
number
No
null
tasks[].command[]
​tasks > command
The command/entrypoint used to run the task inside the container.
Type
Required
array[string]
No
Example:
tasks:
  - command:
    - /bin/sh
    - '-c'
tasks[].args[]
​tasks > args
The arguments used to run the task inside the container.
Type
Required
array[string]
No
Example:
tasks:
  - args:
    - rake
    - 'db:migrate'
tasks[].env
​tasks > env
Key/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.
Type
Required
Default
object
No
{}
Example:
tasks:
  - env:
      MY_VAR: some-value
      MY_SECRET_VAR:
        secretRef:
          name: my-secret
          key: some-key
Complete YAML schema
apiVersion: garden.io/v0
kind: Module
type:
name:
description:
include:
exclude:
repositoryUrl:
allowPublish: true
build:
  dependencies:
    - name:
      copy:
        - source:
          target: <same as source path>
  targetImage:
  timeout: 1200
buildArgs: {}
extraFlags:
image:
hotReload:
  sync:
    - source: .
      target:
dockerfile:
services:
  - name:
    dependencies: []
    annotations: {}
    command:
    args:
    daemon: false
    ingresses:
      - annotations: {}
        hostname:
        path: /
        port:
    env: {}
    healthCheck:
      httpGet:
        path:
        port:
        scheme: HTTP
      command:
      tcpPort:
    hotReloadCommand:
    hotReloadArgs:
    limits:
      cpu: 1000
      memory: 1024
    ports:
      - name:
        protocol: TCP
        containerPort:
        servicePort: <same as containerPort>
        hostPort:
        nodePort:
    replicas: 1
    volumes:
      - name:
        containerPath:
        hostPath:
tests:
  - name:
    dependencies: []
    timeout: null
    command:
    args:
    env: {}
tasks:
  - name:
    description:
    dependencies: []
    timeout: null
    command:
    args:
    env: {}
Outputs
The following keys are available via the ${modules.<module-name>} template string key for container modules.
modules.<module-name>.buildPath
The build path of the module.
Type
Required
string
Yes
Example:
buildPath: "/home/me/code/my-project/.garden/build/my-module"
modules.<module-name>.path
The local path of the module.
Type
Required
string
Yes
Example:
path: "/home/me/code/my-project/my-module"
modules.<module-name>.version
The current version of the module.
Type
Required
string
Yes
Example:
version: "v-17ad4cb3fd"
modules.<module-name>.outputs
The outputs defined by the module.
Type
Required
object
Yes
modules.<module-name>.outputs.local-image-name
​outputs > local-image-name
The name of the image (without tag/version) that the module uses for local builds and deployments.
Type
Required
string
Yes
Example:
outputs:
  ...
  local-image-name: "my-module"
modules.<module-name>.outputs.deployment-image-name
​outputs > deployment-image-name
The name of the image (without tag/version) that the module will use during deployment.
Type
Required
string
Yes
Example:
outputs:
  ...
  deployment-image-name: "my-deployment-registry.io/my-org/my-module"
Module Types
Exec
Last updated Tue Aug 20 2019 12:37:34 GMT+0000 (UTC)
Type	Required	Allowed Values	Default
`string`	Yes	"garden.io/v0"	`"garden.io/v0"`