ephemeral-kubernetes
Description
This feature is still experimental and only available in Garden >=0.13.14
. Please let us know if you have any questions or if any issues come up!
The ephemeral-kubernetes
provider is a specialized version of the kubernetes
provider that allows to deploy applications to one of the ephemeral Kubernetes clusters provided by Garden.
For information about using ephemeral Kubernetes clusters, please refer to Ephemeral Kubernetes clusters guide
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.
Configuration Keys
providers[]
providers[]
providers[].dependencies[]
providers[].dependencies[]
providers > dependencies
List other providers that should be resolved before this one.
Example:
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.
Example:
providers[].name
providers[].name
providers > name
The name of the provider plugin to use.
Example:
providers[].utilImageRegistryDomain
providers[].utilImageRegistryDomain
providers > utilImageRegistryDomain
The container registry domain that should be used for pulling Garden utility images (such as the image used in the Kubernetes sync utility Pod).
If you have your own Docker Hub registry mirror, you can set the domain here and the utility images will be pulled from there. This can be useful to e.g. avoid Docker Hub rate limiting.
Otherwise the utility images are pulled directly from Docker Hub by default.
providers[].namespace
providers[].namespace
providers > namespace
Specify which namespace to deploy services to (defaults to the project name). Note that the framework generates other namespaces as well with this name as a prefix.
providers[].namespace.name
providers[].namespace.name
A valid Kubernetes namespace name. Must be a valid RFC1035/RFC1123 (DNS) label (may contain lowercase letters, numbers and dashes, must start with a letter, and cannot end with a dash) and must not be longer than 63 characters.
providers[].namespace.annotations
providers[].namespace.annotations
providers > namespace > annotations
Map of annotations to apply to the namespace when creating it.
Example:
providers[].namespace.labels
providers[].namespace.labels
providers > namespace > labels
Map of labels to apply to the namespace when creating it.
providers[].setupIngressController
providers[].setupIngressController
providers > setupIngressController
Set this to null or false to skip installing/enabling the nginx
ingress controller. Note: if you skip installing the nginx
ingress controller for ephemeral cluster, your ingresses may not function properly.
Outputs
The following keys are available via the ${providers.<provider-name>}
template string key for ephemeral-kubernetes
providers.
${providers.<provider-name>.outputs.app-namespace}
${providers.<provider-name>.outputs.app-namespace}
The primary namespace used for resource deployments.
${providers.<provider-name>.outputs.default-hostname}
${providers.<provider-name>.outputs.default-hostname}
The dynamic hostname assigned to the ephemeral cluster automatically, when an ephemeral cluster is created.
Last updated