RAUC

https://rauc.readthedocs.io/en/v1.15.1/
Admin
RAUC is a lightweight update client for embedded devices that reliably controls firmware updates...
Tokens:61,622
Snippets:917
Trust Score:8.3
Update:3 months ago
Show doc for...
Tokens:
Raw
### Configure Install Hook

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/using.rst.txt

Examples of configuring an install hook with and without a filename.

```cfg
[hooks]
filename=hook

[image.rootfs]
filename=rootfs.img
size=...
sha256=...
hooks=install
```

```cfg
[hooks]
filename=hook

[image.datafs]
hooks=install
```

--------------------------------

### install

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/man.rst.txt

Installs a bundle to the system.

```APIDOC
## install [BUNDLE]

### Description
Install a bundle.

### Options
- **--ignore-compatible** - Optional - disable compatible check
- **--ignore-version-limit** - Optional - disable version check
- **--transaction-id** (UUID) - Optional - custom transaction ID
- **--require-manifest-hash** (HASH) - Optional - require a specific manifest hash
- **--progress** - Optional - show progress bar
- **--tls-cert** (PEMFILE|PKCS11-URL) - Optional - TLS client certificate file or PKCS#11 URL
- **--tls-key** (PEMFILE|PKCS11-URL) - Optional - TLS client key file or PKCS#11 URL
- **--tls-ca** (PEMFILE) - Optional - TLS CA file
- **--tls-no-verify** - Optional - do not verify TLS server certificate
- **-H, --http-header** (HEADER: VALUE) - Optional - HTTP request header
- **--handler-args** (ARGS) - Optional - extra arguments for full custom handler
- **--override-boot-slot** (BOOTNAME) - Optional - overrides auto-detection of booted slot
```

--------------------------------

### Install() Method

Source: https://rauc.readthedocs.io/en/v1.15.1/reference.html

Triggers the installation of a bundle. Note: This method is deprecated.

```APIDOC
## Install()

### Description
Triggers the installation of a bundle. This method call is non-blocking. After completion, the “Completed” signal will be emitted.

### Parameters
- **source** (s) - Required - Path to bundle to be installed
```

--------------------------------

### Implement Post-Install Hook Script

Source: https://rauc.readthedocs.io/en/v1.15.1/using.html

A shell script example for the post-install hook that performs file operations after a successful installation.

```bash
#!/bin/sh

case "$1" in
        slot-post-install)
                # only rootfs needs to be handled
                test "$RAUC_SLOT_CLASS" = "rootfs" || exit 0

                touch "$RAUC_SLOT_MOUNT_POINT/extra-file"
                ;;
        *)
                exit 1
                ;;
esac

exit 0

```

--------------------------------

### Install() Method

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/reference.rst.txt

Triggers the installation of a bundle. This method is non-blocking and emits a 'Completed' signal upon finishing.

```APIDOC
## Install(source)

### Description
Triggers the installation of a bundle. This method call is non-blocking. After completion, the "Completed" signal will be emitted.

### Parameters
- **source** (s) - Required - Path to bundle to be installed
```

--------------------------------

### Define Partition Table Offsets

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/integration.rst.txt

Example partition layout showing start LBA offsets for bootloader, environment, and root filesystems.

```text
/dev/mmcblk0p1 StartLBA:   8192 -> u-boot etc.
/dev/mmcblk0p2 StartLBA: 114688 -> u-boot environment
/dev/mmcblk0p3 StartLBA: 139264 -> rootfs A
/dev/mmcblk0p4 StartLBA: 475136 -> rootfs B
```

--------------------------------

### Install an update bundle

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/using.rst.txt

Trigger the installation of a bundle from a local path or remote URL.

```console
# rauc install <bundle>
```

--------------------------------

### Trigger Installation via busctl

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/using.rst.txt

Initiates a bundle installation using the D-Bus Installer interface.

```console
$ busctl call de.pengutronix.rauc / de.pengutronix.rauc.Installer InstallBundle sa{sv} "<bundle-path>/<bundle-url>" 0
```

--------------------------------

### Configure Post-Install Hook

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/using.rst.txt

Example configuration for enabling a post-install hook in the system manifest.

```cfg
[hooks]
filename=hook

[image.rootfs]
filename=rootfs.img
size=...
sha256=...
hooks=post-install
```

--------------------------------

### Install D-Bus Method Definition

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/reference.rst.txt

XML definition for the Install method used to trigger bundle installation.

```xml
<method name="Install">
      <arg type="s" name="source" direction="in"/>
    </method>
```

--------------------------------

### Example system.conf configuration

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/reference.rst.txt

A sample configuration file defining system parameters, keyring paths, handlers, and slot definitions.

```cfg
[system]
compatible=FooCorp Super BarBazzer
bootloader=barebox
data-directory=/srv/rauc
bundle-formats=-plain

[keyring]
path=/etc/rauc/keyring.pem

[handlers]
system-info=/usr/lib/rauc/info-provider.sh
post-install=/usr/lib/rauc/postinst.sh

[slot.rootfs.0]
device=/dev/sda0
type=ext4
bootname=system0

[slot.rootfs.1]
device=/dev/sda1
type=ext4
bootname=system1

[artifacts.add-ons]
path=/srv/add-ons
type=trees
```

--------------------------------

### Configure basic install log

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/advanced.rst.txt

Defines a simple log file for installation events using the short format.

```ini
[log.install-log]
filename=install.log
events=install
format=short
```

--------------------------------

### Install Method Definition

Source: https://rauc.readthedocs.io/en/v1.15.1/reference.html

Deprecated method for triggering a bundle installation. Use InstallBundle instead.

```xml
11    <method name="Install">
12      <arg name="source" type="s" direction="in"/>
13    </method>
```

--------------------------------

### Running the QEMU test environment

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/using.rst.txt

Boots a QEMU shell with a mocked RAUC setup for testing and reproduction.

```console
$ ./qemu-test system
```

```console
root@qemu-test:/home/user/git/rauc# rauc status
=== System Info ===
Compatible:  Test Config
Variant:
Booted from: rootfs.0 (A)

=== Bootloader ===
Activated: rootfs.0 (A)

=== Slot States ===
x [rootfs.0] (/dev/root, raw, booted)
        bootname: A
        mounted: /
        boot status: good
    [appfs.0] (/dev/null, raw, active)

o [rootfs.1] (/tmp/rootdev, raw, inactive)
        bootname: B
        boot status: good
    [appfs.1] (/tmp/appdev, raw, inactive)
```

--------------------------------

### Booting QEMU Test Environment

Source: https://rauc.readthedocs.io/en/v1.15.1/using.html

Executes the qemu-test script to enter a shell with a mocked RAUC setup.

```bash
$ ./qemu-test system
```

--------------------------------

### Install an encrypted bundle

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/advanced.rst.txt

Executes the installation of an encrypted bundle on the target system.

```console
# rauc install encrypted-bundle.raucb
```

--------------------------------

### Install RAUC Bundle

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/examples.rst.txt

Installs a bundle file from a specified path on the target system.

```bash
> rauc install /mnt/usb/update-2015.04-1.raucb
```

--------------------------------

### Configure Pre-Install Hook

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/using.rst.txt

Example configuration for enabling a pre-install hook in the system manifest.

```cfg
[hooks]
filename=hook

[image.rootfs]
filename=rootfs.img
size=...
sha256=...
hooks=pre-install
```

--------------------------------

### Inspect UBI device symlinks

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/faq.rst.txt

Example output showing the resulting symlinks after applying custom UBI udev rules.

```text
crw------- 1 root root 249,  0 Nov 18 13:46 /dev/ubi0
crw------- 1 root root 249,  1 Nov 18 13:46 /dev/ubi0_0
lrwxrwxrwx 1 root root       6 Nov 18 13:46 /dev/ubi0_rauc-test -> ubi0_0
lrwxrwxrwx 1 root root       6 Nov 18 13:46 /dev/ubi_nandsim_rauc-test -> ubi0_0
crw------- 1 root root  10, 59 Nov 18 13:46 /dev/ubi_ctrl
lrwxrwxrwx 1 root root       6 Nov 18 13:46 /dev/ubi_mtd3_rauc-test -> ubi0_0
```

--------------------------------

### Install RAUC in image recipe

Source: https://rauc.readthedocs.io/en/v1.15.1/integration.html

Append the RAUC package to your image installation list.

```bitbake
IMAGE_INSTALL:append = " rauc"
```

--------------------------------

### Verify State Setup

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/integration.rst.txt

Use the devinfo command in the Barebox console to verify the state configuration.

```console
barebox@board:/ devinfo state
Parameters:
bootstate.last_chosen: 2 (type: uint32)
bootstate.system0.priority: 10 (type: uint32)
bootstate.system0.remaining_attempts: 3 (type: uint32)
bootstate.system1.priority: 20 (type: uint32)
bootstate.system1.remaining_attempts: 3 (type: uint32)
dirty: 0 (type: bool)
save_on_shutdown: 1 (type: bool)
```

--------------------------------

### Start interactive QEMU shell

Source: https://rauc.readthedocs.io/en/v1.15.1/contributing.html

Open a shell inside the QEMU environment for manual test execution.

```bash
./qemu-test shell
```

--------------------------------

### InstallBundle() Method

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/reference.rst.txt

Triggers the installation of a bundle. This method call is non-blocking and emits a 'Completed' signal upon finishing.

```APIDOC
## InstallBundle(s source, a{sv} args)

### Description
Triggers the installation of a bundle. This method call is non-blocking. After completion, the "Completed" signal will be emitted.

### Parameters
- **source** (s) - Required - Path or URL to the bundle that should be installed
- **args** (a{sv}) - Optional - Arguments to pass to installation

#### Supported args keys:
- **args.ignore-compatible** (b) - Optional - Ignore the default compatible check for forcing installation of bundles on platforms that a compatible not matching the one of the bundle to be installed
- **args.ignore-version-limit** (b) - Optional - Disables the check for the minimum bundle version as configured by system.conf option min-bundle-version checks.
- **args.transaction-id** (s) - Optional - Set UUID to use for identifying the (installation) transaction. If not given, RAUC will generate a random one.
```

--------------------------------

### Verify Barebox state setup

Source: https://rauc.readthedocs.io/en/v1.15.1/integration.html

Command to verify the state configuration from within the Barebox shell.

```bash
barebox@board:/ devinfo state
Parameters:
bootstate.last_chosen: 2 (type: uint32)
bootstate.system0.priority: 10 (type: uint32)
bootstate.system0.remaining_attempts: 3 (type: uint32)
bootstate.system1.priority: 20 (type: uint32)
bootstate.system1.remaining_attempts: 3 (type: uint32)
dirty: 0 (type: bool)
save_on_shutdown: 1 (type: bool)

```

--------------------------------

### Configure Pre-Install Handler

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/using.rst.txt

Defines a pre-install handler in system.conf to execute logic before the installation process begins.

```cfg
[handlers]
pre-install=/usr/lib/rauc/pre-install
```

--------------------------------

### InstallBundle Method Definition

Source: https://rauc.readthedocs.io/en/v1.15.1/reference.html

Method signature for triggering a non-blocking bundle installation with optional arguments.

```xml
22    <method name="InstallBundle">
23      <arg name="source" type="s" direction="in"/>
24      <arg name="args" type="a{sv}" direction="in"/>
25      <annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap"/>
26    </method>
```

--------------------------------

### Minimal Manifest Example

Source: https://rauc.readthedocs.io/en/v1.15.1/integration.html

A basic manifest configuration defining compatibility, format, and image slot mappings.

```ini
[update]
compatible=Test Platform
version=2023.11.0

[bundle]
format=verity

[image.rootfs]
filename=system-image.ext4

[image.bootloader]
filename=barebox.img
```

--------------------------------

### D-Bus Installer Interface

Source: https://rauc.readthedocs.io/en/v1.15.1/reference.html

The Installer interface provides methods for managing updates and querying the status of the RAUC system.

```APIDOC
## D-Bus Installer Interface

### Methods
- **InstallBundle(path)**: Initiates the installation of a RAUC bundle from the specified path.
- **Install(slot, image)**: Installs a specific image to a target slot.
- **Info()**: Returns information about the current system status.
- **InspectBundle(path)**: Inspects the contents of a RAUC bundle.
- **Mark(slot, state)**: Marks a slot with a specific state (e.g., good, bad).
- **GetSlotStatus()**: Retrieves the status of all defined slots.
- **GetPrimary()**: Returns the current primary boot slot.

### Properties
- **Operation**: Current operation being performed by the installer.
- **LastError**: Description of the last error encountered.
- **Progress**: Current progress percentage of the active operation.
- **Compatible**: Compatibility string of the system.
- **Variant**: System variant identifier.
- **BootSlot**: The currently active boot slot.

### Signals
- **Completed**: Emitted when an operation has finished.
```

--------------------------------

### Implement Install-Check Hook Script

Source: https://rauc.readthedocs.io/en/v1.15.1/using.html

A shell script example for the install-check hook that validates compatibility and returns an exit code for rejection.

```bash
#!/bin/sh

case "$1" in
        install-check)
                if [[ "$RAUC_MF_COMPATIBLE" != "$RAUC_SYSTEM_COMPATIBLE" ]]; then
                        echo "Compatible does not match!" 1>&2
                        exit 10
                fi
                ;;
        *)
                exit 1
                ;;
esac

exit 0

```

--------------------------------

### Shell script for install-check

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/using.rst.txt

A basic shell script snippet for performing compatibility checks during installation.

```sh
case "$1" in
        install-check)
                if [[ "$RAUC_MF_COMPATIBLE" != "$RAUC_SYSTEM_COMPATIBLE" ]]; then
                        echo "Compatible does not match!" 1>&2
                        exit 10
                fi
                ;;
        *)
                exit 1
                ;;
esac

exit 0
```

--------------------------------

### Build and Verify RAUC Native Tool

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/integration.rst.txt

Compile RAUC for the host system and verify the installation.

```console
$ bitbake rauc-native
$ tmp/deploy/tools/rauc --version
```

--------------------------------

### Example RAUC Manifest Configuration

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/reference.rst.txt

A standard manifest.raucm file defining update compatibility, bundle format, and individual image slots.

```cfg
[update]
compatible=FooCorp Super BarBazzer
version=2016.08-1

[bundle]
format=verity
verity-hash=3fcb193cb4fd475aa174efa1f1e979b2d649bf7f8224cc97f4413b5ee141a4e9
verity-salt=4b7b8657d03759d387f24fb7bb46891771e1b370fff38c70488e6381d6a10e49
verity-size=24576

[image.rootfs]
filename=rootfs.ext4
size=419430400
sha256=b14c1457dc10469418b4154fef29a90e1ffb4dddd308bf0f2456d436963ef5b3

[image.appfs]
filename=appfs.ext4
size=219430400
sha256=ecf4c031d01cb9bfa9aa5ecfce93efcf9149544bdbf91178d2c2d9d1d24076ca

[image.add-ons/webserver]
filename=webserver.tar
size=6573863
sha256=f23204174c70ff03a9efcd6c2dfd6d2b8ebdd8bb66936043341e728438a1f0ea
```

--------------------------------

### Configure Barebox state driver node

Source: https://rauc.readthedocs.io/en/v1.15.1/integration.html

Example configuration for the state node, defining the backend storage and compatible driver.

```dts
state: state {
        magic = <0x4d433230>;
        compatible = "barebox,state";
        backend-type = "raw";
        backend = <&state_storage>;
        backend-stridesize = <0x40>;
        backend-storage-type = "circular";
        #address-cells = <1>;
        #size-cells = <1>;

        [...]
}

```

--------------------------------

### Configure Yocto Recipe

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/integration.rst.txt

Add RAUC to the image installation and configure the bbappend file for system configuration.

```bitbake
IMAGE_INSTALL:append = " rauc"
```

```bitbake
FILESEXTRAPATHS:prepend := "${THISDIR}/files:"
```

--------------------------------

### Minimal Yocto bundle recipe configuration

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/integration.rst.txt

Example of a basic bundle recipe configuration including compatibility, slots, and format settings.

```bitbake
inherit bundle

RAUC_BUNDLE_COMPATIBLE ?= "Demo Board"

RAUC_BUNDLE_SLOTS ?= "rootfs"

RAUC_BUNDLE_FORMAT ?= "verity"

RAUC_SLOT_rootfs ?= "core-image-minimal"
```

--------------------------------

### Identify Booted Slot via Barebox Bootchooser

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/integration.rst.txt

Example of the command-line parameter used by the Barebox bootchooser mechanism to identify the active slot.

```text
bootchooser.active=system0
```

--------------------------------

### Run RAUC interactively in QEMU

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/contributing.rst.txt

Starts the RAUC service within a QEMU environment with D-Bus and dummy target slots for testing update scenarios.

```bash
./qemu-test system
```

--------------------------------

### Slot Status Configuration Format

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/reference.rst.txt

Example of a slot status entry in the central RAUC status file, containing bundle metadata and installation history.

```cfg
[slot.rootfs.0]
bundle.compatible=FooCorp Super BarBazzer
bundle.version=2024.08-1
bundle.description=Introduction of Galactic Feature XYZ
bundle.build=2024.08.1/imx8mp/20240824-7
status=ok
sha256=b14c1457dc10469418b4154fef29a90e1ffb4dddd308bf0f2456d436963ef5b3
size=419430400
installed.transaction=dad3289a-7de1-4ad2-931e-fb827edc6496
installed.timestamp=2024-09-06T09:51:13Z
installed.count=3
```

--------------------------------

### Configure Install Hook

Source: https://rauc.readthedocs.io/en/v1.15.1/using.html

Manifest configuration for an install hook, which replaces the default installation process for a slot.

```ini
[hooks]
filename=hook

[image.rootfs]
filename=rootfs.img
size=...
sha256=...
hooks=install

```

```ini
[hooks]
filename=hook

[image.datafs]
hooks=install

```

--------------------------------

### Prepare Bundle Components

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/examples.rst.txt

Collect the root file system image into a temporary directory for bundle creation.

```bash
> mkdir temp-dir/
> cp …/rootfs.ext4.img temp-dir/
```

--------------------------------

### Create Bundle Manifest

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/integration.rst.txt

Initialize the manifest file and define the update configuration.

```console
$ vi install-content/manifest.raucm
```

```cfg
[update]
compatible=Test Platform
version=2023.11.0

[bundle]
format=verity

[image.rootfs]
filename=system-image.ext4

[image.bootloader]
filename=barebox.img
```

--------------------------------

### Enable Barebox Debugging Tools

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/integration.rst.txt

Kconfig settings to enable command-line tools for interacting with bootchooser and state.

```cfg
CONFIG_CMD_STATE=y
CONFIG_CMD_BOOTCHOOSER=y
```

--------------------------------

### RAUC Installer Interface XML Definition

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/reference.rst.txt

XML definition for the RAUC Installer D-Bus interface.

```xml
<interface name="de.pengutronix.rauc.Installer">
```

--------------------------------

### Start RAUC Service Manually

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/integration.rst.txt

Execute this command to start the RAUC service manually. Changes to system.conf require a restart to take effect.

```console
# rauc service
```

--------------------------------

### Install Casync Bundle via Network

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/advanced.rst.txt

Installs a casync bundle directly from a remote URL. RAUC expects the chunk store to be available at the same base URL with a .castr extension.

```bash
rauc install https://server.example.com/deploy/bundle-20180112.raucb
```

--------------------------------

### Completed Signal

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/reference.rst.txt

Emitted when an installation process finishes.

```APIDOC
## Completed

### Description
Signal emitted upon completion of an installation, indicating success or failure.

### Output
- **result** (integer) - Return code (0 for success).
```

--------------------------------

### Create and Populate Bundle Directory

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/integration.rst.txt

Initialize the directory structure and copy target images for the update bundle.

```console
$ mkdir install-content
$ cp /path/to/system-image.ext3 install-content/system-image.ext4
$ cp /path/to/barebox install-content/barebox.img
```

--------------------------------

### Progress Property Definition

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/reference.rst.txt

Defines the Progress property for installation tracking.

```xml
<property name="Progress" type="(isi)" access="read"/>
```

--------------------------------

### Completed Signal Definition

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/reference.rst.txt

Defines the Completed signal emitted after installation.

```xml
<signal name="Completed">
      <arg type="i" name="result"/>
    </signal>
```

--------------------------------

### Configure GRUB System Settings

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/integration.rst.txt

Basic system configuration snippet for enabling GRUB as the bootloader.

```cfg
[system]
...
bootloader=grub
```

--------------------------------

### Installer Interface Definition

Source: https://rauc.readthedocs.io/en/v1.15.1/reference.html

The base XML definition for the de.pengutronix.rauc.Installer D-Bus interface.

```xml
1<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "https://specifications.freedesktop.org/dbus/introspect-latest.dtd">
2<!-- SPDX-License-Identifier: CC0-1.0 -->
3<node>
4  <interface name="de.pengutronix.rauc.Installer">
```

--------------------------------

### Configure Post-Install Handler

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/using.rst.txt

Defines a post-install handler in system.conf to execute logic after a successful system update.

```cfg
[handlers]
post-install=/usr/lib/rauc/post-install
```

--------------------------------

### Disable Streaming Support

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/advanced.rst.txt

Command to disable streaming support during the meson setup process.

```bash
meson setup -Dstreaming=false
```

--------------------------------

### Symmetric A/B Slot Configuration

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/examples.rst.txt

Defines a fully-redundant root file system setup.

```cfg
[...]

[slot.rootfs.0]
device=/dev/sda2
type=ext4
bootname=A

[slot.rootfs.1]
device=/dev/sda3
type=ext4
bootname=B
```

--------------------------------

### Create Manifest File

Source: https://rauc.readthedocs.io/en/v1.15.1/integration.html

Open the manifest file for editing within the content directory.

```bash
$ vi install-content/manifest.raucm
```

--------------------------------

### Define Bootname in system.conf

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/integration.rst.txt

Example of setting the bootname property for a rootfs slot in the system configuration.

```cfg
[slot.rootfs.0]
...
bootname=system0
```

--------------------------------

### Implement GRUB Boot Selection Logic

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/examples.rst.txt

A GRUB configuration script to handle slot selection and boot status tracking for RAUC.

```sh
# set default menuentry (Slot A) and timeout (3s)
default=0
timeout=3

any_ok=0

set ORDER="A B"
set A_OK=0
set B_OK=0
set A_TRY=0
set B_TRY=0
load_env

# select bootable slot
for SLOT in $ORDER; do
    if [ "$SLOT" == "A" ]; then
        INDEX=0
        OK=$A_OK
        TRY=$A_TRY
        A_TRY=1
    fi
    if [ "$SLOT" == "B" ]; then
        INDEX=1
        OK=$B_OK
        TRY=$B_TRY
        B_TRY=1
    fi
    if [ "$OK" -eq 1 -a "$TRY" -eq 0 ]; then
        default=$INDEX
        any_ok=1
        break
    fi
done

# reset booted flags in case both sides have failed to boot
if [ "$any_ok" -eq 0 ]; then
    if [ "$A_OK" -eq 1 -a "$A_TRY" -eq 1 ]; then
        A_TRY=0
    fi
    if [ "$B_OK" -eq 1 -a "$B_TRY" -eq 1 ]; then
        B_TRY=0
    fi
fi

save_env A_TRY B_TRY

CMDLINE="panic=60 quiet"

menuentry "Slot A (OK=$A_OK TRY=$A_TRY)" {
    linux (hd0,2)/kernel root=/dev/sda2 $CMDLINE rauc.slot=A
}

menuentry "Slot B (OK=$B_OK TRY=$B_TRY)" {
    linux (hd0,3)/kernel root=/dev/sda3 $CMDLINE rauc.slot=B
}
```

--------------------------------

### Enable Barebox Bootchooser and State in Kconfig

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/integration.rst.txt

Required Kconfig settings to enable the bootchooser framework and state backend in Barebox.

```cfg
CONFIG_BOOTCHOOSER=y
CONFIG_STATE=y
CONFIG_STATE_DRV=y
```

--------------------------------

### InstallBundle D-Bus Method Definition

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/reference.rst.txt

XML definition for the InstallBundle method within the RAUC Installer interface.

```xml
<method name="InstallBundle">
      <arg type="s" name="source" direction="in"/>
      <arg type="a{sv}" name="args" direction="in"/>
    </method>
```

--------------------------------

### View RAUC Service Logs

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/using.rst.txt

Accesses systemd logs for the RAUC service to troubleshoot installation failures.

```console
$ journalctl -u rauc
```

--------------------------------

### Create an update bundle

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/using.rst.txt

Use the bundle sub-command to package images and a manifest into a signed update bundle.

```console
$ rauc bundle --cert=<certfile|certurl> --key=<keyfile|keyurl> <input-dir> <bundle-name>
```

--------------------------------

### Run tests using qemu-test

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/contributing.rst.txt

Execute the full test suite or specific tests within the QEMU-based virtual environment to avoid requiring root privileges on the host.

```bash
./qemu-test
```

```bash
./qemu-test test=install
```

```bash
./qemu-test shell
```

--------------------------------

### Post-Install Hook Implementation

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/using.rst.txt

A shell script implementation of a post-install hook that creates a file in the mounted slot.

```sh
#!/bin/sh

case "$1" in
        slot-post-install)
                # only rootfs needs to be handled
                test "$RAUC_SLOT_CLASS" = "rootfs" || exit 0

                touch "$RAUC_SLOT_MOUNT_POINT/extra-file"
                ;;
        *)
                exit 1
                ;;
esac

exit 0
```

--------------------------------

### Inspect EFI boot settings

Source: https://rauc.readthedocs.io/en/v1.15.1/_sources/integration.rst.txt

Verify the current EFI boot configuration.

```console
# efibootmgr -v
```
Tokens:
Raw