Commit 1ca22659 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch 'sselhorn-master-patch-78626' into 'master'

Made deploy token lowercase

See merge request gitlab-org/gitlab!56797
parents 9fcabadd 82eba749
...@@ -5,7 +5,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -5,7 +5,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
type: howto type: howto
--- ---
# Deploy Tokens # Deploy tokens
> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17894) in GitLab 10.7. > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17894) in GitLab 10.7.
> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/199370) from **Settings > Repository** in GitLab 12.9. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/199370) from **Settings > Repository** in GitLab 12.9.
...@@ -23,15 +23,15 @@ Deploy tokens cannot be used with the GitLab API. ...@@ -23,15 +23,15 @@ Deploy tokens cannot be used with the GitLab API.
If you have a key pair, you might want to use [deploy keys](../../project/deploy_keys/index.md) If you have a key pair, you might want to use [deploy keys](../../project/deploy_keys/index.md)
instead. instead.
## Creating a Deploy Token ## Creating a Deploy token
You can create as many deploy tokens as you need from the settings of your You can create as many deploy tokens as you need from the settings of your
project. Alternatively, you can also create [group-scoped deploy tokens](#group-deploy-token). project. Alternatively, you can also create [group-scoped deploy tokens](#group-deploy-token).
1. Sign in to your GitLab account. 1. Sign in to your GitLab account.
1. Go to the project (or group) you want to create Deploy Tokens for. 1. Go to the project (or group) you want to create deploy tokens for.
1. Go to **Settings > Repository**. 1. Go to **Settings > Repository**.
1. Click on "Expand" on **Deploy Tokens** section. 1. Expand the **Deploy tokens** section.
1. Choose a name, expiry date (optional), and username (optional) for the token. 1. Choose a name, expiry date (optional), and username (optional) for the token.
1. Choose the [desired scopes](#limiting-scopes-of-a-deploy-token). 1. Choose the [desired scopes](#limiting-scopes-of-a-deploy-token).
1. Select **Create deploy token**. 1. Select **Create deploy token**.
...@@ -46,8 +46,8 @@ Deploy tokens expire at midnight UTC on the date you define. ...@@ -46,8 +46,8 @@ Deploy tokens expire at midnight UTC on the date you define.
## Revoking a deploy token ## Revoking a deploy token
At any time, you can revoke any deploy token by just clicking the respective To revoke a deploy token, under the **Active deploy tokens** area,
**Revoke** button under the 'Active deploy tokens' area. select the respective **Revoke** button.
## Limiting scopes of a deploy token ## Limiting scopes of a deploy token
...@@ -75,11 +75,11 @@ username to be used when creating the deploy token. ...@@ -75,11 +75,11 @@ username to be used when creating the deploy token.
### Git clone a repository ### Git clone a repository
To download a repository using a Deploy Token, you just need to: To download a repository using a deploy token:
1. Create a Deploy Token with `read_repository` as a scope. 1. Create a deploy token with `read_repository` as a scope.
1. Take note of your `username` and `token`. 1. Take note of your `username` and `token`.
1. `git clone` the project using the Deploy Token: 1. `git clone` the project using the deploy token:
```shell ```shell
git clone https://<username>:<deploy_token>@gitlab.example.com/tanuki/awesome_project.git git clone https://<username>:<deploy_token>@gitlab.example.com/tanuki/awesome_project.git
...@@ -91,7 +91,7 @@ Replace `<username>` and `<deploy_token>` with the proper values. ...@@ -91,7 +91,7 @@ Replace `<username>` and `<deploy_token>` with the proper values.
To read the container registry images, you must: To read the container registry images, you must:
1. Create a Deploy Token with `read_registry` as a scope. 1. Create a deploy token with `read_registry` as a scope.
1. Take note of your `username` and `token`. 1. Take note of your `username` and `token`.
1. Sign in to the GitLab Container Registry using the deploy token: 1. Sign in to the GitLab Container Registry using the deploy token:
...@@ -108,7 +108,7 @@ pull images from your Container Registry. ...@@ -108,7 +108,7 @@ pull images from your Container Registry.
To push the container registry images, you must: To push the container registry images, you must:
1. Create a Deploy Token with `write_registry` as a scope. 1. Create a deploy token with `write_registry` as a scope.
1. Take note of your `username` and `token`. 1. Take note of your `username` and `token`.
1. Sign in to the GitLab Container Registry using the deploy token: 1. Sign in to the GitLab Container Registry using the deploy token:
...@@ -125,7 +125,7 @@ push images to your Container Registry. ...@@ -125,7 +125,7 @@ push images to your Container Registry.
To pull packages in the GitLab package registry, you must: To pull packages in the GitLab package registry, you must:
1. Create a Deploy Token with `read_package_registry` as a scope. 1. Create a deploy token with `read_package_registry` as a scope.
1. Take note of your `username` and `token`. 1. Take note of your `username` and `token`.
1. For the [package type of your choice](../../packages/index.md), follow the 1. For the [package type of your choice](../../packages/index.md), follow the
authentication instructions for deploy tokens. authentication instructions for deploy tokens.
...@@ -152,12 +152,12 @@ Example response: ...@@ -152,12 +152,12 @@ Example response:
To upload packages in the GitLab package registry, you must: To upload packages in the GitLab package registry, you must:
1. Create a Deploy Token with `write_package_registry` as a scope. 1. Create a deploy token with `write_package_registry` as a scope.
1. Take note of your `username` and `token`. 1. Take note of your `username` and `token`.
1. For the [package type of your choice](../../packages/index.md), follow the 1. For the [package type of your choice](../../packages/index.md), follow the
authentication instructions for deploy tokens. authentication instructions for deploy tokens.
### Group Deploy Token ### Group deploy token
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21765) in GitLab 12.9. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21765) in GitLab 12.9.
...@@ -167,7 +167,7 @@ belong either to the specific group or to one of its subgroups. ...@@ -167,7 +167,7 @@ belong either to the specific group or to one of its subgroups.
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i> <i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
For an overview, see [Group Deploy Tokens](https://youtu.be/8kxTJvaD9ks). For an overview, see [Group Deploy Tokens](https://youtu.be/8kxTJvaD9ks).
The Group Deploy Tokens UI is now accessible under **Settings > Repository**, The Group deploy tokens UI is now accessible under **Settings > Repository**,
not **Settings > CI/CD** as indicated in the video. not **Settings > CI/CD** as indicated in the video.
To use a group deploy token: To use a group deploy token:
...@@ -179,12 +179,12 @@ To use a group deploy token: ...@@ -179,12 +179,12 @@ To use a group deploy token:
The scopes applied to a group deploy token (such as `read_repository`) The scopes applied to a group deploy token (such as `read_repository`)
apply consistently when cloning the repository of related projects. apply consistently when cloning the repository of related projects.
### GitLab Deploy Token ### GitLab deploy token
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/18414) in GitLab 10.8. > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/18414) in GitLab 10.8.
There's a special case when it comes to Deploy Tokens. If a user creates one There's a special case when it comes to deploy tokens. If a user creates one
named `gitlab-deploy-token`, the username and token of the Deploy Token is named `gitlab-deploy-token`, the username and token of the deploy token is
automatically exposed to the CI/CD jobs as CI/CD variables: `CI_DEPLOY_USER` automatically exposed to the CI/CD jobs as CI/CD variables: `CI_DEPLOY_USER`
and `CI_DEPLOY_PASSWORD`, respectively. and `CI_DEPLOY_PASSWORD`, respectively.
......
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