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:
Docker (OCI images — AWS VPC only)
Helm — helm-proxy (from charts.helm.sh/stable)
PyPI — pypi-all (from pypi.python.org, includes pypi-internal)
Conan — conan-proxy (from conan.bintray.com)
NPM — npm-all (from registry.npmjs.org, includes npm-internal — not yet active)
Maven — maven-public (from maven-release, maven-snapshots, repo1.maven.org/maven2)
Apt — ubuntu-archive, ubuntu18.04-proxy, ubuntu20.04-proxy, and ubuntu22.04-proxy (from archive.ubuntu.com/ubuntu)
Yum — yum_centos_7-internal and yum_centos_8-internal (from download.fedoraproject.org/pub/epel)
Go — go-proxy (from golang.org/pkg)
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_AUTHORCI_COMMIT_REF_NAMECI_COMMIT_REF_SLUGCI_COMMIT_SHACI_COMMIT_SHORT_SHACI_COMMIT_TIMESTAMPCI_JOB_IDCI_JOB_URLCI_PIPELINE_IDCI_PIPELINE_IIDCI_PIPELINE_URLCI_PROJECT_IDCI_PROJECT_PATH_SLUGCI_PROJECT_URLCI_RUNNER_IDCI_RUNNER_REVISIONCI_RUNNER_TAGSGITLAB_USER_NAMEGITLAB_USER_EMAILGITLAB_USER_LOGINGITLAB_USER_ID
"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:
Key |
Description |
|---|---|
|
FQDN of the Central Artefact Repository — artefact.skao.int |
|
OCI image publishing username |
|
OCI image publishing password |
|
Python package repository URL — https://artefact.skao.int/repository/pypi-internal/ |
|
PyPI publishing username |
|
PyPI publishing password |
|
Helm chart repository URL — https://artefact.skao.int/repository/helm-internal |
|
Helm chart publishing username |
|
Helm chart publishing password |
|
Ansible collections repository URL — https://artefact.skao.int/repository/ansible-internal |
|
Ansible role/collection publishing username |
|
Ansible role/collection publishing password |
|
Raw artefact repository URL — https://artefact.skao.int/repository/raw-internal |
|
Raw repository publishing username |
|
Raw repository publishing password |
|
Conan artefact repository URL — https://artefact.skao.int/repository/conan-internal |
|
Conan repository publishing username |
|
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:
Key |
Description |
|---|---|
|
Set to |
|
BAR API endpoint to publish to. |
|
A GitLab CI ID token (OIDC), not a static secret — GitLab mints it per job for the audience in |
|
Audience claim for the |