From e4be1a20ff1b7321dd257497fe4e0b3046dd0dd8 Mon Sep 17 00:00:00 2001 From: Jan Kiszka Date: Mon, 7 Sep 2020 13:36:43 +0200 Subject: [PATCH] kas-docker, docs: Switch to github container registry All images are now also available on github's new container registry. Refer to that as default, both in kas-docker as well as in the user manual. The latter can benefit from some refreshment at this chance. Automatic deployment via CI will be switched separately. Signed-off-by: Jan Kiszka --- docs/userguide.rst | 15 ++++++++++----- kas-docker | 4 ++-- 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/docs/userguide.rst b/docs/userguide.rst index ab43cef..64bea9b 100644 --- a/docs/userguide.rst +++ b/docs/userguide.rst @@ -19,13 +19,18 @@ To install kas into your python site-package repository, run:: Usage ----- -There are three options for using kas: +There are (at least) four options for using kas: - Install it locally via pip to get the ``kas`` command. -- Use the docker image. In this case, run the commands in the examples below - within ``docker run -it kasproject/kas: sh`` or bind-mount the - project into the container. See https://hub.docker.com/r/kasproject for all - available images. +- Use the container image locally. In this case, download the ``kas-docker`` + script from the kas repository and use it in place of the ``kas`` command. + The script version corresponds to the kas tool and the kas image version. +- Use the container image in CI. Specify + ``ghcr.io/siemens/kas/kas[-isar][:]`` in your CI script that requests + a container image as runtime environment. See + https://github.com/orgs/siemens/packages/container/kas%2Fkas/31765 and + https://github.com/orgs/siemens/packages/container/kas%2Fkas-isar/31794 for + all available images. - Use the **run-kas** wrapper from this directory. In this case, replace ``kas`` in the examples below with ``path/to/run-kas``. diff --git a/kas-docker b/kas-docker index 293da8a..14aef26 100755 --- a/kas-docker +++ b/kas-docker @@ -66,7 +66,7 @@ if [ -z "${KAS_IMAGE_VERSION}" ]; then KAS_IMAGE_VERSION="2.2" fi -DOCKER_IMAGE=kasproject/kas:${KAS_IMAGE_VERSION} +DOCKER_IMAGE=ghcr.io/siemens/kas/kas:${KAS_IMAGE_VERSION} if [ -n "${KAS_WORK_DIR}" ]; then KAS_WORK_DIR=$(readlink -f "${KAS_WORK_DIR}") @@ -105,7 +105,7 @@ esac while [ $# -gt 0 ]; do case "$1" in --isar) - DOCKER_IMAGE="$(echo "${DOCKER_IMAGE}" | sed 's|kasproject/kas|kasproject/kas-isar|g')" + DOCKER_IMAGE="$(echo "${DOCKER_IMAGE}" | sed 's|ghcr.io/siemens/kas/kas|ghcr.io/siemens/kas/kas-isar|g')" ISAR_ARGS="--privileged" case "${KAS_DOCKER_ENGINE}" in