From 274b5cc0154f8c619c5aa06dea6b546ce7b369a2 Mon Sep 17 00:00:00 2001 From: Katrina Prosise Date: Wed, 8 May 2024 07:58:28 -0400 Subject: [PATCH] Add OTA terms to Glossary Added terms gathered by OTA team. QA Steps: Checked rendered HTML, no issues found. Ran linter and spellcheck. This commit addresses FFTK-3010 Signed-off-by: Katrina Prosise --- source/glossary/index.rst | 101 +++++++++++++++++- .../security/factory-registration-ref.rst | 2 +- 2 files changed, 101 insertions(+), 2 deletions(-) diff --git a/source/glossary/index.rst b/source/glossary/index.rst index e10bb54aa..9a46a92c5 100644 --- a/source/glossary/index.rst +++ b/source/glossary/index.rst @@ -219,7 +219,7 @@ Terminology * :ref:`Account Management, Team Based Access and TUF Keys ` * :ref:`Custom CI User Guide, TUF Targets ` * :ref:`CI Targets Reference Manual, TUF Targets; TUF Metadata ` - * :ref:`Offline Updates, TUF Metadata; TUF Keys; TUF Repo; ` + * :ref:`Offline Updates, TUF Metadata; TUF Keys; TUF Repo ` * :ref:`Reference Manual, Offline Factory TUF Keys ` * :ref:`Crypto Key Summary, TUF Signing Keys ` * :ref:`Production Targets, TUF ` @@ -236,3 +236,102 @@ Terminology X.509 An International Telecommunication Union (ITU) standard defining the format of public key certificates. + + Device Fleet + The set of all devices in a Factory. + + * :ref:`OTA Reference Manual, Fleet Wide Configuration ` + * :ref:`OTA Production Devices Reference Manual, Fleet Production Targets ` + * :ref:`Revoke Secure Boot Keys on i.MX, Revoke a Key for Devices in a Fleet ` + + Device Tag + Instructs the Device Gateway to return the corresponding set of TUF metadata. + A tag (string value) gets set in a device config. + + * :ref:`OTA Reference manual, Device Tags` + + Fioconfig + Simple daemon designed to manage configuration data for an embedded device. + Based on a customized OTA Community Edition device-gateway endpoint. + + * :ref:`OTA Reference Manual, Fioconfig ` + * `Fioconfig on GitHub `_ + + ``lmp-device-register`` + Tool for managing device registration via the Foundries.io REST API. + + * :ref:`Getting Started, Registering Your Device ` + * :ref:`Device Gateway PKI User Guide, Online Device Certificate Using lmp-device-register ` + * :ref:`Restorable Apps Reference Manual, extending list of Restorable Apps Using lmp-device-register ` + + OTA Update + Over-The-Air Update + OTA + Updating firmware and software for a system/device remotely. + The update on a device is triggered remotely and the data fetched from the OTA service via internet. + + * :ref:`Reference Manual, OTA ` + * :ref:`Security Reference Manual, OTA ` + + OSTree + OSTree is both a shared library and suite of command line tools. + It combines a “git-like” model for committing and downloading bootable filesystem trees, + along with a layer for deploying them and managing the bootloader configuration. + + * :ref:`Custom CI for RootFS User Guide, OSTree Repo ` + * :ref:`Fioctl User Guide, OSTree Hash ` + + Production Device + A device with a flag in its certificate which enables it to receive production updates. + + * :ref:`Factory Registration Reference Manual, Registering Proudction Devices by Default ` + * :ref:`Reference Manual, Production Targets for Production Devices ` + + Production Targets + :term:`TUF` Targets delivered to production devices during an :term:`OTA Update`. + + * :ref:`Reference Manual, Production Targets ` + * :ref:`Offline Update Reference Manual, Production Targets ` + * :ref:`OTA Reference Manual, CI Targets ` + + Rollback + The process of an online (OTA) or offline update applying a software or firmware version that was running on a device before a failed update. + + * :ref:`Reference Manual, Update Rollback ` + * :ref:`Offline Update User Guide, Rollback Actions and Error Codes ` + * :ref:`Security Reference Manual, Anti-Rollback Protection ` + + SOTA + Secure-Over-The-Air. See :term:`OTA`. + + * :ref:`User Guide, Custom SOTA Client ` + * :ref:`Factory Reset Reference Manual, Keeping SOTA ` + + + Static Deltas + One or more compressed binary files containing a diff between two filesystem trees. + Stored in an ostree repo and represented by a commit hash. + + * :ref:`Reference Manual, Static Deltas ` + + Update Agent + Software that runs on a device and performs OTA updates. + + * :ref:`Custom Sota Client User Guide, Custom Update Agent ` + + Wave + The FoundriesFactory method for adding a specific CI Targets version to production Targets. + Provisions it to production devices in a controlled way. + + * :ref:`Production Targets Reference Manual, Wave ` + + Wave Rollout + An action of rolling out an OTA update associated with a Wave to a subset of production devices. + + Wave Tag + A tag designating production devices to which a given Wave is being provisioned. + + CI Targets + TUF Targets created during the CI builds and delivered to non-production devices during an OTA update. + + * :ref:`Reference Manual, CI Targets ` diff --git a/source/reference-manual/security/factory-registration-ref.rst b/source/reference-manual/security/factory-registration-ref.rst index 77f7ceecd..393030a2c 100644 --- a/source/reference-manual/security/factory-registration-ref.rst +++ b/source/reference-manual/security/factory-registration-ref.rst @@ -47,7 +47,7 @@ However, it does have a couple caveats: Registering Production Device by Default ---------------------------------------- -After the development cycle, when every device to be registered is a production device, it may be good to enable this by default in LmP. +After the development cycle, when every device to be registered is a :term:`production device`, it may be good to enable this by default in LmP. Create or modify the ``lmp-device-register_%.bbappend`` file in the Factory's ``meta-subscriber-overrides``: