Skip to content

Commit

Permalink
v5
Browse files Browse the repository at this point in the history
Signed-off-by: Benedikt Niedermayr <[email protected]>
  • Loading branch information
bniedermayr committed Jul 15, 2024
1 parent 228893e commit 594d247
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions docs/userguide/credentials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,20 +64,17 @@ are set, kas automatically creates a login file for the container
registry at ``~/.docker/config.json``. This file is compatible with
docker, podman and even skopeo.

In other words, if ``CI_REGISTRY``, ``CI_REGISTRY_USER`` and ``CI_JOB_TOKEN`` are
set, kas creates the container registry login file.
If ``CI_JOB_TOKEN`` and ``CI_SERVER_HOST`` are set, kas creates the ``.netrc`` file.

.. note::
Make sure to assign the correct permissions to the ``CI_JOB_TOKEN``.
For details, see `GitLab CI/CD job token <https://docs.gitlab.com/ee/ci/jobs/ci_job_token.html>`_.

Container Registry Authentication File
--------------------------------------

A file named ``config.json`` is saved as ``.docker/config.json`` in the kas home directory.
It contains credentials for the container registry login.
The syntax is specified `containers-auth.json specification <https://github.com/containers/image/blob/main/docs/containers-auth.json.5.md>`_.
A file named ``config.json`` is saved as ``.docker/config.json`` in the kas
home directory. It contains credentials for the container registry login.
The syntax is described in the ``containers-auth.json specification``
(https://github.com/containers/image/blob/main/docs/containers-auth.json.5.md).
The authentication file is compatible with docker, podman and skopeo.
When running in the GitLab CI, the ``CI_JOB_TOKEN`` is appended to automatically grant access
according to the job permissions.
Expand Down

0 comments on commit 594d247

Please sign in to comment.