This article provides the steps required to view and manage deployments.
Deployment owners have access to view and manage their deployments, while Broker Administrators have access to view all user deployments for the Broker.
Accessing Deployments
This section describes the steps required to access Deployments.
Administrative Users should jump ahead to the next step Accessing Deployments (Administrative Users).
Prerequisites
- User owns deployments
and/or - User has been assigned permissions to manage deployments
Procedure Steps
- Login in the the Broker UI
- Navigate to My Deployments
- A list of Deployments is displayed, which includes deployments owned by the user or has the Manage permission assigned to the user
- Click on the Deployment name or the View button to view details of the Deployment
Accessing Deployments (Administrative Users)
This section describes the steps required to access Deployments as an administrative user.
Non-administrative users should refer to the previous step Accessing Deployments.
Prerequisites
- Administrative access to the Broker UI
Procedure Steps
- Login in the the Broker UI as an administrative user
- Navigate to Manage > Deployments
- A list of Deployments is displayed
- Click on the Deployment name or the View button to view details of the Deployment
Deployment States
Deployment states advise the state of the deployment.
The following table lists the possible states of a deployment.
| State | Description |
| Creating | A new deployment request has been received and the deployment is being created |
| Starting | The deployment is starting/restarting from a stopped state |
| Running | The deployment is running normally |
| Stopping/Stopped | The deployment is stopping either as a result of a user request or due to and automated process - eg. Hours of Operation policy |
| Disabling/Disabled |
The deployment is being powered off and disabled due to its lease expiring, with no further automated processes triggered for the deployment Note: The lease should be extended prior to enabling and starting the deployment, otherwise the deployment will automatically be stopped and disabled again |
| Terminating/Terminated | The deployment is being terminated either as a result of a user request or due to a Terminate action on lease expiry |
| Failed |
There has been a failure during the deployment - review the deployment's Logs and Nodes to ascertain the reason for the failure Note: If the Deployment Failure Action property is set as Do not terminate, the deployment can manually be fixed and requested to be restarted |
Deployment Operations
Management operations can be performed against a Deployment. Different management operations are available depending on the state of the deployment.
The following table lists the operations available.
| Operation | Description |
| Start | Powers on the resources in the deployment, adhering to its power on sequence |
| Stop | Powers off the resources in the deployment, adhering to its power off sequence |
| Terminate |
Powers off and removes all resources managed by the deployment Note: Linked existing resources (eg. security groups) and attached resources are not affected by this process as they were not created by the deployment |
| Attach Resource | Attaches an existing resource (created outside of a Broker appliance) to the deployment, to provide management operations - eg. power operations and console connectivity |
| Support Files | Downloads an encrypted archive of support files that can be sent to Buttonwood to aid in a support query |
| Retry Provisioning | Restarts a failed deployment |
Deployment Details
The Details screen is an interactive screen allowing end users to view and drill down into the resources within the deployment as well as any associated resources.
Summary
This section provides a summary of the number of resources in the deployment, as well as a traffic-light status indicator of resource states.
Lease
This section provides details of the deployment's lease such as lease period, total budget reserved, actual cost so far of running the resource, and the percentage of actual cost versus the total reservation.
The following changes can be made in this section by deployment owners and Broker administrators:
- Lease End: The date which the lease for the deployment ends
- Cost Centre: The Cost Centre where this deployment's charges are allocated
Resources / Other Resources
These sections lists the resources which are part of the deployment and provides details of the resource.
Depending on the resource type, clicking on the resource name drills further into the resource management view. Refer to the article Managing Resources for detailed steps in working with resources.
Some resources also allow operations to be performed against them - eg. creating a disk/volume snapshot. These actions appear as a drop down menu against the resource. Refer to the article Managing Resources for a list of supported operations of each resource type.
Deployment Details
This section provides a details of the deployment properties, such as name, description, environment, service provider, owner, etc.
The following changes can be made in this section by deployment owners and Broker administrators:
- Name and Description: The deployment's name and description
- Owner: The deployment's owner
- Termination Safeguard: The deployment-level Termination Safeguard policy configuration
Location
This section provides a map view of the location of all resources contained in the deployment.
Deployment Topology
The Topology tab shows a read-only version of the blueprint/catalog item at the time of deployment as well as the state of each node using a traffic light colour system.
Click the nodes to view its properties.
Deployment Hours of Operation
The Hours of Operation tab displays the configured hours of operation policy for the deployment.
Deployment owners and administrators have access to modify the hours of operations policy for the selected deployment.
Deployment Power Sequence
The Power Sequence tab displays the configured sequence that resources should be power on and powered off in.
By default, all resources are placed in a single power management group and would be powered on or off at the same time. By creating additional groups, deployment owners and administrators can ensure that certain resources are completely started before dependant resources are powered on. eg. Ensuring that a database server is started before a web and/or application server is started.
A request to stop a deployment will result in the deployment's resources being powered off in the reverse order of its configured power on sequence. This may be customised when required by using the Use custom power-off sequence option.
In cases where a resource's power operations shouldn't be managed, that resource can be dragged into the Exclusion Group.
Deployment Alerts
The Alerts tab displays any pending alerts for the selected deployment.
Deployment Logs
The Logs tab displays logged historical events for the selected deployment.
Deployment Notes
The Notes tab can be used to enter comments against the deployment.
Use the drop down menu to Edit or Remove existing notes.
Click Add to add new notes and set its importance.
Deployment Permissions
Permissions allow for deployment owners and administrators to control access to manage the deployment.
By default, no additional users are granted permissions to a deployment and only the deployment owner will have permissions.
Click Add if other users/groups require access. Granting users permissions to manage deployments will also populate the deployment in the user's My Deployments list.
Deployment Nodes
The Nodes tab lists the nodes and resources contained within a deployment and provides an overview of the orchestration events related to each node.
The information on this tab can be used to assist in troubleshooting deployment failures.
