| Message ID | 20240320103229.1078738-5-Adithya.Balakumar@toshiba-tsip.com (mailing list archive) |
|---|---|
| State | Changes Requested |
| Headers | show |
| Series | Integrate Delta Update with rdiff_image and delta handler | expand |
On 3/20/24 11:32 AM, Adithya Balakumar via lists.cip-project.org wrote: > This change includes steps to verify Delta Software Update with > rdiff_image and delta handler > > Signed-off-by: Adithya Balakumar <Adithya.Balakumar@toshiba-tsip.com> > --- > doc/README.swupdate.md | 59 ++++++++++++++++++++++++++++++++++++++++++ > 1 file changed, 59 insertions(+) > > diff --git a/doc/README.swupdate.md b/doc/README.swupdate.md > index b7e13f7..3862649 100644 > --- a/doc/README.swupdate.md > +++ b/doc/README.swupdate.md > @@ -360,6 +360,65 @@ user variables: > > ``` > > +# Building and testing the CIP Core image for Delta Software Update > + > +Set up `kas-container` as described in the [top-level README](../README.md), and then proceed with the following steps. > + > +First build an image using the following command: > +``` > +host$ ./kas-container build kas-cip.yml:kas/board/qemu-amd64.yml:kas/opt/ebg-swu.yml:kas/opt/rt.ym > +``` This is already written in section `# Building and testing the CIP Core image` > + > +## Delta Software Update using rdiff_image handler > + > +Creating an delta update file for rdiff_image handler requires a reference image (against which the delta is computed). In this case, the image built in the previous section can be used as the reference image artifact. By default the `DELTA_UPDATE_TYPE` is set to `rdiff` and `DELTA_RDIFF_REF_IMAGE` is set to the path `image-v1/<artifact-name>.squashfs` (or <artifact-name>.verity in the case of Secure boot enabled image). > +Copy the reference artifact to the mentioned directory in project folder. > + > +Custom artifact path can be set in `DELTA_RDIFF_REF_IMAGE` manually by adding the variable in the `swupdate.yml` file. > + > +Build the image with the modification as shown above with the following command: > +``` > +KAS_BUILD_DIR=image2 ./kas-container build kas-cip.yml:kas/board/qemu-amd64.yml:kas/opt/ebg-swu.yml > +``` > +Now start the first image (which does not contain the packages vim and nano), run the following commands: There is nothing related to vim and nano in the previous steps - and vim or nano are added to any image in cip-core. > +``` > +host$ DISTRO_RELEASE=bookworm SWUPDATE_BOOT=y ./start-qemu.sh amd64 > +``` > +Copy `cip-core-image-cip-core-bookworm-qemu-amd64-delta.swu` file from `image2/tmp/deploy/images/qemu-amd64/` folder into the running system: > +``` > +host$ cd image2/tmp/deploy/images/qemu-amd64/ > +host$ scp -P 22222 ./cip-core-image-cip-core-bookworm-qemu-amd64-delta.swu root@localhost: > +``` > + > +### Delta Software Update Verification > + > +Follow the steps mentioned in the section [SWUpdate verification](#swupdate-verification) for verification. > + > +## Delta Software Update using delta handler > + > +Currently zchunk based delta updates are supported only in Sid images. > +For Delta update with zchunk, set the variable `DELTA_ZCK_URL` with the URL of the zck file that is hosted in a http server and set the `DELTA_UPDATE_TYPE` to `zchunk` im `swupdate.yml` file. > + > +Build the image with the modification as shown above with the following command: > +``` > +KAS_BUILD_DIR=image2 ./kas-container build kas-cip.yml:kas/board/qemu-amd64.yml:kas/opt/ebg-swu.yml > +``` > +Now start the first image (which does not contain the packages vim and nano), run the following commands: > +``` > +host$ DISTRO_RELEASE=bookworm SWUPDATE_BOOT=y ./start-qemu.sh amd64 > +``` > +Copy `cip-core-image-cip-core-bookworm-qemu-amd64-delta.swu` file from `image2/tmp/deploy/images/qemu-amd64/` folder into the running system: > +``` > +host$ cd image2/tmp/deploy/images/qemu-amd64/ > +host$ scp -P 22222 ./cip-core-image-cip-core-bookworm-qemu-amd64-delta.swu root@localhost: > +``` > +The `cip-core-image-cip-core-bookworm-qemu-amd64.zck` file must be hosted in a server. > + > +### Delta Software Update Verification > + > +Follow the steps mentioned in the section [Delta Software Update Verification](#delta-software-update-verification) for verification. > + > + Duplicated section. Already written above. > # Building and testing the CIP Core image for BBB > > Follow the steps mentioned in the section [Building and testing the CIP Core image](README.swupdate.md#building-and-testing-the-cip-core-image) for creating images and .swu files. > > > > -=-=-=-=-=-=-=-=-=-=-=- > Links: You receive all messages sent to this group. > View/Reply Online (#15382): https://lists.cip-project.org/g/cip-dev/message/15382 > Mute This Topic: https://lists.cip-project.org/mt/105041877/1753640 > Group Owner: cip-dev+owner@lists.cip-project.org > Unsubscribe: https://lists.cip-project.org/g/cip-dev/leave/8129121/1753640/1405269326/xyzzy [quirin.gylstorff@siemens.com] > -=-=-=-=-=-=-=-=-=-=-=- >
diff --git a/doc/README.swupdate.md b/doc/README.swupdate.md index b7e13f7..3862649 100644 --- a/doc/README.swupdate.md +++ b/doc/README.swupdate.md @@ -360,6 +360,65 @@ user variables: ``` +# Building and testing the CIP Core image for Delta Software Update + +Set up `kas-container` as described in the [top-level README](../README.md), and then proceed with the following steps. + +First build an image using the following command: +``` +host$ ./kas-container build kas-cip.yml:kas/board/qemu-amd64.yml:kas/opt/ebg-swu.yml:kas/opt/rt.yml +``` + +## Delta Software Update using rdiff_image handler + +Creating an delta update file for rdiff_image handler requires a reference image (against which the delta is computed). In this case, the image built in the previous section can be used as the reference image artifact. By default the `DELTA_UPDATE_TYPE` is set to `rdiff` and `DELTA_RDIFF_REF_IMAGE` is set to the path `image-v1/<artifact-name>.squashfs` (or <artifact-name>.verity in the case of Secure boot enabled image). +Copy the reference artifact to the mentioned directory in project folder. + +Custom artifact path can be set in `DELTA_RDIFF_REF_IMAGE` manually by adding the variable in the `swupdate.yml` file. + +Build the image with the modification as shown above with the following command: +``` +KAS_BUILD_DIR=image2 ./kas-container build kas-cip.yml:kas/board/qemu-amd64.yml:kas/opt/ebg-swu.yml +``` +Now start the first image (which does not contain the packages vim and nano), run the following commands: +``` +host$ DISTRO_RELEASE=bookworm SWUPDATE_BOOT=y ./start-qemu.sh amd64 +``` +Copy `cip-core-image-cip-core-bookworm-qemu-amd64-delta.swu` file from `image2/tmp/deploy/images/qemu-amd64/` folder into the running system: +``` +host$ cd image2/tmp/deploy/images/qemu-amd64/ +host$ scp -P 22222 ./cip-core-image-cip-core-bookworm-qemu-amd64-delta.swu root@localhost: +``` + +### Delta Software Update Verification + +Follow the steps mentioned in the section [SWUpdate verification](#swupdate-verification) for verification. + +## Delta Software Update using delta handler + +Currently zchunk based delta updates are supported only in Sid images. +For Delta update with zchunk, set the variable `DELTA_ZCK_URL` with the URL of the zck file that is hosted in a http server and set the `DELTA_UPDATE_TYPE` to `zchunk` im `swupdate.yml` file. + +Build the image with the modification as shown above with the following command: +``` +KAS_BUILD_DIR=image2 ./kas-container build kas-cip.yml:kas/board/qemu-amd64.yml:kas/opt/ebg-swu.yml +``` +Now start the first image (which does not contain the packages vim and nano), run the following commands: +``` +host$ DISTRO_RELEASE=bookworm SWUPDATE_BOOT=y ./start-qemu.sh amd64 +``` +Copy `cip-core-image-cip-core-bookworm-qemu-amd64-delta.swu` file from `image2/tmp/deploy/images/qemu-amd64/` folder into the running system: +``` +host$ cd image2/tmp/deploy/images/qemu-amd64/ +host$ scp -P 22222 ./cip-core-image-cip-core-bookworm-qemu-amd64-delta.swu root@localhost: +``` +The `cip-core-image-cip-core-bookworm-qemu-amd64.zck` file must be hosted in a server. + +### Delta Software Update Verification + +Follow the steps mentioned in the section [Delta Software Update Verification](#delta-software-update-verification) for verification. + + # Building and testing the CIP Core image for BBB Follow the steps mentioned in the section [Building and testing the CIP Core image](README.swupdate.md#building-and-testing-the-cip-core-image) for creating images and .swu files.
This change includes steps to verify Delta Software Update with rdiff_image and delta handler Signed-off-by: Adithya Balakumar <Adithya.Balakumar@toshiba-tsip.com> --- doc/README.swupdate.md | 59 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+)