From patchwork Fri Mar 12 09:58:42 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Silvano Cirujano Cuesta X-Patchwork-Id: 361 Return-Path: Delivered-To: ilbers.mnt@gmail.com Received: by 2002:a4a:c583:0:0:0:0:0 with SMTP id x3csp1562290oop; Fri, 12 Mar 2021 12:08:48 -0800 (PST) X-Received: by 2002:adf:9261:: with SMTP id 88mr15347418wrj.270.1615579727993; Fri, 12 Mar 2021 12:08:47 -0800 (PST) ARC-Seal: i=3; a=rsa-sha256; t=1615579727; cv=pass; d=google.com; s=arc-20160816; b=gOb1KzceOrlcw+6CMS3NPuZ8zVE6AgK/dvRm5Z4esoumx427oMxtA1EVeDp7cI0kmi M+a1z6bU22hERMXU6clrszRrCFgTX1zZsxl/htZjKddSbIsxyDFUFszNkxg8/axFm42q E3hxI1cYxaVEnCHGxzaNgGf+EOrbWvOWmVqgQrZecb/Hfa3xEikglGxc+blfIQjm16Wk hSEeNg6llV/GFvZedKGqK6+yKG68cJxbp+ZVviA2OCoQffhwRhi0fwlvCX/42nCBLmYE y7HCTHOm81I/mrMAZbImD+nMpdGBOk2BysVbH3e8FYfhASWCUaYO8LNWT08/zX/ZxHr7 AERg== ARC-Message-Signature: i=3; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-unsubscribe:list-subscribe:list-archive:list-help:list-post :list-id:mailing-list:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:to:from :sender:dkim-signature; bh=ztYMsoPh8dIAdf005PDczirA0ktD0tp/os7xnDjLxVM=; b=NjhQWWCrcN0lHStcYlxOWEW1TnsbL0xtb92zhhE9aLv5BHMyM5X83LbIB4MGnV0mju O4CmJfDd16reb7UUegaOjw/m/We4r+dQSHGFcWQ+FlyFRUQFEaGurHxGddmQvh5HfS4m 6exZVWW+O6pn1rqQDfHstMMqnD26gBXg7+FaLqv9BMB4afhhpR7fQ331Riem4sLE59I+ 5SPaPIwKN4zaOzbHIgnEtplwvfQ3HZhXOFP9IIEXXmsTNHOKQlBHfeB4eOMEwdeu6Mog 66k7hwXH2SFBB9t6uWh1ZooPIApzDCKp+s+eWakRmJSCGF7LOdqFPmqRUnfKlsjJtxCU u1jw== ARC-Authentication-Results: i=3; mx.google.com; dkim=pass header.i=@googlegroups.com header.s=20161025 header.b=s5Pive11; arc=pass (i=2 spf=pass spfdomain=siemens.com dmarc=pass fromdomain=siemens.com); spf=pass (google.com: domain of isar-users+bncbcd6jj6cqqfrbt4uv6bamgqe3ijls2i@googlegroups.com designates 209.85.220.55 as permitted sender) smtp.mailfrom=isar-users+bncBCD6JJ6CQQFRBT4UV6BAMGQE3IJLS2I@googlegroups.com; dmarc=fail (p=NONE sp=NONE dis=NONE arc=pass) header.from=siemens.com Received: from mail-sor-f55.google.com (mail-sor-f55.google.com. [209.85.220.55]) by mx.google.com with SMTPS id k7sor3840256wro.34.2021.03.12.12.08.47 (Google Transport Security); Fri, 12 Mar 2021 12:08:47 -0800 (PST) Received-SPF: pass (google.com: domain of isar-users+bncbcd6jj6cqqfrbt4uv6bamgqe3ijls2i@googlegroups.com designates 209.85.220.55 as permitted sender) client-ip=209.85.220.55; Authentication-Results: mx.google.com; dkim=pass header.i=@googlegroups.com header.s=20161025 header.b=s5Pive11; arc=pass (i=2 spf=pass spfdomain=siemens.com dmarc=pass fromdomain=siemens.com); spf=pass (google.com: domain of isar-users+bncbcd6jj6cqqfrbt4uv6bamgqe3ijls2i@googlegroups.com designates 209.85.220.55 as permitted sender) smtp.mailfrom=isar-users+bncBCD6JJ6CQQFRBT4UV6BAMGQE3IJLS2I@googlegroups.com; dmarc=fail (p=NONE sp=NONE dis=NONE arc=pass) header.from=siemens.com ARC-Seal: i=2; a=rsa-sha256; t=1615579727; cv=pass; d=google.com; s=arc-20160816; b=kvJo9IVrAEGggALnrkcNpEEX1SEOMIVhz4QoMHvrW3h/FsY+9j3MUr3C2OiX0dMprH YnJc6v78a7b+46869v/id8YJHSeva6+Lwat4xeBhE0ivA0+MHrISmXmkr8MGZ9ivwVBp 2kBtfIBq/12eTfDUuK6Gvlhh9dvUsCtDqJSOmQLV0yEuB7JcEmz9eUcB41DdcLjwnLOJ oiZ0SCBQefCvFAXRS3jJSKclE74zriCoBW27hLE8Ff71Ab6r7lZ3ELbF72CdkikYi/xa kw3hCaV9ZPtrheEol0RnIChW1ygykLI8a71M5MR6n+zg1IWEn5InnYJRRq5AgpcOYhEb B1Zw== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-unsubscribe:list-subscribe:list-archive:list-help:list-post :list-id:mailing-list:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:to:from :sender:dkim-signature; bh=ztYMsoPh8dIAdf005PDczirA0ktD0tp/os7xnDjLxVM=; b=py/ugAWG7XR6npbRBUQfp2/fR9MRHWmH+dcMKU5CGCZm7eLzwsuNIlHKTT73avt0Ct MicVsXa0KCYxx4eGZshmJbMnDPG6Z6yyfSxtqMDmIPl/Ru3+E/XOxN/UH+MiZM/qB5mq 9Su4J9Zs5D/6fNIzyXtv6NUSf15OP6+IYlUyy3e0+RRq/YTBqho0fG/6/A7jlorFECZT wiSmhyGnE86UHWSkFINtKCiOibUTKImP9AWBbsGIjnzIleLKw6Pv48H12GSj+kKO57dB 5pTTeLjJyovJvOD9MZW4+t4cSJbEzrFMQXl50ZufJuIShXylziNdlKChJp3u0i2Hev1z oxsA== ARC-Authentication-Results: i=2; gmr-mx.google.com; spf=pass (google.com: domain of silvano.cirujano-cuesta@siemens.com designates 194.138.37.40 as permitted sender) smtp.mailfrom=silvano.cirujano-cuesta@siemens.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=siemens.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=googlegroups.com; s=20161025; h=sender:from:to:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding:x-original-sender :x-original-authentication-results:precedence:mailing-list:list-id :list-post:list-help:list-archive:list-subscribe:list-unsubscribe; bh=ztYMsoPh8dIAdf005PDczirA0ktD0tp/os7xnDjLxVM=; b=s5Pive11uCL5p2Xo35fbCxZ3qyJvJWriztTr7PP6eTJx4JEw/NV0xmUArBRyLVQGtl Z2+fBLf61R94KpHVFPTWFQFmNhVe4r7GArEfLv+8KeFLxv6P9Q8317R0ZhXWoDBukkms lL8nG6x6/WtVRfYSY3m6ZdH5VNcFoYj5PD6sC18+7cdqXyVpJCHMNAgG/N2Jv4hpvBCC +361goXu5VVhsvMOU+7JOyIToNg8YttTpcdYqU6cfvAZnTUzAhb+BN5Gmy6Dx3IdrDHE Yef3UBw4PdQWiC7FEeR2UScitwYNoLTQP8VI1cQnLoIAaIS3jC/p03oW/l2cOcBXq8Sa Vxfw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=sender:x-gm-message-state:from:to:subject:date:message-id :in-reply-to:references:mime-version:content-transfer-encoding :x-original-sender:x-original-authentication-results:precedence :mailing-list:list-id:x-spam-checked-in-group:list-post:list-help :list-archive:list-subscribe:list-unsubscribe; bh=ztYMsoPh8dIAdf005PDczirA0ktD0tp/os7xnDjLxVM=; b=OwKx2K4qWzUJ7rXYQPQvSZh0vN0aDHjjhdmC89XHWhG1gJZcLQcOU8ROIT5BJpJtNo 10gLSoiNMckUm/9t7+np2MVzwcz2jo9Cd1nseJHKqjBvD3ND5qPCgku/s2+IXpUDcsxD B6tm0GO3xVEq/1ZTEAsKO5hjDUj66SMLLec6tT7y6D1N/RGQ02rHgFVD9/4gp6r+OSTG NZaik5/56oURUSL5IA5rmM8pq93VApEU+XBzDtbqulmqU0LggmD7SAejUvvwpRDLbLKJ mHjRZy3hFuKXasxMODbKNwOD/22RWwV3tIM2dtyLNBWC1BGv5IFea03KynmrcReRo6zJ 7wjQ== Sender: isar-users@googlegroups.com X-Gm-Message-State: AOAM531BIGAAV1VxVMfZQnwVmphQsGbURLmqFVS5OQ6NTvd/O4Rt1YFh JF/O2IkEiUeOaKTvjZFwQo8= X-Google-Smtp-Source: ABdhPJyieaQIbQixY1q+4ev7+CIN22oJYJqbkrwsQtXqTFlo7M6DNfJw/CPH60LJZTc0mGPqovFW5Q== X-Received: by 2002:adf:a1ce:: with SMTP id v14mr15840030wrv.228.1615579727724; Fri, 12 Mar 2021 12:08:47 -0800 (PST) X-BeenThere: isar-users@googlegroups.com Received: by 2002:adf:d1e6:: with SMTP id g6ls1049204wrd.3.gmail; Fri, 12 Mar 2021 12:08:46 -0800 (PST) X-Received: by 2002:a5d:698e:: with SMTP id g14mr15483277wru.127.1615579726887; Fri, 12 Mar 2021 12:08:46 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1615579726; cv=none; d=google.com; s=arc-20160816; b=WhQ21xAkUQMSV9mDW2fK3Y6X9S57rLJVpo4sLRHf1o9PDgXDGsfwIg9hq2FK9YK0yG usdHFDh/I0RsqRHeABAwVJ/dxeYrgj9TEBdtzxWE2S6rsjFH8gxPDmgX4YLBbqB+OUWc 8vn4I+Hd4tUnGO41pIFrV0YbKDQmoVVqUlVQtc7sGWd/lIC55g1FgjZiImuAQXdgxo6J ybOT+AwV3JFU6jO0C+eC6WeMDKVV+MZ8+et3eYfwHEea4I03oIDP/MEySvR6zKGnPpc2 V4t2EP6MmHP9TvN/NZndIGPZFtPyrkIGpX8esjCY2E/Y4hmuz5VaJBpxo96ca7j0vEw5 hHIg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from; bh=xMyd0Dgf/XnmoPeMNVkHTMwC820lpBNwUb7hHcTpMtw=; b=eBQvIXQYXQ6b4m/uIhEwsjhDOMG3kAzG/jvRvAI/yDj/Tw30k/ZiNoPSCn8RmJHgvy YMF+PuJbp3FzJJ4rOjPhucwh0hUkkXGQ5BN83+GMchSuNRY30vUuqmle5kas3qBpyJYn d+mpLDjEYnF56XU1Xu92tfRj7xrVnt8MI92glvL11y3beKYYEyjIKdZVt2wycUmlRZAz S9DiuVLaTC8kxuaTmTiwsCuPbgSNiYlBjvpK8KitgD1ksMi/rEyzDTC5v58Xd0Ue7Y9d TWd842SyQupRA3helNMC2Vj8yJuzOdUY66PNxAZpy5i7mPE5oop6KlJ3zf33HF53d4lk X18Q== ARC-Authentication-Results: i=1; gmr-mx.google.com; spf=pass (google.com: domain of silvano.cirujano-cuesta@siemens.com designates 194.138.37.40 as permitted sender) smtp.mailfrom=silvano.cirujano-cuesta@siemens.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=siemens.com Received: from gecko.sbs.de (gecko.sbs.de. [194.138.37.40]) by gmr-mx.google.com with ESMTPS id s1si218714wru.4.2021.03.12.12.08.46 for (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Fri, 12 Mar 2021 12:08:46 -0800 (PST) Received-SPF: pass (google.com: domain of silvano.cirujano-cuesta@siemens.com designates 194.138.37.40 as permitted sender) client-ip=194.138.37.40; Received: from mail1.sbs.de (mail1.sbs.de [192.129.41.35]) by gecko.sbs.de (8.15.2/8.15.2) with ESMTPS id 12CK8kVi020412 (version=TLSv1.2 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Fri, 12 Mar 2021 21:08:46 +0100 Received: from md1sf36c.ad001.siemens.net ([167.87.3.106]) by mail1.sbs.de (8.15.2/8.15.2) with ESMTP id 12CJwiaQ008930 for ; Fri, 12 Mar 2021 20:58:45 +0100 From: Silvano Cirujano Cuesta To: isar-users@googlegroups.com Subject: [PATCH v7 4/5] docs: document creation of container images Date: Fri, 12 Mar 2021 20:58:42 +0100 Message-Id: <20210312195843.96000-5-silvano.cirujano-cuesta@siemens.com> X-Mailer: git-send-email 2.30.1 In-Reply-To: <20210312195843.96000-1-silvano.cirujano-cuesta@siemens.com> References: <20210312195843.96000-1-silvano.cirujano-cuesta@siemens.com> MIME-Version: 1.0 X-Original-Sender: silvano.cirujano-cuesta@siemens.com X-Original-Authentication-Results: gmr-mx.google.com; spf=pass (google.com: domain of silvano.cirujano-cuesta@siemens.com designates 194.138.37.40 as permitted sender) smtp.mailfrom=silvano.cirujano-cuesta@siemens.com; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=siemens.com Precedence: list Mailing-list: list isar-users@googlegroups.com; contact isar-users+owners@googlegroups.com List-ID: X-Spam-Checked-In-Group: isar-users@googlegroups.com X-Google-Group-Id: 914930254986 List-Post: , List-Help: , List-Archive: , List-Unsubscribe: , X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: =?utf-8?q?1694058128771148728?= X-GMAIL-MSGID: =?utf-8?q?1694058128771148728?= Signed-off-by: Silvano Cirujano Cuesta --- doc/user_manual.md | 127 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 127 insertions(+) diff --git a/doc/user_manual.md b/doc/user_manual.md index a4f3d1d..f6f49bc 100644 --- a/doc/user_manual.md +++ b/doc/user_manual.md @@ -19,6 +19,7 @@ Copyright (C) 2016-2019, ilbers GmbH - [Add a Custom Application](#add-a-custom-application) - [Enabling Cross-compilation](#isar-cross-compilation) - [Create an ISAR SDK root filesystem](#create-an-isar-sdk-root-filesystem) + - [Create a containerized ISAR SDK root filesystem](#create-a-containerized-isar-sdk-root-filesystem) - [Creation of local apt repo caching upstream Debian packages](#creation-of-local-apt-repo-caching-upstream-debian-packages) @@ -84,6 +85,9 @@ If your host is >= buster, also install the following package. apt install python3-distutils ``` +If you want to generate containerized SDKs, also install the following packages: `umoci` and `skopeo`. +Umoci is provided by Debian Buster and can be installed with `apt install umoci`, Skopeo is provided by Debian Bullseye/Unstable and has to be installed either manually downloading the DEB and installing it (no other packages required) or with `apt install -t bullseye skopeo` (if unstable/bullseye included in `/etc/apt/sources.list[.d]`). + Notes: * BitBake requires Python 3.4+. @@ -223,6 +227,54 @@ qemu-system-x86_64 -m 256M -nographic -bios edk2/Build/OvmfX64/RELEASE_*/FV/OVMF qemu-system-i386 -m 256M -nographic -hda tmp/deploy/images/qemui386/isar-image-base-debian-buster-qemui386.wic.img ``` +### Generate container image with root-filesystem + +A runnable container image is generated if you set IMAGE_TYPE to 'container-img'. +Getting a container image can be the main purpose of an ISAR configuration, but not only. +A container image created from an ISAR configuration meant for bare-metal or virtual machines can be helpfull to test certain applications which requirements (e.g. libraries) can be easily resolved in a containerized environment. + +Container images can be generated in different formats, selected with the variable `CONTAINER_FORMAT`. One or more (whitespace separated) of following options can be given: + - `docker-archive`: (default) an archive containing a Docker image that can be imported with [`docker import`](https://docs.docker.com/engine/reference/commandline/import/) + - `docker-daemon`: resulting container image is made available on the local Docker Daemon + - `containers-storage`: resulting container image is made available to tools using containers/storage back-end (e.g. Podman, CRIO, buildah,...) + - `oci-archive`: an archive containing an OCI image, mostly for archiving as seed for any of the above formats + +Following formats don't work if running `bitbake ...` (to build the image) from inside of a container (e.g. using `kas-container`): `docker-daemon` and `containers-storage`. +It's technically possible, but requires making host resources (e.g. the Docker Daemon socket) accessible in the container. +What can endanger the stability and security of the host. + +The resulting container image archives (only for `docker-archive` and `oci-archive`) are made available as `tmp/deploy/images/${MACHINE}/${DISTRO}-${DISTRO_ARCH}-${container_format}.tar.xz` (being `container_format` each one of the formats specified in `CONTAINER_FORMAT`). + +### Example + + - Make the relevant environment variables available to the task + +For one-shot builds (use `local.conf` otherwise): + +``` +export BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE IMAGE_TYPE CONTAINER_FORMAT" +export IMAGE_TYPE="container-img" +export CONTAINER_FORMAT="docker-archive" +``` + + - Trigger creation of container image from root filesystem + +``` +bitbake mc:qemuarm-buster:isar-image-base +``` + + - Load the container image into the Docker Daemon + +``` +xzcat build/tmp/deploy/images/qemuarm/debian-buster-armhf-docker-archive.tar.xz | docker load +``` + + - Run a container using the container image (following commands starting with `#~:` are to be run in the container) + +``` +docker run --rm -ti --volume "$(pwd):/build" isar-buster-armhf:latest +``` + --- ## Terms and Definitions @@ -834,6 +886,81 @@ ii crossbuild-essential-armhf 12.3 all Inf ~# ``` +## Create a containerized ISAR SDK root filesystem + +### Motivation + +Distributing and using the SDK root filesystem created following the instructions in "[Create an ISAR SDK root filesystem](#create-an-isar-sdk-root-filesystem)" becomes easier using container images (at least for those using containers anyway) +A "containerized" SDK adds to those advantages of a normal SDK root filesystem the comfort of container images. + +### Approach + +Create container image with SDK root filesystem with installed cross-toolchain for target architecture and ability to install already prebuilt target binary artifacts. +Developer: + - runs a container based on the resulting container image mounting the source code to be built, + - develops applications for target platform on the container and + - leaves the container getting the results on the mounted directory. + +### Solution + +User specifies the variable `SDK_FORMAT` providing a space-separated list of SDK formats to generate. + +Supported formats are: + - `tar-xz`: (default) is the non-containerized format that results from following the instructions in "[Create an ISAR SDK root filesystem](#create-an-isar-sdk-root-filesystem)" + - `docker-archive`: an archive containing a Docker image that can be imported with [`docker import`](https://docs.docker.com/engine/reference/commandline/import/) + - `docker-daemon`: resulting container image is made available on the local Docker Daemon + - `containers-storage`: resulting container image is made available to tools using containers/storage back-end (e.g. Podman, CRIO, buildah,...) + - `oci-archive`: an archive containing an OCI image, mostly for archiving as seed for any of the above formats + +User manually triggers creation of SDK formats for his target platform by launching the task `do_populate_sdk` for target image, f.e. +`bitbake -c do_populate_sdk mc:${MACHINE}-${DISTRO}:isar-image-base`. +Packages that should be additionally installed into the SDK can be appended to `SDK_PREINSTALL` (external repositories) and `SDK_INSTALL` (self-built). + +Following formats don't work if running `bitbake -c do_populate_sdk ...` (to generate the containerized SDK) from inside of a container (e.g. using `kas-container`): `docker-daemon` and `containers-storage`. +It's technically possible, but requires making host resources (e.g. the Docker Daemon socket) accessible in the container. +What can endanger the stability and security of the host. + +The resulting SDK formats are archived into `tmp/deploy/images/${MACHINE}/sdk-${DISTRO}-${DISTRO_ARCH}-${sdk_format}.tar.xz` (being `sdk_format` each one of the formats specified in `SDK_FORMATS`). +The SDK container directory `/isar-apt` contains a copy of isar-apt repo with locally prebuilt target debian packages (for ). +One may get into an SDK container and install required target packages with the help of `apt-get install :` command. +The directory with the source code to develop on should be mounted on the container (with `--volume :`) to be able to edit files in the host with an IDE and build in the container. + +### Example + + - Make the SDK formats to generate available to the task + +For one-shot builds (use `local.conf` otherwise): + +``` +export BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE SDK_FORMATS" +export SDK_FORMATS="docker-archive" +``` + + - Trigger creation of SDK root filesystem + +``` +bitbake -c do_populate_sdk mc:qemuarm-buster:isar-image-base +``` + + - Load the SDK container image into the Docker Daemon + +``` +xzcat build/tmp/deploy/images/qemuarm/sdk-debian-buster-armhf-docker-archive.tar.xz | docker load +``` + + - Run a container using the SDK container image (following commands starting with `#~:` are to be run in the container) + +``` +docker run --rm -ti --volume "$(pwd):/build" isar-sdk-buster-armhf:latest +``` + + - Check that cross toolchains are installed + +``` +:~# dpkg -l | grep crossbuild-essential-armhf +ii crossbuild-essential-armhf 12.3 all Informational list of cross-build-essential packages +``` + ## Creation of local apt repo caching upstream Debian packages ### Motivation