container

Description

Provides the container actions and module type. Note that this provider is currently automatically included, and you do not need to configure it in your project configuration.

Below is the full schema reference for the provider configuration. For an introduction to configuring a Garden project with providers, please look at our configuration guide.

The reference is divided into two sections. The first section contains the complete YAML schema, and the second section describes each schema key.

Complete YAML Schema

The values in the schema below are the default values.

providers:
  - # The name of the provider plugin to use.
    name:

    # List other providers that should be resolved before this one.
    dependencies: []

    # If specified, this provider will only be used in the listed environments. Note that an empty array effectively
    # disables the provider. To use a provider in all environments, omit this field.
    environments:

    # **Stability: Experimental**. Subject to breaking changes within minor releases.
    #
    # Extra flags to pass to the `docker build` command. Will extend the `spec.extraFlags` specified in each container
    # Build action.
    dockerBuildExtraFlags:

Configuration Keys

providers[]

Type	Default	Required
array[object]	[]	No

providers[].name

providers > name

The name of the provider plugin to use.

Type	Required
string	Yes

Example:

providers:
  - name: "local-kubernetes"

providers[].dependencies[]

providers > dependencies

List other providers that should be resolved before this one.

Type	Default	Required
array[string]	[]	No

Example:

providers:
  - dependencies:
      - exec

providers[].environments[]

providers > environments

If specified, this provider will only be used in the listed environments. Note that an empty array effectively disables the provider. To use a provider in all environments, omit this field.

Type	Required
array[string]	No

Example:

providers:
  - environments:
      - dev
      - stage

providers[].dockerBuildExtraFlags[]

providers > dockerBuildExtraFlags

Stability: Experimental. Subject to breaking changes within minor releases.

Extra flags to pass to the docker build command. Will extend the spec.extraFlags specified in each container Build action.

Type	Required
array[string]	No