Garden
If you love Garden, please ★ star this repository to show your support
Garden is a tool that combines rapid development, testing, and DevOps automation in one platform. It is designed for teams developing applications that run on Kubernetes and for DevOps Engineers writing infrastructure as code. This repository contains the source of Garden core along with its documentation and examples.
With Garden you can:
- Test and develop with smart caching and live reloading.
- Build container images and push them to any number of registries, automatically, as you write.
- Use remote Kubernetes clusters as your development environment with developer namespaces.
- Declare your entire stack in a single file (or many files), including how it's built, deployed and tested from infrastructure to application code.
Installation
The fastest way to get started with Garden is by following our quickstart guide.
Otherwise:
curl -sL https://get.garden.io/install.sh | bash
For more installation options, see the installation guide.
Demo
Usage
If you have a garden.yml
file in your project, you can run garden
commands from the root of your project. If you don't have a garden.yml
file, clone the quickstart project:
git clone https://github.com/garden-io/garden-quickstart.git
Now start the dev console with:
garden dev
Build with:
build
Deploy with:
deploy
Test with:
test
Exit with exit
.
To create a preview environment on every pull request, simply add the following to your CI pipeline:
garden deploy --env preview
A developer wants to run an end-to-end test from their laptop as they code. Simple:
garden test --name my-e2e-test
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, simply run:
garden deploy --sync
Docs
For a more thorough introduction to Garden and comprehensive documentation, visit our docs.
How Garden Works
The Stack Graph is a key feature of Garden that enables efficient development, testing, and DevOps automation. The Stack 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. Without the Stack Graph, many of these functionalities that distinguish Garden from its competitors would not be possible or would be much less efficient.
-
Efficient builds and deploys: The Stack Graph allows Garden to determine which parts of your project have changed and need to be rebuilt or redeployed, avoiding unnecessary work and speeding up the development process.
-
Automated testing: Garden can automatically run tests for the parts of your project that have changed, thanks to the Stack Graph. This saves time because all parts of your dependency graph are known and cached.
-
DevOps automation: The Stack Graph allows Garden to automate many aspects of the DevOps process, including building, testing, and deploying your project.
For more information on the Stack Graph and how Garden works, see:
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:
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).