Update the docs
This commit is contained in:
34
README.md
34
README.md
@@ -8,13 +8,13 @@ https://docs.mono.si/gateway-development-kit/getting-started
|
||||
* Read-only RootFS
|
||||
* k8s style OS upgrade (see Upgrading)
|
||||
|
||||
## IMPORTANT NOTES
|
||||
## DISCLAIMER
|
||||
|
||||
* This is not your everyday linux image! It is best suited for users that is already familiar
|
||||
with k8s. For first-timers, you may want to try the default config that gives you a ready-to-use
|
||||
cluster then get yourself started from there
|
||||
cluster and get yourself started from there
|
||||
|
||||
* The 3 RJ45 ports are label in eth1, eth2, eth0 respectively by the kernel (left to right)
|
||||
So `ip addr eth0` is your right most port
|
||||
* USE AT YOUR OWN RISKS. I leverage ChatGPT heavily for this.
|
||||
|
||||
### Table of Contents
|
||||
1. Flashing
|
||||
@@ -26,19 +26,20 @@ https://docs.mono.si/gateway-development-kit/getting-started
|
||||
- [Install an ssh pod](docs/installing-ssh-pod.md) (Recommended)
|
||||
|
||||
## Build
|
||||
Find the latest package versions and update build.env
|
||||
* [kernel](https://github.com/nxp-qoriq/linux/archive/refs/tags/)
|
||||
* [busybox](https://github.com/mirror/busybox/archive/refs/tags/)
|
||||
* [CRI-O](https://github.com/cri-o/cri-o/releases)
|
||||
* [Kubelet](https://kubernetes.io/releases/download/)
|
||||
* [UBoot](https://github.com/u-boot/)
|
||||
|
||||
Then run
|
||||
Prerequisites
|
||||
* make
|
||||
* Docker
|
||||
* curl (downloading dependency packages, kubelet, crio, etc)
|
||||
* go (building clitools, control-agent)
|
||||
* controller-gen (see [clitools readme](clitools/README.md))
|
||||
* git (cloning uboot repo because uboot does not provide direct downloads)
|
||||
|
||||
```
|
||||
make release
|
||||
```
|
||||
|
||||
The default configuration will boot as a first time control-plane. Adjust to your own needs.
|
||||
The default configuration will boot as a first time control-plane.
|
||||
|
||||
For control-plane
|
||||
```
|
||||
@@ -73,12 +74,3 @@ make kernel # Builds our kernel from NXP
|
||||
make initramfs
|
||||
make itb # Builds out/board.itb (contains the kernel and the initramfs)
|
||||
```
|
||||
|
||||
## NOTES
|
||||
### The device's dts files are located at here
|
||||
https://github.com/we-are-mono/OpenWRT-ASK/tree/mono-25.12.0-rc3/target/linux/layerscape/files/arch/arm64/boot/dts/freescale
|
||||
* We need both `mono-gateway-dk-sdk.dts` and `mono-gateway-dk.dts` since the sdk one includes the non-sdk one.
|
||||
* The actual dts being used is the `mono-gateway-dk-sdk.dts`
|
||||
|
||||
## DISCLAIMER
|
||||
USE AT YOUR OWN RISKS. I leverage ChatGPT heavily for this.
|
||||
|
||||
Reference in New Issue
Block a user