Skip to content

Commit eb2e14c

Browse files
committed
move section CI variables down, right above runners reference
1 parent ac24148 commit eb2e14c

File tree

1 file changed

+45
-44
lines changed

1 file changed

+45
-44
lines changed

docs/services/cicd.md

Lines changed: 45 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -244,50 +244,6 @@ It also can give you background for inquiring if and when something in the proce
244244
1. If the repository uses git submodules, `GIT_SUBMODULE_STRATEGY: recursive` has to be specified (see [GitLab documentation](https://docs.gitlab.com/ee/ci/git_submodules.html#use-git-submodules-in-cicd-jobs))
245245
1. The [container-builder](#container-builder), which has as input a Dockerfile (specified in the variable `DOCKERFILE`), will take this Dockerfile and execute something similar to `docker build -f $DOCKERFILE .`, where the [build context](#build-context) is the whole (recursively) cloned repository
246246

247-
## CI variables
248-
249-
Many variables exist during a pipeline run, they are documented at [Gitlab's predefined variables](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html).
250-
Variables are exposed as environment variables during job execution, where the key is the environment variable's name.
251-
Additionally to CI variables available through Gitlab, there are a few CSCS specific variables:
252-
253-
### `CSCS_REGISTRY`
254-
value: `jfrog.svc.cscs.ch`
255-
256-
CSCS internal registry, preferred registry to store your container images
257-
258-
### `CSCS_REGISTRY_PATH`
259-
value: `jfrog.svc.cscs.ch/docker-ci-ext/<repository-id>`
260-
261-
The prefix path in the CSCS internal container image registry, to which your pipeline has write access.
262-
Within this prefix, you can choose any directory structure.
263-
Images that are pushed to a path matching **/public/** , can be pulled by anybody within CSCS network
264-
265-
### `CSCS_CI_MW_URL`
266-
value: `https://cicd-ext-mw.cscs.ch/ci`
267-
268-
The URL of the middleware, the orchestrator software
269-
270-
### `CSCS_CI_DEFAULT_SLURM_ACCOUNT`
271-
value: Configured on the CI setup page in the admin section `Firecrest Slurm Account`
272-
273-
The project to which Slurm accounting will go to by default.
274-
It can be overwritten via `SLURM_ACCOUNT` for individual jobs.
275-
276-
### `CSCS_CI_ORIG_CLONE_URL`
277-
value:
278-
279-
* public repositories: HTTPS clone URL, e.g. `https://github.com/my-org/my-project`
280-
* private repositories: SSH clone URL, e.g. `[email protected]:my-org/my-project`
281-
282-
Clone URL for git.
283-
This is needed for some implementation details of the gitlab-runner custom executor.
284-
This is the clone URL of the registered project, i.e. this is not the clone URL of the mirror project.
285-
286-
### `ARCH`
287-
value: `x86_64` or `aarch64`
288-
289-
This is the architecture of the runner. It is either an ARM64 machine, i.e. `aarch64`, or a traditinal `x86_64` machine.
290-
291247
## Containerized CI - best practices
292248
### Multi-architecture images
293249

@@ -785,6 +741,51 @@ Below are known differences:
785741
pipeline_variables: true
786742
```
787743
744+
## CI variables
745+
746+
Many variables exist during a pipeline run, they are documented at [Gitlab's predefined variables](https://docs.gitlab.com/ee/ci/variables/predefined_variables.html).
747+
Variables are exposed as environment variables during job execution, where the key is the environment variable's name.
748+
Additionally to CI variables available through Gitlab, there are a few CSCS specific variables:
749+
750+
### `CSCS_REGISTRY`
751+
value: `jfrog.svc.cscs.ch`
752+
753+
CSCS internal registry, preferred registry to store your container images
754+
755+
### `CSCS_REGISTRY_PATH`
756+
value: `jfrog.svc.cscs.ch/docker-ci-ext/<repository-id>`
757+
758+
The prefix path in the CSCS internal container image registry, to which your pipeline has write access.
759+
Within this prefix, you can choose any directory structure.
760+
Images that are pushed to a path matching **/public/** , can be pulled by anybody within CSCS network
761+
762+
### `CSCS_CI_MW_URL`
763+
value: `https://cicd-ext-mw.cscs.ch/ci`
764+
765+
The URL of the middleware, the orchestrator software
766+
767+
### `CSCS_CI_DEFAULT_SLURM_ACCOUNT`
768+
value: Configured on the CI setup page in the admin section `Firecrest Slurm Account`
769+
770+
The project to which Slurm accounting will go to by default.
771+
It can be overwritten via `SLURM_ACCOUNT` for individual jobs.
772+
773+
### `CSCS_CI_ORIG_CLONE_URL`
774+
value:
775+
776+
* public repositories: HTTPS clone URL, e.g. `https://github.com/my-org/my-project`
777+
* private repositories: SSH clone URL, e.g. `[email protected]:my-org/my-project`
778+
779+
Clone URL for git.
780+
This is needed for some implementation details of the gitlab-runner custom executor.
781+
This is the clone URL of the registered project, i.e. this is not the clone URL of the mirror project.
782+
783+
### `ARCH`
784+
value: `x86_64` or `aarch64`
785+
786+
This is the architecture of the runner. It is either an ARM64 machine, i.e. `aarch64`, or a traditinal `x86_64` machine.
787+
788+
788789
## Runners reference
789790
!!! info
790791
This section is a reference documentation.

0 commit comments

Comments
 (0)