You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/getting-started/ci-selection.rst
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,19 +6,19 @@ FoundriesFactories supports two different modes for building Targets.
6
6
FoundriesFactory Managed
7
7
------------------------
8
8
9
-
Every Factory includes a `containers.git` hosted at source.foundries.io.
9
+
Every Factory includes a ``containers.git`` hosted at ``source.foundries.io``.
10
10
This works out of the box and changes pushed here will be built automatically by our CI system and produce Targets that can be deployed to your device(s).
11
11
12
-
To get started with the Foundriesio managed solution you'll need to:
12
+
To get started with the Foundries.io managed solution you will need to:
13
13
14
-
- :ref:`Install Fioctl <gs-install-fioctl>` in order to work with source.foundries.io.
14
+
- :ref:`Install Fioctl <gs-install-fioctl>` in order to work with ``source.foundries.io``.
15
15
- :ref:`Build and deploy <gs-building-deploying-app>` your first application.
16
16
17
-
Self-hosted
17
+
Self-Hosted
18
18
-----------
19
19
20
20
The self-hosted option works well for people wanting more control of their workflows.
21
21
It works great with products like GitHub.
22
22
There is a one-time setup that takes about 30 minutes.
23
23
24
-
To get started with the self-hosted option, you'll need to follow the steps outlined in the :ref:`Custom CI <ug-custom-ci-for-apps>` guide.
24
+
To get started with the self-hosted option, follow the steps outlined in the :ref:`Custom CI <ug-custom-ci-for-apps>` guide.
Copy file name to clipboardExpand all lines: source/getting-started/gs-container-only.rst
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,17 +1,19 @@
1
1
.. _ref-gs-container-only:
2
2
3
-
Getting Started with Container-only Factories
3
+
Getting Started With Container-Only Factories
4
4
=============================================
5
5
6
-
Container-only Factories allow users to experience a FoundriesFactory without having to run the Linux microPlatform on their device.
6
+
Container-only Factories lets you experience a Factory without having to run the Linux microPlatform on your device.
7
7
Container-only Factories can be done on any Arm64 or x86 platform.
8
8
A Debian package archive_ is included with statically linked binaries for Debian/Ubuntu users.
9
9
There are few differences between the Container-only Factory and the LmP-based Factory:
10
10
11
-
- OS updates are not built into the offering. It's possible, but not integrated the same way OSTree updates are built into LmP based Factories.
12
-
- The Fioup_ update agent is used instead of :ref:`Aktualizr-Lite <ref-aktualizr-lite>`. They share the same configuration format and files, but Fioup is focused on container-only updates.
13
-
- No TUF_ validation. The Factory includes TUF signed metadata.
14
-
However, its not verfied by Fioup in the Community Edition.
11
+
- OS updates are not built into the offering.
12
+
It is possible, but not integrated the same way OSTree updates are built into LmP based Factories.
13
+
- The Fioup_ update agent is used instead of :ref:`Aktualizr-Lite <ref-aktualizr-lite>`.
14
+
They share the same configuration format and files, but Fioup is focused on container-only updates.
15
+
- No TUF_ validation. The Factory includes TUF signed metadata,
16
+
however, it is not verfied by Fioup in the Community Edition.
15
17
This can be enabled for paid versions of the product as you get ready to move from evaluation to production.
Copy file name to clipboardExpand all lines: source/getting-started/index.rst
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,8 @@ Getting Started
2
2
===============
3
3
4
4
FoundriesFactory includes two ways of getting started.
5
-
Most people such as :ref:`gs-arduino-uno-q` users will be using a "Container Only" Factory and can follow the steps outlined in the :ref:`ref-gs-container-only` guide.
6
-
Other users will be creating a factory based on the Linux microPlatform and call follow the steps outlined in the :ref:`ref-gs-lmp` guide.
5
+
Most people, such as :ref:`gs-arduino-uno-q` users, will be using a container-only Factory and can follow the steps outlined in the :ref:`ref-gs-container-only` guide.
6
+
Other users will be creating a Factory based on the Linux microPlatform and call follow the steps outlined in the :ref:`ref-gs-lmp` guide.
Container-only Factories provide a way for people to manage fleets of Arm64 or x86 devices that don't run the LmP.
6
+
Container-only Factories provide a way for you to manage fleets of Arm64 or x86 devices that do not run the LmP.
7
7
8
8
Components
9
9
----------
10
10
11
11
1. **App Developer**: An individual or team that creates and maintains containerized applications using Docker Compose.
12
-
2. **containers.git**: The Foundries provided Git repository where application developers push their Docker Compose files and related resources.
13
-
3. **CI Job**: The Foundries provided CI job that is triggered when changes are pushed to the `containers.git` repository. This job builds the container images, packages the application, and publishes it to the Container Registry and OTA Service.
12
+
2. **containers.git**: The Foundries.io provided Git repository where application developers push their Docker Compose files and related resources.
13
+
3. **CI Job**: The Foundries.io provided CI job that is triggered when changes are pushed to the ``containers.git`` repository.
14
+
This job builds the container images, packages the application, and publishes it to the Container Registry and OTA Service.
14
15
4. **Container Registry**: A storage service where built container images are stored and made available for devices to download.
15
-
5. **OTA Service**: The Over-The-Air service that manages application metadata, including available versions and update information. It interacts with devices to facilitate updates.
16
+
5. **OTA Service**: The Over-The-Air service that manages application metadata, including available versions and update information.
17
+
It interacts with devices to facilitate updates.
16
18
6. **Database**: A storage system used by the OTA Service to persist application metadata and device status information.
17
-
7. **Device Gateway**: A communication endpoint that devices use to check for updates and report their status. It acts as an intermediary between devices and the OTA Service.
18
-
8. **fioup**: The OTA update client running on the device. It checks for updates, downloads necessary container images from the Container Registry, and uses `composeapp` to manage the application lifecycle on the device.
19
+
7. **Device Gateway**: A communication endpoint that devices use to check for updates and report their status.
20
+
It acts as an intermediary between devices and the OTA Service.
21
+
8. **fioup**: The OTA update client running on the device.
22
+
It checks for updates, downloads necessary container images from the Container Registry, and uses ``composeapp`` to manage the application lifecycle on the device.
19
23
20
24
App Creation And Publishing Flow
21
25
--------------------------------
@@ -28,8 +32,8 @@ App Creation And Publishing Flow
28
32
n3 -- publish metadata about app --> n5["OTA Service"]
29
33
n5 -- store app metadata --> n6[("Database")]
30
34
31
-
1. An application developer pushes a new compose app to the `containers.git` repository.
32
-
2. This triggers the Foundries CI job that builds app's container images, packages the app, and publishes them to Container Registry.
35
+
1. An application developer pushes a new compose app to the ``containers.git`` repository.
36
+
2. This triggers the Foundries.io CI job that builds app's container images, packages the app, and publishes them to Container Registry.
33
37
3. The CI job also generates and publishes metadata about the built and published app to the OTA Service.
34
38
4. The OTA Service stores the app metadata in its database.
n2 <-- get list of available apps</br>persist device status --> n4["OTA Service"]
44
48
45
-
1. The `fioup` client on the device checks for updates by communicating with the Device Gateway.
46
-
2. If there are updates available, `fioup` can start updating app to the specified version.
47
-
3. The app update involves fetching the necessary container images from the Container Registry, and then using `composeapp` to orchestrate the update process.
48
-
4. Once the update is complete, `fioup` uploads the device status back to the Device Gateway, which in turn persists this information in the OTA Service.
49
+
1. The ``fioup`` client on the device checks for updates by communicating with the Device Gateway.
50
+
2. If there are updates available, ``fioup`` can start updating apps to the specified version.
51
+
3. The app update involves fetching the necessary container images from the Container Registry, and then using ``composeapp`` to orchestrate the update process.
52
+
4. Once the update is complete, ``fioup`` uploads the device status back to the Device Gateway, which in turn persists this information in the OTA Service.
0 commit comments