Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
db367ede
Commit
db367ede
authored
Sep 06, 2018
by
Achilleas Pipinellis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Copyedit protected environments docs
parent
fccdb622
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
33 additions
and
41 deletions
+33
-41
doc/ci/README.md
doc/ci/README.md
+2
-1
doc/ci/environments/protected_environments.md
doc/ci/environments/protected_environments.md
+31
-40
No files found.
doc/ci/README.md
View file @
db367ede
...
@@ -68,6 +68,8 @@ learn how to leverage its potential even more.
...
@@ -68,6 +68,8 @@ learn how to leverage its potential even more.
-
[
Environments and deployments
](
environments.md
)
: Separate your jobs into
-
[
Environments and deployments
](
environments.md
)
: Separate your jobs into
environments and use them for different purposes like testing, building and
environments and use them for different purposes like testing, building and
deploying
deploying
-
[
Protected Environments
](
environments/protected_environments.md
)
: Ensure that only people
with the right privileges can deploy to an environment.
-
[
Job artifacts
](
../user/project/pipelines/job_artifacts.md
)
-
[
Job artifacts
](
../user/project/pipelines/job_artifacts.md
)
-
[
Caching dependencies
](
caching/index.md
)
-
[
Caching dependencies
](
caching/index.md
)
-
[
Git submodules
](
git_submodules.md
)
- How to run your CI jobs when Git
-
[
Git submodules
](
git_submodules.md
)
- How to run your CI jobs when Git
...
@@ -81,7 +83,6 @@ learn how to leverage its potential even more.
...
@@ -81,7 +83,6 @@ learn how to leverage its potential even more.
-
[
Deploy Boards
](
../user/project/deploy_boards.md
)
- Check the current health
-
[
Deploy Boards
](
../user/project/deploy_boards.md
)
- Check the current health
and status of each CI/CD environment running on Kubernetes
and status of each CI/CD environment running on Kubernetes
-
[
ChatOps
](
chatops/README.md
)
- Trigger CI jobs from chat, with results sent back to the channel.
-
[
ChatOps
](
chatops/README.md
)
- Trigger CI jobs from chat, with results sent back to the channel.
-
[
Protected Environments
](
environments/protected_environments.md
)
: Ensure that only people with right privileges can deploy code to an environment.
## GitLab CI/CD for Docker
## GitLab CI/CD for Docker
...
...
doc/ci/environments/protected_environments.md
View file @
db367ede
# Protected Environments
# Protected Environments
> [Introduced][6303] in [GitLab Premium][ee] 11.
2
.
> [Introduced][6303] in [GitLab Premium][ee] 11.
3
.
## Overview
## Overview
Environments can be used for different scopes, some of them are just for testing
[
Environments
](
../environments.md
)
can be used for different scopes, some of
while others are for production. As deploy jobs could be raised by different users
them are just for testing while others are for production. As deploy jobs could
with different roles, it is very important that specific environments are "protected"
be raised by different users with different roles, it is very important that
to avoid unauthorized people to affect them.
specific environments are "protected" to avoid unauthorized people to affect them.
By default
a protected environment does one simple thing: it ensures that only people
By default
, a protected environment does one thing: it ensures that only people
with
right privileges can deploy code to an environment,
keeping it safe.
with
the right privileges can deploy to it, thus
keeping it safe.
>
**Note**:
NOTE:
**Note**
:
A GitLab admin is always allowed to use environments, even if they are protected.
A GitLab admin is always allowed to use environments, even if they are protected.
To protect, update, or unprotect an environment,
To protect, update, or unprotect an environment,
you need to have at least
you need to have at least
[
Maintainer permission
][
perm
]
level
.
[
Maintainer permissions
](
../../user/permissions.md
)
.
## Configuring protected environments
## Configuring protected environments
1.
Navigate to your project's
**Settings ➔ CI/CD**
To protect an environment:
1.
Navigate to your project's
**Settings ➔ CI/CD**
.
1.
Scroll to find the
**Protected Environments**
section.
1.
Scroll to find the
**Protected Environments**
section.
1.
From the
**Environment**
dropdown menu, select the environment you want to protect and
1.
From the
**Environment**
dropdown menu, select the environment you want to protect and
click
**Protect**
. In the screenshot below, we chose the
`production`
environment
click
**Protect**
.
1.
From the 'Allowed to Deploy' dropdown menu, you can select the role and/or the users and/or the groups
1.
In the "Allowed to Deploy" dropdown menu, you can select the role and/or the
you want to have deploy access. In the screenshot below, we chose the 'maintainers'. role
users and/or the groups you want to have deploy access. There are some
considerations to have in mind:
![Protected Environment form](img/protected_environments_form.png)
-
There are two roles to choose from:
-
**Maintainers**
: will allow access to all maintainers in the project.
1.
Once done, the protected environment will appear in the "Protected Environments" list.
-
**Developers**
: will allow access to all maintainers and all developers in the project.
-
You can only select groups that are associated with the project.
![Protected Environment list](img/protected_environments_list.png)
-
Only users that have at least Developer permission level will appear on
the "Allowed to Deploy" dropdown menu.
For the 'Allowed to Deploy' dropdown, there are some considerations to have in mind:
1.
Once done, the protected environment will appear in the "Protected Environments"
-
There are two roles to choose from:
list.
-
*Maintainers*
- Will allow access to all maintainers in the project.
-
*Developers*
- Will allow access to all maintainers and all developers in the project.
Maintainers can update existing protected environments at any time
-
You can only select groups that are associated with the project.
by changing the access on "Allowed to Deploy" dropdown menu. Similarly,
-
Only users that have at least Developer permimssion level will appear on the 'Allowed to Deploy' dropdown menu.
to unprotect a protected environment, Maintainers need to click the
**Unprotect**
button of the respective environment.
## Updating protected environments access
From time to time, it may be required to update the access to a certain environment.
[
Maintainers
][
perm
]
can update existing protected environments at any time
by changing the access on 'Allowed to Deploy' dropdown menu.
## Unprotecting a protected environment
To unprotect a protected environment,
[
Maintainers
][
perm
]
need to click the 'Unprotect' button
of the respective environment.
[
ee
]:
https://about.gitlab.com/pricing/
[
ee
]:
https://about.gitlab.com/pricing/
[
6303
]:
https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/6303
[
6303
]:
https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/6303
[
perm
]:
../../user/permissions.html
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment