Managing Deployments
When you manage deployments, you can filter the list of displayed deployments and start, stop, or edit deployments. When you edit a deployment, you can add additional stage libraries.
When needed, you can delete a deployment. You can also share deployments with other users and groups, as described in Permissions.
To upgrade an engine version, you must create a new deployment.
Filtering Deployments
In the Deployments view, you can filter the list of displayed deployments by type, state, tag, or engine type. You can also search for deployments by name.
Starting Deployments
Start a deployment when you want to launch engine instances for the deployment.
You can start a deployment when you create it, or you can start it at a later time.
When you start a new self-managed deployment, Control Hub generates the installation script that you run to install and launch engine instances. When you restart an existing self-managed deployment, existing engine instances belonging to that deployment are reactivated and can resume communicating with Control Hub.
When you start a Control Hub-managed deployment, Control Hub connects to the external system represented by the parent environment and automatically provisions the resources needed to run the engine type, ensuring that the resources meet engine requirements. Engine instances are then automatically deployed and launched on those resources.
You can start a deployment that is in the Deactivated or Deactivation Error state.
- In the Control Hub Navigation panel, click .
-
Select the deactivated deployments, and then click the
Start icon:
.
- Click OK to confirm.
Stopping Deployments
Stop a deployment when you want to temporarily prevent engine instances that belong to that deployment from running.
When you stop a self-managed deployment, running engine instances belonging to that deployment are deactivated and can no longer communicate with Control Hub.
When you stop a Control Hub-managed deployment, the provisioned resources in the external system are deleted.
- The deployment is in the Active or Activation Error state.
- No engine instances belonging to the deployment are currently running pipelines.
- In the Control Hub Navigation panel, click .
-
Select the active deployments, and then click the Stop
icon:
.
- Click OK to confirm.
Editing Deployments
You can edit deployments when they are in any state except for the transient Activating and Deactivating states.
When you edit an active self-managed deployment that updates most engine configuration properties, Control Hub prompts you to restart the engine instances for the changes to take effect.
You cannot change all properties when you edit a deployment. You must create a new deployment to change the following properties:
- Deployment type
- Environment that the deployment belongs to
- Engine version
To edit a deployment, locate the deployment in the Deployments view. In the
Actions column, click the More
icon ()
and then click Edit.
Updating Stage Libraries
Add stage libraries to a deployment when you want to use functionality provided by the stage library, such as a stage or credential store.
Remove stage libraries from a deployment when you no longer needed the stage library functionality.
To update stage libraries, you edit the deployment, then restart associated engines. During the restart, the added stage libraries are installed on the engine and the removed stage libraries are uninstalled from the engine.
Editing Engine Proxy Properties
When you edit a deactivated deployment, you can define proxy properties that configure engine instances to use a proxy server for outbound network requests.
Editing for Self-Managed Deployments
To define proxy properties for an existing self-managed deployment, you must shut down all engine instances associated with that deployment and then stop the deployment. After editing the deployment, you start the deployment again and then run the updated engine installation script that includes proxy properties defined as environment variables.
Editing for Cloud Service Provider Deployments
To define proxy properties for an existing cloud service provider deployment, such as an Amazon EC2 or GCE deployment, you must stop the deployment. When you stop a cloud service provider deployment, the provisioned resources in your cloud account are deleted.
After editing the deployment to modify the proxy properties, you start the deployment again. Control Hub provisions resources in the external system again, deploying and launching new engine instances that use the updated proxy properties.
Deleting Deployments
Delete a deployment when you no longer want the deployed engine instances to run pipelines.
Before you delete a self-managed deployment, shut down all engine instances belonging to that deployment. When you delete the self-managed deployment, the engine instances are deactivated and can no longer communicate with Control Hub. You must manually remove the engine installation files from the host machines.
When you delete a Control Hub-managed deployment, all resources provisioned for that deployment are deleted. For example, when you delete an Amazon EC2 deployment, all provisioned EC2 instances are deleted in addition to the AWS CloudFormation stack created for that deployment.
- The deployment is in the Setup Incomplete, Deactivated, or Deactivation Error state.
- No engine instances belonging to the deployment are currently running pipelines.