Go to file
Claudius Heine 503cf183b1 kas-container: make container image variables overwritable
This patch introduces new and improved ways to overwrite kas-container
variables that specify which image should be used.

`KAS_CONTAINER_IMAGE_PREFIX`: can be used to overwrite image sources.
For instance if podman is used, the default value `docker://` is used as
a prefix. But it still allows to overwrite it, by setting a custom
variable.

`KAS_CONTAINER_IMAGE_PATH`: can be used to customize the image source
path.

`KAS_CONTAINER_IMAGE_NAME`: can be set to change the container image
name.  For instance if `--isar` is used, the default value is
`kas-isar`, as with `KAS_CONTAINER_IMAGE_PREFIX` this default value can
still be overwritten by setting a custom value.

And last `KAS_IMAGE_VERSION`: It was possible to overwrite this value
before this patch and its still possible. The default value is the
current release version. Setting it for instance to `latest`, would
allow to used the most recent version of the image.

Signed-off-by: Claudius Heine <ch@denx.de>
Signed-off-by: Jan Kiszka <jan.kiszka@siemens.com>
2020-09-29 08:35:04 +02:00
.github/workflows Switch to github workflow 2020-09-24 13:13:12 +02:00
docs kas-docker, docs: Switch to github container registry 2020-09-07 13:36:43 +02:00
kas repos: remove trailing slash from layer path 2020-09-23 09:34:28 +02:00
scripts kas-container: make container image variables overwritable 2020-09-29 08:35:04 +02:00
tests repos: remove trailing slash from layer path 2020-09-23 09:34:28 +02:00
.dockerignore add dockerignore 2017-06-26 09:29:07 +02:00
.flake8 Add flake8 config 2020-06-17 07:59:51 +02:00
.gitignore Expanded and documented .gitignore 2017-06-28 15:12:15 +02:00
CHANGELOG.md Release 2.2 2020-08-20 09:17:34 +02:00
container-entrypoint rename docker-entrypoint to container-entrypoint 2020-09-29 08:32:57 +02:00
CONTRIBUTING.md CONTRIBUTING: add subscription links for list to document 2018-12-17 10:58:33 +01:00
Dockerfile rename docker-entrypoint to container-entrypoint 2020-09-29 08:32:57 +02:00
Dockerfile.isar rename docker-entrypoint to container-entrypoint 2020-09-29 08:32:57 +02:00
kas-container kas-container: make container image variables overwritable 2020-09-29 08:35:04 +02:00
kas-docker rename kas-docker to kas-container, leave symlink in place 2020-09-29 08:30:10 +02:00
LICENSE Correct grammar, spelling and copyright year in files 2018-09-05 12:46:35 +02:00
README.rst Switch to github workflow 2020-09-24 13:13:12 +02:00
requirements_rtd.txt requirements_rtd: Add jsonschema module 2020-06-02 10:36:54 +02:00
run-kas Correct grammar, spelling and copyright year in files 2018-09-05 12:46:35 +02:00
setup.py Drop Python 3.4 compatibility, include 3.8 2020-01-09 11:35:40 +01:00

Setup tool for bitbake based projects
=====================================

+--------------------+
|    Build Status    |
+====================+
| |workflow-master|_ |
+--------------------+
| |workflow-next|_   |
+--------------------+

.. |workflow-master| image:: https://github.com/siemens/kas/workflows/master/badge.svg
.. _workflow-master: https://github.com/siemens/kas/actions?query=workflow%3Amaster
.. |workflow-next| image:: https://github.com/siemens/kas/workflows/next/badge.svg
.. _workflow-next: https://github.com/siemens/kas/actions?query=workflow%3Anext

This tool provides an easy mechanism to setup bitbake based
projects.

The OpenEmbedded tooling support starts at step 2 with bitbake. The
downloading of sources and then configuration has to be done by
hand. Usually, this is explained in a README. Instead kas is using a
project configuration file and does the download and configuration
phase.

Key features provided by the build tool:

- clone and checkout bitbake layers
- create default bitbake settings (machine, arch, ...)
- launch minimal build environment, reducing risk of host contamination
- initiate bitbake build process

See the `kas documentation <https://kas.readthedocs.io>`_ for further details.