Skip to main content

Create an Environment

This page will walk you through creating an ephemeral environment for your pull request.

Step 1: Open a Pull Request​

Push your branch and open a PR on GitHub as you normally would.

Step 2: Add the Deploy Label​

Add the greyhound label to your PR. Once the label is added, greyhound will:

  1. Detect the label via a GitHub webhook
  2. Read the greyhound config from your branch
  3. Build any container images defined in your builds section
  4. Provision a Kubernetes namespace with your services, jobs, and infrastructure
  5. Set up ingress routing for your services
note

If using greyhound's lower environment, use the greyhound-nonprod label instead.

Step 3: Wait for the PR Comment​

Greyhound posts a comment on your PR with the status of your environment. The comment includes:

  • Environment status — whether provisioning succeeded or failed
  • Service URLs — clickable links to access each service with an ingress rule
  • Build status — the result of each container image build
  • Database info — connection details if your environment includes a database

The comment updates automatically as the environment progresses through provisioning.

What Happens Behind the Scenes​

Troubleshooting​

If your environment fails to deploy or you do not see a greyhound comment appear on your PR within a minute, check out the troubleshooting guide.