Manage deployments

Open the Deployment Launcher window by selecting SpatialOS > Deployment Launcher from the Unity Editor menu.

UI walkthrough

The section of the Deployment Launcher window that you use to manage live deployments can be found under the Live Deployments label.

Initially, the Deployment Launcher does not know of any deployments. It only updates its known list of deployments when requested.

Buttons

Button name Description
Refresh When pressed, the Deployment Launcher retrieves a list of cloud deployments currently running in your SpatialOS project.

Listed deployments

When there are live cloud deployments running, this section is updated with a list of these live deployments and some metadata about them. The deployment metadata is read-only.

Metadata

Metadata Example
Deployment name The name of the given cloud deployment. For example, my_deployment.
Start Time The local time that the deployment was started.
Region The geographical region code that the deployment is running in.
Connected Workers A table of connected worker instances, grouped by worker type.
Tags A list of metadata tags added to the deployment.

Buttons

Button name Description
Open the SpatialOS Console (🌐) When pressed, the Console page for the selected cloud deployment opens in your browser.
Stop deployment When pressed, this begins to stop a deployment chosen from the list of running cloud deployments.

Expected behaviour

Listing deployments

When you press the Refresh button, the Deployment Launcher gathers a list of live cloud deployments within the SpatialOS project.

You should see a notification similar to the following at the bottom of the deployment launcher window:

Listing deployments in project "<project_name>".
Assembly reloading locked.

A list of deployments has been retrieved successfully when:

  • The notification at the bottom of the Deployment Launcher window has disappeared.

Cancel the deployment listing operation

You can stop the Deployment Launcher retrieving an updated list of deployments by pressing the Cancel button shown next to the notification at the bottom of your Deployment Launcher window.

Stopping deployments

When you press the Stop deployment button, the Deployment Launcher sends a request to stop the deployment chosen from the adjacent drop-down option.

The list of deployments and corresponding metadata are not automatically refreshed. Ensure that you have refreshed the list manually before performing any action.

You should see a notification similar to the following at the bottom of the deployment launcher window:

Stopping deployment "<deployment_name>".
Assembly reloading locked.

The deployment has stopped successfully when:

  • You see the following message in your Unity Editor Console window: Stopped deployment: <deployment_name> successfully.
  • The stopped deployment has been removed from the list of live deployments.
  • The notification at the bottom of the Deployment Launcher window has disappeared.

Cancel the deployment stopping operation

When a deployment is being stopped, you can cancel the operation by pressing the Cancel button shown next to the notification at the bottom of your Deployment Launcher window.

Cancelling the operation does not prevent the deployment being stopped, and may leave it in an unknown state.

Updated about a year ago


Manage deployments


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.