Skip to content

The canvas

See a stack's services and resources on the console's canvas, stage edits, and write them to EZGHDeploy as a commit or a pull request as yourself.

Updated View as Markdown

A stack’s page in the console is a canvas of one environment, chosen with the environment switcher at the top. Below 1024 px wide it’s a list of the same cards.

Cards and lines

Each service and resource is a card with its icon, a short summary and its status. A line from one card to another is a reference in the file: a service’s env that uses a resource, or another service’s URL.

Selecting a card (or pressing Enter on it) opens its panel; Escape closes it.

  • Services: Deployments, Variables, Metrics, Logs and Settings. Metrics and logs come from Observability in the environment’s project, and need obs.metrics.query and obs.logs.search.
  • Resources: a summary and a link to the resource’s own product page.

Stage edits

Adding a service or resource, changing a setting or a variable, and drawing a line (which adds the env reference) are staged, not applied. Staged edits are kept per environment and shared by everyone editing it; each edit records who made it. The bar at the top counts them, Deploy N changes, and shows the change to EZGHDeploy as a diff.

A setting is written where its value comes from: the environment’s override if it has one, otherwise the base. Only in <environment> writes an override for the viewed environment instead. Moving changes from one environment to another is your own merge or pull request between their branches.

Edits change only the lines they touch, so the file’s comments and layout stay as they were.

Commit or open a pull request

From the bar, Commit to <branch> commits the edits to the viewed environment’s branch, and Open pull request opens one against it. Either way the write is made as you, with your own rights on the repository:

  • GitHub: the console sends you through GitHub to authorize the EZGH Deploy app for your account, if you haven’t in this session, then comes back to the canvas. GitHub checks your push and pull-request rights and records you as the author.
  • EZGH Git: the console writes the commit or pull request as you.

Others who staged edits in the same set are named as co-authors. A protected branch offers only Open pull request. Once the commit is on the branch, its push deploys it like any other.

Re-apply

If EZGHDeploy changed on the branch after the edits were staged, the bar says so. Re-apply puts the staged edits on the new file; Discard drops them. Edits that no longer fit the file are shown with the reason.

Layout

Card positions are saved per stack, not in the file, and dragging a card saves them. A stack with no saved layout is laid out automatically.

Action Permission
See the canvas deploy.stacks.get, deploy.files.read
Stage edits deploy.changesets.create, deploy.changesets.update
Commit or open a pull request deploy.changesets.submit, and your own rights on the repository
Move cards deploy.layouts.update
Navigation

Type to search…

↑↓ navigate↵ selectEsc close