diff --git a/source/getting-started/building-deploying-app/index.rst b/source/getting-started/building-deploying-app/index.rst index 4bc9fbd08..9f7f3de90 100644 --- a/source/getting-started/building-deploying-app/index.rst +++ b/source/getting-started/building-deploying-app/index.rst @@ -56,7 +56,7 @@ Push all committed modifications to the remote repository: Once your changes to the :term:`containers.git` repository were pushed, the FoundriesFactory® CI automatically started a new ``container-main`` build. Go to https://app.foundries.io, select your Factory and click on :guilabel:`Targets`: -The latest **Target** named :guilabel:`containers-main` should be the CI job you just created. +The latest :term:`Target` named :guilabel:`containers-main` should be the CI job you just created. .. figure:: /_static/tutorials/creating-first-target/tutorial-find-build.png :width: 900 diff --git a/source/getting-started/flash-device/index.rst b/source/getting-started/flash-device/index.rst index cb6358e84..456ecd500 100644 --- a/source/getting-started/flash-device/index.rst +++ b/source/getting-started/flash-device/index.rst @@ -28,10 +28,10 @@ Prerequisites and Pre-Work .. _gs-download: -Downloading the LmP System Image --------------------------------- +Downloading the System Image +---------------------------- -After a successful build, FoundriesFactory produces build artifacts which can be downloaded from the :guilabel:`Targets` tab of your Factory. +After a successful build, FoundriesFactory produces build artifacts which can be downloaded from the :guilabel:`Targets` tab of your :term:`Factory`. #. Navigate to the :guilabel:`Targets` section of your Factory. @@ -69,7 +69,7 @@ Please refer to this section for specifics on flashing your system image using t See :ref:`ref-qemu` for booting Qemu images. .. note:: - LmP enforces eMMC boot whenever possible as this is the path to enable all security features it provides. So for platforms with available eMMC, such as the NXP® i.MX EVKs, booting from eMMC rather than SD is highly recommended and enabled by default. + The :term:`Linux microPlatform` (LmP) enforces eMMC boot whenever possible as this is the path to enable all security features it provides. So for platforms with available eMMC, such as the NXP® i.MX EVKs, booting from eMMC rather than SD is highly recommended and enabled by default. .. _gs-boot: diff --git a/source/getting-started/signup/index.rst b/source/getting-started/signup/index.rst index 921f00d97..c63d399f5 100644 --- a/source/getting-started/signup/index.rst +++ b/source/getting-started/signup/index.rst @@ -19,7 +19,7 @@ Creating Your Factory ===================== :ref:`ref-factory` is the start of your embedded OS, tailored specifically for your product. -When you create a Factory, we immediately bootstrap the CI build process. +When you create a :term:`Factory`, we immediately bootstrap the CI build process. This generates an unmodified :ref:`ref-linux` OS Image, which is from this point onward, **owned by you**. When your account is created, it is not associated with any factories. @@ -82,7 +82,7 @@ Additionally, you will receive an email once the Factory initial setup is comple FoundriesFactory Targets Targets are a reference to a platform image and Docker applications. -When developers push code, FoundriesFactory produces a new target. +When developers push code, FoundriesFactory produces a new :term:`Target`. Registered devices then update and install Targets. .. note:: diff --git a/source/glossary/index.rst b/source/glossary/index.rst index 9addbf648..8b8e48464 100644 --- a/source/glossary/index.rst +++ b/source/glossary/index.rst @@ -4,34 +4,78 @@ Terminology .. Glossary:: :sorted: + FoundriesFactory + :term:`Foundries.io`'s Cloud native DevSecOps platform. + Used for building, testing, deploying and maintaining Linux-based devices. + Includes the :term:`Linux microPlatform` distro, OTA update mechanisms, and management tools, such as Fioctl. + An instance of FoundriesFactory—customized to your needs and machine—is a :term:`Factory`. + + Foundries.io + Provider of FoundriesFactory® DevSecOps platform and the :term:`Linux microPlatform`\™ OS. + `Website `_. + + Factory + An instance of :term:`FoundriesFactory` tailored to your device and needs. + Created to support a specific machine. + A Factory produces :term:`Target`\s. + + * :ref:`Account Management, Factory ` + * :ref:`Creating, Factory ` + * :ref:`Git repositories, Factory ` + + Fioctl + Factory management tool to interact with the Foundries.io REST API. + Source code available via the `Fioctl GitHub repo `_. + + * :ref:`Installing, Fioctl ` + * :ref:`Example use, Fioctl ` + + Aktualizr-lite + Default Update agent for FoundriesFactory. + + * :ref:`Reference Manual, Aktualizr-lite ` + + Linux microPlatform + LmP + The FoundriesFactory embedded Linux distro included in your Factory. + Included via the ``meta-lmp`` Layer. + Source code available via the `meta-lmp GitHub repo `_. + + * :ref:`Reference Manual, LmP ` + * :ref:`Updating, LmP ` + * :ref:`Test plan, LmP ` + * :ref:`Customizing, LmP ` + * :ref:`Porting, LmP ` + Target - A description of the software a device should run. This description is - visible as metadata in :term:`targets.json`. Includes details such as OSTree - Hash and Docker-Compose App URIs, but is arbitrary. + A description of the software a device should run. This description is visible as metadata in :term:`targets.json`. + Includes details such as OSTree Hash and Docker-Compose App URIs, but are arbitrary. - targets.json - Part of `TUF Metadata `_ that - specifies what Targets are valid to install. It can be summarized with - ``fioctl targets list`` or viewed in full with ``fioctl targets list - --raw`` + * :ref:`Tutorial, Target ` Docker-Compose App - Also referred to as 'app'. A folder in :term:`containers.git`, containing a - `docker-compose.yml`. The name of this folder is the name of your - **Docker-Compose App**. Appending ``.disabled`` to the name of the folder will - prevent it from being built by the Foundries.io CI/CD. - - MACHINE - The Yocto machine name. Officially supported by Foundries if listed - in :ref:`ref-linux-supported` - - system image - The OS image produced by the Factory that is flashed to all devices. The - build artifact is usually named ``lmp-factory-image-.wic.gz`` - - factory-config.yml - A file in the :term:`ci-scripts.git` repository of the Factory which - controls all configurable aspects of a Factory. Such as - :ref:`ref-advanced-tagging`, :ref:`ug-container-preloading` - and email alerts. + Compose App + Also referred to as app. A folder in :term:`containers.git`, containing a ``docker-compose.yml``. + The name of this folder is the name of your Docker-Compose App. + + * :ref:`Tutorial, Compose Apps ` + * :ref:`User Guide, Compose Apps ` + + System Image + The OS image produced by the Factory that is flashed to all devices. + The build artifact is usually named ``lmp-factory-image-.wic.gz`` + + ``factory-config.yml`` + A file in the :term:`ci-scripts.git` repository of the Factory which controls all configurable aspects of a Factory. + Such as :ref:`ref-advanced-tagging`, :ref:`ug-container-preloading` and email alerts. + + * `Factory Definition Reference Manual ` + + ``targets.json`` + Part of `TUF Metadata `_ that specifies what Targets are valid to install. + It can be summarized with ``fioctl targets list``, or viewed in full with ``fioctl targets list --raw`` + + ``MACHINE`` + The Yocto machine name. + Officially supported by Foundries if listed in :ref:`ref-linux-supported`. diff --git a/source/reference-manual/factory/factory.rst b/source/reference-manual/factory/factory.rst index f423da135..9b124c396 100644 --- a/source/reference-manual/factory/factory.rst +++ b/source/reference-manual/factory/factory.rst @@ -3,7 +3,7 @@ FoundriesFactory ================ -**FoundriesFactory®**: The set of tools, services, and support that enable a Factory and assist it throughout the device lifecycle. +**FoundriesFactory®**: The set of tools, services, and support that enable a :term:`Factory` and assist it throughout the device lifecycle. This section provides support for working with and customizing FoundriesFactory and the LmP. * Topics that deal with how CI functions include :ref:`ref-factory-definition` and :ref:`ref-ci-webhooks`. diff --git a/source/user-guide/account-management/account-management.rst b/source/user-guide/account-management/account-management.rst index e95fb6f41..b6fb8ee54 100644 --- a/source/user-guide/account-management/account-management.rst +++ b/source/user-guide/account-management/account-management.rst @@ -3,8 +3,8 @@ Factory & Account Management ============================ -This section covers topics related to using the FoundriesFactory® web UI. -This includes managing your subscription, adding members to your Factory, +This section covers topics related to using the :term:`FoundriesFactory`\® web UI. +This includes managing your subscription, adding members to your :term:`Factory`, or setting who can interact with devices and access source code. .. toctree::