Skip to main content

Prerequisites

Repository Setup​

To get started, you will need to create a .greyhound/config.yaml file in your repository root. This file defines your application's deployment topology. See Build Your First App for the main walkthrough, Hello World for the minimal example, and the greyhound config overview for the broader config model. Optionally, you can include an applications.yaml file if you would like to define applications in other repositories which already have greyhound configurations to deploy alongside your application.

For more details on the configuration options available in greyhound, check out the greyhound schema reference.

How to Use Greyhound​

Greyhound supports two complementary ways to deploy environments:

  • Pull request environments — ephemeral environments tied to the PR lifecycle. Add a deploy label to your PR and greyhound automatically provisions, updates, and tears down the environment. Designed to make it easy for developers to preview changes in a real cloud environment before merging.
  • Static environments — long-lived environments that you create and manage explicitly via GitHub Actions, the CLI, or the API. Use these for shared staging, QA, or any environment that needs to outlive a single pull request.

Confused by all the greyhound jargon you're seeing? Check out the greyhound terminology page.