Commit da37f5a0 authored by Marcel Amirault's avatar Marcel Amirault Committed by Evan Read

Docs: Environments Documentation review

parent 05cad997
This diff is collapsed.
...@@ -9,8 +9,8 @@ ...@@ -9,8 +9,8 @@
- Some of them are just for testing. - Some of them are just for testing.
- Others are for production. - Others are for production.
Because deploy jobs can be raised by different users with different roles, it is important that Since deploy jobs can be raised by different users with different roles, it is important that
specific environments are "protected" to avoid unauthorized people affecting them. specific environments are "protected" to prevent unauthorized people from affecting them.
By default, a protected environment does one thing: it ensures that only people 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. with the right privileges can deploy to it, thus keeping it safe.
...@@ -28,14 +28,14 @@ To protect an environment: ...@@ -28,14 +28,14 @@ To protect an environment:
1. Navigate to your project's **Settings > CI/CD**. 1. Navigate to your project's **Settings > CI/CD**.
1. Expand the **Protected Environments** section. 1. Expand the **Protected Environments** section.
1. From the **Environment** dropdown menu, select the environment you want to protect. 1. From the **Environment** dropdown menu, select the environment you want to protect.
1. In the **Allowed to Deploy** dropdown menu, select the role, users, or groups you want to have deploy access. 1. In the **Allowed to Deploy** dropdown menu, select the role, users, or groups you
There are some considerations to have in mind: want to give deploy access to. Keep in mind that:
- There are two roles to choose from: - There are two roles to choose from:
- **Maintainers**: will allow access to all maintainers in the project. - **Maintainers**: will allow access to all maintainers in the project.
- **Developers**: will allow access to all maintainers and all developers in the project. - **Developers**: will allow access to all maintainers and all developers in the project.
- You can only select groups that are associated with 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 on - Only users that have at least Developer permission level will appear in
the **Allowed to Deploy** dropdown menu. the **Allowed to Deploy** dropdown menu.
1. Click the **Protect** button. 1. Click the **Protect** button.
The protected environment will now appear in the list of protected environments. The protected environment will now appear in the list of protected environments.
...@@ -44,5 +44,6 @@ The protected environment will now appear in the list of protected environments. ...@@ -44,5 +44,6 @@ The protected environment will now appear in the list of protected environments.
Maintainers can: Maintainers can:
- Update existing protected environments at any time by changing the access on **Allowed to deploy** dropdown menu. - Update existing protected environments at any time by changing the access in the
- Unprotect a protected environment by clicking the **Unprotect** button of the environment to unprotect. **Allowed to Deploy** dropdown menu.
- Unprotect a protected environment by clicking the **Unprotect** button for that environment.
doc/ci/img/deployments_view.png

22.8 KB | W: | H:

doc/ci/img/deployments_view.png

57.1 KB | W: | H:

doc/ci/img/deployments_view.png
doc/ci/img/deployments_view.png
doc/ci/img/deployments_view.png
doc/ci/img/deployments_view.png
  • 2-up
  • Swipe
  • Onion skin
doc/ci/img/environments_available.png

8.27 KB | W: | H:

doc/ci/img/environments_available.png

19.9 KB | W: | H:

doc/ci/img/environments_available.png
doc/ci/img/environments_available.png
doc/ci/img/environments_available.png
doc/ci/img/environments_available.png
  • 2-up
  • Swipe
  • Onion skin
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment