From patchwork Tue Mar 9 10:52:38 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: 355 Return-Path: Delivered-To: ilbers.mnt@gmail.com Received: by 2002:a4a:c583:0:0:0:0:0 with SMTP id x3csp2947807oop; Tue, 9 Mar 2021 13:02:43 -0800 (PST) X-Received: by 2002:a2e:8706:: with SMTP id m6mr17814238lji.331.1615323763119; Tue, 09 Mar 2021 13:02:43 -0800 (PST) ARC-Seal: i=3; a=rsa-sha256; t=1615323763; cv=pass; d=google.com; s=arc-20160816; b=TE0aoMGC7H6/G1gEUY//OlT5K4HSC7ZPLgPNwIvQajWP+YIUEp3fr0/fsnbzy/U+c5 iEsfV9h+qnEbsod7qUHgmm0D9FObWacdjJ363Sz17ZvQ8SGGA6KneDk6AoCtHSC0JpE3 tR7svEc5sXlFgZUNw9GXUda7z85pNTK53A6gX7HImriwfNz7Kc47tFSe3MDHwlzHEof7 /8g/2BOgU3bPtAemrl2CS4ylnRse/e/9jj7tLrNgvMDH/KWBTJLn+7fzAtzMAl8buESA qlIPyrP9BafpJDYLGbGpANw6jpA5Q1ntfJ5IoxySOzu+K7nbI66eUQT01eBJ8dOpJrej UqgQ== 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=77Dqc4ZQaKMsZCQCh2yHZPWBr5vNjKwuP3IGcs1HE9w=; b=fA30/iu88a7Ry87TfJfuCbWKKAxfEFnOVSCSMpWJbR6lsddo1FBO27e1KkGVKyraod dc2BhYf9a7/OusEzqL5qdMackJHgCbFEAnaTUGnvU1BMY+u/dBQ3Fl37H/mZSwKUjP9s fvzYjiIuRLJRNVHppoNaEvwxDRoGmbXajpsoeU7ngs1pBPGOVFcnRctiU5xIUOfFXBuI 9KXqzpqDkU6YdNIw8pJxzcqZ68VXn4PoAV1H6qcx8QfiMv7jWVwWEaO3CPkHQYkbnF6m wqyx5su+PRxNkhZudWrF0nZo7wUamTgftzNFdW3afthlovhKuc1MY5lsxqJpcC8rIdR5 NXRw== ARC-Authentication-Results: i=3; mx.google.com; dkim=pass header.i=@googlegroups.com header.s=20161025 header.b=Jvl8A7zV; arc=pass (i=2 spf=pass spfdomain=siemens.com dmarc=pass fromdomain=siemens.com); spf=pass (google.com: domain of isar-users+bncbcd6jj6cqqfrb4wet6bamgqecyob2hq@googlegroups.com designates 209.85.220.55 as permitted sender) smtp.mailfrom=isar-users+bncBCD6JJ6CQQFRB4WET6BAMGQECYOB2HQ@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 m9sor3537714lfc.150.2021.03.09.13.02.42 (Google Transport Security); Tue, 09 Mar 2021 13:02:43 -0800 (PST) Received-SPF: pass (google.com: domain of isar-users+bncbcd6jj6cqqfrb4wet6bamgqecyob2hq@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=Jvl8A7zV; arc=pass (i=2 spf=pass spfdomain=siemens.com dmarc=pass fromdomain=siemens.com); spf=pass (google.com: domain of isar-users+bncbcd6jj6cqqfrb4wet6bamgqecyob2hq@googlegroups.com designates 209.85.220.55 as permitted sender) smtp.mailfrom=isar-users+bncBCD6JJ6CQQFRB4WET6BAMGQECYOB2HQ@googlegroups.com; dmarc=fail (p=NONE sp=NONE dis=NONE arc=pass) header.from=siemens.com ARC-Seal: i=2; a=rsa-sha256; t=1615323762; cv=pass; d=google.com; s=arc-20160816; b=fQJj1PvcphXsPJuTgLiVKP/kks4iTd32y/sNVZsm6AbumWrEFX0cekaiEA8VOysJbQ N6B0sB3q/RNFd7H87Hs+X6Xn1xVUDQPq7ZyeH2FYa81IsDPtc0+wJxQQtwfyonwLZ0ks s+kUIteQwdJnHwwrRtcM0nauInwueidFMdEF7fTcjXGZHN9KplOX2QcfxmFKDa9d0n9s lwpGbkxa2OaiBE7dUY5m6Kg0Z/vY20Fdn8q2WjRSc9P6gAy95hnG2DYc8Cad9oftyEZm KN2iCdv36Er/J9oMgFp61WAJiva09GNyiPPeW7iEVdimTs65DS5fv0WVNwNzgb8kOI6N tXeg== 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=77Dqc4ZQaKMsZCQCh2yHZPWBr5vNjKwuP3IGcs1HE9w=; b=irHLqAQdbyphK6GLvGnjXsiZD+xo6u+SebtIpmCsp9cRsDXKmb3IgwTQqGbOTbjfsP 9LwSGUvClytP5QN5ZI/4YXs41uzL+IJJmG6vO95ZebUV44PkPS2IwHw6a8UT8wla7rWT UlZgpmrymmkmUwYrqSl/fjxetnsGUVMVi7SvOvInt/KbMjQXSPNaebNx7LTFMA5lsnAu OzhmQSAu6EOnNJAYC6el572ykF1PrMXN3fftMUZooiCSiuXZZI8PH77l3NVJdqgRDOEO l0z4xPvwa8SPjmNAqQbOohbFHQrOp5+kP7yoOAdroO3/TbuBJVs8vU/HzGxg/yJWY8mk swVw== 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=77Dqc4ZQaKMsZCQCh2yHZPWBr5vNjKwuP3IGcs1HE9w=; b=Jvl8A7zVdRwE+kkMDDju6gI4caunmnLIO9vrQzhz9al4OfU/teCXswOwZzCSojuUsi BMioSWXpPNP+uR/znZOFcgvJGCUksFtJExAPCHRzaNgVX7YyvV/RIUjqxK5AaSeVt74H hAd0a8H1f1syP6hemBGXG9Tzbd+MYslcEliHJaZDrdtfJuFhKhyBq9Bfjc3xueGhXY4n miV2E/WvVzg/TV6E+vCNOhLIX3Th7yQ73P89D383RrGXShjEEojOl8VHh+ftqxGyOs/U ExmcesK2Cb4DxoCV32GTN9ZZdxN9TxU7V0ROug0+DcmDPPBGmiaO842jET+xEvyi4LXi FxHg== 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=77Dqc4ZQaKMsZCQCh2yHZPWBr5vNjKwuP3IGcs1HE9w=; b=Kc7h3Yi6SQEPj1XvdUWD9oIpx+4JWKw/nvzdLJPBadBRbaynJmUCzoV2RC6cnYVrva ckFvxzMbwFFFC+gPsQWzb1BSl1hTQmSauQQX9YB03+4p4MhTtnrq2reNL4O5f2v0hFa3 TzL1P/crMC2NYoRdYZ5CbWBRr2lHeakVKMRlqs0RFXSUut+4xxCmFeHpc/GAZtuurksP gTntAzXLGvEHAmLIMT7bff1mXgQIEdcxDESB8dKkQse+r3PhvweDndEhLAW5zqwd+9Aa 84r5bL+QklfjWy4ZWM3XpPUjKgAuAN25m4Z9IYcYg/Y1VzOzy2OwaA3vc9Ql01kbgy5a 8Nlw== Sender: isar-users@googlegroups.com X-Gm-Message-State: AOAM532na0AP53GShPnvF9X49J75PbItZzOeoX6SS4NCUlFP36MSN6Os 8cjTVWZ6tKUKcjg2uMgu3h8= X-Google-Smtp-Source: ABdhPJzYjjNhPU1FORTpVIIopKOEnLPkod88Itxai+y5KnIEn6Fv9rLOP0i7d18v+/n37bKT5KU7jw== X-Received: by 2002:a05:6512:3a86:: with SMTP id q6mr20019363lfu.286.1615323762805; Tue, 09 Mar 2021 13:02:42 -0800 (PST) X-BeenThere: isar-users@googlegroups.com Received: by 2002:a2e:bc11:: with SMTP id b17ls10872ljf.7.gmail; Tue, 09 Mar 2021 13:02:41 -0800 (PST) X-Received: by 2002:a2e:900b:: with SMTP id h11mr18183593ljg.258.1615323761902; Tue, 09 Mar 2021 13:02:41 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1615323761; cv=none; d=google.com; s=arc-20160816; b=AjMI+wUZwKp6CT81MzoNU6uLPe2awVNjXmwQIA4dcO0fDiL2z9cX/D8LzU5/eQBgMg cxsvSzRzPH2b+hb30KAQDhVIW7Ry0fKUrVE7l+FJ9Hbf0Iqcv5IvaTyYDzVmHFou1M1K kSACf/QFIXY+LkrpW0a0U9wFsaupszwpGzDhLExXhIBp9lRC9vWZlfKruQXJys70ABUn ko/GJQFb0MqUvzQr4tq3dKQRu4TDVUWDosot6VvSlmnjET8EUa/rZJYl08QLxbzIJAmd fd/bH8GOkk4lFt9c9ndve4Z411FrzGvgXiHRXGS42TK8KE35lGuArjzedSfRmXT9CCmP lpZA== 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=mc7t8okr31LidSvQf7XgaaSY45QKhgq6HLDPnI1apkweKgq2LQJHWqzIdJ8RYeFpFA wKbFpB2zZq3DbJ3aN07uQJE+5wg9p/XRKMLutUO4ivwxhefc6cxbVy0fad7QbDPlyWHS Hx+n3d8EWO4fAeb5jZPwCxCmdRcRJ+CRSTnkV7rTvJUoKP5EqVppuW8Jh2whxkLtP/Wy NazRTpJlf7K9D5lOhMtz/bK6oBzpL+ao7S0QzhM3+Bo+T8gCqOazSH5z3kd+cCJnIcEs HvdIBP7rqjGU9XfN3nMrJ8QwlSMQB2iZqan4MLiOdCm6CZ/OwCjPke02U9eox9jH2VMq nYNA== 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 d19si620734ljo.1.2021.03.09.13.02.41 for (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Tue, 09 Mar 2021 13:02:41 -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 129L2fsx020805 (version=TLSv1.2 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Tue, 9 Mar 2021 22:02:41 +0100 Received: from md1sf36c.ad001.siemens.net ([139.22.35.216]) by mail1.sbs.de (8.15.2/8.15.2) with ESMTP id 129Kqeb5031095 for ; Tue, 9 Mar 2021 21:52:40 +0100 From: Silvano Cirujano Cuesta To: isar-users@googlegroups.com Subject: [PATCH v6 4/5] docs: document creation of container images Date: Tue, 9 Mar 2021 21:52:38 +0100 Message-Id: <20210309205239.652677-5-silvano.cirujano-cuesta@siemens.com> X-Mailer: git-send-email 2.30.1 In-Reply-To: <20210309205239.652677-1-silvano.cirujano-cuesta@siemens.com> References: <20210309205239.652677-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?1693789729811695272?= X-GMAIL-MSGID: =?utf-8?q?1693789729811695272?= 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