Skip to content

Commit

Permalink
Merge pull request containers#15653 from edsantiago/docs_dedup_sysctl
Browse files Browse the repository at this point in the history
[CI:DOCS] Man pages: refactor common options: --sysctl
  • Loading branch information
openshift-merge-robot authored Sep 7, 2022
2 parents ac8c1e1 + 4675103 commit 7946628
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 80 deletions.
21 changes: 21 additions & 0 deletions docs/source/markdown/options/sysctl.md
Original file line number Diff line number Diff line change
@@ -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.
16 changes: 1 addition & 15 deletions docs/source/markdown/podman-create.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -500,21 +500,7 @@ When size is `0`, there is no limit on the amount of memory used for IPC by the

@@option subuidname

#### **--sysctl**=*SYSCTL*

Configure namespaced kernel parameters at runtime

IPC Namespace - current sysctls 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 these sysctls will not be allowed.

Network Namespace - current sysctls allowed:
Sysctls beginning with net.*

Note: if you use the --network=host option these sysctls will not be allowed.
@@option sysctl

@@option systemd

Expand Down
22 changes: 1 addition & 21 deletions docs/source/markdown/podman-pod-clone.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -114,27 +114,7 @@ clone process has completed. All containers within the pod are started.

@@option subuidname

#### **--sysctl**=*name=value*

Configure namespace kernel parameters for all containers in the new 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 the ipc namespace is not shared within the pod, these sysctls are not allowed.

For the network namespace, only sysctls beginning with net.\* are allowed.

Note: if the network namespace is not shared within the pod, these sysctls are not allowed.
@@option sysctl

@@option uidmap.pod

Expand Down
22 changes: 1 addition & 21 deletions docs/source/markdown/podman-pod-create.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -255,27 +255,7 @@ When size is `0`, there is no limit on the amount of memory used for IPC by the

@@option subuidname

#### **--sysctl**=*name=value*

Configure namespace kernel parameters 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 the ipc namespace is not shared within the pod, these sysctls are not allowed.

For the network namespace, only sysctls beginning with net.\* are allowed.

Note: if the network namespace is not shared within the pod, these sysctls are not allowed.
@@option sysctl

@@option uidmap.pod

Expand Down
24 changes: 1 addition & 23 deletions docs/source/markdown/podman-run.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -542,29 +542,7 @@ Sets whether the signals sent to the **podman run** command are proxied to the c

@@option subuidname

#### **--sysctl**=*name=value*

Configure namespaced kernel parameters at runtime.

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, the above sysctls will not be allowed.

For the network namespace, the following sysctls are allowed:

- Sysctls beginning with net.\*

Note: if you use the **--network=host** option, these sysctls will not be allowed.
@@option sysctl

@@option systemd

Expand Down

0 comments on commit 7946628

Please sign in to comment.