Deployment approvals

Version history

It may be useful to require additional approvals before deploying to certain protected environments (for example, production). This pre-deployment approval requirement is useful to accommodate testing, security, or compliance processes that must happen before each deployment.

When a protected environment requires one or more approvals, all deployments to that environment become blocked and wait for the required approvals from the Allowed to Deploy list before running.

note
See the epic for planned features.

Requirements

Configure deployment approvals for a project

To configure deployment approvals for a project:

  1. Create a deployment job.
  2. Require approvals for a protected environment.

Create a deployment job

Create a deployment job in the .gitlab-ci.yml file of the desired project. The job does not need to be manual (when: manual).

Example: 

   stages:
     - deploy

   production:
     stage: deploy
     script:
       - 'echo "Deploying to ${CI_ENVIRONMENT_NAME}"'
     environment:
       name: ${CI_JOB_NAME}

Require approvals for a protected environment

There are two ways to configure the approval requirements:

  • Unified approval setting … You can define who can execute and approve deployments. This is useful when there is no separation of duties between executors and approvers in your organization.
  • Multiple approval rules … You can define who can execute or approve deployments. This is useful when there is a separation of duties between executors and approvers in your organization.
note
Multiple approval rules is a more flexible option than the unified approval setting, thus both configurations shouldn’t co-exist and multiple approval rules takes the precedence over the unified approval setting if it happens.

Unified approval setting

There are two ways to configure approvals for a protected environment:

  • Using the UI, set the Required approvals field to 1 or more.
  • Using the REST API, set the required_approval_count field to 1 or more.

After this is configured, all jobs deploying to this environment automatically go into a blocked state and wait for approvals before running. Ensure that the number of required approvals is less than the number of users allowed to deploy.

Example: 

curl --header 'Content-Type: application/json' --request POST \
     --data '{"name": "production", "deploy_access_levels": [{"group_id": 9899826}], "required_approval_count": 1}' \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/projects/22034114/protected_environments"
note
To protect, update, or unprotect an environment, you must have at least the Maintainer role.

Multiple approval rules

Version history
  • Using the REST API.
    • deploy_access_levels represents which entity can execute the deployment job.
    • approval_rules represents which entity can approve the deployment job.

After this is configured, all jobs deploying to this environment automatically go into a blocked state and wait for approvals before running. Ensure that the number of required approvals is less than the number of users allowed to deploy.

Example: 

curl --header 'Content-Type: application/json' --request POST \
     --data '{"name": "production", "deploy_access_levels": [{"group_id": 138}], "approval_rules": [{"group_id": 134}, {"group_id": 135, "required_approvals": 2}]}' \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/groups/128/protected_environments"

With this setup:

  • The operator group (group_id: 138) has permission to execute the deployment jobs to the production environment in the organization (group_id: 128).
  • The QA tester group (group_id: 134) and security group (group_id: 135) have permission to approve the deployment jobs to the production environment in the organization (group_id: 128).
  • Unless two approvals from security group and one approval from QA tester group have been collected, the operator group can’t execute the deployment jobs.
note
To protect, update, or unprotect an environment, you must have at least the Maintainer role.

Optional settings

Allow self-approval

Introduced in GitLab 15.8.

By default, a user who triggered a deployment pipeline can’t self-approve the deployment jobs. You can allow the self-approval by the following settings:

  1. On the top bar, select Main menu > Projects and find your project.
  2. On the left sidebar, select Settings > CI/CD.
  3. Expand Protected environments.
  4. From the Approval options, check Allow pipeline triggerer to approve deployment.

By enabling this, when a pipeline runs, deployment jobs will automatically be approved in the pipeline if the triggerer is allowed to approve, otherwise nothing happens.

Approve or reject a deployment

Introduced in GitLab 14.9

Using either the GitLab UI or the API, you can:

  • Approve a deployment to allow it to proceed.
  • Reject a deployment to prevent it.
note
GitLab administrators can approve or reject all deployments.

Approve or reject a deployment using the UI

Prerequisites:

  • Permission to deploy to the protected environment.

To approve or reject a deployment to a protected environment using the UI:

  1. On the top bar, select Main menu > Projects and find your project.
  2. On the left sidebar, select Deployments > Environments.
  3. Select the environment’s name.
  4. In the deployment’s row, select Approval options (). Before approving or rejecting the deployment, you can view the number of approvals granted and remaining, also who has approved or rejected it.
  5. Optional. Add a comment which describes your reason for approving or rejecting the deployment.
  6. Select Approve or Reject.

Approve or reject a deployment using the API

Prerequisites:

  • Permission to deploy to the protected environment.

To approve or reject a deployment to a protected environment using the API, pass the required attributes. For more details, see Approve or reject a blocked deployment.

Example: 

curl --data "status=approved&comment=Looks good to me" \
     --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/deployments/1/approval"

View the approval details of a deployment

Prerequisites:

  • Permission to deploy to the protected environment.

A deployment to a protected environment can only proceed after all required approvals have been granted.

To view the approval details of a deployment:

  1. On the top bar, select Main menu > Projects and find your project.
  2. On the left sidebar, select Deployments > Environments.
  3. Select the environment’s name.
  4. In the deployment’s row, select Approval options ().

The approval status details are shown:

  • Eligible approvers
  • Number of approvals granted, and number of approvals required
  • Users who have granted approval
  • History of approvals or rejections

How to see blocked deployments

Using the UI

  1. On the top bar, select Main menu > Projects and find your project.
  2. On the left sidebar, select Deployments > Environments.
  3. Select the environment being deployed to.
  4. Look for the blocked label.

Using the API

Use the Deployments API to see deployments.

  • The status field indicates if a deployment is blocked.
  • When the unified approval setting is configured:
    • The pending_approval_count field indicates how many approvals are remaining to run a deployment.
    • The approvals field contains the deployment’s approvals.
  • When the multiple approval rules is configured:
    • The approval_summary field contains the current approval status per rule.

For details about other GitLab features aimed at protecting deployments, see safe deployments.