diff options
author | Patrick Vacek <patrickvacek@gmail.com> | 2019-10-16 16:46:08 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-10-16 16:46:08 +0200 |
commit | 4cffedf243cd62a48f941ad713a6ea92b16dd9f5 (patch) | |
tree | c61f9e88232af778e257798730d70caeef8c37b3 | |
parent | a1f2ccf986e844e130ecc6ae61d2b6fc3632e2f8 (diff) | |
parent | bf8803726d20ae0d6df73fd6278541a08bc1275a (diff) | |
download | meta-updater-4cffedf243cd62a48f941ad713a6ea92b16dd9f5.tar.gz |
Merge pull request #613 from advancedtelematic/docs/update-readme-links
README: update and restructure the links to the dev portal.
-rw-r--r-- | README.adoc | 49 |
1 files changed, 25 insertions, 24 deletions
diff --git a/README.adoc b/README.adoc index 12e0446..4cccc7b 100644 --- a/README.adoc +++ b/README.adoc | |||
@@ -1,17 +1,18 @@ | |||
1 | = meta-updater | 1 | = meta-updater |
2 | :toc: macro | 2 | :toc: macro |
3 | :toc-title: | 3 | :toc-title: |
4 | :aktualizr-docsroot: https://github.com/advancedtelematic/aktualizr/tree/master/docs/ota-client-guide/modules/ROOT/pages/ | 4 | :devguide-docsroot: https://docs.ota.here.com/ota-client/latest/ |
5 | :getstarted-docsroot: https://docs.ota.here.com/getstarted/dev/ | ||
5 | 6 | ||
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]. | 7 | 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]. |
7 | 8 | ||
8 | https://github.com/ostreedev/ostree[OSTree] is a tool for atomic full file system upgrades with rollback capability. OSTree has several advantages over traditional dual-bank systems, but the most important one is that it minimizes network bandwidth and data storage footprint by sharing files with the same contents across file system deployments. | 9 | https://github.com/ostreedev/ostree[OSTree] is a tool for atomic full file system upgrades with rollback capability. OSTree has several advantages over traditional dual-bank systems, but the most important one is that it minimizes network bandwidth and data storage footprint by sharing files with the same contents across file system deployments. |
9 | 10 | ||
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. | 11 | https://github.com/advancedtelematic/aktualizr[Aktualizr] implements https://uptane.github.io/uptane-standard/uptane-standard.html[Uptane], supports device authentication and provisioning, and is integrated with OSTree. You can connect aktualizr to your own server solution or sign up for a free account at https://connect.ota.here.com/[HERE OTA Connect] to get started. |
11 | 12 | ||
12 | == Quickstart | 13 | == Quickstart |
13 | 14 | ||
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 | If you don't already have a Yocto project that you want to add OTA to, you can use the xref:{getstarted-docsroot}get-started.html[HERE OTA Connect Quickstart] project to rapidly get up and running on a xref:{getstarted-docsroot}raspberry-pi.html[Raspberry Pi] or with xref:{getstarted-docsroot}qemuvirtualbox.html[QEMU]. It takes a standard https://www.yoctoproject.org/tools-resources/projects/poky[poky] distribution, and adds OTA and OSTree capabilities. |
15 | 16 | ||
16 | == Dependencies | 17 | == Dependencies |
17 | 18 | ||
@@ -30,43 +31,43 @@ sudo apt install ovmf | |||
30 | [discrete] | 31 | [discrete] |
31 | == Table of Contents | 32 | == Table of Contents |
32 | 33 | ||
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 | 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:{devguide-docsroot}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 | ==== | ||
38 | 35 | ||
39 | * xref:{aktualizr-docsroot}meta-updater-build.adoc[Build] | 36 | * xref:{devguide-docsroot}supported-boards.html[Supported boards] |
40 | + | 37 | + |
41 | Learn how to use this layer to build a basic disk image and add it to your own Yocto project. | 38 | Find out if your board is supported and learn about the minimum hardware requirements. |
42 | + | 39 | + |
43 | * xref:{aktualizr-docsroot}supported-boards.adoc[Supported boards] | 40 | * xref:{devguide-docsroot}build-agl.html[Build an Automotive Grade Linux image] |
44 | + | 41 | + |
45 | Find out if your board is supported and learn about the minimum hardware requirements. | 42 | Learn how to use this layer as part of AGL. |
43 | + | ||
44 | * xref:{devguide-docsroot}add-ota-functonality-existing-yocto-project.html[Add OTA functionality to an existing Yocto project] | ||
45 | + | ||
46 | Learn how to add this layer to your own Yocto project. | ||
46 | + | 47 | + |
47 | * xref:{aktualizr-docsroot}build-configuration.adoc[SOTA-related variables in local.conf] | 48 | * xref:{devguide-docsroot}build-configuration.html[SOTA-related variables in local.conf] |
48 | + | 49 | + |
49 | Learn how to configure OTA-related functionality when building disk images. | 50 | Learn how to configure OTA-related functionality when building images, including how to install custom versions of aktualizr. |
50 | + | 51 | + |
51 | * xref:{aktualizr-docsroot}meta-updater-usage.adoc[Usage] | 52 | * xref:{devguide-docsroot}recommended-clientconfig.html[Recommended configuration] |
52 | + | 53 | + |
53 | Learn about the `garage-push` and `garage-sign` utilities, aktualizr configuration and service resource control, and OSTree. | 54 | Learn how to optimize your build for development or production. |
54 | + | 55 | + |
55 | * xref:{aktualizr-docsroot}meta-updater-dev-config.adoc[Development configuration] | 56 | * xref:{devguide-docsroot}client-provisioning-methods.html[Provisoning methods] |
56 | + | 57 | + |
57 | Learn how to configure logging, install custom versions of aktualizr, and override the version indicator for sofware updates. | 58 | Learn more about the methods for provisioning devices. For more detail, you may also want to read about how to xref:{devguide-docsroot}enable-device-cred-provisioning.html[enable device credential provisioning] or how to xref:{devguide-docsroot}simulate-device-cred-provtest.html[simulate it for testing]. |
58 | + | 59 | + |
59 | * xref:{aktualizr-docsroot}meta-updater-testing.adoc#_qa_with_oe_selftest[QA with oe-selftest] | 60 | * xref:{devguide-docsroot}meta-updater-usage.html[Advanced usage] |
60 | + | 61 | + |
61 | Learn how to use the `oe-selftest` framework for quality assurance. | 62 | Learn about the `garage-push` and `garage-sign` utilities, aktualizr configuration recipes, and service resource control. |
62 | + | 63 | + |
63 | * xref:{aktualizr-docsroot}meta-updater-testing.adoc#_aktualizr_test_suite_with_ptest[Aktualizr test suite with ptest] | 64 | * xref:{devguide-docsroot}meta-updater-testing.html[Testing with oe-selftest and ptest] |
64 | + | 65 | + |
65 | Learn how to enable Yocto's package test functionality and run parts of the aktualizr test suite. | 66 | Learn how to use the `oe-selftest` framework for quality assurance and how to run the aktualizr test suite via ptest. |
66 | + | 67 | + |
67 | * xref:{aktualizr-docsroot}meta-updater-provisioning-methods.adoc[Provisoning methods] | 68 | * xref:{devguide-docsroot}troubleshooting.html[Troubleshooting] |
68 | + | 69 | + |
69 | Learn how to enable different methods for provisioning devices. | 70 | Get help on common problems. |
70 | 71 | ||
71 | == License | 72 | == License |
72 | 73 | ||