diff options
Diffstat (limited to 'README.adoc')
| -rw-r--r-- | README.adoc | 36 |
1 files changed, 20 insertions, 16 deletions
diff --git a/README.adoc b/README.adoc index 12e0446..8c39e4e 100644 --- a/README.adoc +++ b/README.adoc | |||
| @@ -7,7 +7,7 @@ Meta-updater is a link:https://www.yoctoproject.org/software-overview/layers/[Yo | |||
| 7 | 7 | ||
| 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. | 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 | 9 | ||
| 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. | 10 | 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 | 11 | ||
| 12 | == Quickstart | 12 | == Quickstart |
| 13 | 13 | ||
| @@ -36,37 +36,41 @@ The following documentation focuses on tasks that involve the meta-updater layer | |||
| 36 | The following links point to files in the aktualizr repository where the source of the developer guide is stored. | 36 | The following links point to files in the aktualizr repository where the source of the developer guide is stored. |
| 37 | ==== | 37 | ==== |
| 38 | 38 | ||
| 39 | * xref:{aktualizr-docsroot}meta-updater-build.adoc[Build] | ||
| 40 | + | ||
| 41 | Learn how to use this layer to build a basic disk image and add it to your own Yocto project. | ||
| 42 | + | ||
| 43 | * xref:{aktualizr-docsroot}supported-boards.adoc[Supported boards] | 39 | * xref:{aktualizr-docsroot}supported-boards.adoc[Supported boards] |
| 44 | + | 40 | + |
| 45 | Find out if your board is supported and learn about the minimum hardware requirements. | 41 | Find out if your board is supported and learn about the minimum hardware requirements. |
| 46 | + | 42 | + |
| 43 | * xref:{aktualizr-docsroot}build-agl.adoc[Build an Automotive Grade Linux image] | ||
| 44 | + | ||
| 45 | Learn how to use this layer as part of AGL. | ||
| 46 | + | ||
| 47 | * xref:{aktualizr-docsroot}add-ota-functonality-existing-yocto-project.adoc[Add OTA functionality to an existing Yocto project] | ||
| 48 | + | ||
| 49 | Learn how to add this layer to your own Yocto project. | ||
| 50 | + | ||
| 47 | * xref:{aktualizr-docsroot}build-configuration.adoc[SOTA-related variables in local.conf] | 51 | * xref:{aktualizr-docsroot}build-configuration.adoc[SOTA-related variables in local.conf] |
| 48 | + | 52 | + |
| 49 | Learn how to configure OTA-related functionality when building disk images. | 53 | Learn how to configure OTA-related functionality when building images, including how to install custom versions of aktualizr. |
| 50 | + | 54 | + |
| 51 | * xref:{aktualizr-docsroot}meta-updater-usage.adoc[Usage] | 55 | * xref:{aktualizr-docsroot}recommended-clientconfig.adoc[Recommended configuration] |
| 52 | + | 56 | + |
| 53 | Learn about the `garage-push` and `garage-sign` utilities, aktualizr configuration and service resource control, and OSTree. | 57 | Learn how to optimize your build for development or production. |
| 54 | + | 58 | + |
| 55 | * xref:{aktualizr-docsroot}meta-updater-dev-config.adoc[Development configuration] | 59 | * xref:{aktualizr-docsroot}client-provisioning-methods.adoc[Provisoning methods] |
| 56 | + | 60 | + |
| 57 | Learn how to configure logging, install custom versions of aktualizr, and override the version indicator for sofware updates. | 61 | Learn more about the methods for provisioning devices. For more detail, you may also want to read about how to xref:{aktualizr-docsroot}enable-device-cred-provisioning.adoc[enable device credential provisioning] or how to xref:{aktualizr-docsroot}simulate-device-cred-provtest.adoc[simulate it for testing]. |
| 58 | + | 62 | + |
| 59 | * xref:{aktualizr-docsroot}meta-updater-testing.adoc#_qa_with_oe_selftest[QA with oe-selftest] | 63 | * xref:{aktualizr-docsroot}meta-updater-usage.adoc[Advanced usage] |
| 60 | + | 64 | + |
| 61 | Learn how to use the `oe-selftest` framework for quality assurance. | 65 | Learn about the `garage-push` and `garage-sign` utilities, aktualizr configuration recipes, and service resource control. |
| 62 | + | 66 | + |
| 63 | * xref:{aktualizr-docsroot}meta-updater-testing.adoc#_aktualizr_test_suite_with_ptest[Aktualizr test suite with ptest] | 67 | * xref:{aktualizr-docsroot}meta-updater-testing.adoc[Testing with oe-selftest and ptest] |
| 64 | + | 68 | + |
| 65 | Learn how to enable Yocto's package test functionality and run parts of the aktualizr test suite. | 69 | Learn how to use the `oe-selftest` framework for quality assurance and how to run the aktualizr test suite via ptest. |
| 66 | + | 70 | + |
| 67 | * xref:{aktualizr-docsroot}meta-updater-provisioning-methods.adoc[Provisoning methods] | 71 | * xref:{aktualizr-docsroot}troubleshooting.adoc[Troubleshooting] |
| 68 | + | 72 | + |
| 69 | Learn how to enable different methods for provisioning devices. | 73 | Get help on common problems. |
| 70 | 74 | ||
| 71 | == License | 75 | == License |
| 72 | 76 | ||