diff options
Diffstat (limited to 'README.adoc')
| -rw-r--r-- | README.adoc | 42 |
1 files changed, 31 insertions, 11 deletions
diff --git a/README.adoc b/README.adoc index 97b9987..787aaf6 100644 --- a/README.adoc +++ b/README.adoc | |||
| @@ -1,9 +1,7 @@ | |||
| 1 | = meta-updater | 1 | = meta-updater |
| 2 | :toc: macro | 2 | :toc: macro |
| 3 | :toc-title: | 3 | :toc-title: |
| 4 | :meta-updater-github-url: https://github.com/advancedtelematic/meta-updater/tree/master/ | 4 | :aktualizr-docsroot: https://github.com/advancedtelematic/aktualizr/tree/master/docs/ota-client-guide/modules/ROOT/pages/ |
| 5 | |||
| 6 | ifndef::env-github[:meta-updater-github-url:] | ||
| 7 | 5 | ||
| 8 | Meta-updater is a link:https://www.yoctoproject.org/software-overview/layers/[Yocto layer] that enables over-the-air updates (OTA) with https://github.com/ostreedev/ostree[OSTree] and https://github.com/advancedtelematic/aktualizr[Aktualizr] -- the default client for link:https://www.here.com/products/automotive/ota-technology[HERE OTA Connect]. | 6 | Meta-updater is a link:https://www.yoctoproject.org/software-overview/layers/[Yocto layer] that enables over-the-air updates (OTA) with https://github.com/ostreedev/ostree[OSTree] and https://github.com/advancedtelematic/aktualizr[Aktualizr] -- the default client for link:https://www.here.com/products/automotive/ota-technology[HERE OTA Connect]. |
| 9 | 7 | ||
| @@ -11,40 +9,62 @@ https://github.com/ostreedev/ostree[OSTree] is a tool for atomic full file syste | |||
| 11 | 9 | ||
| 12 | https://github.com/advancedtelematic/aktualizr[Aktualizr] (and https://github.com/advancedtelematic/rvi_sota_client[RVI SOTA client]) add authentication and provisioning capabilities to OTA and are integrated with OSTree. You can connect with these open-source applications or sign up for a free account at https://connect.ota.here.com/[HERE OTA Connect] to get started. | 10 | https://github.com/advancedtelematic/aktualizr[Aktualizr] (and https://github.com/advancedtelematic/rvi_sota_client[RVI SOTA client]) add authentication and provisioning capabilities to OTA and are integrated with OSTree. You can connect with these open-source applications or sign up for a free account at https://connect.ota.here.com/[HERE OTA Connect] to get started. |
| 13 | 11 | ||
| 12 | == Quickstart | ||
| 13 | |||
| 14 | If you don't already have a Yocto project that you want to add OTA to, you can use the xref:dev@getstarted::raspberry-pi.adoc[HERE OTA Connect Quickstart] project to rapidly get up and running on a Raspberry Pi. It takes a standard https://www.yoctoproject.org/tools-resources/projects/poky[poky] distribution, and adds OTA and OSTree capabilities. | ||
| 15 | |||
| 16 | == Dependencies | ||
| 17 | |||
| 18 | In addition to the link:https://www.yoctoproject.org/docs/current/ref-manual/ref-manual.html#required-packages-for-the-build-host[standard Yocto dependencies], meta-updater generally requires a few additional dependencies, depending on your use case and target platform. To install these additional packages on Debian/Ubuntu, run this: | ||
| 19 | |||
| 20 | .... | ||
| 21 | sudo apt install cpu-checker default-jre parted | ||
| 22 | .... | ||
| 23 | |||
| 24 | To build for https://github.com/advancedtelematic/meta-updater-minnowboard[Minnowboard] with GRUB, you will also need to install https://github.com/tianocore/tianocore.github.io/wiki/OVMF[TianoCore's ovmf] package on your host system. On Debian/Ubuntu, you can do so with this command: | ||
| 25 | |||
| 26 | .... | ||
| 27 | sudo apt install ovmf | ||
| 28 | .... | ||
| 29 | |||
| 14 | [discrete] | 30 | [discrete] |
| 15 | == Table of Contents | 31 | == Table of Contents |
| 16 | 32 | ||
| 17 | The following documentation focuses on tasks that involve the meta-updater layer. If you want to get an idea of the overall developer workflow in OTA Connect, see the link:https://docs.ota.here.com/ota-client/dev/index.html[OTA Connect Developer Guide]. | 33 | The following documentation focuses on tasks that involve the meta-updater layer. If you want to get an idea of the overall developer workflow in OTA Connect, see the link:https://docs.ota.here.com/ota-client/dev/index.html[OTA Connect Developer Guide]. |
| 34 | [NOTE] | ||
| 35 | ==== | ||
| 36 | The following links point to files in the aktualizr repository where the source of the developer guide is stored. | ||
| 37 | ==== | ||
| 18 | 38 | ||
| 19 | * xref:{meta-updater-github-url}docs/modules/ROOT/pages/build.adoc[Build] | 39 | * xref:{aktualizr-docsroot}meta-updater-build.adoc[Build] |
| 20 | + | 40 | + |
| 21 | Learn how to use this layer to build a basic disk image and add it to your own Yocto project. | 41 | Learn how to use this layer to build a basic disk image and add it to your own Yocto project. |
| 22 | + | 42 | + |
| 23 | * xref:{meta-updater-github-url}docs/modules/ROOT/pages/supported-boards.adoc[Supported boards] | 43 | * xref:{aktualizr-docsroot}supported-boards.adoc[Supported boards] |
| 24 | + | 44 | + |
| 25 | Find out if your board is supported and learn about the minimum hardware requirements. | 45 | Find out if your board is supported and learn about the minimum hardware requirements. |
| 26 | + | 46 | + |
| 27 | * xref:{meta-updater-github-url}docs/modules/ROOT/pages/sota-variables.adoc[SOTA-related variables in local.conf] | 47 | * xref:{aktualizr-docsroot}sota-variables.adoc[SOTA-related variables in local.conf] |
| 28 | + | 48 | + |
| 29 | Learn how to configure OTA-related functionality when building disk images. | 49 | Learn how to configure OTA-related functionality when building disk images. |
| 30 | + | 50 | + |
| 31 | * xref:{meta-updater-github-url}docs/modules/ROOT/pages/meta-updater-usage.adoc[Usage] | 51 | * xref:{aktualizr-docsroot}meta-updater-usage.adoc[Usage] |
| 32 | + | 52 | + |
| 33 | Learn about the `garage-push` and `garage-sign` utilities, aktualizr configuration and service resource control, and OSTree. | 53 | Learn about the `garage-push` and `garage-sign` utilities, aktualizr configuration and service resource control, and OSTree. |
| 34 | + | 54 | + |
| 35 | * xref:{meta-updater-github-url}docs/modules/ROOT/pages/dev-config.adoc[Development configuration] | 55 | * xref:{aktualizr-docsroot}meta-updater-dev-config.adoc[Development configuration] |
| 36 | + | 56 | + |
| 37 | Learn how to configure logging, install custom versions of aktualizr, and override the version indicator for sofware updates. | 57 | Learn how to configure logging, install custom versions of aktualizr, and override the version indicator for sofware updates. |
| 38 | + | 58 | + |
| 39 | * xref:{meta-updater-github-url}docs/modules/ROOT/pages/meta-updater-testing.adoc#_qa_with_oe_selftest[QA with oe-selftest] | 59 | * xref:{aktualizr-docsroot}meta-updater-testing.adoc#_qa_with_oe_selftest[QA with oe-selftest] |
| 40 | + | 60 | + |
| 41 | Learn how to use the `oe-selftest` framework for quality assurance. | 61 | Learn how to use the `oe-selftest` framework for quality assurance. |
| 42 | + | 62 | + |
| 43 | * xref:{meta-updater-github-url}docs/modules/ROOT/pages/meta-updater-testing.adoc#_aktualizr_test_suite_with_ptest[Aktualizr test suite with ptest] | 63 | * xref:{aktualizr-docsroot}meta-updater-testing.adoc#_aktualizr_test_suite_with_ptest[Aktualizr test suite with ptest] |
| 44 | + | 64 | + |
| 45 | Learn how to enable Yocto's package test functionality and run parts of the aktualizr test suite. | 65 | Learn how to enable Yocto's package test functionality and run parts of the aktualizr test suite. |
| 46 | + | 66 | + |
| 47 | * xref:{meta-updater-github-url}docs/modules/ROOT/pages/provisioning-methods.adoc[Provisoning methods] | 67 | * xref:{aktualizr-docsroot}meta-updater-provisioning-methods.adoc[Provisoning methods] |
| 48 | + | 68 | + |
| 49 | Learn how to enable different methods for provisioning devices. | 69 | Learn how to enable different methods for provisioning devices. |
| 50 | 70 | ||
