Software package release references#

Supported package types, required metadata, and CI/CD variables for the Central Artefact Repositories.

Supported artefact types#

SKAO maintains Nexus repositories with native support for the core languages and frameworks used across the project:

  • Docker (OCI images)

  • Helm (charts)

  • PyPI (wheels/source distributions)

  • Conan (C/C++)

  • NPM (Node)

  • Maven (Java)

  • Git LFS (large file support)

  • Apt (Debian)

  • Yum (Fedora)

Upstream proxy/caching repositories are also available:

The Nexus raw format also provides library space for Ansible, raw objects (binary, text, etc.), and RPM packages.

Note

Raw artefact publishing is migrating from Nexus to the SKAO Binary Artefacts Repository (BAR). Set CAR_RAW_REPOSITORY_USE_BAR: true to opt a project’s pipeline into publishing raw artefacts there instead — see Migration Guidelines for Binary Artefacts Repository (BAR) from Nexus Raw Artefact Repositories before switching an existing project over.

Required metadata#

An artefact must carry a set of metadata that certifies its origin before it counts as valid. Because every artefact is published from a GitLab pipeline, include the following predefined variables in its metadata:

  • CI_COMMIT_AUTHOR

  • CI_COMMIT_REF_NAME

  • CI_COMMIT_REF_SLUG

  • CI_COMMIT_SHA

  • CI_COMMIT_SHORT_SHA

  • CI_COMMIT_TIMESTAMP

  • CI_JOB_ID

  • CI_JOB_URL

  • CI_PIPELINE_ID

  • CI_PIPELINE_IID

  • CI_PIPELINE_URL

  • CI_PROJECT_ID

  • CI_PROJECT_PATH_SLUG

  • CI_PROJECT_URL

  • CI_RUNNER_ID

  • CI_RUNNER_REVISION

  • CI_RUNNER_TAGS

  • GITLAB_USER_NAME

  • GITLAB_USER_EMAIL

  • GITLAB_USER_LOGIN

  • GITLAB_USER_ID

Example labels from an OCI image inspection#
"Labels": {
    "CI_COMMIT_AUTHOR": "Ugur Yilmaz <ugur.yilmaz@skao.int>",
    "CI_COMMIT_REF_NAME": "0.9.0",
    "CI_COMMIT_REF_SLUG": "0-9-0",
    "CI_COMMIT_SHA": "9262f0d42fffff549d85a0f93f102bc7ae8f4f6f",
    "CI_COMMIT_SHORT_SHA": "9262f0d4",
    "CI_COMMIT_TIMESTAMP": "2023-07-26T12:30:15+00:00",
    "CI_JOB_ID": "4744388752",
    "CI_JOB_URL": "https://gitlab.com/ska-telescope/ska-cicd-k8s-tools/-/jobs/4744388752",
    "CI_PIPELINE_ID": "946033414",
    "CI_PIPELINE_IID": "531",
    "CI_PIPELINE_URL": "https://gitlab.com/ska-telescope/ska-cicd-k8s-tools/-/pipelines/946033414",
    "CI_PROJECT_ID": "24071551",
    "CI_PROJECT_PATH_SLUG": "ska-telescope-ska-cicd-k8s-tools",
    "CI_PROJECT_URL": "https://gitlab.com/ska-telescope/ska-cicd-k8s-tools",
    "CI_RUNNER_ID": "25177620",
    "CI_RUNNER_REVISION": "85586bd1",
    "CI_RUNNER_TAGS": "[\"k8srunner\"]",
    "GITLAB_USER_EMAIL": "ugur.yilmaz@skao.int",
    "GITLAB_USER_ID": "3049864",
    "GITLAB_USER_LOGIN": "limonkufu",
    "GITLAB_USER_NAME": "Ugur Yilmaz",
    "author": "Matteo Di Carlo <matteo.dicarlo@inaf.it>",
    "description": "This image includes tools for the deployment of a chart and the execution of pytest",
    "int.skao.application": "SKA Deploy",
    "license": "BSD-3-Clause",
    "org.opencontainers.image.ref.name": "ubuntu",
    "org.opencontainers.image.version": "22.04",
    "org.skatelescope.team": "Systems Team",
    "org.skatelescope.version": "1.0.0",
    "registry": "/ska-cicd-build-deploy"
}

See the GitLab predefined variables reference for details on each variable.

Global GitLab variables#

The ska-telescope GitLab group defines these variables for access to the CARs in CI/CD pipelines:

GitLab ska-telescope group variables#

Key

Description

CAR_OCI_REGISTRY_HOST

FQDN of the Central Artefact Repository — artefact.skao.int

CAR_OCI_REGISTRY_USERNAME

OCI image publishing username

CAR_OCI_REGISTRY_PASSWORD

OCI image publishing password

CAR_PYPI_REPOSITORY_URL

Python package repository URL — https://artefact.skao.int/repository/pypi-internal/

CAR_PYPI_USERNAME

PyPI publishing username

CAR_PYPI_PASSWORD

PyPI publishing password

CAR_HELM_REPOSITORY_URL

Helm chart repository URL — https://artefact.skao.int/repository/helm-internal

CAR_HELM_USERNAME

Helm chart publishing username

CAR_HELM_PASSWORD

Helm chart publishing password

CAR_ANSIBLE_REPOSITORY_URL

Ansible collections repository URL — https://artefact.skao.int/repository/ansible-internal

CAR_ANSIBLE_USERNAME

Ansible role/collection publishing username

CAR_ANSIBLE_PASSWORD

Ansible role/collection publishing password

CAR_RAW_REPOSITORY_URL

Raw artefact repository URL — https://artefact.skao.int/repository/raw-internal

CAR_RAW_USERNAME

Raw repository publishing username

CAR_RAW_PASSWORD

Raw repository publishing password

CAR_CONAN_REPOSITORY_URL

Conan artefact repository URL — https://artefact.skao.int/repository/conan-internal

CAR_CONAN_USERNAME

Conan repository publishing username

CAR_CONAN_PASSWORD

Conan repository publishing password

Publishing raw artefacts to BAR#

Set these in a project’s own pipeline (they are not group-wide) to opt into publishing raw artefacts to BAR instead of Nexus:

BAR raw-publish variables#

Key

Description

CAR_RAW_REPOSITORY_USE_BAR

Set to true to publish raw artefacts to BAR instead of Nexus. Defaults to false.

CAR_RAW_BAR_REPOSITORY_URL

BAR API endpoint to publish to.

CAR_RAW_BAR_TOKEN

A GitLab CI ID token (OIDC), not a static secret — GitLab mints it per job for the audience in CAR_RAW_BAR_TOKEN_AUDIENCE.

CAR_RAW_BAR_TOKEN_AUDIENCE

Audience claim for the CAR_RAW_BAR_TOKEN ID token.

Was this page helpful?