Skip to content

AB: Slot update artefacts now have a basename #4326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
learmj wants to merge 1 commit into
base: master
Choose a base branch
from
Open

AB: Slot update artefacts now have a basename #4326

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions documentation/asciidoc/services/connect/ab-boot-update.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Configuring for A/B boot requires being able to physically access the device. Th

Raspberry Pi 5 and later devices that use EEPROM boot can also be configured to use A/B boot update. See xref:../computers/raspberry-pi.adoc#ab-bootloader-updates[A/B bootloader updates].

Use https://github.com/raspberrypi/rpi-image-gen[rpi-image-gen] to create both the A/B boot configuration (`.img` file) and the update artefacts (`.tar.zst` files). Use https://www.raspberrypi.com/software/[Raspberry Pi Imager] to configure the `.img` file and write it to the storage device for transfer to the recipient Raspberry Pi.
Use https://github.com/raspberrypi/rpi-image-gen[rpi-image-gen] to create both the A/B boot configuration (`.img` file) and the update artefacts (`update.tar.zst` files). Use https://www.raspberrypi.com/software/[Raspberry Pi Imager] to configure the `.img` file and write it to the storage device for transfer to the recipient Raspberry Pi.

==== Prerequisites

Expand Down Expand Up @@ -264,7 +264,7 @@ To host the update artefact:
+
[source,console]
----
$ python -m http.server 8080 --directory ./work/image-myapp-1.1.0
$ python -m http.server 8080 --directory ./work/image-myapp
----

===== Step 2: Calculate the SHA-256 checksum of the update file
Expand All @@ -273,7 +273,7 @@ $ python -m http.server 8080 --directory ./work/image-myapp-1.1.0
+
[source,console]
----
$ sha256sum ./work/image-myapp-1.1.0/update.tar.zst
$ sha256sum ./work/image-myapp/myapp-update.tar.zst
----
. Copy down the checksum.

Expand Down Expand Up @@ -315,4 +315,4 @@ The command line returns something like the following, indicating that the `Arte
----
Generated using rpi-image-gen e3828f885c860f15991468883d3b8484b0eaf9d8 on 2025-12-09
Artefact version: 1.1.0
----
----
6 changes: 3 additions & 3 deletions documentation/asciidoc/services/connect/remote-update.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,19 @@ Host the artefact anywhere the recipient device can reach it: your own web serve

The location must be accessible to the recipient device, but it doesn't have to be accessible to the Raspberry Pi Connect servers, or to the internet at large. Serving an artefact from another computer on the same local network as the recipient device works well.

Here is an example URI: http://192.168.0.1:8080/path/to/update.tar.zst
Here is an example URI: http://192.168.0.1:8080/path/to/app.update.tar.zst

It contains the following required information:

* The host IP: 192.168.0.1
* The port: 8080
* The path: /path/to/update.tar.zst
* The path: /path/to/app.update.tar.zst

You also need the artefact's SHA-256 checksum, which Connect passes to the device so that it can check that the artefact hasn't been corrupted or tampered with in transit. `otamaker` prints the checksum when it builds a script artefact; otherwise, calculate it with `sha256sum`:

[source,console]
----
$ sha256sum update.tar.zst
$ sha256sum app.update.tar.zst
----

Copy down the URI and the checksum; you need both in the next section.
Expand Down