Managing Cloud Platform CD environments | Cloud Platform

To give increased production-ready deployment speed, reliability, and cost efficiency, Cloud Platform CD enables developer teams to create and work in multiple development environments, and remove those on-demand environments when developer teams no longer require them. Created CD environments persist until you delete them.

CD environments are built dynamically and are similar to regular Drupal-based environments. For more information on CD environments, see:

Cloud Platform CD environment entitlements vary by subscription type. Contact your Acquia account team if you have questions about the Cloud Platform CD environments included with your subscription:

Managing your environments with the Cloud Platform user interface
Managing your environments with Pipelines
Managing your environments with Cloud Platform API v2

If you need more CD environments, contact your Account Manager.

Managing your environments with the Cloud Platform user interface¶

The Cloud Platform user interface allows users with the Add an environment and Delete an environment permissions to add and remove CD environments from your application.

Adding an environment with the user interface¶

To add a CD environment to your subscription:

Sign in to the Cloud Platform user interface as a user with the Add an environment permission.
Select the application in which you want to create a CD environment. To find if an application already has a CD environment, examine the application’s card as displayed in the following example:
Click Actions > Add CD Environment.

If your application doesn’t have any environments, Cloud Platform displays an Add environment button on the page.
In Enter a label for the new environment, enter a label for this environment. Acquia strongly recommends you label this environment as a temporary environment.
Click Continue.
Cloud Platform displays the Add Environment dialog box.
In the Select branch list, click the branch you want to deploy to your Cloud Platform CD environment.
Click Continue.
If you have more than three databases in your environment, Cloud Platform displays the Select up to 3 databases dialog box.
Select the checkboxes next to the database schemas you want to add to the environment, up to a maximum of three schemas.
Click Continue.
Cloud Platform displays a dialog box to confirm your choices and display the number of remaining CD environments.
Click Add environment.

Cloud Platform creates your CD environment. You can review the environment’s creation status in the activity notifications section of the interface. You can configure the settings for your new CD environment in the configuration settings.

Deleting an environment with the user interface¶

When you no longer need a CD environment, use the following steps to delete the environment from Cloud Platform:

Sign in to the Cloud Platform user interface as a user with the Delete an environment permission
Use one of the following methods for the CD environment you want to remove:
- Click the Trash can icon for the environment you want to remove, as displayed in the following example:
- From your environment’s action icons, click the Remove icon.
In the dialog box, type CONFIRM, and then click Remove.

After Cloud Platform completes the removal process, the CD environment is no longer available for your use.

Managing your environments with Pipelines¶

Using Pipelines, Cloud Platform CD allows you to create or remove CD environments as instructions in an executed build definition file. To create or remove a CD environment during a pipeline job, use the pipelines-deploy command.

Creating a CD environment with Pipelines
Removing a CD environment with Pipelines
Copying files to an on-demand environment

Important

You can’t run the pipelines-deploy command inside the build event.
For more information about building and using build definition files, see Creating and managing your build definition file.

Creating a CD environment with Pipelines¶

To create a CD environment, place the pipelines-deploy instruction in the build element, similar to the following example:

build:
  steps:
    - build_site:
          script:
            - echo "Build instructions here"
post-deploy:
  steps:
    - deploy:
            script:
            - pipelines-deploy

Note

If you receive a failure notice for your deployment, review the Cloud CD known issues.

Removing a CD environment with Pipelines¶

To remove a CD environment, place the pipelines-deploy instruction in either the pr-merged or pr-closed elements, similar to the following examples:

pr-merged:
  steps:
     - deploy:
          script:
             - pipelines-deploy

pr-closed:
     steps:
      - deploy:
           script:
                - pipelines-deploy

Managing your environments with Cloud Platform API v2¶

The Cloud Platform API provides a REST API you can use to manage your CD environments, and monitor the progress of ongoing tasks.

The API includes the following methods you can use with your CD environments:

For information about authenticating to the API, including generating an API token, authenticating requests, and available endpoints, visit the Cloud Platform API documentation.