A deployment request asks for a target state definition to be applied to one or more domains. Before you submit anything, Admin Portal reads each domain and shows you exactly what a deploy would create, update and remove, so the request you raise is a reviewed plan rather than a leap of faith.
Raising a request changes nothing in any domain. Each request waits for a second person to approve it, and the definition is only applied when someone then selects Deploy now.
Prerequisites
A target state definition stored in a registered source. See how to create a definition.
Access to the cells that own the domains you want to deploy to. Domains are listed by cell, and you only see cells you have access to.
The entitlement to request deployments. If you can see Deployments under Configuration Management but the New deployment button is missing, you have read-only access.
A colleague who holds the Trigger Deployments right for each target domain, to approve your request. You cannot approve your own.
Method
Step 1: Start a new deployment
Navigate to Configuration Management > Deployments.
Select New deployment.
The page walks you through four steps: Definition, Domains, Plan and Review. A strip at the top shows what you have chosen so far. To leave at any point, select Leave without requesting or Cancel. Admin Portal asks you to confirm with Leave the flow or Stay here, and nothing is requested.
Step 2: Choose the definition
Find the definition you want to deploy. Use the search box to filter by scope, code, title or source. Each row shows the definition's
scope/code, its title, how many resources it holds, when it was last edited and where it is stored.Select the definition, then select Continue.
If the list is empty, there are no definitions to deploy yet. Create one first, then come back.
Step 3: Choose the target domains
Select one or more domains. Domains are grouped by the cell that owns them.
Optionally select Preview the consequences to see, per domain, how many resources a deploy would create, update and remove. Nothing is read from the domains until you do.
Select Continue.
Each domain you pick gets its own request, its own plan and its own approval. A domain that is already a target of this deployment is marked Already a target.
Step 4: Review the plan
Admin Portal reads each domain and works out what would change. This can take a few seconds per domain. Nothing has happened yet.
If you chose more than one domain, a tab appears for each. A tab shows a red count (for example −3) when that domain has removals.
The tiles across the top count each kind of change: + Create, ~ Update, − Remove and = Unchanged, plus ⊘ Skipped for resources that write behaviour leaves alone. Select a tile to show only those resources, and select it again to show everything.
Select a resource to expand it and see what changes, field by field.
Tags on a row tell you more about what will happen to it:
Tag | Meaning |
|---|---|
Reference | The definition depends on it, but the deployment never creates, changes or deletes it. |
Adopts existing | If a resource with the same identity already exists in the domain, the deploy takes it over instead of failing. |
Fails if exists | The deploy fails if the resource already exists in the domain. If it might, change its write behaviour to Adopt. |
Write control | Write behaviour stops this resource being updated or deleted. The deploy leaves it alone. |
Could not compare | Admin Portal could not read the live value, so it treats the resource as an update rather than assuming it is unchanged. |
Keeping resources the plan would remove
If a domain holds resources that this deployment manages but the definition no longer lists, the plan says how many will be permanently removed. To leave one in the domain:
Select Review removals.
Select Keep on each resource you want to leave alone. The button changes to Keeping.
If you change the domains or the definition after this, Admin Portal recomputes the plan and your Keep choices are cleared.
If the plan cannot be computed, select Try again, or go back and change the domains.
When you are happy with the plan, select Continue.
Step 5: Confirm and submit
The Confirm and submit step summarises the requests you are about to raise:
one card per domain, headed Reconcile [domain] to the definition, with its change counts and its Permanent removals;
the Target domains, with the warning This includes a production domain. if any of them sits in a production cell;
the Origin the definition is read from. The definition is read fresh from here when each run executes;
a reminder that each request needs a second person's Approval.
If the plan removes anything, tick I understand this will permanently delete N resources once each request is approved and run. You cannot submit until you do.
Select Submit request.
If the definition refers to a resource it holds neither as a resource nor as a reference, Admin Portal refuses it with The definition refers to resources it does not hold, so the configuration service would refuse it. Each line names the resource and what it refers to, for example <resource> refers to <resource>, which this definition does not hold. Add it as a resource or a reference. A resource you chose to Keep counts as held for that domain.
If LUSID's configuration service refuses the definition for another reason, the message starts The configuration service refused the definition for one of the selected domains. and gives its reason. Either way, nothing is submitted. Fix the definition, save it, then submit again.
Step 6: Check what was raised
The Submitted screen lists each request with its run number and status, normally Awaiting approval. Select View deployment to open the deployment's page.
Let your approver know the request is waiting. They can find it under Configuration Management > Deployments on the Activity tab, or on the Approvals page. See how to approve someone else's deployment request.
Other ways to raise a request
The steps above start a brand-new deployment. Admin Portal offers shorter routes when some of the choices are already made. Each still shows you the plan and the review before anything is requested.
Where you start | Select | Steps you see |
|---|---|---|
A pipeline board | Promote on a stage, or Deploy or Retry on a domain | Plan, Review. The pipeline decides the definition and the domains. |
A deployment's page | Add domain | Domains, Plan, Review. The definition is already chosen. |
A domain in a deployment | Redeploy or Deploy latest | Origin, Plan, Review. |
On the Origin step of a redeploy, choose Use the existing origin, or choose Change the origin to read the definition from a different repository or branch, a LUSID Drive path, or a file uploaded from your machine. The origin you pick becomes the deployment's origin from then on. Uploaded files are not stored, so you must upload the file again to redeploy it later.
After you submit
Your requests appear under Configuration Management > Deployments on the Activity tab, and on the deployment's own page. The Activity tab shows each request's status:
Status | What it means | What happens next |
|---|---|---|
Awaiting approval | Waiting for a second person with deploy rights for the domain. | A colleague approves or denies it. |
Approved | Approved, but nothing has been applied yet. | Anyone with the Trigger Deployments right for the domain selects Deploy now. |
Queued or In progress | The run is applying the definition. | Progress appears on the run as it happens. |
Completed or Failed | The run has finished. | It moves to the History tab with its plan, its log and who approved it. |
Denied or Cancelled | The request was turned down or withdrawn. Nothing was applied. | Raise a new request if you still need the change. |
Select Refresh at the top of the page to see the latest status.
The deployment's page and the pipeline board describe the same states from the domain's point of view, as Awaiting approval, Approved · ready and Deploying now.
Once a request is approved, Deploy now appears on the request in the Activity tab, beside the domain on the deployment's page, on the domain's detail page and, for a promotion, on the domain's node on the pipeline board.
Cancelling your request
Until someone selects Deploy now, you can withdraw your request:
On the Activity tab, find the request and select Cancel request.
Select Cancel the request to confirm.
Nothing has been applied to the domain, and the approval is withdrawn with it. Only the person who raised a request can cancel it.
FAQs
Does raising a request change anything in the domain? No. Admin Portal reads each domain to compute the plan, but nothing is applied until the request is approved and someone selects Deploy now.
Can I approve my own request? No. Every request needs a second person with the Trigger Deployments right for that domain, even if you hold that right yourself.
What if the definition changes after I submit? A run always reads the latest revision of the definition from its origin at the moment it executes, not the revision the plan was computed against. The run records both, so any difference is visible afterwards.
Why can't I raise another request for this domain? A domain can have only one request in play per deployment. The button's tooltip says why: the domain is awaiting approval, is already approved and ready to deploy, or is deploying now. Approve and deploy, or cancel, the request that is already there.
Can I deploy to several domains at once? Yes. Pick several domains in Step 3. Admin Portal raises one request per domain, and each is planned, approved and deployed on its own.