LogoLogo
Bonsai (0.13) DocsGitHubDiscord CommunityGarden Enterprise
Docs Edge
Docs Edge
  • Welcome to Garden!
  • Overview
    • What is Garden
    • Use Cases
      • Isolated On-Demand Preview Environments
      • Fast, Portable CI Pipelines that Run Anywhere
      • Shift Testing Left
      • Local Development With Remote Clusters
      • Jumpstart your Internal Developer Platform
    • Garden vs Other Tools
  • Getting Started
    • Quickstart
    • Garden Basics
    • Next Steps
  • Tutorials
    • Your First Project
      • 1. Create a Garden Project
      • 2. Pick a Kubernetes Plugin
      • 3. Add Actions
      • 4. Add Tests
      • 5. Code Syncing (Hot Reload)
      • 6. Next Steps
    • Setting up a Kubernetes cluster
      • 1. Create a Cluster
        • AWS
        • GCP
        • Azure
      • 2. Configure Container Registry
        • AWS
        • GCP
        • Azure
        • Docker Hub
      • 3. Set Up Ingress, TLS and DNS
      • 4. Configure the Provider
  • Using Garden With
    • Containers
      • Using Remote Container Builder
      • Building Containers
    • Kubernetes
      • Using Remote Kubernetes
      • Using Local Kubernetes
      • Deploying K8s Resources
      • Installing Helm charts
      • Running Tests and Tasks
    • Terraform
      • Using Terraform
      • Applying Terrform Stacks
    • Pulumi
      • Using Pulumi
      • Applying Pulumi Stacks
    • Local Scripts
  • Features
    • Remote Container Builder
    • Team Caching
    • Variables and Templating
    • Config Templates
    • Workflows
    • Code Synchronization
    • Custom Commands
    • Remote Sources
  • Guides
    • Connecting a Project
    • Environments and Namespaces
    • Installing Garden
    • Including/Excluding files
    • Installing Local Kubernetes
    • Migrating from Docker Compose to Garden
    • Using the CLI
    • Using Garden in CircleCI
    • Minimal RBAC Configuration for Development Clusters
    • Deploying to Production
    • Using a Registry Mirror
    • Local mode
  • Reference
    • Providers
      • container
      • ephemeral-kubernetes
      • exec
      • jib
      • kubernetes
      • local-kubernetes
      • otel-collector
      • pulumi
      • terraform
    • Action Types
      • Build
        • container Build
        • exec Build
        • jib-container Build
      • Deploy
        • configmap Deploy
        • container Deploy
        • exec Deploy
        • helm Deploy
        • kubernetes Deploy
        • persistentvolumeclaim Deploy
        • pulumi Deploy
        • terraform Deploy
      • Run
        • container Run
        • exec Run
        • helm-pod Run
        • kubernetes-exec Run
        • kubernetes-pod Run
      • Test
        • container Test
        • exec Test
        • helm-pod Test
        • kubernetes-exec Test
        • kubernetes-pod Test
    • Template Strings
      • Project template context
      • Environment template context
      • Provider template context
      • Action (all fields) template context
      • Action spec template context
      • Module template context
      • Remote Source template context
      • Project Output template context
      • Custom Command template context
      • Workflow template context
      • Template Helper Functions
    • Commands
    • Project Configuration
    • ConfigTemplate Reference
    • RenderTemplate Reference
    • Workflow Configuration
    • Garden Containers on Docker Hub
    • Glossary
    • Module Template Configuration
    • Module Types
      • configmap
      • container
      • exec
      • helm
      • jib-container
      • kubernetes
      • persistentvolumeclaim
      • pulumi
      • templated
      • terraform
  • Misc
    • FAQ
    • Troubleshooting
    • Telemetry
    • How Organizations Adopt Garden
    • New Garden Cloud Version
    • Migrating to Bonsai
  • Contributing to Garden
    • Contributor Covenant Code of Conduct
    • Contributing to the Docs
    • Setting up Your Developer Environment
    • Developing Garden
    • Config Resolution
    • Graph Execution
Powered by GitBook
On this page
  • Description
  • Complete YAML Schema
  • Configuration Keys
  • providers[]
  • providers[].dependencies[]
  • providers[].environments[]
  • providers[].name
  • providers[].utilImageRegistryDomain
  • providers[].namespace
  • providers[].namespace.name
  • providers[].namespace.annotations
  • providers[].namespace.labels
  • providers[].setupIngressController
  • Outputs
  • ${providers.<provider-name>.outputs.app-namespace}
  • ${providers.<provider-name>.outputs.default-hostname}

Was this helpful?

  1. Reference
  2. Providers

ephemeral-kubernetes

PreviouscontainerNextexec

Last updated 1 month ago

Was this helpful?

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 that allows to deploy applications to one of the ephemeral Kubernetes clusters provided by Garden.

Below is the full schema reference for the provider configuration..

The reference is divided into two sections. The contains the complete YAML schema, and the describes each schema key.

Complete YAML Schema

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:

    # The name of the provider plugin to use.
    name: ephemeral-kubernetes

    # 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.
    utilImageRegistryDomain: docker.io

    # 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. Note: if you skip
    # installing the `nginx` ingress controller for ephemeral cluster, your ingresses may not function properly.
    setupIngressController: nginx

Configuration Keys

providers[]

Type
Default
Required

array[object]

[]

No

providers[].dependencies[]

List other providers that should be resolved before this one.

Type
Default
Required

array[string]

[]

No

Example:

providers:
  - dependencies:
      - exec

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.

Type
Required

array[string]

No

Example:

providers:
  - environments:
      - dev
      - stage

providers[].name

The name of the provider plugin to use.

Type
Default
Required

string

"ephemeral-kubernetes"

Yes

Example:

providers:
  - name: "ephemeral-kubernetes"

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.

Type
Default
Required

string

"docker.io"

No

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.

Type
Required

object | string

No

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.

Type
Required

string

No

providers[].namespace.annotations

Map of annotations to apply to the namespace when creating it.

Type
Required

object

No

Example:

providers:
  - namespace: ''
      ...
      annotations:
          cluster-autoscaler.kubernetes.io/safe-to-evict: 'false'

providers[].namespace.labels

Map of labels to apply to the namespace when creating it.

Type
Required

object

No

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.

Type
Default
Required

string

"nginx"

No

Outputs

The following keys are available via the ${providers.<provider-name>} template string key for ephemeral-kubernetes providers.

${providers.<provider-name>.outputs.app-namespace}

The primary namespace used for resource deployments.

Type

string

${providers.<provider-name>.outputs.default-hostname}

The dynamic hostname assigned to the ephemeral cluster automatically, when an ephemeral cluster is created.

Type

string

> dependencies

> environments

> name

> utilImageRegistryDomain

> namespace

> > name

> > annotations

> > labels

> setupIngressController

kubernetes provider
first section
second section
providers
providers
providers
providers
providers
providers
namespace
providers
namespace
providers
namespace
providers