Docs menu

Deploy

Goal: See exactly what a deploy will do before it runs, then run it.

Saving and accepting write changes to the workspace; Deploy builds them in Azure. The Deploy button in the top bar opens a review window, and the deploy runs from that window. It is not in the Environment menu.

Before you start

  • The right to deploy, Workspace.Deploy. A workspace's owners hold it with no access card. Without it the top bar shows Activate to Deploy, which opens the Current License window instead.
  • A saved workspace. With unsaved changes the button is disabled: "Deploy waits until your changes are saved."

No cloud connection or landing zone is needed to deploy. Until your workspace has its private landing zone, everything goes to the shared environment.

The button reads Deploy, or Deploy · N removals when removals are waiting for it. While a deploy runs it shows a spinner instead.

What the window shows

Review before you deploy: "Everything below is what this deploy would do to your workspace. Nothing has happened yet." The pill reads Ready, or Nothing to do when "Your workspace matches what is deployed. There is nothing to send."

SectionWhat it lists
Shared environmentWhat goes to the shared environment
Your private cloudWhat goes to your private cloud, and, while that is not ready, the next setup step
Workspace onlyRecords with nothing to build, when there are any
RemovingThe removals waiting for this deploy, with how much of each goes
Not in this DeployProposals still waiting, each with Accept
In progressWhile a deploy runs: each removal as it is worked through
Accepted since the last DeployEvery accept since the last Deploy, when there are any, each with Undo, or Redo once undone
Recent activityDeployments and Saves, newest first, each with Open details

What Undo and Redo do, and when they are refused, is in Undo an accept until Deploy.

Each record row reads New, Changed, Up to date or Moving from the shared environment, with its health. When the plan has no destinations, the sections are New, Changed and Live now instead.

"This runs in your cloud and bills while it exists. You can close this at any time. The deploy keeps running, and you can come back to it."

Moving to your private cloud

Once your landing zone exists, records that were deployed to the shared environment are listed as Moving from the shared environment, and the next deploy moves them. A kind that cannot move yet is marked Can't move yet with its reason, and the deploy is held: "Some records can't move to your private cloud yet, so Deploy is held. Each one says why."

While the private cloud is not ready, Your private cloud offers the next step, which closes this window and opens the setup window:

ButtonReason shown
Connect a cloud"Connect your own Azure cloud to deploy here. Until then, everything goes to the shared environment."
Create your landing zone"Create your landing zone to deploy here. Until then, everything goes to the shared environment."
Set up IoT"Set up IoT in your cloud to move data connections here. Until then, they stay on the shared hub."

Removals

Each removal row offers How much of it goes: everything goes or configuration only, plus any settings the kind has. These choices are edits to the workspace: "Your handling choice is saved with your next Save, and takes effect on the deploy after that." See Removals.

Proposals

"Accepting a proposal adds it to your flow. It is not part of this Deploy." Accept accepts it as the Proposals drawer would. Any workspace member can accept a proposal; some changes (access, licences, connected-app requests) need a management right.

Run the deploy

Click Deploy at the foot of the window. If anything would be removed or moved, a confirm lists it first (Deploy · N removals, Deploy · M moves); confirm with Deploy. Then:

  1. Removals are torn down, in order.
  2. Every saved record is built or updated in Azure, in the shared environment or your private cloud.
  3. The window records what is now live, so the next review lists only what changed.

You can close the window; the deploy keeps running. When it finishes the page reloads.

Outcome
Deploy finished.
Deploy finished, and some things were kept. Each one says why below.
Deploy stopped before it finished. What it had already done was not undone.

Only one deploy, or one setup window's save, runs at a time per workspace.

Rights

Reading the review and deploying need Workspace.Deploy. Some parts of a deploy need more: retiring a licence plan needs Licenses.Manage, and access changes need an owner or Workspace.Access.Manage. Owners hold Workspace.Deploy and Licenses.Manage with no access card.

Azi and agents

Deploying is a person's act. Azi and agents can only propose; there is no deploy or accept tool over MCP, and Greenfield never deploys.

Messages you may see

CodeMessage
DEPLOY_NOT_ALLOWED"You do not have permission to deploy this workspace."
DEPLOY_PLAN_CHANGEDThe list changed since you opened the window: confirm the list, then deploy again
MOVE_HELDA record would move to your private cloud and its kind cannot move yet. Nothing was deployed
DEPLOY_IN_PROGRESSA deploy or a setup window is already running for the workspace. Wait for it to finish, then try again
DEPLOY_DELETES_NOT_STAGED"Deploy tears down only what is on the removal list. Save the removal first, then deploy."
The window"The deploy did not go through." and the reason, or "We could not read what this deploy would do."
Lost track"We stopped checking this deploy because its status could not be read. Reopen Deploy to check again."

TIP

The first deploy after OpenX started tracking what is live lists everything as new: "After this deploy, the list will only show what actually changed."

Next steps

On this page