- Notifications
You must be signed in to change notification settings - Fork274
Automation for Kubernetes development and testing. Spin up production-like environments for development, testing, and CI on demand. Use the same configuration and workflows at every step of the process. Speed up your builds and test runs via shared result caching
License
garden-io/garden
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
If you love Garden, please ★ star this repository to show your support 💚. Looking for support? Join ourDiscord.
Garden is a DevOps automation tool for developing and testing Kubernetes apps faster.
- Spin upproduction-like environments for development, testing, and CIon demand
- Use thesame configuration and workflows forevery stage of software delivery
- Speed up builds and test runs via smart caching.
The fastest way to get started with Garden is by following ourquickstart guide.
For a thorough introduction to Garden and comprehensive documentation, visit ourdocs.
Garden is configured viagarden.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:Deployname:dbtype:helmspec:chart:name:postgresrepo:https://charts.bitnami.com/bitnami---kind:Buildname:apitype:containersource:path:./api---kind:Deployname:apitype:kubernetesdependencies:[build.api, deploy.postgres]spec:files:[./manifests/api/**/*]---kind:Testname:integtype:containerdependencies:[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—ensuringblazing 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
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:
Garden ispluggable: 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:
Join ourDiscord community to ask questions, give feedback or just say hi 🙂
Garden accepts contributions! Please see ourcontributing guide for more information.
Garden is licensed according toMozilla Public License 2.0 (MPL-2.0).
About
Automation for Kubernetes development and testing. Spin up production-like environments for development, testing, and CI on demand. Use the same configuration and workflows at every step of the process. Speed up your builds and test runs via shared result caching