Manage Environments

By default, all projects created in the cloud data planes (irrespective of the data plane region) are provisioned with two environments (i.e., development and production).

The environments are listed in the order of deployment and promotion. The initial deployment takes place in the first environment and you can proceed to promote a component to subsequent environments.

Create a new environment

Prerequisites

• To create additional environments, you must have a Choreo subscription or a private data plane.
• To create a new environment in a private data plane organization, you must have the ENVIRONMENT-MANAGEMENT permission. By default, ENVIRONMENT-MANAGEMENT permission is granted to Admin and Choreo DevOps roles.

To create a new environment, follow the steps given below:

1. Sign in to the Choreo Console and switch to the organization where you want to create a new project.
2. In the left navigation menu, click DevOps and then click Environments (note that this is the Environments page under your organization, not your projects).

3. On the Environments page, click Create and specify the following details to create a new environment:

   • Name: A display name for the new environment.

   • Data Plane - The data plane to create the new environment.

     Tip

     The Data Plane list displays all the private data planes registered under your organization.

   • DNS Prefix: A DNS prefix to identify the exposed APIs in the environment. Here, the base domain depends on the custom domain attached to the API gateways provisioned on the selected data plane.

   • Mark environment as a Production environment: Select if you want this environment to be a production environment.

     Tip

     In Choreo, you can have multiple non-production and production environments. To work in a production environment, you must have privileged permissions to access and deploy to production environments.

Change the order of promotion

The order in which environments are listed on the Environments page is the same order in which promotion takes place.

To change the order of promotion across environments in an organization, follow the steps given below:

1. Sign in to the Choreo Console and switch to the organization for which you want to change the order of promotion.
2. In the left navigation menu, click DevOps and then click Environments.

3. On the Environments page, click and drag environment list items to rearrange the order of listed environments.

   Note

   Although changes to the order of promotion for environments are applied immediately, the change does not affect the components already running in environments. Only subsequent builds and promotions will follow the new order.

To see the changes, go to the Deploy page of a component (in any project).

Delete an environment

To delete an environment, follow the steps given below:

Warning

Environment deletion is a permanent, non-reversible operation.

1. Sign in to the Choreo Console and switch to your organization.
2. In the left navigation menu, click DevOps and then click Environments.
3. In the Environments list, click the delete icon corresponding to the environment you want to delete. This displays a confirmation dialog with details on the impact of deletion.
4. Review the details, then type the environment name to confirm the deletion.
5. Click Delete.