feat: adjust the docs to the current Orchestrator functionality #2499
Conversation
Tickets: MEN-6996 MEN-7016 CE-447 Signed-off-by: Kristian Amlie <[email protected]> Signed-off-by: Alan <[email protected]>
TheMeaningfulEngineer
requested review from
estenberg,
michaelntech and
jo-lund
There was a problem hiding this comment.
First off, do you know how docs gets merged to stable these days? This is great to have in master for now and iterate over, but we should not merge it into the stable / default docs site.
A few nitpicks here, overall:
- Names are Capital Case. For example, Mender Client, Orchestrator, Manifest, Artifact, etc.
- We need to define such new concepts clearly (one sentence) and add them to Taxonomy.
- Separate examples from Concepts
- There are some unrelated changes included in the PR
|
|
||
| ! The Orchestrator is not yet available for public evaluation, please [contact us](https://mender.io/contact?target=_blank) if you would like to learn more. | ||
|
|
||
| The Orchestrator is a tool to provide advanced Over the Air (OTA) updates to a Systems. |
|
|
||
| The Orchestrator is a tool to provide advanced Over the Air (OTA) updates to a Systems. | ||
|
|
||
| If you want to skip the introduction, head over to the [Installation section](01.Installation/docs.md) and then to [Examples](02.Examples/docs.md) to try it in practice. |
There was a problem hiding this comment.
I would move this as a section to the end. They can also see it in the navigation.
|
|
||
| ### A system | ||
|
|
||
| A system is a combination of interdependent digital components running on multiple hardware boards that together acts like a single product. |
There was a problem hiding this comment.
Please add this to Taxonomy doc as well. You can remove "digital" I think it's implicit.
| A system is a combination of interdependent digital components running on multiple hardware boards that together acts like a single product. | ||
|
|
||
| Examples of a system: | ||
| - a car consisting of multiple interconnected CPUs/MCUs for infotainment, motor control, charging |
There was a problem hiding this comment.
ECUs instead of CPUs/MCUs (that's what they call them)
|
|
||
| Examples of a system: | ||
| - a car consisting of multiple interconnected CPUs/MCUs for infotainment, motor control, charging | ||
| - a drone with onboard sensors, GPS, a flight control computer, and communication modules |
There was a problem hiding this comment.
Also some real world inspiration here: https://docs.google.com/presentation/d/1-2Aa379Jx5rkgQ2aaH5l-pNneTXUqkVJeLBymR4Si3c/edit#slide=id.g1f0dd852e08_0_127
Often it's in Transportation, but HVAC is a good one too. You know these cases..
|
|
||
|
|
||
|
|
||
| ### Update interface |
There was a problem hiding this comment.
Interface.
By the way, didn't we rename this to just "Interface" now? (drop Update)? Check the Epic.. there are at least some tasks for that.
Also should go in Taxonomy.
| For details on the Update interface protocol please [follow this link](50.Interface-protocol/docs.md). | ||
|
|
||
|
|
||
| ### Manifests and artifacts |
| 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. |
| @@ -24,7 +24,7 @@ mkfifo /data/mender/dump | |||
| mender-snapshot dump > /data/mender/dump | |||
| ``` | |||
|
|
|||
| Then, back to the shell on the host where you have the variables form the Get Started guide, run: | |||
| The last command will not terminate, but will wait for you to execute commands from the host. So back in the shell on the host where you have the variables form the Get Started guide, run: | |||
There was a problem hiding this comment.
Would split to separate PR.
| @@ -36,6 +36,8 @@ mender-artifact write rootfs-image \ | |||
| -f rootfs.ext4 | |||
| ``` | |||
|
|
|||
| While the command is running, you should see a progress bar in the device window. | |||
There was a problem hiding this comment.
Would split to separate PR.
Tickets: MEN-6996 MEN-7016 CE-447
Examples work once mendersoftware/mender-orchestrator-update-interfaces#7 is merged