Move --userns-uid-map/--userns-gid-map description into buildah man page

Currently we are describing a root global option --userns-uid-map and --userns-gid-map
options in the buildah-bud man page, These global flags can be used in lots of buildah
commands, and should have complete description in the buildah man page.

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
This commit is contained in:
Daniel J Walsh 2020-09-30 10:15:21 -04:00
parent 5955652650
commit 00b511e4d4
No known key found for this signature in database
GPG Key ID: A2DF901DABE2C028
3 changed files with 32 additions and 49 deletions

View File

@ -44,7 +44,6 @@ func init() {
Aliases: []string{"bud"},
Short: "Build an image using instructions in a Dockerfile",
Long: budDescription,
//Flags: sortFlags(append(append(buildahcli.BudFlags, buildahcli.LayerFlags...), buildahcli.FromAndBudFlags...)),
RunE: func(cmd *cobra.Command, args []string) error {
br := budOptions{
&layerFlagsResults,

View File

@ -497,48 +497,6 @@ the user namespace in which `buildah` itself is being run should be reused, or
it can be the path to an user namespace which is already in use by another
process.
**--userns-uid-map** *mapping*
Directly specifies a UID mapping which should be used to set ownership, at the
filesystem level, on the working container's contents.
Commands run when handling `RUN` instructions will default to being run in
their own user namespaces, configured using the UID and GID maps.
Entries in this map take the form of one or more colon-separated triples of a starting
in-container UID, a corresponding starting host-level UID, and the number of
consecutive IDs which the map entry represents.
This option overrides the *remap-uids* setting in the *options* section of
/etc/containers/storage.conf.
If this option is not specified, but a global --userns-uid-map setting is
supplied, settings from the global option will be used.
If none of --userns-uid-map-user, --userns-gid-map-group, or --userns-uid-map
are specified, but --userns-gid-map is specified, the UID map will be set to
use the same numeric values as the GID map.
**--userns-gid-map** *mapping*
Directly specifies a GID mapping which should be used to set ownership, at the
filesystem level, on the working container's contents.
Commands run when handling `RUN` instructions will default to being run in
their own user namespaces, configured using the UID and GID maps.
Entries in this map take the form of one or more colon-separated triples of a starting
in-container GID, a corresponding starting host-level GID, and the number of
consecutive IDs which the map entry represents.
This option overrides the *remap-gids* setting in the *options* section of
/etc/containers/storage.conf.
If this option is not specified, but a global --userns-gid-map setting is
supplied, settings from the global option will be used.
If none of --userns-uid-map-user, --userns-gid-map-group, or --userns-gid-map
are specified, but --userns-uid-map is specified, the GID map will be set to
use the same numeric values as the UID map.
**--userns-uid-map-user** *user*
Specifies that a UID mapping which should be used to set ownership, at the
@ -550,6 +508,8 @@ If --userns-gid-map-group is specified, but --userns-uid-map-user is not
specified, `buildah` will assume that the specified group name is also a
suitable user name to use as the default setting for this option.
Users can specify the maps directly using `--userns-uid-map` described in the buildah(1) man page.
**--userns-gid-map-group** *group*
Specifies that a GID mapping which should be used to set ownership, at the
@ -561,6 +521,8 @@ If --userns-uid-map-user is specified, but --userns-gid-map-group is not
specified, `buildah` will assume that the specified user name is also a
suitable group name to use as the default setting for this option.
Users can specify the maps directly using `--userns-gid-map` described in the buildah(1) man page.
**--uts** *how*
Sets the configuration for UTS namespaces when the handling `RUN` instructions.

View File

@ -69,24 +69,46 @@ Storage driver option, Default storage driver options are configured in /etc/con
**--userns-uid-map** *mapping*
Specifies UID mappings which should be used to set ownership, at the
filesystem level, on the contents of images and containers.
Entries in this map take the form of one or more triples of a starting
Directly specifies a UID mapping which should be used to set ownership, at the
filesystem level, on the working container's contents.
Commands run when handling `RUN` instructions will default to being run in
their own user namespaces, configured using the UID and GID maps.
Entries in this map take the form of one or more colon-separated triples of a starting
in-container UID, a corresponding starting host-level UID, and the number of
consecutive IDs which the map entry represents.
This option overrides the *remap-uids* setting in the *options* section of
/etc/containers/storage.conf.
If this option is not specified, but a global --userns-uid-map setting is
supplied, settings from the global option will be used.
If none of --userns-uid-map-user, --userns-gid-map-group, or --userns-uid-map
are specified, but --userns-gid-map is specified, the UID map will be set to
use the same numeric values as the GID map.
**--userns-gid-map** *mapping*
Specifies GID mappings which should be used to set ownership, at the
filesystem level, on the contents of images and containers.
Entries in this map take the form of one or more triples of a starting
Directly specifies a GID mapping which should be used to set ownership, at the
filesystem level, on the working container's contents.
Commands run when handling `RUN` instructions will default to being run in
their own user namespaces, configured using the UID and GID maps.
Entries in this map take the form of one or more colon-separated triples of a starting
in-container GID, a corresponding starting host-level GID, and the number of
consecutive IDs which the map entry represents.
This option overrides the *remap-gids* setting in the *options* section of
/etc/containers/storage.conf.
If this option is not specified, but a global --userns-gid-map setting is
supplied, settings from the global option will be used.
If none of --userns-uid-map-user, --userns-gid-map-group, or --userns-gid-map
are specified, but --userns-uid-map is specified, the GID map will be set to
use the same numeric values as the UID map.
**--version, -v**
Print the version