summaryrefslogtreecommitdiffstats
path: root/README.adoc
diff options
context:
space:
mode:
authorPatrick Vacek <patrickvacek@gmail.com>2018-03-01 15:13:06 +0100
committerPatrick Vacek <patrickvacek@gmail.com>2018-03-01 15:21:21 +0100
commit97ea268738bbacbe383d20f0ae9b1df7aff2b58a (patch)
treee7d4dcc084eb378fe12854d335b8ad4e209bfd59 /README.adoc
parent0fb122d88290a7476d694547f4d05a15d5ec38d1 (diff)
downloadmeta-updater-97ea268738bbacbe383d20f0ae9b1df7aff2b58a.tar.gz
Mention SOTA_PACKED_CREDENTIALS in oe-selftest section of docs.
Also fix a broken link.
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc10
1 files changed, 6 insertions, 4 deletions
diff --git a/README.adoc b/README.adoc
index c87bd01..3562f52 100644
--- a/README.adoc
+++ b/README.adoc
@@ -20,7 +20,7 @@ If you already have a Yocto-based project and you want to add atomic filesystem
202. Clone BSP integration layer (`meta-updater-$\{PLATFORM}`, e.g. https://github.com/advancedtelematic/meta-updater-raspberrypi[meta-updater-raspberrypi]) and add it to your `conf/bblayers.conf`. If your board isn't supported yet, you could write a BSP integration for it yourself. See the <<Adding support for your board>> section for the details. 202. Clone BSP integration layer (`meta-updater-$\{PLATFORM}`, e.g. https://github.com/advancedtelematic/meta-updater-raspberrypi[meta-updater-raspberrypi]) and add it to your `conf/bblayers.conf`. If your board isn't supported yet, you could write a BSP integration for it yourself. See the <<Adding support for your board>> section for the details.
213. Set up your https://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#var-DISTRO[distro]. If you are using "poky", the default distro in Yocto, you can change it in your `conf/local.conf` to "poky-sota". Alternatively, if you are using your own or third party distro configuration, you can add `INHERIT += " sota"` to it, thus combining capabilities of your distro with meta-updater features. 213. Set up your https://www.yoctoproject.org/docs/2.1/ref-manual/ref-manual.html#var-DISTRO[distro]. If you are using "poky", the default distro in Yocto, you can change it in your `conf/local.conf` to "poky-sota". Alternatively, if you are using your own or third party distro configuration, you can add `INHERIT += " sota"` to it, thus combining capabilities of your distro with meta-updater features.
22 22
23You can then build your image as usual, with bitbake. After building the root file system, bitbake will then create an https://ostree.readthedocs.io/en/latest/manual/adapting-existing/[OSTree-enabled version] of it, commit it to your local OSTree repo and (optionally) push it to a remote server. Additionally, a live disk image will be created (normally named `$\{IMAGE_NAME}.-sdimg-ota` e.g. `core-image-raspberrypi3.rpi-sdimg-ota`). You can control this behaviour through <<variables in your local.conf,OSTree-related variables in your local.conf>>. 23You can then build your image as usual, with bitbake. After building the root file system, bitbake will then create an https://ostree.readthedocs.io/en/latest/manual/adapting-existing/[OSTree-enabled version] of it, commit it to your local OSTree repo and (optionally) push it to a remote server. Additionally, a live disk image will be created (normally named `$\{IMAGE_NAME}.-sdimg-ota` e.g. `core-image-raspberrypi3.rpi-sdimg-ota`). You can control this behaviour through <<sota-related-variables-in-localconf,variables in your local.conf>>.
24 24
25=== Build in AGL 25=== Build in AGL
26 26
@@ -73,7 +73,7 @@ You may take a look into https://github.com/advancedtelematic/meta-updater-minno
73 73
74Although we have used U-Boot so far, other boot loaders can be configured work with OSTree as well. 74Although we have used U-Boot so far, other boot loaders can be configured work with OSTree as well.
75 75
76== SOTA-related variables in `local.conf` 76== SOTA-related variables in local.conf
77 77
78* `OSTREE_REPO` - path to your OSTree repository. Defaults to `$\{DEPLOY_DIR_IMAGE}/ostree_repo` 78* `OSTREE_REPO` - path to your OSTree repository. Defaults to `$\{DEPLOY_DIR_IMAGE}/ostree_repo`
79* `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". 79* `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".
@@ -151,13 +151,15 @@ SANITY_TESTED_DISTROS = ""
151IMAGE_INSTALL_append = " dropbear " 151IMAGE_INSTALL_append = " dropbear "
152``` 152```
153 153
1543. To be able to build an image for the grub tests, you will need to install https://github.com/tianocore/tianocore.github.io/wiki/OVMF[TianoCore's ovmf] package on your host system. On Debian-like systems, you can do so with this command: 1543. Some tests require that `SOTA_PACKED_CREDENTIALS` is set in your `conf/local.conf`. See the <<sota-related-variables-in-localconf,SOTA-related variables in local.conf>> section.
155
1564. To be able to build an image for the grub tests, you will need to install https://github.com/tianocore/tianocore.github.io/wiki/OVMF[TianoCore's ovmf] package on your host system. On Debian-like systems, you can do so with this command:
155+ 157+
156``` 158```
157sudo apt install ovmf 159sudo apt install ovmf
158``` 160```
159 161
1604. Run oe-selftest: 1625. Run oe-selftest:
161+ 163+
162``` 164```
163oe-selftest --run-tests updater 165oe-selftest --run-tests updater