Managing Environments

Learn about the types of environments you can create and how to create them for your Cloud Manager project.

Environment Types

A user with the requisite permissions can create the following environment types (within the bounds of what is available to the specific tenant).

  • Production + Stage - The production and staging environments are available as a pair and are used for production and testing purposes, respectively.

  • Development - A development environment can be created for development as well as testing purposes and can be associated with non-production pipelines only.

  • Rapid Development - A rapid development environment (RDE) allows a developer to swiftly deploy and review changes, minimizing the amount of time needed to test features that are proven to work on a local development environment. Please see the rapid development environment documentation for details about how to use an RDE.

The capabilities of individual environments depend upon the solutions enabled in the program of the environment.

NOTE

Production and staging environments are only created as a pair. You can not create only a staging or only a production environment.

Adding an Environment

  1. Log into Cloud Manager at my.cloudmanager.adobe.com and select the appropriate organization.

  2. Click on the program for which you want to add an environment.

  3. From the Program Overview page, click on Add Environment on the Environments card to add an environment.

    Environments card

    • The Add Environment option is also available on the Environments tab.

      Environments tab

    • The Add Environment option may be disabled due to lack of permissions or depending on the licensed resources.

  4. In the Add environment dialog that appears:

    • Select an environment type.
      • The number of available/used environments is displayed in parentheses behind the environment type name.
    • Provide an environment Name.
    • Provide an environment Description.
    • Select a Primary region from the drop-down.
      • Note that this can not be changed after creation.
    • If you are adding a Production + Stage environment, you need to provide a environment name and description for both your production and staging environments.
      Add environment dialog
  5. Click Save to add the specified environment.

The Overview screen now displays your new environment in the Environments card. You can now set up pipelines for your new environment.

Environment Details

You can use the Environments card on the overview page to access an environments details in two ways.

  1. From the Overview page, click on the Environments tab at the top of the screen.

    Environments tab

    • Alternatively, click on the Show All button on the Environments card to jump directly to the Environments tab.

      Show all option

  2. The Environments opens and lists all environments for the program.

    The environments tab

  3. Click an environment in the list to reveal its details.

    Environment details

Alternatively, click the ellipsis button of the environment you want and then select View Details.

View environment details

NOTE

The Environments card only lists three environments. Click on the Show All button as described previously to see all environments of the program.

Accessing the Preview Service

Cloud Manager provides a preview service (delivered as an additional publish service) to each AEM as a Cloud Service environment.

Using the service you can preview a website’s final experience before it reaches the actual publish environment and is available publicly.

Upon creation, the preview service will have a default IP allow list applied to it, labeled Preview Default [<envId>], which blocks all traffic to the preview service. You must actively un-apply the default IP allow list from the preview service in order to enable access.

Preview service and its allow list

A user with requisite permissions must complete the following steps before sharing the preview service URL in order to ensure access to it.

  1. Create an appropriate IP allow list, apply it to the preview service, and immediately un-apply the Preview Default [<envId>] allow list.

  2. Use the update IP Allow List workflow to remove the default IP and add IPs as appropriate. Refer to Managing IP Allow Lists to learn more.

Once access to preview service is unlocked, the lock icon in front of the preview service name will no longer be displayed.

Once activated, you can publish content to the preview service by using the Manage Publication UI inside AEM. Please refer to the document Previewing Content for more details.

NOTE

Your environment must be on AEM version 2021.05.5368.20210529T101701Z or newer to use the preview service. Make sure an update pipeline has successfully run on your environment to do this.

Updating Environments

As a cloud-native service, updates of your staging and production environments within production programs are automatically managed by Adobe.

However updates to development environments as well as to environments in sandbox programs are managed within the programs. When such an environment is not running the latest publicly available AEM version, the status on the Environments card on the Overview screen of the program will show Update Available.

Environment update status

Updates and Pipelines

Pipelines are the only way to deploy code to the environments of AEM as a Cloud Service. For this reason, each pipeline is associated with a particular AEM version.

If Cloud Manager detects that there is a newer version of AEM available than that which was last deployed with the pipeline, it shows the Update Available status for the environment.

The process of updating is therefore a two-step process:

  1. Updating the pipeline with the latest AEM version
  2. Running the pipeline to deploy the new version of AEM to an environment

Updating Your Environments

The Update option is available from the Environments card for development environments and environments in sandbox programs by clicking on the ellipsis button of the environment.

Update option from Environments card

This option is also available by clicking on the Environments tab of the program and then selecting the ellipsis button of the environment.

Update option from Environments tab

A user with the Deployment Manager role can use this option to update the pipeline associated with this environment to the latest AEM version.

Once the pipeline version is updated to the latest publicly available AEM version, the user is prompted to run the associated pipeline to deploy the latest version to the environment.

Prompt to run pipeline to update environment

The Update option’s behavior varies depending on the configuration and current state of the program.

  • If the pipeline has already been updated, the Update option prompts the user to execute the pipeline.
  • If the pipeline is already being updated, the Update option informs the user that an update is already running.
  • If an appropriate pipeline does not exits, the Update option prompts the user to create one.

Deleting Development Environments

User with the requisite permissions will be able to delete a development environment.

From the Overview screen of the program on the Environments card, click on the ellipsis button of the development environment you want to delete.

The delete option

The delete option is also available from the Environments tab of the Overview window of the program. Click on the ellipsis button of the environment and select Delete.

The delete option from the Environments tab

NOTE
  • Production and staging environments created in a production program can not be deleted.
  • Production and staging environments in a sandbox program can be deleted.

Managing Access

Select Manage Access from the ellipsis menu of the environment on the Environments card. You can navigate to the author instance directly and manage access for your environment.

Manage access option

Accessing the Developer Console

Select Developer Console from the ellipsis menu of the environment on the Environments card. This will open a new tab in your browser with the login page to the Developer Console.

Only a user with the Developer role will have access to the Developer Console. However for sandbox programs, any user with access to the sandbox program will have access to Developer Console.

Please refer to the document Hibernating and De-hibernating Sandbox Environments for more details.

This option is also available from the Environment tab of the Overview window when clicking the ellipsis menu of an individual environment.

Login Locally

Select Local Login from the ellipsis menu of the environment in the Environments card to login locally to Adobe Experience Manager.

Login locally

Additionally, you can login locally from the Environments tab of the Overview page.

Login locally from Environments tab

Managing Custom Domain Names

Custom domain names are supported in Cloud Manager for Sites programs for both publish and preview services. Each Cloud Manager environment can host up to a maximum of 250 custom domains.

To configure custom domain names, navigate to the Environments tab and click on an environment to view environment details.

Environment details

The following actions can be performed on the publish service for your environment.

Managing IP Allow Lists

IP allow lists are supported in Cloud Manager for author, publish, and preview services for Sites programs.

To manage IP allow lists, navigate to the Environments tab of the Overview page of your program. Click on an individual environment to manage its details.

Applying an IP Allow List

Applying an IP allow list associates all IP ranges included in the definition of the allow list with an author or publish service in an environment. A user in the Business Owner or Deployment Manager role must be logged in in order to be able to apply an IP allow list.

The IP allow list must exist in Cloud Manager in order to apply it to an environment. To learn more about IP allow lists in Cloud Manager please refer to the documentIntroduction to IP Allow Lists in Cloud Manager.

Follow these steps to apply an IP allow list.

  1. Navigate to the specific environment from the Environments tab of the program Overview screen and navigate to the IP Allow Lists table.
  2. Use the input fields at the top of the IP allow list table to select the IP allow list and the author or publish service you wish to apply it to.
  3. Click on Apply and confirm your submission.

Un-Applying an IP Allow List

Un-applying an IP allow list disassociates all IP ranges included in the definition of the allow list from an author or publisher service in an environment. A user in the Business Owner or Deployment Manager role must be logged in in order to be able to un-apply an IP allow list.

Follow these steps to un-apply an IP allow list.

  1. Navigate to the specific environment from the Environments tab of the program Overview screen and navigate to the IP Allow Lists table.
  2. Identify the row where the IP allow list rule you wish to un-apply is listed.
  3. Select the ellipsis button from end of the row.
  4. Select Unapply and confirm your submission.

On this page