RtBrick Host System

Overview

The RtBrick Host Operating System is a customized host system built on the Debian, developed specifically to support RBFS. The homegrown RtBrick Host System (rtbrick-host) provides a secure and stable host operating environment and supports a wide range of hardware architectures. The Host System provides stable and flexible host environment and is well-suited for RBFS where uptime is critical.

Starting with release 25.3.1.Candidate.1, RBFS operates on rtbrick-host system. RBFS comes pre-packaged with the Rtbrick Host (rtbrick-host) system.

The RtBrick host system benefits include:

Independency

RtBrick host system operates independently of third-party projects like RtBrick Host. It eliminates external dependencies and allows for quicker and more focused improvements in RBFS.

Complete System Control

The host system provides complete visibility and ownership of the host system. It offers the flexibility to customize the environment and is a predictable platform that aligns with the evolving needs of the customers.

The following sections provide information about the changes introduced with the transition to the RtBrick host system from RtBrick Host.

The following table provides you information about the new commands introduced.

Command Description Example Usage

rtb-container

It allows you to start, stop, and create containers. It is used during the rtb-init process. Usage: /usr/local/sbin/rtb-container {create|start|stop|remove|status}

rtb-container status

rtb-install

Installs the RtBrick image from a file or a URL. Usage: /usr/local/sbin/rtb-install -i A|B [-f filename|-u url]
* -i Install into target A/B
* -f read image from file
* -u read image from url

rtb-install -i B -f /tmp/image-filename

rtb-reboot

Modify the boot settings for the upcoming reboot or make them permanent. Usage: /usr/local/sbin/rtb-reboot [-p] A|B|install|update|rescue|uninstall

  • -p Set boot target permanently. The boot target will remain permanent even after a system reboot. It is saved as the default for all future boots.

  • A Boot RTB: Image-A Kernel. Boot the device using the RBFS Image-A.

  • B Boot RTB: Image-B Kernel. Boot using the RBFS Image-B.

  • install Boot ONIE: Install OS once. Boots into ONIE to install once.

  • update Boot ONIE: Update ONIE. Boots into ONIE for updating the ONIE environment itself.

  • rescue Boot ONIE: Rescue. Boots into ONIE in rescue mode.

  • uninstall Boot ONIE: Uninstall OS. Boots into ONIE and removes the installed OS.

rtb-reboot install and rtb-reboot -p B

Image Partitioning

Image partition allows the device to hold multiple software images (for example, Image-A and Image-B). Image partitioning provides a upgrade-safe environment for installing and running images. It allows to install a new image in a partition, and if the new image fails, the system can rollback to the previous functioning image.

This image partition layout describes how RBFS organizes its disk into logical partitions, each serving a specific purpose.

Name Mount Point Survives Reinstall Description

RTB-IMAGE-A

/ (root)

No

One of the two bootable system images. This partition contains the OS files and binaries for Image A. During a reinstall or software upgrade, this partition will be overwritten.

RTB-IMAGE-B

/ (root)

No

The alternate bootable system image. Similar to IMAGE-A, it holds OS files and is also overwritten during reinstall. The device usually boots into one of these images.

RTB-CONFIG

/var/config

Yes

Stores persistent configuration files such as user settings and system configuration. This partition survives reinstallation and the settings are preserved across upgrades.

RTB-LOG

/var/log

No

Intended to store system logs. It will survive reinstalls, allowing logs to be retained for troubleshooting even after system image upgrades.

RTB-CRASH

/var/crash

No

Stores crash data (core dumps). In the future, this partition will also persist across reinstallations.

4.1.1. RtBrick Host Operating System for RBFS

Starting with the release 25.3.1.Candidate.1, RBFS now operates on the RtBrick Host System. This is a customized host system built on the Debian, developed specifically to support RBFS. The RtBrick Host Operating System (rtbrick-host) provides a secure and stable operating environment, functioning independently of third-party projects like RtBrick Host. This new host eliminates external dependencies, allowing for quicker improvements in RBFS.

The following changes have been implemented in the image build for the RtBrick Host Operating System:

  • Replaced RtBrick Host base packages with new host base packages.

  • Renamed all host package build names to 'bookworm-host'.

  • Migrated from 'onl-installer' to 'host-installer'.

The following table lists the new commands introduced for installation, reboot, and so on.

Command Description Example Usage

rtb-container

It allows you to start, stop, and create containers. It is used during the rtb-init process. Usage: /usr/local/sbin/rtb-container {create|start|stop|remove|status}

rtb-container status

rtb-install

Installs the RtBrick image from a file or a URL. Usage: /usr/local/sbin/rtb-install -i A|B [-f filename|-u url]
* -i Install into target A/B
* -f Read image from file.
* -u Read image from URL.

rtb-install -i B -f /tmp/image-filename

rtb-reboot

Modify the boot settings for the upcoming reboot or make them permanent. Usage: /usr/local/sbin/rtb-reboot [-p] A|B|install|update|rescue|uninstall

  • -p Set boot target permanently. The boot target will remain permanent even after a system reboot. It is saved as the default for all future boots.

  • A Boot RTB: Image-A Kernel. Boot the device using the RBFS Image-A.

  • B Boot RTB: Image-B Kernel. Boot using the RBFS Image-B.

  • install Boot ONIE: Install OS once. Boots into ONIE to install once.

  • update Boot ONIE: Update ONIE. Boots into ONIE for updating the ONIE environment itself.

  • rescue Boot ONIE: Rescue. Boots into ONIE in rescue mode.

  • uninstall Boot ONIE: Uninstall OS. Boots into ONIE and removes the installed OS.

rtb-reboot install and rtb-reboot -p B