2019-09-04 21:01:54 +05:30
|
|
|
---
|
|
|
|
|
type: concepts, howto
|
|
|
|
|
---
|
|
|
|
|
|
2019-09-30 21:07:59 +05:30
|
|
|
# Protected Environments **(PREMIUM)**
|
2019-07-07 11:18:12 +05:30
|
|
|
|
2020-03-09 13:42:32 +05:30
|
|
|
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6303) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.3.
|
2019-07-07 11:18:12 +05:30
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
|
|
|
|
|
[Environments](../environments.md) can be used for different reasons:
|
|
|
|
|
|
|
|
|
|
- Some of them are just for testing.
|
|
|
|
|
- Others are for production.
|
|
|
|
|
|
2019-07-31 22:56:46 +05:30
|
|
|
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.
|
2019-07-07 11:18:12 +05:30
|
|
|
|
|
|
|
|
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](../../user/permissions.md).
|
|
|
|
|
|
|
|
|
|
## Protecting environments
|
|
|
|
|
|
|
|
|
|
To protect an environment:
|
|
|
|
|
|
|
|
|
|
1. Navigate to your project's **Settings > CI/CD**.
|
|
|
|
|
1. Expand the **Protected Environments** section.
|
|
|
|
|
1. From the **Environment** dropdown menu, select the environment you want to protect.
|
2019-07-31 22:56:46 +05:30
|
|
|
1. 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.
|
2019-07-07 11:18:12 +05:30
|
|
|
1. Click the **Protect** button.
|
|
|
|
|
|
|
|
|
|
The protected environment will now appear in the list of protected environments.
|
|
|
|
|
|
|
|
|
|
## Modifying and unprotecting environments
|
|
|
|
|
|
|
|
|
|
Maintainers can:
|
|
|
|
|
|
2019-07-31 22:56:46 +05:30
|
|
|
- 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.
|
2019-09-04 21:01:54 +05:30
|
|
|
|
|
|
|
|
<!-- ## Troubleshooting
|
|
|
|
|
|
|
|
|
|
Include any troubleshooting steps that you can foresee. If you know beforehand what issues
|
|
|
|
|
one might have when setting this up, or when something is changed, or on upgrading, it's
|
|
|
|
|
important to describe those, too. Think of things that may go wrong and include them here.
|
|
|
|
|
This is important to minimize requests for support, and to avoid doc comments with
|
|
|
|
|
questions that you know someone might ask.
|
|
|
|
|
|
|
|
|
|
Each scenario can be a third-level heading, e.g. `### Getting error message X`.
|
|
|
|
|
If you have none to add when creating a doc, leave this section in place
|
|
|
|
|
but commented out to help encourage others to add to it in the future. -->
|
