exec
Description
A simple provider that allows running arbitary scripts when initializing providers, and provides the exec module 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. 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:
# 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[]
providers[]
array[object]
[]
No
providers[].name
providers[].name
providers > name
The name of the provider plugin to use.
string
Yes
Example:
providers:
- name: "local-kubernetes"
providers[].dependencies[]
providers[].dependencies[]
providers > dependencies
List other providers that should be resolved before this one.
array[string]
[]
No
Example:
providers:
- dependencies:
- exec
providers[].environments[]
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.
array[string]
No
Example:
providers:
- environments:
- dev
- stage
providers[].initScript
providers[].initScript
providers > initScript
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.
string
No
Last updated
Was this helpful?