diff --git a/source/user_guide/define_token.rst b/source/user_guide/define_token.rst index d3212de0ab2dba9e051cc9c8fd2dbea4739fa698..12e8071fd7b57446f756d5517a57361cd12944c8 100644 --- a/source/user_guide/define_token.rst +++ b/source/user_guide/define_token.rst @@ -13,7 +13,7 @@ If your project's visibility is *private* or *internal*, you need to create depl To view or modify the visibility of your project ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -After creation, you can view/odify the visibility of your gitlab project in *Settings* --> *General* --> *Visibility, project features, permissions* section in gitlab page. +After creation, you can view/modify the visibility of your gitlab project in *Settings* --> *General* --> *Visibility, project features, permissions* section in gitlab page. .. image:: /_static/visibility_gitlab_project.png :width: 50em @@ -33,11 +33,11 @@ With a deploy token, automated tasks can: - Pull from and push to a GitLab package registry. -Here, Token allows kubernetes to pull your docker image on your gitlab docker repository. +Here, we need a token to allows kubernetes to pull your docker image on your gitlab docker registry. A deploy token is a pair of values: -- username:  ``username`` in the HTTP authentication framework. The default username format is ``gitlab+deploy-token-{n}``. You can specify a custom username when you create the deploy token. +- username: ``username`` in the HTTP authentication framework. The default username format is ``gitlab+deploy-token-{n}``. You can specify a custom username when you create the deploy token. - token: ``password`` in the HTTP authentication framework. | A GitLab deploy token is a special type of deploy token. If you create a deploy token named gitlab-deploy-token, the deploy token is automatically exposed to the CI/CD jobs as variables, for use in a CI/CD pipeline: @@ -49,13 +49,13 @@ A deploy token is a pair of values: More details on `gitlab documentation <https://docs.gitlab.com/ee/user/project/deploy_tokens/>`_ -Here, we need to define a token with ``read_registry`` scope correspond to **Read-only access to the images in the project’s container registry**. +Here, we need to define a token with only ``read_registry`` scope which correspond to **Read-only access to the images in the project’s container registry**. -To create a token **read_registry** : +To create such token: - From your Gitlab project page, go to **Settings - Repository** --> https://gitlab.pasteur.fr/ada-team/my-project/-/settings/repository - Expand **"Deploy tokens"** section. -- Set a **Name** for your token.For example, name it `read_registry`, easier to keep a track on what it can do +- Set a **Name** for your token. For example, name it `read_registry`, easier to keep a track on what it can do - Add a **Username** or let default valule - Chose the scope **read_registry** - Apply your chose by clinking on **Create deploy token** button @@ -82,7 +82,7 @@ See an example below : Don't forget to save the token password just created !! You need it for add it on CI/CD variables -To retrieve all token previously created, you can go again the "Deploy tokens" section of your Settings/Repository. +To see created tokens, you can go again to the "Deploy tokens" section of your Settings/Repository. You can find the list of active deploy token at the end of the section, like below : .. image:: /_static/deploy_token_3.png