persistentvolumeclaim Deploy

Description

Creates a PersistentVolumeClaim in your namespace, that can be referenced and mounted by other resources and container Deploy actions.

See the PersistentVolumeClaim guide for more info and usage examples.

Below is the full schema reference for the action. For an introduction to configuring Garden, please look at our Configuration guide.

persistentvolumeclaim actions also export values that are available in template strings. See the Outputs section below for details.

Configuration Keys

type

The type of action, e.g. exec, container or kubernetes. Some are built into Garden but mostly these will be defined by your configured providers.

TypeRequired

string

Yes

name

A valid name for the action. Must be unique across all actions of the same kind in your project.

TypeRequired

string

Yes

description

A description of the action.

TypeRequired

string

No

source

By default, the directory where the action is defined is used as the source for the build context.

You can override this by setting either source.path to another (POSIX-style) path relative to the action source directory, or source.repository to get the source from an external repository.

If using source.path, you must make sure the target path is in a git repository.

For source.repository behavior, please refer to the Remote Sources guide.

TypeRequired

object

No

source.path

source > path

A relative POSIX-style path to the source directory for this action. You must make sure this path exists and is in a git repository!

TypeRequired

posixPath

No

source.repository

source > repository

When set, Garden will import the action source from this repository, but use this action configuration (and not scan for configs in the separate repository).

TypeRequired

object

No

source.repository.url

source > repository > url

A 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>

TypeRequired

gitUrl | string

Yes

Example:

source:
  ...
  repository:
    ...
    url: "git+https://github.com/org/repo.git#v2.0"

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.

TypeDefaultRequired

array[actionReference]

[]

No

Example:

dependencies:
  - build.my-image
  - deploy.api

disabled

Set 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.

TypeDefaultRequired

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"}.

TypeRequired

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.

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.

TypeRequired

array[posixPath]

No

Example:

include:
  - my-app.js
  - some-assets/**/*

exclude[]

Specify a list of POSIX-style paths or glob patterns that should be explicitly excluded from the action's version.

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 Configuration Files guide for details.

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.

TypeRequired

array[posixPath]

No

Example:

exclude:
  - tmp/**/*
  - '*.log'

variables

A 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.

TypeRequired

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.

  • .env - Standard "dotenv" format, as defined by dotenv.

  • .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.

varfiles:
  - path: my-action.env
    optional: true
TypeDefaultRequired

array[alternatives]

[]

No

Example:

varfiles:
  "my-action.env"

varfiles[].path

varfiles > path

Path to a file containing a path.

TypeRequired

posixPath

Yes

varfiles[].optional

varfiles > optional

Whether the varfile is optional.

TypeRequired

boolean

No

build

Specify 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.

TypeRequired

string

No

kind

TypeAllowed ValuesRequired

string

"Deploy"

Yes

timeout

Timeout for the deploy to complete, in seconds.

TypeDefaultRequired

number

300

No

spec

TypeRequired

object

No

spec.namespace

spec > namespace

The namespace to deploy the PVC in. Note that any resources referencing the PVC must be in the same namespace, so in most cases you should leave this unset.

TypeRequired

string

No

spec.spec

spec > spec

The spec for the PVC. This is passed directly to the created PersistentVolumeClaim resource. Note that the spec schema may include (or even require) additional fields, depending on the used storageClass. See the PersistentVolumeClaim docs for details.

TypeRequired

object

Yes

spec.spec.accessModes[]

spec > spec > accessModes

AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

TypeRequired

array

No

spec.spec.dataSource

spec > spec > dataSource

TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.

TypeRequired

object

No

spec.spec.dataSource.apiGroup

spec > spec > dataSource > apiGroup

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

TypeRequired

string

No

spec.spec.dataSource.kind

spec > spec > dataSource > kind

Kind is the type of resource being referenced

TypeRequired

string

Yes

spec.spec.dataSource.name

spec > spec > dataSource > name

Name is the name of resource being referenced

TypeRequired

string

Yes

spec.spec.resources

spec > spec > resources

ResourceRequirements describes the compute resource requirements.

TypeRequired

object

No

spec.spec.resources.limits

spec > spec > resources > limits

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

TypeRequired

object

No

spec.spec.resources.requests

spec > spec > resources > requests

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

TypeRequired

object

No

spec.spec.selector

spec > spec > selector

A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.

TypeRequired

object

No

spec.spec.selector.matchExpressions[]

spec > spec > selector > matchExpressions

matchExpressions is a list of label selector requirements. The requirements are ANDed.

TypeRequired

array

No

spec.spec.selector.matchExpressions[].key

spec > spec > selector > matchExpressions > key

key is the label key that the selector applies to.

TypeRequired

string

No

spec.spec.selector.matchExpressions[].operator

spec > spec > selector > matchExpressions > operator

operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

TypeRequired

string

No

spec.spec.selector.matchExpressions[].values[]

spec > spec > selector > matchExpressions > values

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

TypeRequired

array

No

spec.spec.selector.matchLabels

spec > spec > selector > matchLabels

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.

TypeRequired

object

No

spec.spec.storageClassName

spec > spec > storageClassName

Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

TypeRequired

string

No

spec.spec.volumeMode

spec > spec > volumeMode

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature.

TypeRequired

string

No

spec.spec.volumeName

spec > spec > volumeName

VolumeName is the binding reference to the PersistentVolume backing this claim.

TypeRequired

string

No

Outputs

The following keys are available via the ${actions.deploy.<name>} template string key for persistentvolumeclaim action.

${actions.deploy.<name>.name}

The name of the action.

Type

string

${actions.deploy.<name>.disabled}

Whether the action is disabled.

Type

boolean

Example:

my-variable: ${actions.deploy.my-deploy.disabled}

${actions.deploy.<name>.buildPath}

The local path to the action build directory.

Type

string

Example:

my-variable: ${actions.deploy.my-deploy.buildPath}

${actions.deploy.<name>.sourcePath}

The local path to the action source directory.

Type

string

Example:

my-variable: ${actions.deploy.my-deploy.sourcePath}

${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.

TypeDefault

string

"default"

Example:

my-variable: ${actions.deploy.my-deploy.mode}

${actions.deploy.<name>.var.*}

The variables configured on the action.

TypeDefault

object

{}

${actions.deploy.<name>.var.<name>}

Type

string | number | boolean | link | array[link]

Last updated