Managing on-demand CD environments

To provide increased production-ready deployment speed, reliability, and cost efficiency, Acquia Cloud CD enables developer teams to create and work in test environments on-demand, and then remove those on-demand, development environments when they're no longer required.

CD environments are built dynamically and are very similar to regular Drupal-based environments. The most notable difference between CD and regular Drupal-based environments is that CD environments have orange headers for the Code, Databases, and Files cards, instead of the regular blue headers. For more information about how CD environments are different from regular environments, including limitations for their use, see CD environment resources and limitations.

CD environment

Created CD environments will persist until you delete them. For additional information about what CD environments contain, see the following:

At its initial level, Acquia Cloud CD includes five CD environments for your use. If you need additional CD environments, contact your Account Manager.

You can use any of the following methods to add or remove CD environments from your Acquia Cloud application:

Managing your environments with the Acquia Cloud interface

The Acquia Cloud interface allows you to both add and remove CD environments from your application,
as required.

Adding an environment with the user-interface

To add a CD environment to your subscription, complete the following steps:

  1. Sign in to Acquia Cloud, and then select the application in which you want to create a CD environment.
  2. From your subscription's action icons, click the Add Environment icon. Add environment icon
  3. In the dialog box, add a label in Enter a label for the new environment.
  4. Click Continue.
    Acquia Cloud displays an Add environment dialog box.

    Select a branch

  5. In the Select branch list, select the branch you want to deploy to your Acquia Cloud CD environment, and then click Continue.
  6. If you have more than three databases in your environment, Acquia Cloud will display a dialog box labeled Select up to 3 databases. Select the check boxes next to the database schemas that you want to add to the environment, up to a maximum of three.
  7. Click Continue.
    Acquia Cloud then displays a dialog box to both confirm your choices and display the number of remaining CD environments.
  8. Click Add environment.

Acquia Cloud will begin to create your CD environment. You can monitor the environment's creation status in the activity notifications section of the interface.

Deleting an environment with the user interface

When you are finished with a CD environment, it can be deleted from Acquia Cloud. To do this, complete the following steps:

  1. Sign in to Acquia Cloud, and then click the Trash can icon for the environment that you want to remove.
    Delete a CD environment
    Acquia Cloud displays a Remove cloned environment dialog box.
  2. In the dialog box, enter your password in the Enter your account password to confirm this action text field.
  3. Click Remove.

or

  1. Sign in to Acquia Cloud, and then select the CD environment that you want to remove.
  2. From your environment's action icons, click the Remove icon. Delete an environment
    Acquia Cloud displays a Remove cloned environment dialog box.
  3. In the dialog box, enter your password in the Enter your account password to confirm this action text field.
  4. Click Remove.

Acquia Cloud will begin the removal of the environment. The CD environment is no longer available for your use.

Managing your environments with CD pipelines

Using pipelines, Acquia Cloud 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 following script instruction:

- pipelines-deploy

For more information about building and using build definition files, see Creating and managing your build definition file.

Creating a CD environment with CD 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"
      - deploy:
          script:
            - pipelines-deploy

Removing a CD environment with CD 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 API v2

Version 2 of the Cloud API provides a REST API that you can use to manage your CD environments. You can view the list of available Cloud API calls at the following URL:

http://cloud.acquia.com/api-docs/cde/

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

Code Description
POST /api/applications/{uuid}/environments Create a CD environment for the {uuid} application
DELETE /api/environments/{id} Remove the {id} CD environment

For complete information about these and other methods, see the Cloud API v2 documentation.

Contact supportStill need assistance? Contact Acquia Support