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
  • Connecting a project
  • Creating personal access tokens
  • Offline mode
  • Limits

Was this helpful?

  1. Guides

Connecting a Project

PreviousRemote SourcesNextEnvironments and Namespaces

Last updated 1 month ago

Was this helpful?

Connecting a project is only possible for Garden versions 0.14.0 and higher.

To use key Garden features such as and the you need to connect your Garden project to the .

Connecting a project

A "connected project" is a Garden project that has an organizationId field set in the project level Garden config file.

To connect a project, run the login command from your project directory with:

garden login

Note that:

  • If this is your first time, you'll be asked to create an account.

  • If you already have an account and are a part of multiple organizations, you will be asked to pick the organization this project should belong to.

After you've logged in, the organization ID will be automatically added to your project level Garden configuration. You should check these changes into source control. If a project already has an organization ID, nothing will happen.

And that's it!

You can now benefit from team-wide caching and use the Remote Container Builder—and so can other people on your team as long as they're logged in. Note that the container builder needs to be enabled specifically in your config, .

See below for how to create an access token so that you can also use team-wide caching and Remote Container Builder in CI.

Creating personal access tokens

To use Garden in CI you need to create a personal access token and use the GARDEN_AUTH_TOKEN environment variable.

You can create the token from the Settings page in and copy it to your clipboard.

To use the token, run Garden with the GARDEN_AUTH_TOKEN set like so:

GARDEN_AUTH_TOKEN=<my-personal-access-token> garden deploy

Offline mode

After you connect your project and set the organizationId, you need to remain logged in to use Garden.

If you're not logged in, the command fails. This to prevent degraded performance such as slower builds or missed cache hits that users might not notice, especially in environments like CI.

If you can't log in for some reason, you can use "offline mode" by simply adding the --offline flag to your commands or by using the GARDEN_OFFLINE environment variable. For example:

garden test --offline

...or:

GARDEN_OFFLINE=true garden deploy

Limits

Create and copy personal access token

See also the section above about for environments like CI where you can't run the interactive login command.

Our free-tier includes a certain amount of build minutes and cache hits/cache retention and you can get more by upgrading to our team or enterprise tiers. You can learn more about the different tiers on our .

team-wide caching
Remote Container Builder
Garden Cloud backend
see here for more
Garden Cloud
plans page
creating access tokens
Create and copy personal access token
Create and copy personal access token