Skip to content
This repository has been archived by the owner on Feb 24, 2020. It is now read-only.

doc/devel: detail execution flow between stages #2945

Merged
merged 2 commits into from Aug 18, 2016

Conversation

s-urbaniak
Copy link
Contributor

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

@s-urbaniak s-urbaniak added this to the v1.11.0 milestone Jul 19, 2016
@s-urbaniak
Copy link
Contributor Author

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.

Copy link
Contributor

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.

Copy link
Contributor Author

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>>
Copy link
Contributor

@sgotti sgotti Jul 19, 2016

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.

Copy link
Contributor Author

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.

@s-urbaniak
Copy link
Contributor Author

@sgotti thanks a lot for the initial comments! 👍

@s-urbaniak s-urbaniak force-pushed the execflow branch 2 times, most recently from 4b8b64c to c33b220 Compare July 19, 2016 08:25
@s-urbaniak
Copy link
Contributor Author

@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.

@s-urbaniak
Copy link
Contributor Author

@joshix I'd appreciate a review for this, PTAL :-)

@iaguis
Copy link
Member

iaguis commented Jul 20, 2016

LGTM too FWIW

@lucab
Copy link
Member

lucab commented Jul 20, 2016

Waiting on @joshix, I'm moving to next milestone, but this could be merged at anytime once proofread.

@lucab lucab modified the milestones: v1.12.0, v1.11.0 Jul 20, 2016
@s-urbaniak
Copy link
Contributor Author

@joshix ping, do you mind to have a look at this?

@lucab lucab modified the milestones: v1.13.0, v1.12.0 Aug 4, 2016
@lucab
Copy link
Member

lucab commented Aug 15, 2016

@s-urbaniak can you please rebase this? It has some conflicts now...

@s-urbaniak
Copy link
Contributor Author

@lucab rebased, and also converted the image lifecycle figures to PNG, PTAL

@jonboulle
Copy link
Contributor

@s-urbaniak is there a make diagrams in the works? ;-)

@s-urbaniak
Copy link
Contributor Author

@jonboulle fair point, I'll add a make target in this PR ;-)

@s-urbaniak
Copy link
Contributor Author

s-urbaniak commented Aug 17, 2016

For the sake of having this documentation finally in v1.13.0 I created a separate issue #3085 for introducing a new make diagrams target.

@jonboulle
Copy link
Contributor

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.

@lucab
Copy link
Member

lucab commented Aug 18, 2016

LGTM then, @jonboulle and @joshix can follow up later on any nits they have.

@s-urbaniak s-urbaniak merged commit e29600e into rkt:master Aug 18, 2016
@s-urbaniak s-urbaniak deleted the execflow branch November 7, 2016 12:58
@lucab lucab unassigned joshix Apr 5, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants