stage1-implementors-guide.md: Add filesystem layout assumptions. #1832
Conversation
|
|
||
| ### opt/stage2 | ||
|
|
||
| As mentioned above, in rkt, the apps will be executed during stage2. rkt expects the directory path `opt/stage2` to exist under the stage1 rootfs. This directory is used by stage0 to extract the app's ACI. `rkt gc` also expects the app's rootfs to be mounted under this directory when overlayfs is used (e.g. `/var/lib/rkt/pods/$uuid/stage1/rootfs/opt/stage2/$appname/rootfs`). |
There was a problem hiding this comment.
Sentence per line for now please
yifan-gu
force-pushed
the
doc_stage1_rkt_dir
branch
from
4f23114
to
55fa44c
Compare
| ### opt/stage2 | ||
|
|
||
| As mentioned above, in rkt, the apps will be executed during stage2. | ||
| rkt expects the directory path `opt/stage2` to exist under the stage1 rootfs. |
There was a problem hiding this comment.
This is actually created by stage0:
- Overlay: run.go:556
- Non-overlay: run.go:525
There was a problem hiding this comment.
@iaguis: So it looks like I can drop the creation of the /opt/stage2 directory tree from the build system, right?
There was a problem hiding this comment.
Actually, we probably still have to write something about /opt/stage2 directories being created by rkt, so stage1 implementation shouldn't have any file named stage2 in /opt directory. Or something like that.
There was a problem hiding this comment.
@iaguis @krnowak OK, then can we create /rkt/status /rkt/env in stage0 as well?
The error @steveej got is from
https://github.com/coreos/rkt/blob/master/stage0/run.go#L641
Seems it's because /rkt directory does not exist.
|
Small nit and needs a rebase. |
yifan-gu
force-pushed
the
doc_stage1_rkt_dir
branch
3 times, most recently
from
3123b95
to
fdbb8ca
Compare
yifan-gu
force-pushed
the
doc_stage1_rkt_dir
branch
from
fdbb8ca
to
7db2519
Compare
yifan-gu
force-pushed
the
doc_stage1_rkt_dir
branch
from
7db2519
to
e8b8aa0
Compare
|
|
||
| This directory path is used for extracting the app's ACI. | ||
| `rkt gc` also expects the app's rootfs to be mounted under this directory when | ||
| overlayfs is used (e.g. `/var/lib/rkt/pods/$uuid/stage1/rootfs/opt/stage2/$appname/rootfs`). |
yifan-gu
force-pushed
the
doc_stage1_rkt_dir
branch
from
e8b8aa0
to
e9b53fa
Compare
|
@alban Addressed comments. |
|
|
||
| ### rkt/env | ||
|
|
||
| This directory path is used for passing the environments to each app. |
There was a problem hiding this comment.
"the environment" or "environment variables"
| This directory path is used for storing the apps' exit statuses. | ||
| For example, if an app named `foo` exits with status = `42`, stage1 should write `42` | ||
| in `/var/lib/rkt/pods/$state/$uuid/stage1/rootfs/rkt/status/foo`. | ||
| Later the exit status will be fetch and shown by `rkt status $uuid` |
There was a problem hiding this comment.
s/will/can/
s/fetch/retrieved/
trailing full-stop
|
A few comments, LGTM after that. |
yifan-gu
force-pushed
the
doc_stage1_rkt_dir
branch
from
e7ac594
to
dcfa4bf
Compare
|
@jonboulle Thanks! Fixed ! |
| ## Filesystem Layout Assumptions | ||
|
|
||
| The following paths are reserved for the stage1 image, and they will be created during stage0. | ||
| Users **SHOULD NOT** create or use these paths when making a stage1 image. |
There was a problem hiding this comment.
@yifan-gu sorry my comment here seems to have been lost. I'm a little wary of the word "Users" as I don't want to mislead anyone - I suggest a slight tweak:
When creating a stage1 image, developers SHOULD NOT create or use these paths in the image's filesystem
I didn't follow this one @joshix |
yifan-gu
force-pushed
the
doc_stage1_rkt_dir
branch
from
dcfa4bf
to
16cf215
Compare
|
@joshix Fixed other comments. Replace stage1 with stage 1 in the paragraph. Add $state(run/prepare) in the path. |
|
@yifan-gu I was suggesting that you number your list as 1, 2, 3, 4 (index 1), rather than starting with 0. Notice that the markdown 0, 1, 2, 3, will be rendered as a list beginning with 1 in the HTML presentation. See below:
|
yifan-gu
force-pushed
the
doc_stage1_rkt_dir
branch
from
16cf215
to
2978db3
Compare
|
@joshix Gotcha, fixed. |
Also replace " with ` for more clearness.
yifan-gu
force-pushed
the
doc_stage1_rkt_dir
branch
from
2978db3
to
e47a27b
Compare
|
LGTM |
stage1-implementors-guide.md: Add filesystem layout assumptions.
cc @steveej @jonboulle @alban @iaguis