Information for: DEVELOPERS   PARTNERS

Managing Acquia Cloud CD environments

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

CD environments are built dynamically and are similar to regular Drupal-based environments.

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

By default, Acquia Cloud CD includes five CD environments for your use. If you need more 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 user interface

The Acquia Cloud user interface allows users with the Add an environment and Delete an environment permissions to 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 as a user with the Add an environment permission.

  2. Select the application in which you want to create a CD environment. To determine if an application already contains a CD environment, examine the application’s card as displayed in the following example:

    Number of CD environments

  3. From your subscription’s action icons, click Add Environment Add environment icon.

    If your application doesn’t have any environments, Acquia Cloud will display an Add environment button on the page.

  4. In the dialog box, enter a label in Enter a label for the new environment.

    Note

    To prevent confusion, Acquia strongly recommends you label this environment as a temporary environment.

  5. Click Continue. Acquia Cloud displays an Add environment dialog box.

    Select a branch

  6. In the Select branch list, click the branch you want to deploy to your Acquia Cloud CD environment.

  7. Click Continue.
    If you have more than three databases in your environment, Acquia Cloud will display a dialog box labeled Select up to 3 databases.

  8. Select the check boxes next to the database schemas you want to add to the environment, up to a maximum of three schemas.

  9. Click Continue.
    Acquia Cloud displays a dialog box to confirm your choices and display the number of remaining CD environments.

  10. Click Add environment.

Acquia Cloud will begin to create your CD environment. You can review 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, use the following steps to delete the environment from Acquia Cloud:

  1. Sign in to Acquia Cloud as a user with the Delete an environment permission

  2. 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:

      Delete a CD environment

    • From your environment’s action icons, click the Remove icon Delete an environment.

  3. In the dialog box, click Remove.

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

Managing your environments with 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

Important

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"
post-deploy:
  steps:
    - 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 Acquia Cloud API v2

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

https://cloudapi-docs.acquia.com/

Acquia Cloud API access note

Visit the Acquia Cloud API documentation page for information about authenticating to the API, including generating an API token and authenticating requests.

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 Acquia Cloud API v2 documentation.