Deployment management
A TypeDB Cloud deployment is a TypeDB Enterprise cluster that TypeDB Cloud manages.
A deployment can be created and destroyed in the TypeDB Cloud. While it exists, it can be suspended and resumed.
Most of the deployment life-cycle functions are available from the Deployments page.
The page includes a list of the deployments in the currency active organization that the current user can access.
The list has some built-in functions:
-
filtering
-
sorting
-
pagination
Create a new deployment
By creating a deployment, we create a cluster of TypeDB Enterprise servers, managed by TypeDB Cloud service and hosted in a cloud environment.
To create a new deployment, use the following steps:
-
Select an Organization to create a deployment in.
-
Open the Deployments page from the navigation menu on the left.
-
Click the Create button in the top toolbar.
-
Use the Create new deployment form to provide the required information:
-
Deployment ID — enter the new deployment’s unique (in the project scope) name.
-
Select location — select the zone to deploy. Each zone named after the respective cloud provider and geographic location (E.g., AWS EU West 2).
-
Select project — select one of the projects available to you to deploy.
-
Select servers — select a number of servers in the TypeDB Enterprise cluster for this deployment.
-
-
Click the Submit button.
Show deployment details
To open a Deployment Details page:
-
Select the Organization with the deployment.
-
Open the Deployments page from the navigation menu on the left.
-
Select the deployment to see the details from the list and click on it.
Suspend a deployment
Suspended deployment will not consume computation resources but will use storage space.
To suspend a running deployment use the following steps:
-
Select the Organization with the deployment.
-
Open the Deployments page from the navigation menu on the left.
-
Select the deployment or deployments to suspend by ticking the checkbox in the respective lines on the left.
-
Click Suspend button at the top toolbar.
-
Confirm suspension by clicking the Confirm button in the confirmation window.
-
Select the Organization with the deployment.
-
Open the Deployments page from the navigation menu on the left.
-
Select the deployment to suspend by clicking on it.
-
Click the Suspend button at the top right toolbar.
-
Confirm suspension by clicking the Confirm button in the confirmation window.
Resume a deployment
To resume a suspended deployment:
-
Select the Organization with the deployment.
-
Open the Deployments page from the navigation menu on the left.
-
Select the deployment or deployments to resume by ticking the checkbox in the respective lines on the left.
-
Click the Resume button at the top toolbar.
-
Confirm resuming by clicking the Confirm button in the confirmation window.
-
Select the Organization with the deployment.
-
Open the Deployments page from the navigation menu on the left.
-
Select the deployment to resume by clicking on it.
-
Click the Resume button at the top right toolbar.
-
Confirm resuming by clicking the Confirm button in the confirmation window.
Destroy a deployment
To destroy a Deployment means to suspend it and then delete all its data.
|
This action is irreversible and all information stored in the deployment will be lost. |
To destroy a deployment use the following steps:
-
Select the Organization with the deployment.
-
Open the Deployments page from the navigation menu on the left.
-
Select the deployment or deployments to destroy by ticking the checkbox in the respective lines on the left.
-
Click Destroy button at the top toolbar.
-
Confirm destruction by clicking the Confirm button in the confirmation window.
-
Select the Organization with the deployment.
-
Open the Deployments page from the navigation menu on the left.
-
Select the deployment to destroy by clicking on it.
-
Click the Destroy button at the bottom of the page.
-
Confirm destruction by clicking the Destroy button in the confirmation window.