From f2dcc347e576dc30ca1ac750a1c9d341a3d41dd5 Mon Sep 17 00:00:00 2001 From: Merlin Carter Date: Thu, 5 Sep 2019 15:42:59 +0200 Subject: OTA-3682: Remove the existing doc Removing the existing meta-updater doc so it can be moved into the aktualizr repo. Also updated README to point to same files in aktualizr repo. Signed-off-by: Merlin Carter --- README.adoc | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) (limited to 'README.adoc') diff --git a/README.adoc b/README.adoc index 97b9987..af3d2ff 100644 --- a/README.adoc +++ b/README.adoc @@ -1,9 +1,7 @@ = meta-updater :toc: macro :toc-title: -:meta-updater-github-url: https://github.com/advancedtelematic/meta-updater/tree/master/ - -ifndef::env-github[:meta-updater-github-url:] +:aktualizr-docsroot: https://github.com/advancedtelematic/aktualizr/tree/master/docs/ota-client-guide/modules/ROOT/pages/ 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]. @@ -15,36 +13,40 @@ https://github.com/advancedtelematic/aktualizr[Aktualizr] (and https://github.co == Table of Contents 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]. +[NOTE] +==== +The following links point to files in the aktualizr repository where the source of the developer guide is stored. +==== -* xref:{meta-updater-github-url}docs/modules/ROOT/pages/build.adoc[Build] +* xref:{aktualizr-docsroot}meta-updater-build.adoc[Build] + Learn how to use this layer to build a basic disk image and add it to your own Yocto project. + -* xref:{meta-updater-github-url}docs/modules/ROOT/pages/supported-boards.adoc[Supported boards] +* xref:{aktualizr-docsroot}supported-boards.adoc[Supported boards] + Find out if your board is supported and learn about the minimum hardware requirements. + -* xref:{meta-updater-github-url}docs/modules/ROOT/pages/sota-variables.adoc[SOTA-related variables in local.conf] +* xref:{aktualizr-docsroot}sota-variables.adoc[SOTA-related variables in local.conf] + Learn how to configure OTA-related functionality when building disk images. + -* xref:{meta-updater-github-url}docs/modules/ROOT/pages/meta-updater-usage.adoc[Usage] +* xref:{aktualizr-docsroot}meta-updater-usage.adoc[Usage] + Learn about the `garage-push` and `garage-sign` utilities, aktualizr configuration and service resource control, and OSTree. + -* xref:{meta-updater-github-url}docs/modules/ROOT/pages/dev-config.adoc[Development configuration] +* xref:{aktualizr-docsroot}meta-updater-dev-config.adoc[Development configuration] + Learn how to configure logging, install custom versions of aktualizr, and override the version indicator for sofware updates. + -* xref:{meta-updater-github-url}docs/modules/ROOT/pages/meta-updater-testing.adoc#_qa_with_oe_selftest[QA with oe-selftest] +* xref:{aktualizr-docsroot}meta-updater-testing.adoc#_qa_with_oe_selftest[QA with oe-selftest] + Learn how to use the `oe-selftest` framework for quality assurance. + -* xref:{meta-updater-github-url}docs/modules/ROOT/pages/meta-updater-testing.adoc#_aktualizr_test_suite_with_ptest[Aktualizr test suite with ptest] +* xref:{aktualizr-docsroot}meta-updater-testing.adoc#_aktualizr_test_suite_with_ptest[Aktualizr test suite with ptest] + Learn how to enable Yocto's package test functionality and run parts of the aktualizr test suite. + -* xref:{meta-updater-github-url}docs/modules/ROOT/pages/provisioning-methods.adoc[Provisoning methods] +* xref:{aktualizr-docsroot}meta-updater-provisioning-methods.adoc[Provisoning methods] + Learn how to enable different methods for provisioning devices. -- cgit v1.2.3-54-g00ecf From 0862f1603688badf96e61e0a8266584e0d84fba8 Mon Sep 17 00:00:00 2001 From: Patrick Vacek Date: Thu, 5 Sep 2019 17:17:05 +0200 Subject: Restore basic doc about getting started and dependencies. Signed-off-by: Patrick Vacek --- README.adoc | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'README.adoc') diff --git a/README.adoc b/README.adoc index af3d2ff..787aaf6 100644 --- a/README.adoc +++ b/README.adoc @@ -9,6 +9,24 @@ https://github.com/ostreedev/ostree[OSTree] is a tool for atomic full file syste 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. +== Quickstart + +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. + +== Dependencies + +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: + +.... +sudo apt install cpu-checker default-jre parted +.... + +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: + +.... +sudo apt install ovmf +.... + [discrete] == Table of Contents -- cgit v1.2.3-54-g00ecf