Below is the schema reference for the kubernetes provider. 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 lists and describes the available schema keys. The second section contains the complete YAML schema.

Configuration keys

apiVersion

The schema version of this project's config (currently not used).

kind

name

The name of the project.

Example:

name: "my-sweet-project"

defaultEnvironment

The default environment to use when calling commands without the --env parameter.

environmentDefaults

Default environment settings. These are inherited (but can be overridden) by each configured environment.

Example:

environmentDefaults:
  providers: []
  variables: {}

environmentDefaults.providers[]

​environmentDefaults > providers

A list of providers that should be used for this environment, and their configuration. Please refer to individual plugins/providers for details on how to configure them.

environmentDefaults.providers[].name

​environmentDefaults > providers > name

The name of the provider plugin to use.

Example:

environmentDefaults:
  providers: []
  variables: {}
  ...
  providers:
    - name: "local-kubernetes"

environmentDefaults.variables

​environmentDefaults > variables

A key/value map of variables that modules can reference when using this environment.

sources

A list of remote sources to import into project.

sources[].name

​sources > name

The name of the source to import

sources[].repositoryUrl

​sources > 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: #

Example:

sources:
  - repositoryUrl: "git+https://github.com/org/repo.git#v2.0"

environments

environments[].providers[]

​environments > providers

environments[].providers[].defaultHostname

​environments > providers > defaultHostname

A default hostname to use when no hostname is explicitly configured for a service.

Example:

environments:
  - providers:
      - defaultHostname: "api.mydomain.com"

environments[].providers[].defaultUsername

​environments > providers > defaultUsername

Set a default username (used for namespacing within a cluster).

environments[].providers[].forceSsl

​environments > providers > forceSsl

Require SSL on all services. If set to true, an error is raised when no certificate is available for a configured hostname.

environments[].providers[].imagePullSecrets[]

​environments > providers > imagePullSecrets

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 module configuration, and is required when configuring a remote Kubernetes environment.

environments[].providers[].imagePullSecrets[].name

​environments > providers > imagePullSecrets > name

The name of the Kubernetes secret.

Example:

environments:
  - providers:
      - imagePullSecrets:
          - name: "my-secret"

environments[].providers[].imagePullSecrets[].namespace

​environments > providers > imagePullSecrets > namespace

The namespace where the secret is stored. If necessary, the secret may be copied to the appropriate namespace before use.

environments[].providers[].tlsCertificates[]

​environments > providers > tlsCertificates

One or more certificates to use for ingress.

environments[].providers[].tlsCertificates[].name

​environments > providers > tlsCertificates > name

A unique identifier for this certificate.

Example:

environments:
  - providers:
      - tlsCertificates:
          - name: "wildcard"

environments[].providers[].tlsCertificates[].hostnames[]

​environments > providers > tlsCertificates > hostnames

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.

Example:

environments:
  - providers:
      - tlsCertificates:
          - hostnames:
            - www.mydomain.com

environments[].providers[].tlsCertificates[].secretRef

​environments > providers > tlsCertificates > secretRef

A reference to the Kubernetes secret that contains the TLS certificate and key for the domain.

Example:

environments:
  - providers:
      - tlsCertificates:
          - secretRef:
            name: my-tls-secret
            namespace: default

environments[].providers[].tlsCertificates[].secretRef.name

​environments > providers > tlsCertificates > secretRef > name

The name of the Kubernetes secret.

Example:

environments:
  - providers:
      - tlsCertificates:
          - secretRef:
            name: my-tls-secret
            namespace: default
              ...
              name: "my-secret"

environments[].providers[].tlsCertificates[].secretRef.namespace

​environments > providers > tlsCertificates > secretRef > namespace

The namespace where the secret is stored. If necessary, the secret may be copied to the appropriate namespace before use.

environments[].providers[].name

​environments > providers > name

The name of the provider plugin to use.

Example:

environments:
  - providers:
      - name: "kubernetes"

environments[].providers[].context

​environments > providers > context

The kubectl context to use to connect to the Kubernetes cluster.

Example:

environments:
  - providers:
      - context: "my-dev-context"

environments[].providers[].deploymentRegistry

​environments > providers > deploymentRegistry

The registry where built containers should be pushed to, and then pulled to the cluster when deploying services.

environments[].providers[].deploymentRegistry.hostname

​environments > providers > deploymentRegistry > hostname

The hostname (and optionally port, if not the default port) of the registry.

Example:

environments:
  - providers:
      - deploymentRegistry:
          ...
          hostname: "gcr.io"

environments[].providers[].deploymentRegistry.port

​environments > providers > deploymentRegistry > port

The port where the registry listens on, if not the default.

environments[].providers[].deploymentRegistry.namespace

​environments > providers > deploymentRegistry > namespace

The namespace in the registry where images should be pushed.

Example:

environments:
  - providers:
      - deploymentRegistry:
          ...
          namespace: "my-project"

environments[].providers[].ingressClass

​environments > providers > ingressClass

The ingress class to use on configured Ingresses (via the kubernetes.io/ingress.class annotation) when deploying container services. Use this if you have multiple ingress controllers in your cluster.

environments[].providers[].ingressHttpPort

​environments > providers > ingressHttpPort

The external HTTP port of the cluster's ingress controller.

environments[].providers[].ingressHttpsPort

​environments > providers > ingressHttpsPort

The external HTTPS port of the cluster's ingress controller.

environments[].providers[].namespace

​environments > providers > namespace

Specify which namespace to deploy services to (defaults to ). Note that the framework generates other namespaces as well with this name as a prefix.

Complete YAML schema

apiVersion: garden.io/v0
kind: Project
name:
defaultEnvironment: ''
environmentDefaults:
  providers:
    - name:
  variables: {}
sources:
  - name:
    repositoryUrl:
environments:
  - providers:
      - defaultHostname:
        defaultUsername:
        forceSsl: false
        imagePullSecrets:
          - name:
            namespace: default
        tlsCertificates:
          - name:
            hostnames:
            secretRef:
              name:
              namespace: default
        name: kubernetes
        context:
        deploymentRegistry:
          hostname:
          port:
          namespace: _
        ingressClass:
        ingressHttpPort: 80
        ingressHttpsPort: 443
        namespace: