public inbox for isar-users@googlegroups.com
 help / color / mirror / Atom feed
* [PATCH v6 0/5] Allow better control over container tags
@ 2021-12-15 17:25 Henning Schild
  2021-12-15 17:25 ` [PATCH v6 1/5] classes: make sure container extension can run multiple times Henning Schild
                   ` (5 more replies)
  0 siblings, 6 replies; 8+ messages in thread
From: Henning Schild @ 2021-12-15 17:25 UTC (permalink / raw)
  To: isar-users; +Cc: Silvano Cirujano Cuesta, Henning Schild

changes since v5:

- allow to prepend a suffix so that one recipe can create multiple
  containers, i.e. the target and its sdk

changes since v4:

- one more rename of a variable we now use NAME[:TAG] and get
  CONTAINER_IMAGE_NAME, CONTAINER_IMAGE_TAG

changed since v3:

- only naming and docs
- rename variables again, patter is "class prefix"+"docker name"
  - docker calls the bits of a tag "TARGET_IMAGE[:TAG]"
  - prefix is "CONTAINER_IMAGE"
- also rename CONTAINER_FORMATS to CONTAINER_IMAGE_FORMATS in p4
- fix docs in p4

changes since v2:

- use CONTAINER_TARGET_IMAGE instead of CONTAINER_IMAGE_NAME
- update docs

changes since v1:

- add RECIPE-API-CHANGELOG entry for interface change in p3

--

A container tags consists of "name:tag" and both have been kind of
hardcoded so far. "tag" was always "latest" which is not proper
versioning. And "name" has always been "isar-DISTRO-ARCH" which is also
not proper because the name should probably describe the content and not
so much the build system. Plus that name means guaranteed collision if
you build two containers with isar based on the same disto and arch.


Henning Schild (5):
  classes: make sure container extension can run multiple times
  classes: simplify tag handling in container class
  classes: allow more control over container image name and tag
  classes: rename CONTAINER_FORMATS to CONTAINER_IMAGE_FORMATS
  classes: fix comment in container-img class

 RECIPE-API-CHANGELOG.md                       |  8 +++++
 doc/user_manual.md                            | 16 +++++-----
 meta/classes/container-img.bbclass            | 10 +++----
 .../classes/image-container-extension.bbclass | 30 ++++++++++---------
 meta/classes/image-sdk-extension.bbclass      |  2 +-
 5 files changed, 37 insertions(+), 29 deletions(-)

-- 
2.32.0


^ permalink raw reply	[flat|nested] 8+ messages in thread

* [PATCH v6 1/5] classes: make sure container extension can run multiple times
  2021-12-15 17:25 [PATCH v6 0/5] Allow better control over container tags Henning Schild
@ 2021-12-15 17:25 ` Henning Schild
  2021-12-15 17:25 ` [PATCH v6 2/5] classes: simplify tag handling in container class Henning Schild
                   ` (4 subsequent siblings)
  5 siblings, 0 replies; 8+ messages in thread
From: Henning Schild @ 2021-12-15 17:25 UTC (permalink / raw)
  To: isar-users; +Cc: Silvano Cirujano Cuesta, Henning Schild

If the container extension fails somewhere in the middle, it could leave
things behind resulting in issues when trying to run only that one task
again.

So make sure to remove stuff as root and remove another possibly
existing directory.

Signed-off-by: Henning Schild <henning.schild@siemens.com>
---
 meta/classes/image-container-extension.bbclass | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/meta/classes/image-container-extension.bbclass b/meta/classes/image-container-extension.bbclass
index e26604a04f06..6537fc693265 100644
--- a/meta/classes/image-container-extension.bbclass
+++ b/meta/classes/image-container-extension.bbclass
@@ -18,7 +18,7 @@ containerize_rootfs() {
 
     # prepare OCI container image skeleton
     bbdebug 1 "prepare OCI container image skeleton"
-    rm -rf "${oci_img_dir}"
+    sudo rm -rf "${oci_img_dir}" "${oci_img_dir}_unpacked"
     sudo umoci init --layout "${oci_img_dir}"
     sudo umoci new --image "${oci_img_dir}:${empty_tag}"
     sudo umoci config --image "${oci_img_dir}:${empty_tag}" \
-- 
2.32.0


^ permalink raw reply	[flat|nested] 8+ messages in thread

* [PATCH v6 2/5] classes: simplify tag handling in container class
  2021-12-15 17:25 [PATCH v6 0/5] Allow better control over container tags Henning Schild
  2021-12-15 17:25 ` [PATCH v6 1/5] classes: make sure container extension can run multiple times Henning Schild
@ 2021-12-15 17:25 ` Henning Schild
  2021-12-15 17:25 ` [PATCH v6 3/5] classes: allow more control over container image name and tag Henning Schild
                   ` (3 subsequent siblings)
  5 siblings, 0 replies; 8+ messages in thread
From: Henning Schild @ 2021-12-15 17:25 UTC (permalink / raw)
  To: isar-users; +Cc: Silvano Cirujano Cuesta, Henning Schild

Call the variable "tag" and use it in all places where "latest" was
hardcoded. This prepares for another patch that will allow chosing
something else than "latest" for a tag.

Signed-off-by: Henning Schild <henning.schild@siemens.com>
---
 meta/classes/image-container-extension.bbclass | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/meta/classes/image-container-extension.bbclass b/meta/classes/image-container-extension.bbclass
index 6537fc693265..0e70ba9c1405 100644
--- a/meta/classes/image-container-extension.bbclass
+++ b/meta/classes/image-container-extension.bbclass
@@ -10,7 +10,7 @@ CONTAINER_FORMATS ?= "docker-archive"
 containerize_rootfs() {
     local cmd="/bin/dash"
     local empty_tag="empty"
-    local full_tag="latest"
+    local tag="latest"
     local oci_img_dir="${WORKDIR}/oci-image"
     local rootfs="$1"
     local rootfs_id="$2"
@@ -33,7 +33,7 @@ containerize_rootfs() {
 
     # pack container image
     bbdebug 1 "pack container image"
-    sudo umoci repack --image "${oci_img_dir}:${full_tag}" \
+    sudo umoci repack --image "${oci_img_dir}:${tag}" \
         "${oci_img_dir}_unpacked"
     sudo umoci remove --image "${oci_img_dir}:${empty_tag}"
     sudo rm -rf "${oci_img_dir}_unpacked"
@@ -49,14 +49,14 @@ containerize_rootfs() {
         case "${image_type}" in
             "docker-archive" | "oci-archive")
                 if [ "${image_type}" = "oci-archive" ] ; then
-                    target="${image_type}:${image_archive}:latest"
+                    target="${image_type}:${image_archive}:${tag}"
                 else
-                    target="${image_type}:${image_archive}:${image_name}:latest"
+                    target="${image_type}:${image_archive}:${image_name}:${tag}"
                 fi
                 rm -f "${image_archive}" "${image_archive}.xz"
                 bbdebug 2 "Converting OCI image to ${image_type}"
                 skopeo --insecure-policy copy \
-                    "oci:${oci_img_dir}:${full_tag}" "${target}"
+                    "oci:${oci_img_dir}:${tag}" "${target}"
                 bbdebug 2 "Compressing image"
                 xz -T0 "${image_archive}"
                 ;;
@@ -69,8 +69,8 @@ containerize_rootfs() {
                     die "Adding the container image to a container runtime (${image_type}) not supported if running from a container (e.g. 'kas-container')"
                 fi
                 skopeo --insecure-policy copy \
-                    "oci:${oci_img_dir}:${full_tag}" \
-                    "${image_type}:${image_name}:latest"
+                    "oci:${oci_img_dir}:${tag}" \
+                    "${image_type}:${image_name}:${tag}"
                 ;;
             *)
                 die "Unsupported format for containerize_rootfs: ${image_type}"
-- 
2.32.0


^ permalink raw reply	[flat|nested] 8+ messages in thread

* [PATCH v6 3/5] classes: allow more control over container image name and tag
  2021-12-15 17:25 [PATCH v6 0/5] Allow better control over container tags Henning Schild
  2021-12-15 17:25 ` [PATCH v6 1/5] classes: make sure container extension can run multiple times Henning Schild
  2021-12-15 17:25 ` [PATCH v6 2/5] classes: simplify tag handling in container class Henning Schild
@ 2021-12-15 17:25 ` Henning Schild
  2022-01-04 17:53   ` Henning Schild
  2021-12-15 17:25 ` [PATCH v6 4/5] classes: rename CONTAINER_FORMATS to CONTAINER_IMAGE_FORMATS Henning Schild
                   ` (2 subsequent siblings)
  5 siblings, 1 reply; 8+ messages in thread
From: Henning Schild @ 2021-12-15 17:25 UTC (permalink / raw)
  To: isar-users; +Cc: Silvano Cirujano Cuesta, Henning Schild

This patch allows more fine-grained control over how the resulting
container will be tagged. Where the default name will be PN together
with DISTRO and ARCH, and tag will be derived from PV and PR

Signed-off-by: Henning Schild <henning.schild@siemens.com>
---
 RECIPE-API-CHANGELOG.md                        |  4 ++++
 doc/user_manual.md                             |  8 ++++----
 meta/classes/container-img.bbclass             |  4 +---
 meta/classes/image-container-extension.bbclass | 12 +++++++-----
 meta/classes/image-sdk-extension.bbclass       |  2 +-
 5 files changed, 17 insertions(+), 13 deletions(-)

diff --git a/RECIPE-API-CHANGELOG.md b/RECIPE-API-CHANGELOG.md
index 55836258ce49..b3e6a2af199d 100644
--- a/RECIPE-API-CHANGELOG.md
+++ b/RECIPE-API-CHANGELOG.md
@@ -306,3 +306,7 @@ When using the plugins it is advised to name the partition "/boot" and to exclud
 
 The variable is renamed to get closer to OE/Poky variables naming. The old naming
 will still also work, but with deprecation warning shown.
+
+### Change default "NAME:TAG" when building container images
+
+The "NAME" used to be rather static and the TAG was always "latest", now the values are derived from recipe variables PN, PV, PR.
diff --git a/doc/user_manual.md b/doc/user_manual.md
index c81c6e466e40..eaafd6a9d708 100644
--- a/doc/user_manual.md
+++ b/doc/user_manual.md
@@ -305,14 +305,14 @@ bitbake mc:qemuarm-buster:isar-image-base
  - Load the container image into the Docker Daemon
 
 ```
-docker load -i build/tmp/deploy/images/qemuarm/debian-buster-armhf-docker-archive.tar.xz
+docker load -i build/tmp/deploy/images/qemuarm/isar-image-base-debian-buster-armhf-1.0-r0-docker-archive.tar.xz
 ```
 
  - 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
+docker run --rm -ti --volume "$(pwd):/build" isar-image-base-debian-buster-armhf:1.0-r0
 ```
 
 ---
@@ -1139,14 +1139,14 @@ bitbake -c do_populate_sdk mc:qemuarm-buster:isar-image-base
  - Load the SDK container image into the Docker Daemon
 
 ```
-docker load -i build/tmp/deploy/images/qemuarm/sdk-debian-buster-armhf-docker-archive.tar.xz
+docker load -i build/tmp/deploy/images/qemuarm/sdk-isar-image-base-debian-buster-armhf-1.0-r0-docker-archive.tar.xz
 ```
 
  - 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
+docker run --rm -ti --volume "$(pwd):/build" sdk-isar-image-base-debian-buster-armhf:1.0-r0
 ```
 
  - Check that cross toolchains are installed
diff --git a/meta/classes/container-img.bbclass b/meta/classes/container-img.bbclass
index 8fef52a7195c..4e0fe0efb484 100644
--- a/meta/classes/container-img.bbclass
+++ b/meta/classes/container-img.bbclass
@@ -10,10 +10,8 @@ do_container_image[dirs] = "${DEPLOY_DIR_IMAGE}"
 do_container_image[stamp-extra-info] = "${DISTRO}-${MACHINE}"
 do_container_image[vardeps] += "CONTAINER_FORMATS"
 do_container_image(){
-    rootfs_id="${DISTRO}-${DISTRO_ARCH}"
-
     bbdebug 1 "Generate container image in these formats: ${CONTAINER_FORMATS}"
-    containerize_rootfs "${IMAGE_ROOTFS}" "${rootfs_id}" "${CONTAINER_FORMATS}"
+    containerize_rootfs "${IMAGE_ROOTFS}" "${CONTAINER_FORMATS}"
 }
 
 addtask container_image before do_image after do_image_tools
diff --git a/meta/classes/image-container-extension.bbclass b/meta/classes/image-container-extension.bbclass
index 0e70ba9c1405..b8cf85a5c256 100644
--- a/meta/classes/image-container-extension.bbclass
+++ b/meta/classes/image-container-extension.bbclass
@@ -6,15 +6,17 @@
 # This class extends the image.bbclass for containerizing the root filesystem.
 
 CONTAINER_FORMATS ?= "docker-archive"
+CONTAINER_IMAGE_NAME ?= "${PN}-${DISTRO}-${DISTRO_ARCH}"
+CONTAINER_IMAGE_TAG ?= "${PV}-${PR}"
 
 containerize_rootfs() {
     local cmd="/bin/dash"
     local empty_tag="empty"
-    local tag="latest"
+    local tag="${CONTAINER_IMAGE_TAG}"
     local oci_img_dir="${WORKDIR}/oci-image"
     local rootfs="$1"
-    local rootfs_id="$2"
-    local container_formats="$3"
+    local container_formats="$2"
+    local container_name_prefix="$3"
 
     # prepare OCI container image skeleton
     bbdebug 1 "prepare OCI container image skeleton"
@@ -42,9 +44,9 @@ containerize_rootfs() {
     sudo chown --recursive $(id -u):$(id -g) "${oci_img_dir}"
 
     # convert the OCI container image to the desired format
-    image_name="isar-${rootfs_id}"
+    image_name="${container_name_prefix}${CONTAINER_IMAGE_NAME}"
     for image_type in ${CONTAINER_FORMATS} ; do
-        image_archive="${DEPLOY_DIR_IMAGE}/${rootfs_id}-${image_type}.tar"
+        image_archive="${DEPLOY_DIR_IMAGE}/${image_name}-${tag}-${image_type}.tar"
         bbdebug 1 "Creating container image type: ${image_type}"
         case "${image_type}" in
             "docker-archive" | "oci-archive")
diff --git a/meta/classes/image-sdk-extension.bbclass b/meta/classes/image-sdk-extension.bbclass
index 426b92595554..052c1b580451 100644
--- a/meta/classes/image-sdk-extension.bbclass
+++ b/meta/classes/image-sdk-extension.bbclass
@@ -80,7 +80,7 @@ do_populate_sdk() {
     # generate the SDK in all the desired container formats
     if [ -n "${sdk_container_formats}" ] ; then
         bbnote "Generating SDK container in ${sdk_container_formats} format"
-        containerize_rootfs "${SDKCHROOT_DIR}" "sdk-${DISTRO}-${DISTRO_ARCH}" "${sdk_container_formats}"
+        containerize_rootfs "${SDKCHROOT_DIR}" "${sdk_container_formats}" "sdk-"
     fi
 }
 
-- 
2.32.0


^ permalink raw reply	[flat|nested] 8+ messages in thread

* [PATCH v6 4/5] classes: rename CONTAINER_FORMATS to CONTAINER_IMAGE_FORMATS
  2021-12-15 17:25 [PATCH v6 0/5] Allow better control over container tags Henning Schild
                   ` (2 preceding siblings ...)
  2021-12-15 17:25 ` [PATCH v6 3/5] classes: allow more control over container image name and tag Henning Schild
@ 2021-12-15 17:25 ` Henning Schild
  2021-12-15 17:25 ` [PATCH v6 5/5] classes: fix comment in container-img class Henning Schild
  2021-12-22 15:27 ` [PATCH v6 0/5] Allow better control over container tags Anton Mikanovich
  5 siblings, 0 replies; 8+ messages in thread
From: Henning Schild @ 2021-12-15 17:25 UTC (permalink / raw)
  To: isar-users; +Cc: Silvano Cirujano Cuesta, Henning Schild

This brings some consistency with other image-classes, that image class
variables are prefixed with that class.

Also fix the docs (where the trailing S was missing), and mention the
interface break in our changelog.

Signed-off-by: Henning Schild <henning.schild@siemens.com>
---
 RECIPE-API-CHANGELOG.md                        | 4 ++++
 doc/user_manual.md                             | 8 ++++----
 meta/classes/container-img.bbclass             | 6 +++---
 meta/classes/image-container-extension.bbclass | 4 ++--
 4 files changed, 13 insertions(+), 9 deletions(-)

diff --git a/RECIPE-API-CHANGELOG.md b/RECIPE-API-CHANGELOG.md
index b3e6a2af199d..3bbb42a9a701 100644
--- a/RECIPE-API-CHANGELOG.md
+++ b/RECIPE-API-CHANGELOG.md
@@ -310,3 +310,7 @@ will still also work, but with deprecation warning shown.
 ### Change default "NAME:TAG" when building container images
 
 The "NAME" used to be rather static and the TAG was always "latest", now the values are derived from recipe variables PN, PV, PR.
+
+### Renamed variable CONTAINER_FORMATS to CONTAINER_IMAGE_FORMATS
+
+The meaning remains the same, just the name changed.
diff --git a/doc/user_manual.md b/doc/user_manual.md
index eaafd6a9d708..caaab8ccfc02 100644
--- a/doc/user_manual.md
+++ b/doc/user_manual.md
@@ -260,7 +260,7 @@ 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 
+variable `CONTAINER_IMAGE_FORMATS`. 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 load`](https://docs.docker.com/engine/reference/commandline/load)
@@ -282,7 +282,7 @@ 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`).
+`CONTAINER_IMAGE_FORMATS`).
 
 ### Example
 
@@ -291,9 +291,9 @@ The resulting container image archives (only for `docker-archive` and
 For one-shot builds (use `local.conf` otherwise):
 
 ```
-export BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE IMAGE_FSTYPES CONTAINER_FORMAT"
+export BB_ENV_EXTRAWHITE="$BB_ENV_EXTRAWHITE IMAGE_TYPE CONTAINER_IMAGE_FORMATS"
 export IMAGE_FSTYPES="container-img"
-export CONTAINER_FORMAT="docker-archive"
+export CONTAINER_IMAGE_FORMATS="docker-archive"
 ```
 
  - Trigger creation of container image from root filesystem
diff --git a/meta/classes/container-img.bbclass b/meta/classes/container-img.bbclass
index 4e0fe0efb484..e26895a92b1e 100644
--- a/meta/classes/container-img.bbclass
+++ b/meta/classes/container-img.bbclass
@@ -8,10 +8,10 @@
 
 do_container_image[dirs] = "${DEPLOY_DIR_IMAGE}"
 do_container_image[stamp-extra-info] = "${DISTRO}-${MACHINE}"
-do_container_image[vardeps] += "CONTAINER_FORMATS"
+do_container_image[vardeps] += "CONTAINER_IMAGE_FORMATS"
 do_container_image(){
-    bbdebug 1 "Generate container image in these formats: ${CONTAINER_FORMATS}"
-    containerize_rootfs "${IMAGE_ROOTFS}" "${CONTAINER_FORMATS}"
+    bbdebug 1 "Generate container image in these formats: ${CONTAINER_IMAGE_FORMATS}"
+    containerize_rootfs "${IMAGE_ROOTFS}" "${CONTAINER_IMAGE_FORMATS}"
 }
 
 addtask container_image before do_image after do_image_tools
diff --git a/meta/classes/image-container-extension.bbclass b/meta/classes/image-container-extension.bbclass
index b8cf85a5c256..cdec46334370 100644
--- a/meta/classes/image-container-extension.bbclass
+++ b/meta/classes/image-container-extension.bbclass
@@ -5,7 +5,7 @@
 #
 # This class extends the image.bbclass for containerizing the root filesystem.
 
-CONTAINER_FORMATS ?= "docker-archive"
+CONTAINER_IMAGE_FORMATS ?= "docker-archive"
 CONTAINER_IMAGE_NAME ?= "${PN}-${DISTRO}-${DISTRO_ARCH}"
 CONTAINER_IMAGE_TAG ?= "${PV}-${PR}"
 
@@ -45,7 +45,7 @@ containerize_rootfs() {
 
     # convert the OCI container image to the desired format
     image_name="${container_name_prefix}${CONTAINER_IMAGE_NAME}"
-    for image_type in ${CONTAINER_FORMATS} ; do
+    for image_type in ${CONTAINER_IMAGE_FORMATS} ; do
         image_archive="${DEPLOY_DIR_IMAGE}/${image_name}-${tag}-${image_type}.tar"
         bbdebug 1 "Creating container image type: ${image_type}"
         case "${image_type}" in
-- 
2.32.0


^ permalink raw reply	[flat|nested] 8+ messages in thread

* [PATCH v6 5/5] classes: fix comment in container-img class
  2021-12-15 17:25 [PATCH v6 0/5] Allow better control over container tags Henning Schild
                   ` (3 preceding siblings ...)
  2021-12-15 17:25 ` [PATCH v6 4/5] classes: rename CONTAINER_FORMATS to CONTAINER_IMAGE_FORMATS Henning Schild
@ 2021-12-15 17:25 ` Henning Schild
  2021-12-22 15:27 ` [PATCH v6 0/5] Allow better control over container tags Anton Mikanovich
  5 siblings, 0 replies; 8+ messages in thread
From: Henning Schild @ 2021-12-15 17:25 UTC (permalink / raw)
  To: isar-users; +Cc: Silvano Cirujano Cuesta, Henning Schild

The task name is in fact a different one, the function sits in another
class.

Signed-off-by: Henning Schild <henning.schild@siemens.com>
---
 meta/classes/container-img.bbclass | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/meta/classes/container-img.bbclass b/meta/classes/container-img.bbclass
index e26895a92b1e..322889a9eb03 100644
--- a/meta/classes/container-img.bbclass
+++ b/meta/classes/container-img.bbclass
@@ -3,7 +3,7 @@
 #
 # SPDX-License-Identifier: MIT
 #
-# This class provides the task 'containerize_rootfs'
+# This class provides the task 'container_image'
 # to create container images containing the target rootfs.
 
 do_container_image[dirs] = "${DEPLOY_DIR_IMAGE}"
-- 
2.32.0


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH v6 0/5] Allow better control over container tags
  2021-12-15 17:25 [PATCH v6 0/5] Allow better control over container tags Henning Schild
                   ` (4 preceding siblings ...)
  2021-12-15 17:25 ` [PATCH v6 5/5] classes: fix comment in container-img class Henning Schild
@ 2021-12-22 15:27 ` Anton Mikanovich
  5 siblings, 0 replies; 8+ messages in thread
From: Anton Mikanovich @ 2021-12-22 15:27 UTC (permalink / raw)
  To: Henning Schild, isar-users; +Cc: Silvano Cirujano Cuesta

15.12.2021 20:25, Henning Schild wrote:
> changes since v5:
>
> - allow to prepend a suffix so that one recipe can create multiple
>    containers, i.e. the target and its sdk
>
> changes since v4:
>
> - one more rename of a variable we now use NAME[:TAG] and get
>    CONTAINER_IMAGE_NAME, CONTAINER_IMAGE_TAG
>
> changed since v3:
>
> - only naming and docs
> - rename variables again, patter is "class prefix"+"docker name"
>    - docker calls the bits of a tag "TARGET_IMAGE[:TAG]"
>    - prefix is "CONTAINER_IMAGE"
> - also rename CONTAINER_FORMATS to CONTAINER_IMAGE_FORMATS in p4
> - fix docs in p4
>
> changes since v2:
>
> - use CONTAINER_TARGET_IMAGE instead of CONTAINER_IMAGE_NAME
> - update docs
>
> changes since v1:
>
> - add RECIPE-API-CHANGELOG entry for interface change in p3

Applied to next, thanks.

-- 
Anton Mikanovich
Promwad Ltd.
External service provider of ilbers GmbH
Maria-Merian-Str. 8
85521 Ottobrunn, Germany
+49 (89) 122 67 24-0
Commercial register Munich, HRB 214197
General Manager: Baurzhan Ismagulov


^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH v6 3/5] classes: allow more control over container image name and tag
  2021-12-15 17:25 ` [PATCH v6 3/5] classes: allow more control over container image name and tag Henning Schild
@ 2022-01-04 17:53   ` Henning Schild
  0 siblings, 0 replies; 8+ messages in thread
From: Henning Schild @ 2022-01-04 17:53 UTC (permalink / raw)
  To: isar-users; +Cc: Silvano Cirujano Cuesta

Am Wed, 15 Dec 2021 18:25:48 +0100
schrieb Henning Schild <henning.schild@siemens.com>:

> This patch allows more fine-grained control over how the resulting
> container will be tagged. Where the default name will be PN together
> with DISTRO and ARCH, and tag will be derived from PV and PR
> 
> Signed-off-by: Henning Schild <henning.schild@siemens.com>
> ---
>  RECIPE-API-CHANGELOG.md                        |  4 ++++
>  doc/user_manual.md                             |  8 ++++----
>  meta/classes/container-img.bbclass             |  4 +---
>  meta/classes/image-container-extension.bbclass | 12 +++++++-----
>  meta/classes/image-sdk-extension.bbclass       |  2 +-
>  5 files changed, 17 insertions(+), 13 deletions(-)
> 
> diff --git a/RECIPE-API-CHANGELOG.md b/RECIPE-API-CHANGELOG.md
> index 55836258ce49..b3e6a2af199d 100644
> --- a/RECIPE-API-CHANGELOG.md
> +++ b/RECIPE-API-CHANGELOG.md
> @@ -306,3 +306,7 @@ When using the plugins it is advised to name the
> partition "/boot" and to exclud 
>  The variable is renamed to get closer to OE/Poky variables naming.
> The old naming will still also work, but with deprecation warning
> shown. +
> +### Change default "NAME:TAG" when building container images
> +
> +The "NAME" used to be rather static and the TAG was always "latest",
> now the values are derived from recipe variables PN, PV, PR. diff
> --git a/doc/user_manual.md b/doc/user_manual.md index
> c81c6e466e40..eaafd6a9d708 100644 --- a/doc/user_manual.md
> +++ b/doc/user_manual.md
> @@ -305,14 +305,14 @@ bitbake mc:qemuarm-buster:isar-image-base
>   - Load the container image into the Docker Daemon
>  
>  ```
> -docker load -i
> build/tmp/deploy/images/qemuarm/debian-buster-armhf-docker-archive.tar.xz
> +docker load -i
> build/tmp/deploy/images/qemuarm/isar-image-base-debian-buster-armhf-1.0-r0-docker-archive.tar.xz

I just tried this for real in the layer i wrote it for. Turns out that
the version in the filename might not be the best idea, because none of
our images do that.
Having the version in the metadata might be good enough while having a
stable filename.

What do you guys think, should i write another patch to remove the
version from the deployed image? I tend to do so and it would be more
in line with all our other image types.

On the other hand we could think about PV in the filename of all our
images, but that would be a pretty dramatic change. In fact the PV of
an image is not too meaningful to most people and hardly ever bumped,
people rely on metadata ... /etc/os-release.

Henning

> ``` 
>   - 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
> +docker run --rm -ti --volume "$(pwd):/build"
> isar-image-base-debian-buster-armhf:1.0-r0 ```
>  
>  ---
> @@ -1139,14 +1139,14 @@ bitbake -c do_populate_sdk
> mc:qemuarm-buster:isar-image-base
>   - Load the SDK container image into the Docker Daemon
>  
>  ```
> -docker load -i
> build/tmp/deploy/images/qemuarm/sdk-debian-buster-armhf-docker-archive.tar.xz
> +docker load -i
> build/tmp/deploy/images/qemuarm/sdk-isar-image-base-debian-buster-armhf-1.0-r0-docker-archive.tar.xz
> ``` 
>   - 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 +docker run --rm -ti --volume
> "$(pwd):/build" sdk-isar-image-base-debian-buster-armhf:1.0-r0 ```
>  
>   - Check that cross toolchains are installed
> diff --git a/meta/classes/container-img.bbclass
> b/meta/classes/container-img.bbclass index 8fef52a7195c..4e0fe0efb484
> 100644 --- a/meta/classes/container-img.bbclass
> +++ b/meta/classes/container-img.bbclass
> @@ -10,10 +10,8 @@ do_container_image[dirs] = "${DEPLOY_DIR_IMAGE}"
>  do_container_image[stamp-extra-info] = "${DISTRO}-${MACHINE}"
>  do_container_image[vardeps] += "CONTAINER_FORMATS"
>  do_container_image(){
> -    rootfs_id="${DISTRO}-${DISTRO_ARCH}"
> -
>      bbdebug 1 "Generate container image in these formats:
> ${CONTAINER_FORMATS}"
> -    containerize_rootfs "${IMAGE_ROOTFS}" "${rootfs_id}"
> "${CONTAINER_FORMATS}"
> +    containerize_rootfs "${IMAGE_ROOTFS}" "${CONTAINER_FORMATS}"
>  }
>  
>  addtask container_image before do_image after do_image_tools
> diff --git a/meta/classes/image-container-extension.bbclass
> b/meta/classes/image-container-extension.bbclass index
> 0e70ba9c1405..b8cf85a5c256 100644 ---
> a/meta/classes/image-container-extension.bbclass +++
> b/meta/classes/image-container-extension.bbclass @@ -6,15 +6,17 @@
>  # This class extends the image.bbclass for containerizing the root
> filesystem. 
>  CONTAINER_FORMATS ?= "docker-archive"
> +CONTAINER_IMAGE_NAME ?= "${PN}-${DISTRO}-${DISTRO_ARCH}"
> +CONTAINER_IMAGE_TAG ?= "${PV}-${PR}"
>  
>  containerize_rootfs() {
>      local cmd="/bin/dash"
>      local empty_tag="empty"
> -    local tag="latest"
> +    local tag="${CONTAINER_IMAGE_TAG}"
>      local oci_img_dir="${WORKDIR}/oci-image"
>      local rootfs="$1"
> -    local rootfs_id="$2"
> -    local container_formats="$3"
> +    local container_formats="$2"
> +    local container_name_prefix="$3"
>  
>      # prepare OCI container image skeleton
>      bbdebug 1 "prepare OCI container image skeleton"
> @@ -42,9 +44,9 @@ containerize_rootfs() {
>      sudo chown --recursive $(id -u):$(id -g) "${oci_img_dir}"
>  
>      # convert the OCI container image to the desired format
> -    image_name="isar-${rootfs_id}"
> +    image_name="${container_name_prefix}${CONTAINER_IMAGE_NAME}"
>      for image_type in ${CONTAINER_FORMATS} ; do
> -
> image_archive="${DEPLOY_DIR_IMAGE}/${rootfs_id}-${image_type}.tar"
> +
> image_archive="${DEPLOY_DIR_IMAGE}/${image_name}-${tag}-${image_type}.tar"
> bbdebug 1 "Creating container image type: ${image_type}" case
> "${image_type}" in "docker-archive" | "oci-archive")
> diff --git a/meta/classes/image-sdk-extension.bbclass
> b/meta/classes/image-sdk-extension.bbclass index
> 426b92595554..052c1b580451 100644 ---
> a/meta/classes/image-sdk-extension.bbclass +++
> b/meta/classes/image-sdk-extension.bbclass @@ -80,7 +80,7 @@
> do_populate_sdk() { # generate the SDK in all the desired container
> formats if [ -n "${sdk_container_formats}" ] ; then
>          bbnote "Generating SDK container in ${sdk_container_formats}
> format"
> -        containerize_rootfs "${SDKCHROOT_DIR}"
> "sdk-${DISTRO}-${DISTRO_ARCH}" "${sdk_container_formats}"
> +        containerize_rootfs "${SDKCHROOT_DIR}"
> "${sdk_container_formats}" "sdk-" fi
>  }
>  


^ permalink raw reply	[flat|nested] 8+ messages in thread

end of thread, other threads:[~2022-01-04 17:53 UTC | newest]

Thread overview: 8+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-12-15 17:25 [PATCH v6 0/5] Allow better control over container tags Henning Schild
2021-12-15 17:25 ` [PATCH v6 1/5] classes: make sure container extension can run multiple times Henning Schild
2021-12-15 17:25 ` [PATCH v6 2/5] classes: simplify tag handling in container class Henning Schild
2021-12-15 17:25 ` [PATCH v6 3/5] classes: allow more control over container image name and tag Henning Schild
2022-01-04 17:53   ` Henning Schild
2021-12-15 17:25 ` [PATCH v6 4/5] classes: rename CONTAINER_FORMATS to CONTAINER_IMAGE_FORMATS Henning Schild
2021-12-15 17:25 ` [PATCH v6 5/5] classes: fix comment in container-img class Henning Schild
2021-12-22 15:27 ` [PATCH v6 0/5] Allow better control over container tags Anton Mikanovich

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox