diff options
-rw-r--r-- | README.adoc | 34 |
1 files changed, 29 insertions, 5 deletions
diff --git a/README.adoc b/README.adoc index b047f91..1a4d6bb 100644 --- a/README.adoc +++ b/README.adoc | |||
@@ -61,7 +61,7 @@ and get as a result an `ostree_repo` folder in your images directory (`tmp/deplo | |||
61 | 61 | ||
62 | * your OSTree repository, with the rootfs committed as an OSTree deployment, | 62 | * your OSTree repository, with the rootfs committed as an OSTree deployment, |
63 | * an `ota-ext4` bootstrap image, which is an OSTree physical sysroot as a burnable filesystem image, and optionally | 63 | * an `ota-ext4` bootstrap image, which is an OSTree physical sysroot as a burnable filesystem image, and optionally |
64 | * some machine-dependent live images (e.g. `.wic` for Raspberry Pi or `.porter-sdimg-ota` Renesas Porter board). | 64 | * some machine-dependent live images (e.g. `.wic` for Raspberry Pi or `.porter-sdimg-ota` for Renesas Porter board). |
65 | 65 | ||
66 | Although `aglsetup.sh` hooks provide reasonable defaults for SOTA-related variables, you may want to tune some of them. | 66 | Although `aglsetup.sh` hooks provide reasonable defaults for SOTA-related variables, you may want to tune some of them. |
67 | 67 | ||
@@ -71,11 +71,18 @@ Ubuntu users that encounter an error due to missing `Python.h` should install `l | |||
71 | 71 | ||
72 | == Supported boards | 72 | == Supported boards |
73 | 73 | ||
74 | Currently supported platforms are | 74 | Currently supported platforms are: |
75 | 75 | ||
76 | * https://github.com/advancedtelematic/meta-updater-raspberrypi[Raspberry Pi3] | 76 | * https://github.com/advancedtelematic/meta-updater-raspberrypi[Raspberry Pi 2 and 3] |
77 | * https://github.com/advancedtelematic/meta-updater-minnowboard[Minnowboard] | 77 | * https://github.com/advancedtelematic/meta-updater-minnowboard[Intel Minnowboard] |
78 | * https://github.com/advancedtelematic/meta-updater-qemux86-64[Native QEMU emulation] | 78 | * https://github.com/advancedtelematic/meta-updater-qemux86-64[Native QEMU emulation] |
79 | * Renesas R-Car H3 and M3 | ||
80 | * https://github.com/advancedtelematic/meta-updater-ti/[TI BeagleBone Black] (rocko only, using TI SDK 05.03) | ||
81 | * https://github.com/advancedtelematic/meta-updater-ti/[TI AM65x industrial development kit] (rocko only, using TI SDK 05.03) | ||
82 | |||
83 | Additionally, there is community support for https://github.com/ricardosalveti/meta-updater-riscv[RISC-V] boards, in particular the Freedom U540. | ||
84 | |||
85 | We also historically supported the https://github.com/advancedtelematic/meta-updater-porter[Renesas Porter] board. | ||
79 | 86 | ||
80 | === Adding support for your board | 87 | === Adding support for your board |
81 | 88 | ||
@@ -92,6 +99,7 @@ Your images will also need network connectivity to be able to reach an actual OT | |||
92 | 99 | ||
93 | == SOTA-related variables in local.conf | 100 | == SOTA-related variables in local.conf |
94 | 101 | ||
102 | * `OSTREE_BRANCHNAME` - OSTree branch name. Defaults to `${SOTA_HARDWARE_ID}`. Particularly useful for grouping similar images. | ||
95 | * `OSTREE_REPO` - path to your OSTree repository. Defaults to `$\{DEPLOY_DIR_IMAGE}/ostree_repo` | 103 | * `OSTREE_REPO` - path to your OSTree repository. Defaults to `$\{DEPLOY_DIR_IMAGE}/ostree_repo` |
96 | * `OSTREE_OSNAME` - OS deployment name on your target device. For more information about deployments and osnames see the https://ostree.readthedocs.io/en/latest/manual/deployment/[OSTree documentation]. Defaults to "poky". | 104 | * `OSTREE_OSNAME` - OS deployment name on your target device. For more information about deployments and osnames see the https://ostree.readthedocs.io/en/latest/manual/deployment/[OSTree documentation]. Defaults to "poky". |
97 | * `OSTREE_COMMIT_BODY` - Message attached to OSTree commit. Empty by default. | 105 | * `OSTREE_COMMIT_BODY` - Message attached to OSTree commit. Empty by default. |
@@ -191,7 +199,23 @@ RESOURCE_CPU_WEIGHT_pn-aktualizr = "50" | |||
191 | 199 | ||
192 | == Development configuration | 200 | == Development configuration |
193 | 201 | ||
194 | There are a few settings that can be controlled in `local.conf` to simplify the development process: | 202 | === Logging |
203 | |||
204 | To troubleshoot problems that you might encounter during development, we recommend that you enable persistent `systemd` logging. This setting is enabled by default for newly configured environments (see link:conf/local.conf.sample.append[]). To enable it manually, put this to your `local.conf`: | ||
205 | |||
206 | .... | ||
207 | IMAGE_INSTALL_append += " systemd-journald-persistent" | ||
208 | .... | ||
209 | |||
210 | It may also be helpful to run with debug logging enabled in aktualizr. To do so, add this to your `local.conf`: | ||
211 | |||
212 | .... | ||
213 | IMAGE_INSTALL_append += " aktualizr-log-debug" | ||
214 | .... | ||
215 | |||
216 | === Custom aktualizr versions | ||
217 | |||
218 | You can override the version of aktualizr included in your image. This requires that the version you wish to run is pushed to the https://github.com/advancedtelematic/aktualizr[aktualizr github repo]. You can then use these settings in your `local.conf` to simplify the development process: | ||
195 | 219 | ||
196 | [options="header"] | 220 | [options="header"] |
197 | |====================== | 221 | |====================== |