Skip to content

Commit

Permalink
Review changes
Browse files Browse the repository at this point in the history
Signed-off-by: Alan <[email protected]>
  • Loading branch information
TheMeaningfulEngineer committed Dec 18, 2024
1 parent af69d1d commit ad38e1f
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
14 changes: 7 additions & 7 deletions 09.Add-ons/05.Orchestrator/02.Examples/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This section will explain how the Orchestrator works through copy-pastable worki

* you can run [mender-artifact](../../../10.Downloads/docs.md#mender-artifact) on your host
* you can run a Docker image on your host
* you have a Hosted Mender tenant and can get a token
* you have a hosted Mender tenant and can get a token
<!-- MEN-7215: Needs to be replaced with package install. -->
* you have the preview binary of the Mender Orchestrator software (please [contact us](https://mender.io/contact?target=_blank) to get this)

Expand Down Expand Up @@ -84,7 +84,7 @@ Once the logging prompt shows, you can log in.
The username is root.


Once the device boots it will be visible in Hosted Mender as pending.
Once the device boots it will be visible in hosted Mender as pending.
Accept it.

With the previous terminal consumed by the virtual device, execute these commands on a different terminal on the **host**:
Expand Down Expand Up @@ -162,7 +162,7 @@ mender-artifact write rootfs-image \
```

As the result you now have gateway Artifacts generated (gateway-v1.mender, gateway-v2.mender).
Go to your Hosted Mender account and upload them under Releases.
Go to your hosted Mender account and upload them under Releases.


Still on the **host** in the location where you cloned `mender-orchestrator-update-interfaces`, go to `mender-orchestrator-update-interfaces/demo/premade-artifacts` and upload the 4 Artifacts (`manifest-v1.mender manifest-v2.mender rtos-v1.mender rtos-v2.mender`) from there as well.
Expand All @@ -177,16 +177,16 @@ Once complete, your Releases list will look like this:
In these examples we will update the root filesystem of the gateway where the Orchestrator runs, as
well as update two peripheral mock RTOS devices.

! Before starting, please ensure that all the Artifacts have been uploaded to Hosted Mender.
! Before starting, please ensure that all the Artifacts have been uploaded to hosted Mender.


### Standard System update

In this example we will perform the update of the System using Hosted Mender.
In this example we will perform the update of the System using hosted Mender.
This works just like a regular Mender deployment.

We are only deploying an Artifact containing the manifest.
The Orchestrator will download the other Artifacts from Hosted Mender as they are needed.
The Orchestrator will download the other Artifacts from hosted Mender as they are needed.

Create a deployment to the device and select manifest-v1 as the Release.

Expand All @@ -211,7 +211,7 @@ The following graph shows a higher level flow:

As part of the deployment, the Orchestrator received the new manifest.
Based on the Manifest the Orchestrator took the required steps to update the System.
This also meant downloading the Artifacts from Hosted Mender directly.
This also meant downloading the Artifacts from hosted Mender directly.

Using the remote terminal we can see the state of the System from the device CLI as well:

Expand Down
6 changes: 3 additions & 3 deletions 09.Add-ons/05.Orchestrator/50.Interface-protocol/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -333,7 +333,7 @@ versioning](../../../06.Artifact-creation/09.Software-versioning/docs.md) for
more information about what Provides values are, and see [Execution](#execution)
below to find out how the type and ID are obtained.

The output format is the same as the output from the Mender client
The output format is the same as the output from the Mender Client
`show-provides` command, which consists of "key=value" pairs, with no spaces,
separated by newlines. Unlike in the `Inventory` query, list data is not
permitted in Provides data.
Expand Down Expand Up @@ -453,9 +453,9 @@ but then the interface must clean it up by implementing the `Cleanup` state.
### Streams tree

The streams tree only exists during the `Download` state, which is when the
download is still being streamed from the server. If the update interface
download is still being streamed from the Mender Server. If the update interface
doesn't want to perform its own streaming, and just wishes to save the streams
to files, it can simply do nothing in the `Download` state, and Mender will
to files, it can simply do nothing in the `Download` state, and Mender Client will
automatically save the streams in the "files tree".

`stream-next` is a named pipe which is intended to be read in a loop, where each
Expand Down
6 changes: 3 additions & 3 deletions 09.Add-ons/05.Orchestrator/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The Orchestrator is a tool to provide advanced Over the Air (OTA) updates to a w

### A System

A System is a combination of interdependent digital components running on multiple hardware boards that act together as a single product.
A System is a combination of interdependent components running on multiple hardware boards that act together as a single product.

Examples of a System:
- a car consisting of multiple interconnected ECUs for infotainment, motor control, charging
Expand Down Expand Up @@ -137,9 +137,9 @@ For details on the Interface protocol please [follow this link](50.Interface-pro
For the Orchestrator to be able to update the System, it needs both Manifest and the Artifacts for the System components.
The Orchestrator is agnostic about the way it gets the required content.

For the default case, the Mender Client (in daemon mode, communicating with the Mender server) will download the manifest as part of an update and the Orchestrator will pull the Artifacts it needs based on the manifest.
For the default case, the Mender Client (in daemon mode, communicating with the Mender Server) will download the manifest as part of an update and the Orchestrator will pull the Artifacts it needs based on the manifest.

However it is also possible to deliver both the manifest and Artifacts to the Orchestrator in other ways (i.e. an USB stick) and have the System update happen unrelated to the server.
However it is also possible to deliver both the manifest and Artifacts to the Orchestrator in other ways (i.e. an USB stick) and have the System update happen unrelated to the Mender Server.


This concludes the concepts.
Expand Down

0 comments on commit ad38e1f

Please sign in to comment.