-
Notifications
You must be signed in to change notification settings - Fork 541
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
config-linux: fix format and definitely require value of masked and r… #587
config-linux: fix format and definitely require value of masked and r… #587
Conversation
@@ -552,7 +552,7 @@ Its value is either slave, private, or shared. | |||
|
|||
## Masked Paths | |||
|
|||
`maskedPaths` will mask over the provided paths inside the container so that they cannot be read. | |||
**`maskedPaths`** (array of strings, OPTIONAL) will mask over the provided paths inside the container so that they cannot be read. The values MUST be absolute paths. |
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.
Second sentence should go on a new line.
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.
fixed, thanks
@@ -564,7 +564,7 @@ Its value is either slave, private, or shared. | |||
|
|||
## Readonly Paths | |||
|
|||
`readonlyPaths` will set the provided paths as readonly inside the container. | |||
**`readonlyPaths`** (array of strings, OPTIONAL) will set the provided paths as readonly inside the container. The values MUST be absolute paths. |
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.
Second sentence should go on a new line.
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.
fixed, thanks.
@@ -576,7 +576,7 @@ Its value is either slave, private, or shared. | |||
|
|||
## Mount Label | |||
|
|||
`mountLabel` will set the Selinux context for the mounts in the container. | |||
**`mountLabel`** will set the Selinux context for the mounts in the container. |
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.
This (and a number of other entries you bold) should probably also get (object, OPTIONAL)
.
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.
added, thanks.
67c6964
to
807c66f
Compare
@@ -395,11 +395,11 @@ The following parameters can be specified to setup the controller: | |||
|
|||
#### Huge page limits | |||
|
|||
`hugepageLimits` represents the `hugetlb` controller which allows to limit the | |||
**`hugepageLimits`** (array, OPTIONAL) represents the `hugetlb` controller which allows to limit the |
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.
“array” → “array of objects”.
HugeTLB usage per control group and enforces the controller limit during page fault. | ||
For more information, see the [kernel cgroups documentation about HugeTLB][cgroup-v1-hugetlb]. | ||
|
||
`hugepageLimits` is an array of entries, each having the following structure: | ||
**`hugepageLimits`** is an array of entries, each having the following structure: |
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.
And now that we've covered the array-ness above, this can be reduced to:
Each entry has the following properties:
@@ -564,7 +565,8 @@ Its value is either slave, private, or shared. | |||
|
|||
## Readonly Paths | |||
|
|||
`readonlyPaths` will set the provided paths as readonly inside the container. | |||
**`readonlyPaths`** (array of strings, OPTIONAL) will set the provided paths as readonly inside the container. | |||
The values MUST be absolute paths. |
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.
Maybe “…MUST be absolute paths in the container mount namespace.”
…eadonly paths Signed-off-by: Ma Shimiao <mashimiao.fnst@cn.fujitsu.com>
807c66f
to
25f44dd
Compare
@wking all mentioned fixed. |
25f44dd looks good to me :).
|
ping @opencontainers/runtime-spec-maintainers |
1 similar comment
The old language is from 72cbff6 (config-linux.md: clearly require absolute path for namespace, 2017-03-10, opencontainers#720), but without RFC 2119 language in the absolute path wording, it's not a compliance requirement (per spec.md's "compliant" definition). This commit adjusts the language to bring it in line with our current wording for maskedPaths and readonlyPaths, which we've had since 25f44dd ( config-linux: fix format and definitely require value of masked and readonly paths, 2016-09-30, opencontainers#587). Signed-off-by: W. Trevor King <wking@tremily.us>
…eadonly paths
Signed-off-by: Ma Shimiao mashimiao.fnst@cn.fujitsu.com