Configure your CI/CD Pipeline

NOTE

To learn how to configure CI/CD Pipeline for Cloud Manager in AEM as a Cloud Service, see here.

The following page explains how to configure the Pipeline. To review more conceptual information on how the pipeline works see the CI/CD pipeline overview.

Understanding the Flow

You can configure your pipeline from the Pipeline Settings tile in the Cloud Manager UI.

The Deployment Manager is responsible for setting up the pipeline. When doing so, you first select a branch from the Git Repository. Pipeline configuration consists of:

  • defining the trigger that will start the pipeline.
  • defining the parameters controlling the production deployment.
  • configuring the performance test parameters.

Video Tutorial

Configuring Pipeline in Cloud Manager

The CI/CD Production Pipeline configuration defines the trigger that will initiate the pipeline, parameters controlling the production deployment and performance test parameters.

Setting up the Pipeline

CAUTION

The pipeline cannot be setup until the Git repository has at least one branch and Program Setup is complete.

Before you start to deploy your code, you must configure your pipeline settings from the Cloud Manager.

NOTE

You can change the pipeline settings after initial set up.

Adding a New Production Pipeline from Pipelines Card

Once you have setup your program and have at least one environment using Cloud Manager UI, you are ready to add a production pipeline.

Follow these steps to configure the behavior and preferences for your production pipeline:

  1. Navigate to the Pipelines card from the Program Overview page.

  2. Click on +Add and select Add Production Pipeline.

  3. Add Production Pipeline dialog box displays.

    1. Enter the Pipeline Name. You can choose the Repository and the Git Branch.

    2. You can set up Deployment Trigger and Important Metric Failures Behavior from Deployment Options.

      You can assign the following deployment triggers to start the pipeline:

      • Manual - using the UI manually start the pipeline.
      • On Git Changes - starts the CI/CD pipeline whenever there are commits added to the configured git branch. Even if you select this option, you can always start the pipeline manually.

      During pipeline setup or edit, the Deployment Manager has the option of defining the behavior of the pipeline when an important failure is encountered in any of the quality gates.

      This is useful for customers who have the desire for more automated processes. The available options are:

      • Ask every time - This is the default setting and requires manual intervention on any Important failure.
      • Fail Immediately - If selected, the pipeline will be cancelled whenever an Important failure occurs. This is essentially emulating a user manually rejecting each failure.
      • Continue immediately - If selected, the pipeline will proceed automatically whenever an Important failure occurs. This is essentially emulating a user manually approving each failure.
    3. Select the Deployment Options.

      • Approve after Stage Deployment functions similarly to the approval before the production deployment, but occurs immediately after the stage deployment step,that is, before any testing is done, compared with the approval before the production deployment, which is done after all testing is complete.

      • Skip Load Balancer changes skips the changes.

    4. Select the Dispatcher Configuration for Stage. Enter the path, select the action from Type, and click Add Path. You can specify up to 100 paths per environment.

    5. Select the Deployment Options for Production. Now you define the parameters controlling the production deployment.

      The three available options are as follows:

      • Use Go Live Approval - A deployment must be manually approved by a business owner, project manager, or deployment manager via the Cloud Manager UI.

      • Scheduled - This option allows the user to enable the scheduled production deployment.

        NOTE

        If Scheduled option is selected, you can schedule your production deployment to the pipeline after the stage deployment (and Use GoLive Approval, if that has been enabled) to wait for a schedule to be set. The user can also choose to execute the production deployment immediately.

        Please refer to Deploy your Code, to set the deployment schedule or execute the production immediately.

        • Use CSE Oversight - A CSE is engaged to actually start the deployment. During pipeline setup or edit when CSE Oversight is enabled, the Deployment Manager has the option of selecting:

          • Any CSE: refers to any available CSE
          • My CSE: refers to a specific CSE assigned to the customer or their backup, if the CSE is out of the office
    6. Setup the Dispatcher Configurations for Production. Enter the path, select the action from Type, and click Add Path. You can specify up to 100 paths per environment.

      As a Deployment Manager, you have the opportunity to configure a set of content paths which will either be invalidated or flushed from the AEM Dispatcher cache for publish instances, while setting up or editing pipeline.

      You can configure a separate set of paths for Stage and Production deployment. If configured, these cache actions will be performed as part of the deployment pipeline step, just after any content packages are deployed. These settings use standard AEM Dispatcher behavior - invalidate performs a cache invalidation, similar to when content is activated from author to publish; flush performs a cache deletion.

      In general, the use of the invalidate action is preferable but there may be cases where flushing is required, especially when using AEM HTML Client Libraries.

      NOTE

      Please refer to Dispatcher Overview get more information on Dispatcher caching.

  4. Click on Continue once you have selected all the options.

  5. Select your options from the Stage Testing step. You can configure AEM Sites and AEM Assets Performance Testing, depending on which products you have licensed. Refer to Performance Testing for more details.

    1. Select your options from Sites Content Delivery/Distributed Load Weight. See AEM Sites in Performance Testing for more details.

    2. Select your options from Assets Performance Testing Distribution. See AEM Assets in Performance Testing for more details.

  6. Click on Save to complete adding production pipeline.

Editing a Production Pipeline

You can edit the pipeline configurations from the Program Overview page.

Follow the steps below to edit the configured pipeline:

  1. Navigate to Pipelines card from the Program Overview page.

  2. Click on from the Pipelines card and click on Edit, as shown in the figure below.

  3. The Edit Production Pipeline dialog box displays.

    1. The Configuration tab allows you to update the Pipeline Name, Repository, Git Branch, Deployment Trigger, Important Metrics Failure Behavior, Deployment Options and Dispatcher Configurations.

      NOTE

      See Adding and Managing Repositories to learn how to add and manage repositories in Cloud Manager.

    2. The Stage Testing tab provides you an option to re-select your options from Sites Content Delivery/Distributed Load Weight and Assets Performance Testing Distribution.

  4. Click on Update once you are done editing the pipeline.

Additional Production Pipeline Actions

Running a Production Pipeline

You can run the production pipeline from the Pipelines card:

  1. Navigate to Pipelines card from the Program Overview page.

  2. Click on from the Pipelines card and click on Run, as shown in the figure below.

Deleting a Production Pipeline

You can delete the production pipeline from the Pipelines card:

  1. Navigate to Pipelines card from the Program Overview page.

  2. Click on from the Pipelines card and click on Delete, as shown in the figure below.

    NOTE

    A user in Deployment Manager role can now delete Production pipeline in a self-service manner via the Delete option from the Pipeline card.

Non-Production & Code Quality Only Pipelines

In addition to the main pipeline which deploys to stage and production, customers are able to set up additional pipelines, referred to as Non-Production Pipelines. These pipelines always execute the build and code quality steps. They can optionally also deploy to Adobe Managed Services environment.

Video Tutorial

Cloud Manager Non-Production & Code Quality Only Pipelines

CI/CD Non-production pipelines are broken into two categories, Code Quality pipelines, and Deployment pipelines. Code Quality pipelines all code from a Git branch to build and be evaluated against Cloud Manager’s code quality scan.

Adding a Non-Production Pipeline

On the home screen, these pipelines are listed in a new card:

  1. Access the Pipelines card from the Cloud Manager home screen. Click on +Add and select Add Non-Production Pipeline.

  2. Add Non-Production Pipeline dialog box displays. Select the type of pipeline you want to create, either Code Quality Pipeline or Deployment Pipeline.

    Additionally, you can also set up Deployment Trigger and Important Metric Failures Behavior from Deployment Options. Click on Continue.

  3. The newly created non-production pipeline now displays in the Pipelines card.

    The pipeline is shown on the card on the home screen with three actions, as shown below:

    • Add - allows adding of a new pipeline.
    • Access Repo Info - allows the user to get the information necessary to access Cloud Manager Git repository.
    • Learn More - navigates to understanding the CI/CD pipeline documentation resource.

Editing a Non-Production Pipeline

You can edit the pipeline configurations from the Pipelines card from Program Overview page.

Follow the steps below to edit the configured non-production pipeline:

  1. Navigate to Pipelines card from the Program Overview page.

  2. Select the non-production pipeline and click on . Click on Edit, as shown in the figure below.

  3. The Edit Production Pipeline dialog box displays that allows you to update the Pipeline Name, Repository, Git Branch, Deployment Trigger, and Important Metrics Failure Behavior.

    NOTE

    See Adding and Managing Repositories to learn how to add and manage repositories in Cloud Manager.

    You can assign the following deployment triggers to start the pipeline:

    • Manual - using the UI manually start the pipeline.
    • On Git Changes - starts the CI/CD pipeline whenever there are commits added to the configured git branch. Even if you select this option, you can always start the pipeline manually.

    During pipeline setup or edit, the Deployment Manager has the option of defining the behavior of the pipeline when an important failure is encountered in any of the quality gates. This is useful for customers who have the desire for more automated processes. The available options are:

    • Ask every time - This is the default setting and requires manual intervention on any Important failure.
    • Fail Immediately - If selected, the pipeline will be cancelled whenever an Important failure occurs. This is essentially emulating a user manually rejecting each failure.
    • Continue immediately - If selected, the pipeline will proceed automatically whenever an Important failure occurs. This is essentially emulating a user manually approving each failure.
  4. Click on Update once you are done editing the non-production pipeline.

Additional Non-Production Pipeline Actions

Running a Non-Production Pipeline

You can run the production pipeline from the Pipelines card:

  1. Navigate to Pipelines card from the Program Overview page.

  2. Click on from the Pipelines card and click on Run, as shown in the figure below.

Deleting a Non-Production Pipeline

You can delete the production pipeline from the Pipelines card:

  1. Navigate to Pipelines card from the Program Overview page.

  2. Click on from the Pipelines card and click on Delete, as shown in the figure below.

The Next Steps

Once you have configured the pipeline, you need to deploy your code.

Please see Deploy your Code for more details.

On this page