gitlab-org--gitlab-foss/doc/ci/environments/protected_environments.md
2019-04-28 23:13:52 +00:00

2 KiB

Protected Environments [PREMIUM]

Introduced in GitLab Premium 11.3.

Overview

Environments can be used for different reasons:

  • Some of them are just for testing.
  • Others are for production.

Since deploy jobs can be raised by different users with different roles, it is important that specific environments are "protected" to prevent unauthorized people from affecting them.

By default, a protected environment does one thing: it ensures that only people with the right privileges can deploy to it, thus keeping it safe.

NOTE: Note: A GitLab admin is always allowed to use environments, even if they are protected.

To protect, update, or unprotect an environment, you need to have at least Maintainer permissions.

Protecting environments

To protect an environment:

  1. Navigate to your project's Settings > CI/CD.
  2. Expand the Protected Environments section.
  3. From the Environment dropdown menu, select the environment you want to protect.
  4. In the Allowed to Deploy dropdown menu, select the role, users, or groups you want to give deploy access to. Keep in mind that:
    • There are two roles to choose from:
      • Maintainers: will allow access to all maintainers in the project.
      • Developers: will allow access to all maintainers and all developers in the project.
    • You can only select groups that are already associated with the project.
    • Only users that have at least Developer permission level will appear in the Allowed to Deploy dropdown menu.
  5. Click the Protect button.

The protected environment will now appear in the list of protected environments.

Modifying and unprotecting environments

Maintainers can:

  • Update existing protected environments at any time by changing the access in the Allowed to Deploy dropdown menu.
  • Unprotect a protected environment by clicking the Unprotect button for that environment.