aboutsummaryrefslogtreecommitdiff
path: root/docs/source/markdown/options
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-09-06 09:07:22 -0600
committerEd Santiago <santiago@redhat.com>2022-09-06 09:59:14 -0600
commit4675103c22b23de7c30ff3ae979700e90d7f3adb (patch)
tree38bade208df41823c9af9da61554e5286cb93759 /docs/source/markdown/options
parent6da1eaf287c13a67dde688663b4dc8ed0cd868ad (diff)
downloadpodman-4675103c22b23de7c30ff3ae979700e90d7f3adb.tar.gz
podman-4675103c22b23de7c30ff3ae979700e90d7f3adb.tar.bz2
podman-4675103c22b23de7c30ff3ae979700e90d7f3adb.zip
Man pages: refactor common options: --sysctl
As promised, harder and harder to review. Please take your time with this one. For IPC, I went with the list form. For net, I used the single- sentence form instead of a one-element list. The container/pod diffs are clumsy, sorry. Maybe it's time to start thinking of a more flexible conditional mechanism, but I'd really like to avoid that so I hope this is acceptable. In the first sentence I went with 'namespaced' (final 'd') in all instances. I also got rid of the 'new' in 'new pod' in pod-clone. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/options')
-rw-r--r--docs/source/markdown/options/sysctl.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/source/markdown/options/sysctl.md b/docs/source/markdown/options/sysctl.md
new file mode 100644
index 000000000..6fc1bbebe
--- /dev/null
+++ b/docs/source/markdown/options/sysctl.md
@@ -0,0 +1,21 @@
+#### **--sysctl**=*name=value*
+
+Configure namespaced kernel parameters <<at runtime|for all containers in the pod>>.
+
+For the IPC namespace, the following sysctls are allowed:
+
+- kernel.msgmax
+- kernel.msgmnb
+- kernel.msgmni
+- kernel.sem
+- kernel.shmall
+- kernel.shmmax
+- kernel.shmmni
+- kernel.shm_rmid_forced
+- Sysctls beginning with fs.mqueue.\*
+
+Note: <<if you use the **--ipc=host** option|if the ipc namespace is not shared within the pod>>, the above sysctls are not allowed.
+
+For the network namespace, only sysctls beginning with net.\* are allowed.
+
+Note: <<if you use the **--network=host** option|if the network namespace is not shared within the pod>>, the above sysctls are not allowed.