Skip to content

Commit 23ece5f

Browse files
committed
use sections for CI variables
1 parent 4d051da commit 23ece5f

File tree

1 file changed

+37
-12
lines changed

1 file changed

+37
-12
lines changed

docs/services/cicd.md

Lines changed: 37 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -187,18 +187,43 @@ Many variables exist during a pipeline run, they are documented at [Gitlab's pre
187187
Variables are exposed as environment variables during job execution, where the key is the environment variable's name.
188188
Additionally to CI variables available through Gitlab, there are a few CSCS specific variables:
189189

190-
* `CSCS_REGISTRY` (value: `jfrog.svc.cscs.ch`)
191-
* CSCS internal registry, preferred registry to store your container images
192-
* `CSCS_REGISTRY_PATH` (value: `jfrog.svc.cscs.ch/docker-ci-ext/<repository-id>`)
193-
* The prefix path in the CSCS internal container image registry, to which your pipeline has write access. Within this prefix, you can choose any directory structure. Images that are pushed to a path matching **/public/** , can be pulled by anybody within CSCS network
194-
* `CSCS_CI_MW_URL` (value: `https://cicd-ext-mw.cscs.ch/ci`)
195-
* The URL of the middleware, the orchestrator software
196-
* `CSCS_CI_DEFAULT_SLURM_ACCOUNT` (empty if not set on CI setup page)
197-
* The project to which SLURM accounting will go to. It is set up on the CI setup page in the Admin section. It can be overwritten via SLURM_ACCOUNT for individual jobs
198-
- `CSCS_CI_ORIG_CLONE_URL` (public repositories: `https://github.com/my-org/my-project`, private repositories: `[email protected]:my-org/my-project`)
199-
* Clone URL for git. This is needed for some implementation details of the gitlab-runner custom executor. This is the clone URL of the registered project, i.e. this is not the clone URL of the mirror project
200-
- `ARCH` (`x86_64` or `aarch64`)
201-
This is the architecture of the runner. It is either an ARM64 machine, i.e. `aarch64`, or a traditinal `x86_64` machine.
190+
### `CSCS_REGISTRY`
191+
value: `jfrog.svc.cscs.ch`
192+
193+
CSCS internal registry, preferred registry to store your container images
194+
195+
### `CSCS_REGISTRY_PATH`
196+
value: `jfrog.svc.cscs.ch/docker-ci-ext/<repository-id>`
197+
198+
The prefix path in the CSCS internal container image registry, to which your pipeline has write access.
199+
Within this prefix, you can choose any directory structure.
200+
Images that are pushed to a path matching **/public/** , can be pulled by anybody within CSCS network
201+
202+
### `CSCS_CI_MW_URL`
203+
value: `https://cicd-ext-mw.cscs.ch/ci`
204+
205+
The URL of the middleware, the orchestrator software
206+
207+
### `CSCS_CI_DEFAULT_SLURM_ACCOUNT`
208+
value: Configured on the CI setup page in the admin section `Firecrest Slurm Account`
209+
210+
The project to which Slurm accounting will go to by default.
211+
It can be overwritten via `SLURM_ACCOUNT` for individual jobs.
212+
213+
### `CSCS_CI_ORIG_CLONE_URL`
214+
value:
215+
216+
* public repositories: HTTPS clone URL, e.g. `https://github.com/my-org/my-project`
217+
* private repositories: SSH clone URL, e.g. `[email protected]:my-org/my-project`
218+
219+
Clone URL for git.
220+
This is needed for some implementation details of the gitlab-runner custom executor.
221+
This is the clone URL of the registered project, i.e. this is not the clone URL of the mirror project.
222+
223+
### `ARCH`
224+
value: `x86_64` or `aarch64`
225+
226+
This is the architecture of the runner. It is either an ARM64 machine, i.e. `aarch64`, or a traditinal `x86_64` machine.
202227

203228
## Containerized CI - best practices
204229
### Multi-architecture images

0 commit comments

Comments
 (0)