Mermaid example: onboarding sequence diagram #73
Conversation
Modified 'workload-orchestration-edge-onboarding.md' to include a diagram example Signed-off-by: Andreas Ziller <[email protected]> Signed-off-by: Silvano Cirujano Cuesta <[email protected]>
|
This is as of now a PR meant to be used as discussion basis, therefore Draft. Some parts of it will be discussed directly in this PR. Micro-commits for easy understanding of the changes should be squashed before merging! @g0zilla could you please have a look at the changes I've put onto yours? |
|
@Silvanoc , this is okay from my side. |
I will then squash my micro-commits and mark the PR as ready for merging. Thanks for the quick feedback! |
Improvements and fixes: - Uniformize actor activation code in Mermaid sequence diagram. - Fix erroneous arrows for return messages in onboarding sequence diagram. - Small readibility improvement in onboarding sequence diagram: Request messages have a continuous line and returns a dashed line. - Add to onboarding sequence diagram a box showing the proposal for using a FIDO onboarding workflow. - Improve readability - Add legend - Document possible sequence diagram change - Typos Signed-off-by: Silvano Cirujano Cuesta <[email protected]>
Silvanoc
force-pushed
the
mermaid-onboarding-sequence
branch
from
956b3ad to
89c3a3f
Compare
There was a problem hiding this comment.
This workflow looks good and demonstrates how Fido on boarding could assist us in on boarding the API client to the Server within the Workload Fleet Manager.
- There is a note that FIDO has not been selected, but I it's positive to include as a proposal within the documentation. This is still a decision we need to finalize within the Management interface working group.
As for the content, I would recommend removing the sections in the mermaid drawing beyond line # 57. I mention this as I think we should have a sequence diagram within the workload deployment markdown describing this process. I have a draft of this sequence in the following issue comment
Additionally, lines 55-71 mention the sequence for Git storage and retrieval. This strategy to utilize or mandate git storage was not approved by the TWG. I think keeping line 55 shows a crucial step in onboarding the client, however, we should make a note that it is still under discussion how the client will receive url and any access related tokens/secrets to the location where the desired states will be stored.
Description
Replace a diagram added as an image with a diagram generated on-the-fly with Mermaid.
Issues Addressed
Diagrams as images are not editable and changes cannot be easily identified.
Change Type
Please select the relevant options:
Checklist