Operate

Use the Dashboard

Find any rollout, read what holds it and act on it.

On this page
  1. Find an app or a rollout
  2. Read a rollout
  3. Follow a change
  4. Act on a rollout
    1. Approve a build
    2. Skip a gate once
    3. Change version and pin
    4. Retry a failed deploy
    5. Roll back
  5. Check the result
  6. Next steps

Find an app or a rollout

Search reaches every app, rollout and pull request.

  1. Open Home for what needs you, or Rollouts, Apps and Environments for the whole fleet.
  2. Press Ctrl K (⌘ K on a Mac), or select Search at the top of the sidebar.
  3. Type part of a name.
  4. To find a pull request, paste its GitHub URL, owner/repo#123 or a commit sha, then select Open change #123 · repo.
The command palette resolving a pasted pull request URL to Open change #80 · checkout-apiThe command palette resolving a pasted pull request URL to Open change #80 · checkout-api

Read a rollout

Progress shows where a release is, Gates what holds it.

  1. Open an app from Apps, then select the Progress tab.
  2. With several releases in flight, pick one in the release list. The drawing shows every environment, its regions grouped by Wave, and each place’s state: deployed, deploying, checking, held, waiting for approval, failed, or Not reached.
  3. Select a place in the drawing to open that rollout. When the app waits or failed, the banner above also has Open rollout; What the dashboard shows explains each banner.
The Progress card of hello-waves-app on build c6f19d2, deployed to development, staging and two production wavesThe Progress card of hello-waves-app on build c6f19d2, deployed to development, staging and two production waves
  1. On the rollout, select the Gates tab. Gated by lists every gate, the environment before this one and the services it depends on, Downstream the rollouts that deploy after it. All dependencies › opens the dependency network.
The Gates graph of billing-edge in production: Business hours and Release approval hold build 5.8.0-62, each with Skip onceThe Gates graph of billing-edge in production: Business hours and Release approval hold build 5.8.0-62, each with Skip once
  1. On a rendered-manifests rollout, select View source in the rollout header to read the deployed files (Rendered manifests).

Follow a change

The Changes page tracks each merged pull request through every service and environment.

  1. Open Changes. Your failing change, if any, leads in a banner.
  2. Select a change, then read its page.
WhereWhat it shows
AttentionYour other failing changes, then approvals you can give
Your changesYour repositories with a change in flight
TeamOther people’s repositories with a change in flight
Strip under the titleA row per service, a box per environment, a mark per region that opens its rollout
History and SummaryWhat happened, and the time from merge to the first deploy and to production

Without a GitHub connection, these pages show Changes need GitHub.

Act on a rollout

Each action sits on a gate’s tile or the rollout page.

Approve a build

  1. On the Gates tab, find the approval gate that reads Needs you. It reads Needs approval when you cannot approve it.
  2. Select Approve. When the build waits in several regions, it reads Approve all and approves them all.
  3. Confirm the Approve build dialog with Approve.

Skip a gate once

  1. On the Gates tab, select Skip once on a schedule, approval or hand-written gate. Health checks and pins have no Skip once, and the button shows only when you may change the rollout.
  2. Read the dialog, Skip gate once: every other rule still applies, and the gate keeps holding every other build.
  3. Optionally select the other rollouts the gate holds, then confirm. When production is selected, type the build, or the gate’s name when the selected rollouts hold different builds.

Change version and pin

  1. On the rollout’s Overview, select Change version.
  2. Pick a build, or search by sha, version or commit.
  3. Turn on Pin build to keep the rollout on this build until you clear it. Without the pin, a build that is not the newest stays only until its bake succeeds, and then the rollout deploys the newest build its rules allow.
  4. In production, write why and type the build. Elsewhere the note is optional, and you type the build too when it failed on this rollout. Select Deploy to environment (Deploy anyway for a build that failed here, Roll back for an older build).
The Change version dialog for held build 4.45.0-45 of checkout-api in production: the rule it overrides, the Pin build switch, a reason and the typed confirmationThe Change version dialog for held build 4.45.0-45 of checkout-api in production: the rule it overrides, the Pin build switch, a reason and the typed confirmation
Change version skips every rule, including the wait for the earlier environment’s bake: a build development never baked, or failed, deploys to staging at once. Once staging bakes it, production may take it.

To follow new releases again, select Clear pin on the Overview banner or the pin’s tile.

Retry a failed deploy

  1. On the rollout’s Overview, select Retry on the Deployment failed banner.
  2. In production, or when a rule holds the build, confirm Redeploy to environment. When tests failed, it offers to retry or skip them.

Roll back

Start from one of two places:

  • After a failed deploy: select Roll back on the Deployment failed banner of the rollout’s Overview. It deploys the build before the failed one.
  • Any other build: select Roll back in the rollout header. It shows whenever an older build exists, and goes to the last older build this environment ran, else the release just below the running one. To pick the build yourself, choose an older one in Change version.

Then confirm. A rollback always pins, so the dialog has no Pin build switch. Select Roll back; in production, write why and type the build first.

The rollout stays on that build, under a Rolled back banner, until you select Clear pin. A force-deploy back does not hold: see Deploy a specific version.

Check the result

After Approve, the gate’s tile reads Approved. A skipped gate reads Skipped once for build until that build deploys.

Next steps