persistentvolumeclaim
Description
Creates a PersistentVolumeClaim in your namespace, that can be referenced and mounted by other resources and container modules.
See the PersistentVolumeClaim guide for more info and usage examples.
Below is the full schema reference. For an introduction to configuring Garden modules, please look at our Configuration guide.
The first section contains the complete YAML schema, and the second section describes each schema key.
persistentvolumeclaim
modules also export values that are available in template strings. See the Outputs section below for details.
Complete YAML Schema
The values in the schema below are the default values.
Configuration Keys
apiVersion
apiVersion
The schema version of this config (currently not used).
Type | Allowed Values | Default | Required |
---|---|---|---|
| "garden.io/v0" |
| Yes |
kind
kind
Type | Allowed Values | Default | Required |
---|---|---|---|
| "Module" |
| Yes |
type
type
The type of this module.
Type | Required |
---|---|
| Yes |
Example:
name
name
The name of this module.
Type | Required |
---|---|
| Yes |
Example:
build
build
Specify how to build the module. Note that plugins may define additional keys on this object.
Type | Default | Required |
---|---|---|
|
| No |
build.dependencies[]
build.dependencies[]
build > dependencies
A list of modules that must be built before this module is built.
Type | Default | Required |
---|---|---|
|
| No |
Example:
build.dependencies[].name
build.dependencies[].name
build > dependencies > name
Module name to build ahead of this module.
Type | Required |
---|---|
| Yes |
build.dependencies[].copy[]
build.dependencies[].copy[]
build > dependencies > copy
Specify one or more files or directories to copy from the built dependency to this module.
Type | Default | Required |
---|---|---|
|
| No |
build.dependencies[].copy[].source
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 |
---|---|
| Yes |
build.dependencies[].copy[].target
build.dependencies[].copy[].target
build > dependencies > copy > target
POSIX-style path or filename to copy the directory or file(s), relative to the build directory. Defaults to the same as source path.
Type | Required |
---|---|
| No |
build.timeout
build.timeout
build > timeout
Maximum time in seconds to wait for build to finish.
Type | Default | Required |
---|---|---|
|
| No |
description
description
A description of the module.
Type | Required |
---|---|
| No |
disabled
disabled
Set this to true
to disable the module. You can use this with conditional template strings to disable modules 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 modules for specific environments, e.g. only for development.
Disabling a module means that any services, tasks and tests contained in it will not be deployed or run. It also means that the module is not built unless it is declared as a build dependency by another enabled module (in which case building this module is necessary for the dependant to be built).
If you disable the module, and its services, tasks or tests are referenced as runtime dependencies, Garden will automatically ignore those dependency declarations. Note however that template strings referencing the module's service or task outputs (i.e. runtime outputs) will fail to resolve when the module is disabled, so you need to make sure to provide alternate values for those if you're using them, using conditional expressions.
Type | Default | Required |
---|---|---|
|
| No |
include[]
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 |
---|---|
| No |
Example:
exclude[]
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 guide for details.
Unlike the modules.exclude
field in the project config, the filters here have no effect on which files and directories are watched for changes. Use the project modules.exclude
field to affect those, if you have large directories that should not be watched for changes.
Type | Required |
---|---|
| No |
Example:
repositoryUrl
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: #<branch|tag>
Garden will import the repository source code into this module, but read the module's config from the local garden.yml file.
Type | Required |
---|---|
| No |
Example:
allowPublish
allowPublish
When false, disables pushing this module to remote registries.
Type | Default | Required |
---|---|---|
|
| No |
generateFiles[]
generateFiles[]
A list of files to write to the module directory when resolving this module. This is useful to automatically generate (and template) any supporting files needed for the module.
Type | Default | Required |
---|---|---|
|
| No |
generateFiles[].sourcePath
generateFiles[].sourcePath
generateFiles > sourcePath
POSIX-style filename to read the source file contents from, relative to the path of the module (or the ModuleTemplate configuration file if one is being applied). This file may contain template strings, much like any other field in the configuration.
Type | Required |
---|---|
| No |
generateFiles[].targetPath
generateFiles[].targetPath
generateFiles > targetPath
POSIX-style filename to write the resolved file contents to, relative to the path of the module source directory (for remote modules this means the root of the module repository, otherwise the directory of the module configuration).
Note that any existing file with the same name will be overwritten. If the path contains one or more directories, they will be automatically created if missing.
Type | Required |
---|---|
| Yes |
generateFiles[].resolveTemplates
generateFiles[].resolveTemplates
generateFiles > resolveTemplates
By default, Garden will attempt to resolve any Garden template strings in source files. Set this to false to skip resolving template strings. Note that this does not apply when setting the value
field, since that's resolved earlier when parsing the configuration.
Type | Default | Required |
---|---|---|
|
| No |
generateFiles[].value
generateFiles[].value
generateFiles > value
The desired file contents as a string.
Type | Required |
---|---|
| No |
variables
variables
A map of variables scoped to this particular module. These are resolved before any other parts of the module configuration and take precedence over project-scoped variables. They may reference project-scoped variables, and generally use any template strings normally allowed when resolving modules.
Type | Required |
---|---|
| No |
varfile
varfile
Specify a path (relative to the module root) to a file containing variables, that we apply on top of the module-level variables
field.
The format of the files is determined by the configured file's extension:
.env
- Standard "dotenv" format, as defined by dotenv..yaml
/.yml
- YAML. The file must consist of a YAML document, which must be a map (dictionary). Keys may contain any value type..json
- JSON. Must contain a single JSON object (not an array).
NOTE: The default varfile format will change to YAML in Garden v0.13, since YAML allows for definition of nested objects and arrays.
To use different module-level varfiles in different environments, you can template in the environment name to the varfile name, e.g. varfile: "my-module.${environment.name}.env
(this assumes that the corresponding varfiles exist).
Type | Required |
---|---|
| No |
Example:
dependencies[]
dependencies[]
List of services and tasks to deploy/run before deploying this PVC.
Type | Default | Required |
---|---|---|
|
| No |
namespace
namespace
The namespace to deploy the PVC in. Note that any module referencing the PVC must be in the same namespace, so in most cases you should leave this unset.
Type | Required |
---|---|
| No |
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.
Type | Required |
---|---|
| Yes |
spec.accessModes[]
spec.accessModes[]
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
Type | Required |
---|---|
| No |
spec.dataSource
spec.dataSource
spec > dataSource
TypedLocalObjectReference contains enough information to let you locate the typed referenced object inside the same namespace.
Type | Required |
---|---|
| No |
spec.dataSource.apiGroup
spec.dataSource.apiGroup
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.
Type | Required |
---|---|
| No |
spec.dataSource.kind
spec.dataSource.kind
spec > dataSource > kind
Kind is the type of resource being referenced
Type | Required |
---|---|
| Yes |
spec.dataSource.name
spec.dataSource.name
spec > dataSource > name
Name is the name of resource being referenced
Type | Required |
---|---|
| Yes |
spec.resources
spec.resources
spec > resources
ResourceRequirements describes the compute resource requirements.
Type | Required |
---|---|
| No |
spec.resources.limits
spec.resources.limits
Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
Type | Required |
---|---|
| No |
spec.resources.requests
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/
Type | Required |
---|---|
| No |
spec.selector
spec.selector
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.
Type | Required |
---|---|
| No |
spec.selector.matchExpressions[]
spec.selector.matchExpressions[]
spec > selector > matchExpressions
matchExpressions is a list of label selector requirements. The requirements are ANDed.
Type | Required |
---|---|
| No |
spec.selector.matchLabels
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.
Type | Required |
---|---|
| No |
spec.storageClassName
spec.storageClassName
spec > storageClassName
Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
Type | Required |
---|---|
| No |
spec.volumeMode
spec.volumeMode
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.
Type | Required |
---|---|
| No |
spec.volumeName
spec.volumeName
spec > volumeName
VolumeName is the binding reference to the PersistentVolume backing this claim.
Type | Required |
---|---|
| No |
Outputs
Module Outputs
The following keys are available via the ${modules.<module-name>}
template string key for persistentvolumeclaim
modules.
${modules.<module-name>.buildPath}
${modules.<module-name>.buildPath}
The build path of the module.
Type |
---|
|
Example:
${modules.<module-name>.name}
${modules.<module-name>.name}
The name of the module.
Type |
---|
|
${modules.<module-name>.path}
${modules.<module-name>.path}
The local path of the module.
Type |
---|
|
Example:
${modules.<module-name>.var.*}
${modules.<module-name>.var.*}
A map of all variables defined in the module.
Type | Default |
---|---|
|
|
${modules.<module-name>.var.<variable-name>}
${modules.<module-name>.var.<variable-name>}
Type |
---|
|
${modules.<module-name>.version}
${modules.<module-name>.version}
The current version of the module.
Type |
---|
|
Example:
Service Outputs
The following keys are available via the ${runtime.services.<service-name>}
template string key for persistentvolumeclaim
module services. Note that these are only resolved when deploying/running dependants of the service, so they are not usable for every field.
${runtime.services.<service-name>.version}
${runtime.services.<service-name>.version}
The current version of the service.
Type |
---|
|
Example:
Task Outputs
The following keys are available via the ${runtime.tasks.<task-name>}
template string key for persistentvolumeclaim
module tasks. Note that these are only resolved when deploying/running dependants of the task, so they are not usable for every field.
${runtime.tasks.<task-name>.version}
${runtime.tasks.<task-name>.version}
The current version of the task.
Type |
---|
|
Example:
Last updated