Comment on page
local-kubernetes
The
local-kubernetes provider is a specialized version of the kubernetes provider that automates and simplifies working with local Kubernetes clusters.For general Kubernetes usage information, please refer to the Kubernetes guides. For local clusters a good place to start is the Local Kubernetes guide.
If you're working with a remote Kubernetes cluster, please refer to the
kubernetes provider docs, and the Remote Kubernetes guide 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.
The values in the schema below are the default values.
providers:
- # 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:
# Choose the mechanism for building container images before deploying. By default your local Docker daemon is
# used, but you can set it to `cluster-buildkit` or `kaniko` to sync files to the cluster, and build container
# images there. This removes the need to run Docker locally, and allows you to share layer and image caches
# between multiple developers, as well as between your development and CI workflows.
#
# For more details on all the different options and what makes sense to use for your setup, please check out the
# [in-cluster building guide](https://docs.garden.io/kubernetes-plugins/advanced/in-cluster-building).
buildMode: local-docker
# Configuration options for the `cluster-buildkit` build mode.
clusterBuildkit: {}
# Use the `cache` configuration to customize the default cluster-buildkit cache behaviour.
#
# The default value is:
# clusterBuildkit:
# cache:
# - type: registry
# mode: auto
#
# For every build, this will
# - import cached layers from a docker image tag named `_buildcache`
# - when the build is finished, upload cache information to `_buildcache`
#
# For registries that support it, `mode: auto` (the default) will enable the buildkit `mode=max`
# option.
#
# See the following table for details on our detection mechanism:
#
# | Registry Name | Registry Domain | Assumed `mode=max` support |
# |---------------------------------|-------------------------|------------------------------|
# | Google Cloud Artifact Registry | `pkg.dev` | Yes |
# | Azure Container Registry | `azurecr.io` | Yes |
# | GitHub Container Registry | `ghcr.io` | Yes |
# | DockerHub | `hub.docker.com` | Yes |
# | Any other registry | | No |
#
# In case you need to override the defaults for your registry, you can do it like so:
#
# clusterBuildkit:
# cache:
# - type: registry
# mode: max
#
# When you add multiple caches, we will make sure to pass the `--import-cache` options to buildkit in the same
# order as provided in the cache configuration. This is because buildkit will not actually use all imported
# caches
# for every build, but it will stick with the first cache that yields a cache hit for all the following layers.
#
# An example for this is the following:
#
# clusterBuildkit:
# cache:
# - type: registry
# tag: _buildcache-${slice(kebabCase(git.branch), "0", "30")}
# - type: registry
# tag: _buildcache-main
# export: false
#
# Using this cache configuration, every build will first look for a cache specific to your feature branch.
# If it does not exist yet, it will import caches from the main branch builds (`_buildcache-main`).
# When the build is finished, it will only export caches to your feature branch, and avoid polluting the `main`
# branch caches.
# A configuration like that may improve your cache hit rate and thus save time.
#
# If you need to disable caches completely you can achieve that with the following configuration:
#
# clusterBuildkit:
# cache: []
cache:
- # Use the Docker registry configured at `deploymentRegistry` to retrieve and store buildkit cache
# information.
#
# See also the [buildkit registry cache
# documentation](https://github.com/moby/buildkit#registry-push-image-and-cache-separately)
type:
# The registry from which the cache should be imported from, or which it should be exported to.
#
# If not specified, use the configured `deploymentRegistry` in your kubernetes provider config.
#
# Important: You must make sure `imagePullSecrets` includes authentication with the specified cache
# registry, that has the appropriate write privileges (usually full write access to the configured
# `namespace`).
registry:
# The hostname (and optionally port, if not the default port) of the registry.
hostname:
# The port where the registry listens on, if not the default.
port:
# The registry namespace. Will be placed between hostname and image name, like so:
# <hostname>/<namespace>/<image name>
namespace: _
# Set to true to allow insecure connections to the registry (without SSL).
insecure: false
# This is the buildkit cache mode to be used.
#
# The value `inline` ensures that garden is using the buildkit option `--export-cache inline`. Cache
# information will be inlined and co-located with the Docker image itself.
#
# The values `min` and `max` ensure that garden passes the `mode=max` or `mode=min` modifiers to the
# buildkit `--export-cache` option. Cache manifests will only be
# stored stored in the configured `tag`.
#
# `auto` is the same as `max` for some registries that are known to support it. Garden will fall back to
# `inline` for all other registries.
# See the [clusterBuildkit cache option](#providersclusterbuildkitcache) for a description of the detection
# mechanism.
#
# See also the [buildkit export cache documentation](https://github.com/moby/buildkit#export-cache)
mode: auto
# This is the Docker registry tag name buildkit should use for the registry build cache. Default is
# `_buildcache`
#
# **NOTE**: `tag` can only be used together with the `registry` cache type
tag: _buildcache
# If this is false, only pass the `--import-cache` option to buildkit, and not the `--export-cache` option.
# Defaults to true.
export: true
# Enable rootless mode for the cluster-buildkit daemon, which runs the daemon with decreased privileges.
# Please see [the buildkit docs](https://github.com/moby/buildkit/blob/master/docs/rootless.md) for caveats when
# using this mode.
rootless: false
# Exposes the `nodeSelector` field on the PodSpec of the BuildKit deployment. This allows you to constrain the
# BuildKit daemon to only run on particular nodes.
#
# [See here](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/) for the official Kubernetes
# guide to assigning Pods to nodes.
nodeSelector: {}
# Specify tolerations to apply to cluster-buildkit daemon. Useful to control which nodes in a cluster can run
# builds.
tolerations:
- # "Effect" indicates the taint effect to match. Empty means match all taint effects. When specified,
# allowed values are "NoSchedule", "PreferNoSchedule" and "NoExecute".
effect:
# "Key" is the taint key that the toleration applies to. Empty means match all taint keys.
# If the key is empty, operator must be "Exists"; this combination means to match all values and all keys.
key:
# "Operator" represents a key's relationship to the value. Valid operators are "Exists" and "Equal".
# Defaults to
# "Equal". "Exists" is equivalent to wildcard for value, so that a pod can tolerate all taints of a
# particular category.
operator: Equal
# "TolerationSeconds" represents the period of time the toleration (which must be of effect "NoExecute",
# otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate
# the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately)
# by the system.
tolerationSeconds:
# "Value" is the taint value the toleration matches to. If the operator is "Exists", the value should be
# empty,
# otherwise just a regular string.
value:
# Specify annotations to apply to both the Pod and Deployment resources associated with cluster-buildkit.
# Annotations may have an effect on the behaviour of certain components, for example autoscalers.
annotations:
# Specify annotations to apply to the Kubernetes service account used by cluster-buildkit. This can be useful to
# set up IRSA with in-cluster building.
serviceAccountAnnotations:
# Setting related to Jib image builds.
jib:
# In some cases you may need to push images built with Jib to the remote registry via Kubernetes cluster, e.g.
# if you don't have connectivity or access from where Garden is being run. In that case, set this flag to true,
# but do note that the build will take considerably take longer to complete! Only applies when using in-cluster
# building.
pushViaCluster: false
# Configuration options for the `kaniko` build mode.
kaniko:
# Specify extra flags to use when building the container image with kaniko. Flags set on `container` Builds take
# precedence over these.
extraFlags:
# Change the kaniko image (repository/image:tag) to use when building in kaniko mode.
image: >-
gcr.io/kaniko-project/executor:v1.11.0-debug@sha256:32ba2214921892c2fa7b5f9c4ae6f8f026538ce6b2105a93a36a8b5ee50fe517
# Choose the namespace where the Kaniko pods will be run. Defaults to the project namespace.
namespace:
# Exposes the `nodeSelector` field on the PodSpec of the Kaniko pods. This allows you to constrain the Kaniko
# pods to only run on particular nodes. The same nodeSelector will be used for each util pod unless they are
# specifically set under `util.nodeSelector`.
#
# [See here](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/) for the official Kubernetes
# guide to assigning pods to nodes.
nodeSelector:
# Specify tolerations to apply to each Kaniko builder pod. Useful to control which nodes in a cluster can run
# builds. The same tolerations will be used for each util pod unless they are specifically set under
# `util.tolerations`
tolerations:
- # "Effect" indicates the taint effect to match. Empty means match all taint effects. When specified,
# allowed values are "NoSchedule", "PreferNoSchedule" and "NoExecute".
effect:
# "Key" is the taint key that the toleration applies to. Empty means match all taint keys.
# If the key is empty, operator must be "Exists"; this combination means to match all values and all keys.
key:
# "Operator" represents a key's relationship to the value. Valid operators are "Exists" and "Equal".
# Defaults to
# "Equal". "Exists" is equivalent to wildcard for value, so that a pod can tolerate all taints of a
# particular category.
operator: Equal
# "TolerationSeconds" represents the period of time the toleration (which must be of effect "NoExecute",
# otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate
# the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately)
# by the system.
tolerationSeconds:
# "Value" is the taint value the toleration matches to. If the operator is "Exists", the value should be
# empty,
# otherwise just a regular string.
value:
# Specify annotations to apply to each Kaniko builder pod. Annotations may have an effect on the behaviour of
# certain components, for example autoscalers. The same annotations will be used for each util pod unless they
# are specifically set under `util.annotations`
annotations:
# Specify annotations to apply to the Kubernetes service account used by kaniko. This can be useful to set up
# IRSA with in-cluster building.
serviceAccountAnnotations:
util:
# Specify tolerations to apply to each garden-util pod.
tolerations:
- # "Effect" indicates the taint effect to match. Empty means match all taint effects. When specified,
# allowed values are "NoSchedule", "PreferNoSchedule" and "NoExecute".
effect:
# "Key" is the taint key that the toleration applies to. Empty means match all taint keys.
# If the key is empty, operator must be "Exists"; this combination means to match all values and all keys.
key:
# "Operator" represents a key's relationship to the value. Valid operators are "Exists" and "Equal".
# Defaults to
# "Equal". "Exists" is equivalent to wildcard for value, so that a pod can tolerate all taints of a
# particular category.
operator: Equal
# "TolerationSeconds" represents the period of time the toleration (which must be of effect "NoExecute",
# otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate
# the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately)
# by the system.
tolerationSeconds:
# "Value" is the taint value the toleration matches to. If the operator is "Exists", the value should be
# empty,
# otherwise just a regular string.
value:
# Specify annotations to apply to each garden-util pod and deployments.
annotations:
# Specify the nodeSelector constraints for each garden-util pod.
nodeSelector:
# A default hostname to use when no hostname is explicitly configured for a service.
defaultHostname:
# Configuration options for code synchronization.
sync:
# Specifies default settings for syncs (e.g. for `container`, `kubernetes` and `helm` services).
#
# These are overridden/extended by the settings of any individual sync specs.
#
# Sync is enabled e.g by setting the `--sync` flag on the `garden deploy` command.
#
# See the [Code Synchronization guide](https://docs.garden.io/guides/code-synchronization) for more information.
defaults:
# Specify a list of POSIX-style paths or glob patterns that should be excluded from the sync.
#
# Any exclusion patterns defined in individual sync specs will be applied in addition to these patterns.
#
# `.git` directories and `.garden` directories are always ignored.
exclude:
# The default permission bits, specified as an octal, to set on files at the sync target. Defaults to 0o644
# (user can read/write, everyone else can read). See the [Mutagen
# docs](https://mutagen.io/documentation/synchronization/permissions#permissions) for more information.
fileMode: 420
# The default permission bits, specified as an octal, to set on directories at the sync target. Defaults to
# 0o755 (user can read/write, everyone else can read). See the [Mutagen
# docs](https://mutagen.io/documentation/synchronization/permissions#permissions) for more information.
directoryMode: 493
# Set the default owner of files and directories at the target. Specify either an integer ID or a string name.
# See the [Mutagen docs](https://mutagen.io/documentation/synchronization/permissions#owners-and-groups) for
# more information.
owner:
# Set the default group on files and directories at the target. Specify either an integer ID or a string name.
# See the [Mutagen docs](https://mutagen.io/documentation/synchronization/permissions#owners-and-groups) for
# more information.
group:
# Require SSL on all `container` Deploys. If set to true, an error is raised when no certificate is available for
# a configured hostname on a `container`Deploy.
forceSsl: false
# References to `docker-registry` secrets to use for authenticating with remote registries when pulling
# images. This is necessary if you reference private images in your action configuration, and is required
# when configuring a remote Kubernetes environment with buildMode=local.
imagePullSecrets:
- # The name of the Kubernetes secret.
name:
# The namespace where the secret is stored. If necessary, the secret may be copied to the appropriate
# namespace before use.
namespace: default
# References to secrets you need to have copied into all namespaces deployed to. These secrets will be
# ensured to exist in the namespace before deploying any service.
copySecrets:
- # The name of the Kubernetes secret.
name:
# The namespace where the secret is stored. If necessary, the secret may be copied to the appropriate
# namespace before use.
namespace: default
# Resource requests and limits for the in-cluster builder..
resources:
# Resource requests and limits for the in-cluster builder. It's important to consider which build mode you're
# using when configuring this.
#
# When `buildMode` is `kaniko`, this refers to _each Kaniko pod_, i.e. each individual build, so you'll want to
# consider the requirements for your individual image builds, with your most expensive/heavy images in mind.
#
# When `buildMode` is `cluster-buildkit`, this applies to the BuildKit deployment created in _each project
# namespace_. So think of this as the resource spec for each individual user or project namespace.
builder:
limits:
# CPU limit in millicpu.
cpu: 4000
# Memory limit in megabytes.
memory: 8192
# Ephemeral storage limit in megabytes.
ephemeralStorage:
requests:
# CPU request in millicpu.
cpu: 100
# Memory request in megabytes.
memory: 512
# Ephemeral storage request in megabytes.
ephemeralStorage:
# Resource requests and limits for the util pod for in-cluster builders.
# This pod is used to get, start, stop and inquire the status of the builds.
#
# This pod is created in each garden namespace.
util:
limits:
# CPU limit in millicpu.
cpu: 256
# Memory limit in megabytes.
memory: 512
# Ephemeral storage limit in megabytes.
ephemeralStorage:
requests:
# CPU request in millicpu.
cpu: 256
# Memory request in megabytes.
memory: 512
# Ephemeral storage request in megabytes.
ephemeralStorage:
# One or more certificates to use for ingress.
tlsCertificates:
- # A unique identifier for this certificate.
name:
# A list of hostnames that this certificate should be used for. If you don't specify these, they will be
# automatically read from the certificate.
hostnames:
# A reference to the Kubernetes secret that contains the TLS certificate and key for the domain.
secretRef:
# The name of the Kubernetes secret.
name:
# The namespace where the secret is stored. If necessary, the secret may be copied to the appropriate
# namespace before use.
namespace: default
# Exposes the `nodeSelector` field on the PodSpec of system services. This allows you to constrain the system
# services to only run on particular nodes.
#
# [See here](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/) for the official Kubernetes guide
# to assigning Pods to nodes.
systemNodeSelector: {}
# The name of the provider plugin to use.
name: local-kubernetes
# The kubectl context to use to connect to the Kubernetes cluster.
context:
# 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.
namespace:
# 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.
name:
# Map of annotations to apply to the namespace when creating it.
annotations:
# Map of labels to apply to the namespace when creating it.
labels:
# Set this to null or false to skip installing/enabling the `nginx` ingress controller.
setupIngressController: nginx
Type | Default | Required |
|---|---|---|
array[object] | [] | No |
List other providers that should be resolved before this one.
Type | Default | Required |
|---|---|---|
array[string] | [] | No |
Example:
providers:
- dependencies:
- exec
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.
Type | Required |
|---|---|
array[string] | No |
Example:
providers:
- environments:
- dev
- stage
Choose the mechanism for building container images before deploying. By default your local Docker daemon is used, but you can set it to
cluster-buildkit or kaniko to sync files to the cluster, and build container images there. This removes the need to run Docker locally, and allows you to share layer and image caches between multiple developers, as well as between your development and CI workflows.For more details on all the different options and what makes sense to use for your setup, please check out the in-cluster building guide.
Type | Allowed Values | Default | Required |
|---|---|---|---|
string | "local-docker", "kaniko", "cluster-buildkit" | "local-docker" | Yes |
Configuration options for the
cluster-buildkit build mode.Type | Default | Required |
|---|---|---|
object | {} | No |
Use the
cache configuration to customize the default cluster-buildkit cache behaviour.The default value is:
clusterBuildkit:
cache:
- type: registry
mode: auto
For every build, this will
- import cached layers from a docker image tag named
_buildcache - when the build is finished, upload cache information to
_buildcache
For registries that support it,
mode: auto (the default) will enable the buildkit mode=max option.See the following table for details on our detection mechanism:
Registry Name | Registry Domain | Assumed mode=max support |
Google Cloud Artifact Registry | pkg.dev | Yes |
Azure Container Registry | azurecr.io | Yes |
GitHub Container Registry | ghcr.io | Yes |
DockerHub | hub.docker.com | Yes |
Any other registry | | No |
In case you need to override the defaults for your registry, you can do it like so:
clusterBuildkit:
cache:
- type: registry
mode: max
When you add multiple caches, we will make sure to pass the
--import-cache options to buildkit in the same order as provided in the cache configuration. This is because buildkit will not actually use all imported caches for every build, but it will stick with the first cache that yields a cache hit for all the following layers.An example for this is the following:
clusterBuildkit:
cache:
- type: registry
tag: _buildcache-${slice(kebabCase(git.branch), "0", "30")}
- type: registry
tag: _buildcache-main
export: false
Using this cache configuration, every build will first look for a cache specific to your feature branch. If it does not exist yet, it will import caches from the main branch builds (
_buildcache-main). When the build is finished, it will only export caches to your feature branch, and avoid polluting the main branch caches. A configuration like that may improve your cache hit rate and thus save time.If you need to disable caches completely you can achieve that with the following configuration:
clusterBuildkit:
cache: []
Type | Default | Required |
|---|---|---|
array[object] | [{"type":"registry","mode":"auto","tag":"_buildcache","export":true}] | No |
Use the Docker registry configured at
deploymentRegistry to retrieve and store buildkit cache information.Type | Allowed Values | Required |
|---|---|---|
string | "registry" | Yes |
The registry from which the cache should be imported from, or which it should be exported to.
If not specified, use the configured
deploymentRegistry in your kubernetes provider config.Important: You must make sure
imagePullSecrets includes authentication with the specified cache registry, that has the appropriate write privileges (usually full write access to the configured namespace).Type | Required |
|---|---|
object | No |
The hostname (and optionally port, if not the default port) of the registry.
Type | Required |
|---|---|
string | Yes |
Example:
providers:
- clusterBuildkit:
...
cache:
- registry:
...
hostname: "gcr.io"
The port where the registry listens on, if not the default.
Type | Required |
|---|---|
number | No |
The registry namespace. Will be placed between hostname and image name, like so: //
Type | Default | Required |
|---|---|---|
string | "_" | No |
Example:
providers:
- clusterBuildkit:
...
cache:
- registry:
...
namespace: "my-project"
Set to true to allow insecure connections to the registry (without SSL).
Type | Default | Required |
|---|---|---|
boolean | false | No |
This is the buildkit cache mode to be used.
The value
inline ensures that garden is using the buildkit option --export-cache inline. Cache information will be inlined and co-located with the Docker image itself.The values
min and max ensure that garden passes the mode=max or mode=min modifiers to the buildkit --export-cache option. Cache manifests will only be stored stored in the configured tag.auto is the same as max for some registries that are known to support it. Garden will fall back to inline for all other registries. See the clusterBuildkit cache option for a description of the detection mechanism.Type | Allowed Values | Default | Required |
|---|---|---|---|
string | "auto", "min", "max", "inline" | "auto" | Yes |
This is the Docker registry tag name buildkit should use for the registry build cache. Default is
_buildcacheNOTE:
tag can only be used together with the registry cache typeType | Default | Required |
|---|---|---|
string | "_buildcache" | No |
If this is false, only pass the
--import-cache option to buildkit, and not the --export-cache option. Defaults to true.Type | Default | Required |
|---|---|---|
boolean | true | No |
Enable rootless mode for the cluster-buildkit daemon, which runs the daemon with decreased privileges. Please see the buildkit docs for caveats when using this mode.
Type | Default | Required |
|---|---|---|
boolean | false | No |
Exposes the
nodeSelector field on the PodSpec of the BuildKit deployment. This allows you to constrain the BuildKit daemon to only run on particular nodes.Type | Default | Required |
|---|---|---|
object | {} | No |
Example:
providers:
- clusterBuildkit:
...
nodeSelector:
disktype: ssd
Specify tolerations to apply to cluster-buildkit daemon. Useful to control which nodes in a cluster can run builds.
Type | Default | Required |
|---|---|---|
array[object] | [] | No |
"Effect" indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are "NoSchedule", "PreferNoSchedule" and "NoExecute".
Type | Required |
|---|---|
string | No |
"Key" is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be "Exists"; this combination means to match all values and all keys.
Type | Required |
|---|---|
string | No |
"Operator" represents a key's relationship to the value. Valid operators are "Exists" and "Equal". Defaults to "Equal". "Exists" is equivalent to wildcard for value, so that a pod can tolerate all taints of a particular category.
Type | Default | Required |
|---|---|---|
string | "Equal" | No |
"TolerationSeconds" represents the period of time the toleration (which must be of effect "NoExecute", otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.
Type | Required |
|---|---|
string | No |
"Value" is the taint value the toleration matches to. If the operator is "Exists", the value should be empty, otherwise just a regular string.
Type | Required |
|---|---|
string | No |
Specify annotations to apply to both the Pod and Deployment resources associated with cluster-buildkit. Annotations may have an effect on the behaviour of certain components, for example autoscalers.
Type | Required |
|---|---|
object | No |
Example:
providers:
- clusterBuildkit:
...
annotations:
cluster-autoscaler.kubernetes.io/safe-to-evict: 'false'
Specify annotations to apply to the Kubernetes service account used by cluster-buildkit. This can be useful to set up IRSA with in-cluster building.
Type | Required |
|---|---|
object | No |
Example:
providers:
- clusterBuildkit:
...
serviceAccountAnnotations:
eks.amazonaws.com/role-arn: arn:aws:iam::111122223333:role/my-role
Setting related to Jib image builds.
Type | Required |
|---|---|
object |