Skip to content

Commit

Permalink
Merge pull request containers#15450 from edsantiago/docs_dedup_gidmap
Browse files Browse the repository at this point in the history
[CI:DOCS] Man pages: refactor common options: --gidmap
  • Loading branch information
openshift-merge-robot authored Aug 24, 2022
2 parents 2195656 + ef6285a commit 1bccead
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 22 deletions.
8 changes: 8 additions & 0 deletions docs/source/markdown/options/gidmap.container.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#### **--gidmap**=*container_gid:host_gid:amount*

Run the container in a new user namespace using the supplied GID mapping. This
option conflicts with the **--userns** and **--subgidname** options. This
option provides a way to map host GIDs to container GIDs in the same way as
__--uidmap__ maps host UIDs to container UIDs. For details see __--uidmap__.

Note: the **--gidmap** flag cannot be called in conjunction with the **--pod** flag as a gidmap cannot be set on the container level when in a pod.
4 changes: 4 additions & 0 deletions docs/source/markdown/options/gidmap.pod.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#### **--gidmap**=*pod_gid:host_gid:amount*

GID map for the user namespace. Using this flag will run all containers in the pod with user namespace enabled.
It conflicts with the **--userns** and **--subgidname** flags.
9 changes: 1 addition & 8 deletions docs/source/markdown/podman-create.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -210,14 +210,7 @@ Read in a line delimited file of environment variables. See **Environment** note

@@option expose

#### **--gidmap**=*container_gid:host_gid:amount*

Run the container in a new user namespace using the supplied GID mapping. This
option conflicts with the **--userns** and **--subgidname** options. This
option provides a way to map host GIDs to container GIDs in the same way as
__--uidmap__ maps host UIDs to container UIDs. For details see __--uidmap__.

Note: the **--gidmap** flag cannot be called in conjunction with the **--pod** flag as a gidmap cannot be set on the container level when in a pod.
@@option gidmap.container

@@option group-add

Expand Down
4 changes: 1 addition & 3 deletions docs/source/markdown/podman-pod-clone.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,7 @@ Limit read rate (bytes per second) from a device (e.g. --device-read-bps=/dev/sd

Limit write rate (bytes per second) to a device (e.g. --device-write-bps=/dev/sda:1mb)

#### **--gidmap**=*pod_gid:host_gid:amount*

GID map for the user namespace. Using this flag will run all containers in the pod with user namespace enabled. It conflicts with the `--userns` and `--subgidname` flags.
@@option gidmap.pod

#### **--help**, **-h**

Expand Down
4 changes: 1 addition & 3 deletions docs/source/markdown/podman-pod-create.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,7 @@ Set the exit policy of the pod when the last container exits. Supported policie
| *continue* | The pod continues running, by keeping its infra container alive, when the last container exits. Used by default. |
| *stop* | The pod (including its infra container) is stopped when the last container exits. Used in `kube play`. |

#### **--gidmap**=*container_gid:host_gid:amount*

GID map for the user namespace. Using this flag will run the container with user namespace enabled. It conflicts with the `--userns` and `--subgidname` flags.
@@option gidmap.pod

#### **--help**, **-h**

Expand Down
9 changes: 1 addition & 8 deletions docs/source/markdown/podman-run.1.md.in
Original file line number Diff line number Diff line change
Expand Up @@ -245,14 +245,7 @@ Read in a line delimited file of environment variables. See **Environment** note

@@option expose

#### **--gidmap**=*container_gid:host_gid:amount*

Run the container in a new user namespace using the supplied GID mapping. This
option conflicts with the **--userns** and **--subgidname** options. This
option provides a way to map host GIDs to container GIDs in the same way as
__--uidmap__ maps host UIDs to container UIDs. For details see __--uidmap__.

Note: the **--gidmap** flag cannot be called in conjunction with the **--pod** flag as a gidmap cannot be set on the container level when in a pod.
@@option gidmap.container

@@option group-add

Expand Down

0 comments on commit 1bccead

Please sign in to comment.