-
Notifications
You must be signed in to change notification settings - Fork 595
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add Radxa ROCK 5B docs to Single Board Computer section
This adds documentation on how to setup a ROCK 5B with Talos initally and it adds the SBC to the support matrix. It also fixes a typo of an unreferenced link alias. Signed-off-by: Christoph Hoopmann <[email protected]>
- Loading branch information
Showing
7 changed files
with
267 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 2 additions & 0 deletions
2
website/content/v1.10/talos-guides/configuration/disk-management.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
130 changes: 130 additions & 0 deletions
130
website/content/v1.10/talos-guides/install/single-board-computers/rock5b.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| --- | ||
| title: "Radxa ROCK 5B" | ||
| description: "Installing Talos on Radxa ROCK 5B SBC using raw disk image." | ||
| aliases: | ||
| - ../../../single-board-computers/rock5b | ||
| --- | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| You will need | ||
|
|
||
| - `talosctl` | ||
| - an SD card | ||
|
|
||
| Download the latest `talosctl`. | ||
|
|
||
| ```bash | ||
| curl -Lo /usr/local/bin/talosctl https://github.com/siderolabs/talos/releases/download/{{< release >}}/talosctl-$(uname -s | tr "[:upper:]" "[:lower:]")-amd64 | ||
| chmod +x /usr/local/bin/talosctl | ||
| ``` | ||
|
|
||
| ## Download the Image | ||
|
|
||
| Visit the [Image Factory](https://factory.talos.dev/), select `Single Board Computers`, select the version and select `Radxa ROCK 5B` from the options. | ||
|
|
||
| Choose `realtek-firmware` and any other desired extension. | ||
| Next fill in the kernel command line arguments if needed. | ||
|
|
||
| Download the image and decompress it: | ||
|
|
||
| ```bash | ||
| curl -LO https://factory.talos.dev/image/[uuid]/{{< release >}}/metal-arm64.raw.xz | ||
| xz -d metal-arm64.raw.xz | ||
| ``` | ||
|
|
||
| Note the `uuid` as it might be helpful during [upgrades](#upgrading). | ||
|
|
||
| ## Writing the Image | ||
|
|
||
| This guide assumes the node should boot from SD card. | ||
| Booting from eMMC or NVMe has not been tested yet. | ||
|
|
||
| The path to your SD card can be found using `fdisk` on Linux or `diskutil` on macOS. | ||
| In this example, we will assume `/dev/mmcblk0`. | ||
|
|
||
| Now `dd` the image to your SD card: | ||
|
|
||
| ```bash | ||
| sudo dd if=metal-arm64.raw of=/dev/mmcblk0 conv=fsync oflag=direct status=progress bs=4M | ||
| ``` | ||
|
|
||
| ## First boot | ||
|
|
||
| Insert the SD card into the board, turn it on and proceed to [bootstrapping the node](#bootstrapping-the-node). | ||
|
|
||
| ### Bootstrapping the Node | ||
|
|
||
| Your node will appear on your local network after it has booted successfully. | ||
| You can then proceed to configure it: | ||
|
|
||
| ```bash | ||
| talosctl apply-config --insecure --mode=interactive --nodes <node IP or DNS name> | ||
| ``` | ||
|
|
||
| Once the interactive installation is applied, the cluster will form and you can then use `kubectl`. | ||
|
|
||
| ### Retrieve the `kubeconfig` | ||
|
|
||
| Retrieve the admin `kubeconfig` by running: | ||
|
|
||
| ```bash | ||
| talosctl kubeconfig | ||
| ``` | ||
|
|
||
| ## Upgrading | ||
|
|
||
| To upgrade to the latest version of Talos, you can run: | ||
|
|
||
| ```bash | ||
| talosctl -n <node IP or DNS name> upgrade --image=factory.talos.dev/installer/[uuid]:{{< release >}} | ||
| ``` | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### Serial console | ||
|
|
||
| If you experience any issues you can check the serial console. | ||
| Follow the [official guideline](https://wiki.radxa.com/Rock5/dev/serial-console) | ||
| on how to connect a serial adapter. | ||
|
|
||
| Hint: The rock5b overlay uses baudrate of `115200` instead of the default `1500000` | ||
|
|
||
| ### Power supplies and endless restarts | ||
|
|
||
| It is a known issue that USB Power Delivery negotiation is performed at a late stage in kernel. | ||
| This can lead to endless restarts if the power supply cuts power to early. | ||
| Check the list of [known working](https://wiki.radxa.com/Rock5/5b/power_supply) power supplies. | ||
|
|
||
| ## Tips and tricks | ||
|
|
||
| ### EPHEMERAL on NVMe | ||
|
|
||
| The Radxa ROCK 5B SBC provides a M.2 NVMe SSD slot. | ||
|
|
||
| This allows to use a separate disk for the EPHEMERAL partition by following | ||
| [Disk Management]({{< relref "../../configuration/disk-management" >}}). | ||
|
|
||
| Add something similar to the machine configuration before | ||
| [bootstrapping the node](#bootstrapping-the-node) to make use of a M.2 NVMe SSD: | ||
|
|
||
| ```yaml | ||
| # worker.yaml | ||
| --- | ||
| version: v1alpha1 | ||
| debug: false | ||
| persist: true | ||
| machine: | ||
| # ... | ||
| cluster: | ||
| # ... | ||
| --- | ||
| apiVersion: v1alpha1 | ||
| kind: VolumeConfig | ||
| name: EPHEMERAL | ||
| provisioning: | ||
| diskSelector: | ||
| match: disk.transport == 'nvme' | ||
| minSize: 100GB | ||
| grow: true | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 2 additions & 0 deletions
2
website/content/v1.9/talos-guides/configuration/disk-management.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
130 changes: 130 additions & 0 deletions
130
website/content/v1.9/talos-guides/install/single-board-computers/rock5b.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| --- | ||
| title: "Radxa ROCK 5B" | ||
| description: "Installing Talos on Radxa ROCK 5B SBC using raw disk image." | ||
| aliases: | ||
| - ../../../single-board-computers/rock5b | ||
| --- | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| You will need | ||
|
|
||
| - `talosctl` | ||
| - an SD card | ||
|
|
||
| Download the latest `talosctl`. | ||
|
|
||
| ```bash | ||
| curl -Lo /usr/local/bin/talosctl https://github.com/siderolabs/talos/releases/download/{{< release >}}/talosctl-$(uname -s | tr "[:upper:]" "[:lower:]")-amd64 | ||
| chmod +x /usr/local/bin/talosctl | ||
| ``` | ||
|
|
||
| ## Download the Image | ||
|
|
||
| Visit the [Image Factory](https://factory.talos.dev/), select `Single Board Computers`, select the version and select `Radxa ROCK 5B` from the options. | ||
|
|
||
| Choose `realtek-firmware` and any other desired extension. | ||
| Next fill in the kernel command line arguments if needed. | ||
|
|
||
| Download the image and decompress it: | ||
|
|
||
| ```bash | ||
| curl -LO https://factory.talos.dev/image/[uuid]/{{< release >}}/metal-arm64.raw.xz | ||
| xz -d metal-arm64.raw.xz | ||
| ``` | ||
|
|
||
| Note the `uuid` as it might be helpful during [upgrades](#upgrading). | ||
|
|
||
| ## Writing the Image | ||
|
|
||
| This guide assumes the node should boot from SD card. | ||
| Booting from eMMC or NVMe has not been tested yet. | ||
|
|
||
| The path to your SD card can be found using `fdisk` on Linux or `diskutil` on macOS. | ||
| In this example, we will assume `/dev/mmcblk0`. | ||
|
|
||
| Now `dd` the image to your SD card: | ||
|
|
||
| ```bash | ||
| sudo dd if=metal-arm64.raw of=/dev/mmcblk0 conv=fsync oflag=direct status=progress bs=4M | ||
| ``` | ||
|
|
||
| ## First boot | ||
|
|
||
| Insert the SD card into the board, turn it on and proceed to [bootstrapping the node](#bootstrapping-the-node). | ||
|
|
||
| ### Bootstrapping the Node | ||
|
|
||
| Your node will appear on your local network after it has booted successfully. | ||
| You can then proceed to configure it: | ||
|
|
||
| ```bash | ||
| talosctl apply-config --insecure --mode=interactive --nodes <node IP or DNS name> | ||
| ``` | ||
|
|
||
| Once the interactive installation is applied, the cluster will form and you can then use `kubectl`. | ||
|
|
||
| ### Retrieve the `kubeconfig` | ||
|
|
||
| Retrieve the admin `kubeconfig` by running: | ||
|
|
||
| ```bash | ||
| talosctl kubeconfig | ||
| ``` | ||
|
|
||
| ## Upgrading | ||
|
|
||
| To upgrade to the latest version of Talos, you can run: | ||
|
|
||
| ```bash | ||
| talosctl -n <node IP or DNS name> upgrade --image=factory.talos.dev/installer/[uuid]:{{< release >}} | ||
| ``` | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### Serial console | ||
|
|
||
| If you experience any issues you can check the serial console. | ||
| Follow the [official guideline](https://wiki.radxa.com/Rock5/dev/serial-console) | ||
| on how to connect a serial adapter. | ||
|
|
||
| Hint: The rock5b overlay uses baudrate of `115200` instead of the default `1500000` | ||
|
|
||
| ### Power supplies and endless restarts | ||
|
|
||
| It is a known issue that USB Power Delivery negotiation is performed at a late stage in kernel. | ||
| This can lead to endless restarts if the power supply cuts power to early. | ||
| Check the list of [known working](https://wiki.radxa.com/Rock5/5b/power_supply) power supplies. | ||
|
|
||
| ## Tips and tricks | ||
|
|
||
| ### EPHEMERAL on NVMe | ||
|
|
||
| The Radxa ROCK 5B SBC provides a M.2 NVMe SSD slot. | ||
|
|
||
| This allows to use a separate disk for the EPHEMERAL partition by following | ||
| [Disk Management]({{< relref "../../configuration/disk-management" >}}). | ||
|
|
||
| Add something similar to the machine configuration before | ||
| [bootstrapping the node](#bootstrapping-the-node) to make use of a M.2 NVMe SSD: | ||
|
|
||
| ```yaml | ||
| # worker.yaml | ||
| --- | ||
| version: v1alpha1 | ||
| debug: false | ||
| persist: true | ||
| machine: | ||
| # ... | ||
| cluster: | ||
| # ... | ||
| --- | ||
| apiVersion: v1alpha1 | ||
| kind: VolumeConfig | ||
| name: EPHEMERAL | ||
| provisioning: | ||
| diskSelector: | ||
| match: disk.transport == 'nvme' | ||
| minSize: 100GB | ||
| grow: true | ||
| ``` |