Scroll to navigation

KAS-CONTAINER(1) kas KAS-CONTAINER(1)

NAME

kas-container - a setup tool for bitbake based projects

SYNOPSIS

kas-container [OPTIONS] { build | shell } [KASOPTIONS] [KASFILE]
kas-container [OPTIONS] { checkout | dump | lock } [KASOPTIONS] [KASFILE]
kas-container [OPTIONS] { diff } [KASOPTIONS] config1 config2
kas-container [OPTIONS] for-all-repos [KASOPTIONS] [KASFILE] COMMAND
kas-container [OPTIONS] { clean | cleansstate | cleanall | purge} [KASFILE]
kas-container [OPTIONS] menu [KCONFIG]

DESCRIPTION

The kas-container script is a wrapper to run kas inside a build container. It gives fine grained control over the data that is mapped into the build and decouples the build environment from the host system. For details, see Environment Variables <#env-vars-label>. The wrapper also takes care of mounting the necessary directories and setting up the environment variables inside the container.

Note:

The kas-container script has limited support for Git worktrees. Regular Git operations on the checked-out repository are supported. However, executing any git worktree ... command inside the container is not allowed.


By default kas-container uses the official images provided by the kas project: ghcr.io/siemens/kas/kas[-isar]:<version>. To specify your own image set the KAS_CONTAINER_IMAGE environment variable. The kas-container script version should match the kas version inside the container. If kas detects that is was called from kas-container and the versions do not match, a warning is emitted. This limitation might be lessened in the future, once a stable interface between kas-container and kas is introduced.

From version 5.0 onward, kas offers images built on several base distributions. Select a distribution by setting the environment variable KAS_CONTAINER_IMAGE_DISTRO to the desired value (e.g. debian-bookworm or debian-trixie). The corresponding image tags follow the pattern :<version>-<base-distro> (e.g. :5.0-debian-bookworm). Alternatively, you can adjust KAS_CONTAINER_IMAGE_DISTRO_DEFAULT in the kas-container script if you copy this into your downstream layer already for encoding the supported kas version.

As container backends, Docker and Podman are supported. To force the use of podman over docker, set KAS_CONTAINER_ENGINE=podman. For details, see Environment Variables <#env-vars-label>.

Running under docker in rootless mode <https://docs.docker.com/engine/security/rootless/> is partially supported. It is recommended to use a distinct KAS_WORK_DIR outside of the calling directory (repo-dir), as kas temporarily changes the ownership of the working directory during its operation. All files managed by kas (including the repos) must not be written to from the host. To completely remove all data managed by kas, use kas-container purge. This also restores the directory owners of the dirs passed to kas, so they can be removed from the host.

Note:

The ISAR build system is not compatible with rootless execution. By that, we fall back to the system docker or podman instance.


KAS-CONTAINER COMMANDS

Check out repositories and build target.
Check out repositories but do not build.
Compare two kas configurations.
Check out repositories and write flat version of config to stdout.
Create and update kas project lockfiles
Run a shell in the build environment.
Run specified command in each repository.
Clean build artifacts, keep sstate cache and downloads.
Clean build artifacts and sstate cache, keep downloads.
Clean build artifacts, sstate cache and downloads.
Remove all data managed by kas. Run with '--dry-run' to check what would be removed
Provide configuration menu and trigger configured build.

OPTIONS

Use kas-isar container to build Isar image. To force the use of run0 over sudo, set KAS_SUDO_CMD=run0.
Pass a loop device to the container. Only required if loop-mounting is used by recipes.
Additional arguments to pass to the container runtime for running the build.
Set log level (default=info).
print program version.
Directory containing SSH configurations. Avoid $HOME/.ssh unless you fully trust the container.
Forward ssh-agent socket to the container.
Directory containing AWScli configuration. Avoid $HOME/.aws unless you fully trust the container.
File path to the git credential store
Do not inherit proxy settings from environment.
Mount current repository read-only (default for build command)
Mount current repository writable (default for shell command)
Show this help message and exit.

SEE ALSO

kas(1),

KAS

Part of the kas(1) suite.

Author

Daniel Wagner, Jan Kiszka, Claudius Heine

Copyright

Siemens and contributors, 2017-2025

May 31, 2026 5.3