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 the Hello World guide for a minimal example, and check out the greyhound config overview for more on how to create a greyhound config. 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 currently only supports ephemeral pull requests environments. Designed to function similarly to Lifecycle, these environments are intended to make it easy for developers to preview their changes in a real cloud environment before merging code changes. To learn how to create these environments with greyhound, continue on to the overview page for pull request environments.

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