From 6ab385a27d6c84fafcbfe37aa157f64c3c59e1ff Mon Sep 17 00:00:00 2001 From: Anatoli Babenia <anatoli@rainforce.org> Date: Mon, 6 Nov 2023 14:10:02 +0000 Subject: [PATCH] Clarify CI_REGISTRY and CI_REGISTRY_IMAGE Both are container server addresses, but one is used for authentication, and another for pushing images. --- doc/ci/variables/predefined_variables.md | 4 ++-- doc/user/packages/container_registry/index.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/ci/variables/predefined_variables.md b/doc/ci/variables/predefined_variables.md index a77ba781d7da2..ceca0eefe5bda 100644 --- a/doc/ci/variables/predefined_variables.md +++ b/doc/ci/variables/predefined_variables.md @@ -107,10 +107,10 @@ as it can cause the pipeline to behave unexpectedly. | `CI_PROJECT_URL` | 8.10 | 0.5 | The HTTP(S) address of the project. | | `CI_PROJECT_VISIBILITY` | 10.3 | all | The project visibility. Can be `internal`, `private`, or `public`. | | `CI_PROJECT_CLASSIFICATION_LABEL` | 14.2 | all | The project [external authorization classification label](../../administration/settings/external_authorization.md). | -| `CI_REGISTRY_IMAGE` | 8.10 | 0.5 | The address of the project's Container Registry. Only available if the Container Registry is enabled for the project. | +| `CI_REGISTRY` | 8.10 | 0.5 | Address of the [Container Registry](../../user/packages/container_registry/index.md) server, formatted as `<host>[:<port>]`. For example: `registry.gitlab.example.com`. Only available if the Container Registry is enabled for the GitLab instance. | +| `CI_REGISTRY_IMAGE` | 8.10 | 0.5 | Base address for the container registry to push, pull, or tag project's images, formatted as `<host>[:<port>]/<project_full_path>`. For example: `registry.gitlab.example.com/my_group/my_project`. Image names must follow the [container registry naming convention](../../user/packages/container_registry/index.md#naming-convention-for-your-container-images). Only available if the Container Registry is enabled for the project. | | `CI_REGISTRY_PASSWORD` | 9.0 | all | The password to push containers to the project's GitLab Container Registry. Only available if the Container Registry is enabled for the project. This password value is the same as the `CI_JOB_TOKEN` and is valid only as long as the job is running. Use the `CI_DEPLOY_PASSWORD` for long-lived access to the registry | | `CI_REGISTRY_USER` | 9.0 | all | The username to push containers to the project's GitLab Container Registry. Only available if the Container Registry is enabled for the project. | -| `CI_REGISTRY` | 8.10 | 0.5 | The address of the GitLab Container Registry. Only available if the Container Registry is enabled for the project. This variable includes a `:port` value if one is specified in the registry configuration. | | `CI_REPOSITORY_URL` | 9.0 | all | The full path to Git clone (HTTP) the repository with a [CI/CD job token](../jobs/ci_job_token.md), in the format `https://gitlab-ci-token:$CI_JOB_TOKEN@gitlab.example.com/my-group/my-project.git`. | | `CI_RUNNER_DESCRIPTION` | 8.10 | 0.5 | The description of the runner. | | `CI_RUNNER_EXECUTABLE_ARCH` | all | 10.6 | The OS/architecture of the GitLab Runner executable. Might not be the same as the environment of the executor. | diff --git a/doc/user/packages/container_registry/index.md b/doc/user/packages/container_registry/index.md index 1f95d2f940353..786fd0ca65813 100644 --- a/doc/user/packages/container_registry/index.md +++ b/doc/user/packages/container_registry/index.md @@ -79,7 +79,7 @@ For more information on running container images, see the [Docker documentation] Your container images must follow this naming convention: ```plaintext -<registry URL>/<namespace>/<project>/<image> +<registry server>/<namespace>/<project>[/<optional path>] ``` For example, if your project is `gitlab.example.com/mynamespace/myproject`, -- GitLab