Garden

If you love Garden, please ★ star this repository to show your support 💚. Looking for support? Join our Discord.

Quickstart   •   Website   •   Docs   •   Examples   •   Blog   •   Discord

Welcome to Garden!

Garden is a DevOps automation tool for developing and testing Kubernetes apps faster.

• Spin up production-like environments for development, testing, and CI on demand
• Use the same configuration and workflows for every stage of software delivery
• Speed up builds and test runs via smart caching.

Getting Started

The fastest way to get started with Garden is by following our quickstart guide.

Demo

Docs

For a thorough introduction to Garden and comprehensive documentation, visit our docs.

Usage Overview

Garden is configured via garden.yml files. For large projects you can split the files up and co-locate them with the relevant parts of your stack, even across multiple repositories.

A (simplified) Garden configuration for a web app looks like this:

kind: Deploy
name: db
type: helm
spec:
  chart:
    name: postgres
    repo: https://charts.bitnami.com/bitnami
---
kind: Build
name: api
type: container
source:
  path: ./api
---
kind: Deploy
name: api
type: kubernetes
dependencies: [build.api, deploy.postgres]
spec:
  manifestFiles: [./manifests/api/**/*]
---
kind: Test
name: integ
type: container
dependencies: [deploy.api]
spec:
  args: [npm, run, test:integ]

You can build and deploy this project with:

garden deploy

...and test it with:

garden test

To create a preview environment on every pull request, you would add the following to your CI pipeline:

garden deploy --env preview

Garden also has a special mode called "sync mode" which live reloads changes to your running services—ensuring blazing fast feedback while developing. To enable it, run:

garden deploy --sync

You can also start an interactive dev console (see screencap above) from which you can build, deploy, and test your project with:

garden dev

How Garden Works

Garden Core is a standalone binary that can run from CI or from a developer’s machine. Its configuration framework allows you to codify a complete description of your stack using intuitive YAML config—making your workflows reproducible and portable.

Garden's "action graph" allows you to declare the dependency structure of your project and track changes to avoid unnecessary builds, deploys and test runs. It's like CI/CD config that you can additionally use for development.

Check out the How Garden Works page of our docs to learn more.

Plugins

Garden is pluggable: how actions are executed depends on the plugins used. Our Kubernetes plugin is currently the most popular, followed by our Terraform and Pulumi plugins. For a more thorough introduction to Garden and its plugins, visit our docs:

• Kubernetes plugin
• Terraform plugin
• Pulumi plugin

Community

Join our Discord community to ask questions, give feedback or just say hi 🙂

Contributing

Garden accepts contributions! Please see our contributing guide for more information.

License

Garden is licensed according to Mozilla Public License 2.0 (MPL-2.0).