Download Release

View On Github

Deploy

Deploy GyroidOS on Raspberry Pi platforms

This section describes how to deploy GyroidOS on Raspberry Pi platforms.

Current pre-built release image:
gyroidosimage-v1.1-raspberrypi2.tar.xz
gyroidosimage-v1.1-raspberrypi3-64.tar.xz
gyroidosimage-v1.1-raspberrypi5.tar.xz

Create bootable medium

Requirements

  • A successfully built GyroidOS image file (gyroidosimage.img), either downloaded from Github Release or built following the instructions here.
  • The script copy_image_to_disk_mbr.sh which can be found on GitHub or in your build folder at gyroidos/build/yocto/copy_image_to_disk_mbr.sh
  • A MicroSD card compatible with your board
  • Optional: Bmap file gyroidosimage.img.bmap which is automatically created by the build system and deployed next to gyroidosimage.img. This enables flashing using bmaptool.

First, ensure the needed packages are installed on your system.

apt-get install util-linux btrfs-progs sgdisk parted bmap-tools

Copy GyroidOS image to disk

Now the GyroidOS image can be copied to the MicroSD card. The provided script takes care of expanding the partitions to use all of the available disk space.

WARNING: This operation will wipe all data on the target device

sudo copy_image_to_disk_mbr.sh <gyroidos-image> </path/to/target/device>

If you have built from source in ws-yocto and your target device is /dev/mmcblk0 the command would be:

  • Raspberry Pi2 
    cd ws-yocto # your yocto workspace directory
sudo copy_image_to_disk_mbr.sh \
  out-yocto/tmp/deploy/images/raspberrypi2/gyroidos_image/gyroidosimage.img \
  /dev/mmcblk0
  • Raspberry Pi3 
    cd ws-yocto # your yocto workspace directory
sudo copy_image_to_disk_mbr.sh \
  out-yocto/tmp/deploy/images/raspberrypi3-64/gyroidos_image/gyroidosimage.img \
  /dev/mmcblk0
  • Raspberry Pi4 
    cd ws-yocto # your yocto workspace directory
sudo copy_image_to_disk_mbr.sh \
  out-yocto/tmp/deploy/images/raspberrypi4-64/gyroidos_image/gyroidosimage.img \
  /dev/mmcblk0
  • Raspberry Pi5 
    cd ws-yocto # your yocto workspace directory
sudo copy_image_to_disk_mbr.sh \
  out-yocto/tmp/deploy/images/raspberrypi5/gyroidos_image/gyroidosimage.img \
  /dev/mmcblk0

Boot GyroidOS

Connect a monitor to the HDMI port and a keyboard to the USB connector of your Raspberry Pi board.

After boot a shell in the management container (c0) will be available at tty1. Also a debug shell into the CML will be available at tty12. Further, the init log messages will appear on tty11.

Note: On first boot several keys are generated, thus it may take a long time untill login prompt may appear. You can accelerate the progress by generating randomness with the connected keyboard.

For instructions on how to operate GyroidOS please refer to section Operate.

Secure Boot

GyroidOS provides facilities to conveniently configure and deploy signed images on RaspberryPi 4 + 5. These facilities support the user by

  1. enable simple deployment of the secure boot public key on the device, and
  2. sign the GyroidOS image with the corresponding private key that can be deployed on the previously provisioned device.

Configuration

To enable secure boot for RaspberryPi, add the following line to your local.conf:

RPI_SECURE_BOOT = "1"

Important: This will force the PKI to be generated with 2048 bit RSA keys as the RaspberryPI 4 + 5 do only support this key type. Set this config before the initial build since the PKI will not automatically be regenerated once set up.

Deploy the Secure Boot key

The GyroidOS build system ships a helper image that can be used to easily deploy a public key on the RaspberryPi to enforce secure boot. The deployed keyis the public part of the SECURE_BOOT_SIG_KEY variable that defaults to the Software Signing Sub CA Key defined in PKI. To obtain the image run:

bitbake rpi-eeprom-secure-boot-image

Once built, copy the image to an SD card.

sudo dd \
  if=out-yocto/tmp/deploy/images/raspberrypi5/rpi-eeprom-secure-boot-image-raspberrypi5.vfat \
  of=/dev/mmcblk0

Insert the SD-Card into your RaspberryPi, and apply power. After a few seconds, the green LED on your RaspberryPi should start blinking. This indicates that the flash update was successful.

Build + Operate

The GyroidOS image can built and deployed as described in the sections “Copy GyroidOS image to disk” and “Boot GyroidOS” above.

Lock Secure Boot

The current setup does not fuse the public key’s hash to OTP memory, therefore, the deployed public key can be exchanged or secure boot can be disabled again. To permanently deploy the public key on the RaspberryPi, refer to the RaspberryPi documentation.