docs

Table of Contents

• Welcome to Garden!

🌸 Overview

• How Garden Works
• Core Concepts
• Use Cases
• Adopting Garden
• Garden vs Other Tools

🌳 Getting Started

• Quickstart Guide
• Interactive Playgrounds
• Installing Garden
• Next Steps

🌻 Tutorials

• Your First Project
  • 1. Initialize a Project
  • 2. Connect to a Cluster
  • 3. Deploy and Test
  • 4. Configure Your Project

💐 Using Garden

• Configuration Overview
• Projects
• Actions
• Tests
• Runs
• Workflows
• Variables and templating
• Config Templates
• Using the CLI
• Modules

🌿 Kubernetes Plugins

• About
• Remote K8s Plugin Configuration
  • 1. Create a Cluster
    • AWS
    • GCP
    • Azure
  • 2. Configure Container Registry
    • AWS
    • GCP
    • Azure
  • 3. Set Up Ingress, TLS and DNS
  • 4. Configure the Provider
• Local K8s Plugin Configuration
  • 1. Install Local Kubernetes
  • 2. Configure the Provider
• Ephemeral K8s Plugin Configuration
  • 1. Configure the Provider
  • 2. Login to the Garden Web Dashboard
  • 3. Configure Ingress (optional)
  • 4. Retrieve Kubeconfig (optional)
• Action Configuration
  • Container
  • Kubernetes
  • Helm
  • PersistentVolumeClaim
  • ConfigMap
  • Kubernetes-exec
• Advanced
  • In-Cluster Building
  • Minimal RBAC Configuration for Development Clusters
  • Deploying to Production

🌺 Terraform Plugin

• About
• Plugin Configuration
• Action Configuration

☘️ Pulumi Plugin

• About
• Plugin Configuration
• Action Configuration

🌹 Other Plugins

• Container
• Exec (local scripts)

🌼 Guides

• Migrating to Bonsai
• Connecting a local application to a Kubernetes cluster (Local Mode)
• Environments and namespaces
• Migrating from Docker Compose to Garden
• Code Synchronization
• Using Garden in CI

🌷 Advanced

• Using Remote Sources
• Custom Commands

🪷 Reference

• Providers
  • conftest-container
  • conftest-kubernetes
  • conftest
  • container
  • ephemeral-kubernetes
  • exec
  • hadolint
  • jib
  • kubernetes
  • local-kubernetes
  • octant
  • 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
    • conftest-helm Test
    • conftest Test
    • container Test
    • exec Test
    • hadolint 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
• Module Template Configuration
• Module Types
  • configmap
  • conftest
  • container
  • exec
  • hadolint
  • helm
  • jib-container
  • kubernetes
  • persistentvolumeclaim
  • pulumi
  • templated
  • terraform

🎋 Garden Seeds

• About
• Languages
  • Go 🌸

🌸 Misc

• FAQ
• Troubleshooting
• Telemetry

🌳 Contributing to Garden

• Contributor Covenant Code of Conduct
• Contributing to the Docs
• Setting up your developer environment
• Developing Garden
• Config resolution
• Graph execution