Skip to content

Commit

Permalink
docs: Update devguide to latest changes on container images
Browse files Browse the repository at this point in the history
Document the new build process and the reproducibility check.

Signed-off-by: Jan Kiszka <[email protected]>
  • Loading branch information
jan-kiszka committed Mar 11, 2024
1 parent c4e4bf3 commit e42a64a
Showing 1 changed file with 15 additions and 11 deletions.
26 changes: 15 additions & 11 deletions docs/devguide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,27 @@ That will install a backlink ~/.local/bin/kas to this project. Now you are
able to call it from anywhere.


Docker image build
------------------

For the Yocto/OE build image, just run::
Container image build
---------------------

$ docker build -t <kas_image_name> .
To build the container images kas provides, there is a script provided for
your convenience. It uses docker buildx and requires BuildKit 0.13.0 or newer.
To start the build both container variants, invoke::

For the Yocto/OE build image, use::
$ scripts/build-container.sh

$ docker build --target kas-isar -t <kas-isar_image_name> .
You can limit the target type to either Yocto/OE (``kas``) or isar
(``kas-isar``) via the ``--target`` options. See the script help for more
options.

When you need a proxy to access the internet, add::
Since release 4.3, the containers officially provided via ghcr.io are fully
reproducible. To test this, you can use the following script, e.g. to validate
that release::

--build-arg http_proxy=<http_proxy> --build-arg https_proxy=<https_proxy>
--build-arg ftp_proxy=<ftp_proxy> --build-arg no_proxy=<no_proxy>
$ scripts/reproduce-container.sh kas:4.3

to the call.
Both scripts also support building/checking of the arm64 container images. See
the help of both scripts for more details.


Measure code coverage
Expand Down

0 comments on commit e42a64a

Please sign in to comment.