exec

Description

A simple provider that allows running arbitrary scripts when initializing providers, and provides the exec action type.

Note: This provider is always loaded when running Garden. You only need to explicitly declare it in your provider configuration if you want to configure a script for it to run.

Below is the full schema reference for the provider configuration..

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.
    #
    # Example: `["exec"]`
    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.
    #
    # Example: `["dev","stage"]`
    environments:

    preInit:
      # A script to run before the provider is initialized. This is useful for performing any provider-specific setup
      # outside of Garden. For example, you can use this to perform authentication, such as authenticating with a
      # Kubernetes cluster provider.
      # The script will always be run from the project root directory.
      # Note that provider statuses are cached, so this script will generally only be run once, but you can force a
      # re-run by setting `--force-refresh` on any Garden command that uses the provider.
      runScript:

    # DEPRECATED: Use the `preInit.runScript` field instead on any provider that needs setup outside of Garden.
    #
    # An optional script to run in the project root when initializing providers. This is handy for running an
    # arbitrary
    # script when initializing. For example, another provider might declare a dependency on this provider, to ensure
    # this script runs before resolving that provider.
    initScript:

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

providers[].dependencies[]

providers > dependencies

List other providers that should be resolved before this one.

Example: ["exec"]

Type
Default
Required

array

[]

No

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.

Example: ["dev","stage"]

Type
Required

array

No

providers[].preInit

providers > preInit

Type
Required

object

No

providers[].preInit.runScript

providers > preInit > runScript

A script to run before the provider is initialized. This is useful for performing any provider-specific setup outside of Garden. For example, you can use this to perform authentication, such as authenticating with a Kubernetes cluster provider. The script will always be run from the project root directory. Note that provider statuses are cached, so this script will generally only be run once, but you can force a re-run by setting --force-refresh on any Garden command that uses the provider.

Type
Required

string

No

providers[].initScript

providers > initScript

DEPRECATED: Use the preInit.runScript field instead on any provider that needs setup outside of Garden.

An optional script to run in the project root when initializing providers. This is handy for running an arbitrary script when initializing. For example, another provider might declare a dependency on this provider, to ensure this script runs before resolving that provider.

Type
Required

string

No

Outputs

The following keys are available via the ${providers.<provider-name>} template string key for exec providers.

${providers.<provider-name>.outputs.initScript.log}

The log output from the initScript specified in the provider configuration, if any.

Type
Default

string

""

Last updated

Was this helpful?