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 <jan.kiszka@siemens.com>
This commit is contained in:
parent
747790d05d
commit
e4be1a20ff
@ -19,13 +19,18 @@ To install kas into your python site-package repository, run::
|
|||||||
Usage
|
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.
|
- Install it locally via pip to get the ``kas`` command.
|
||||||
- Use the docker image. In this case, run the commands in the examples below
|
- Use the container image locally. In this case, download the ``kas-docker``
|
||||||
within ``docker run -it kasproject/kas:<version> sh`` or bind-mount the
|
script from the kas repository and use it in place of the ``kas`` command.
|
||||||
project into the container. See https://hub.docker.com/r/kasproject for all
|
The script version corresponds to the kas tool and the kas image version.
|
||||||
available images.
|
- Use the container image in CI. Specify
|
||||||
|
``ghcr.io/siemens/kas/kas[-isar][:<x.y>]`` 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,
|
- Use the **run-kas** wrapper from this directory. In this case,
|
||||||
replace ``kas`` in the examples below with ``path/to/run-kas``.
|
replace ``kas`` in the examples below with ``path/to/run-kas``.
|
||||||
|
|
||||||
|
@ -66,7 +66,7 @@ if [ -z "${KAS_IMAGE_VERSION}" ]; then
|
|||||||
KAS_IMAGE_VERSION="2.2"
|
KAS_IMAGE_VERSION="2.2"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
DOCKER_IMAGE=kasproject/kas:${KAS_IMAGE_VERSION}
|
DOCKER_IMAGE=ghcr.io/siemens/kas/kas:${KAS_IMAGE_VERSION}
|
||||||
|
|
||||||
if [ -n "${KAS_WORK_DIR}" ]; then
|
if [ -n "${KAS_WORK_DIR}" ]; then
|
||||||
KAS_WORK_DIR=$(readlink -f "${KAS_WORK_DIR}")
|
KAS_WORK_DIR=$(readlink -f "${KAS_WORK_DIR}")
|
||||||
@ -105,7 +105,7 @@ esac
|
|||||||
while [ $# -gt 0 ]; do
|
while [ $# -gt 0 ]; do
|
||||||
case "$1" in
|
case "$1" in
|
||||||
--isar)
|
--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"
|
ISAR_ARGS="--privileged"
|
||||||
|
|
||||||
case "${KAS_DOCKER_ENGINE}" in
|
case "${KAS_DOCKER_ENGINE}" in
|
||||||
|
Loading…
Reference in New Issue
Block a user