-
Notifications
You must be signed in to change notification settings - Fork 882
doc/devel: detail execution flow between stages #2945
Conversation
PS: Yes, I can migrate the dot diagrams to Google Docs, I was just faster with this ;-) |
|
||
2. stage0 -> stage1: | ||
An ordinary `exec(3)` is being used to replace the stage0 process with the stage1 entrypoint. The entrypoint is referenced by the `coreos.com/rkt/stage1/run` annotation in the stage1 image manifest. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like the stop entrypoint is currently called as a forked process.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point, actually for the stop execution chain I would prepare a different diagrams, in order not to bloat the startup execution chain diagram.s
systemdNspawn | ||
|
||
subgraph cluster_2 { | ||
label=<<B>stage2</B>> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
An unique stage2 box with inside systemd and the apps looks strange to me. In my view systemd
and systemd journal
live in the stage1 and I'll do a stage2
box for every app.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good points, will correct the diagram.
@sgotti thanks a lot for the initial comments! 👍 |
4b8b64c
to
c33b220
Compare
@sgotti PTAL, I created two separate top-level chapters "Stages", and "Flavors", since they are orthogonal concepts to describe. The "Stages" chapter contains abstract stage documentation, the "Flavors" chapter contains flavor specific documentation. |
@joshix I'd appreciate a review for this, PTAL :-) |
LGTM too FWIW |
Waiting on @joshix, I'm moving to next milestone, but this could be merged at anytime once proofread. |
@joshix ping, do you mind to have a look at this? |
@s-urbaniak can you please rebase this? It has some conflicts now... |
@lucab rebased, and also converted the image lifecycle figures to PNG, PTAL |
@s-urbaniak is there a |
@jonboulle fair point, I'll add a make target in this PR ;-) |
For the sake of having this documentation finally in v1.13.0 I created a separate issue #3085 for introducing a new |
I have various nits but in the spirit of moving forward I'm inclined for this to land and I can just chase up myself. |
LGTM then, @jonboulle and @joshix can follow up later on any nits they have. |
First part of additional documentation/architecture diagrams. This PR concentrates on the execution chain between stages, and the process parent-child relationships.
Note: The focus is on the systemd/nspawn and the fly flavors.
Fixes partially #2115