Skip to content
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

specs-go/config: add keyring support #1112

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update keyring support docs
Signed-off-by: Kailun Qin <kailun.qin@intel.com>
  • Loading branch information
kailun-qin committed Aug 3, 2021
commit fa2890234880a3f28376c630ebd59f01517053cc
16 changes: 16 additions & 0 deletions config-linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -826,6 +826,21 @@ subset of the available options.
* **`flags`** *(array of strings, OPTIONAL)* - the additional flags to apply.
Currently no flag values are supported.

## <a name="configLinuxKeyrings" />Keyrings

**`keyrings`** (object, OPTIONAL) sets the kernel keyrings that are created and/or joined by the
container. For more information, see the [keyrings][keyrings.7] man page.

* **`session`** *(object, OPTIONAL)* - the session shared process keyring.
The session-specific keyring is inherited and shared by all child processes. If `session` is
not specified, no new session keyring will be created/and or joined by the container. This
will cause the container to inherit the calling processes session key.

* **`process`** *(object, OPTIONAL)* - the per-process shared keyring.
The process-specific keyring is shared by all threads in a process.

* **`thread`** *(object, OPTIONAL)* - the per-thread keyring.
The thread-specific keyring is kept to a particular thread.

[cgroup-v1]: https://www.kernel.org/doc/Documentation/cgroup-v1/cgroups.txt
[cgroup-v1-blkio]: https://www.kernel.org/doc/Documentation/cgroup-v1/blkio-controller.txt
Expand All @@ -849,6 +864,7 @@ subset of the available options.
[tmpfs]: https://www.kernel.org/doc/Documentation/filesystems/tmpfs.txt

[full.4]: http://man7.org/linux/man-pages/man4/full.4.html
[keyrings.7]: https://man7.org/linux/man-pages/man7/keyrings.7.html
[mknod.1]: http://man7.org/linux/man-pages/man1/mknod.1.html
[mknod.2]: http://man7.org/linux/man-pages/man2/mknod.2.html
[namespaces.7_2]: http://man7.org/linux/man-pages/man7/namespaces.7.html
Expand Down