Document the mounts.conf file

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>

Closes: #521
Approved by: rhatdan
This commit is contained in:
Daniel J Walsh 2018-03-17 19:29:50 -04:00 committed by Atomic Bot
parent 604fdb0de1
commit 28a64ee68c
1 changed files with 23 additions and 5 deletions

View File

@ -26,7 +26,20 @@ Print debugging information
**--default-mounts-file**
Path to default mounts file (default path: "/usr/share/containers/mounts.conf")
Path to default mounts file (default path: "/usr/share/containers/mounts.conf"). Users can also create an additional conf file, `/etc/containers/mounts.conf`.
The mounts.conf files specify volume mount directories that are automatically mounted inside containers when executing the `buildah run` or `buildah build-using-dockerfile` commands. Container process can then use this content. The volume mount content does not get committed to the final image.
Usually these directories are used for passing secrets or credentials required by the package software to access remote package repositories.
For example, a mounts.conf with the line "`/usr/share/rhel/secrets:/run/secrets`", the content of `/usr/share/rhel/secrets` directory is mounted on `/run/secrets` inside the container. This mountpoint allows Red Hat Enterprise Linux subscriptions from the host to be used within the container.
The format of the mounts.conf is the volume format /SRC:/DEST, one mount per line.
Users can create an `/etc/containers/mounts.conf`, to specify their
own special volumes to mount in the container. Buildah by default reads /usr/share/containers/mounts.conf and the /etc/containers/mounts.conf
if it exists. Specifying the `--default-mounts-file` overrides both `default` mounts files.
Note this is not a volume mount. The content of the volumes is copied into container storage, not
bind mounted directly from the host.
**--help, -h**
@ -73,7 +86,7 @@ Storage driver option, Default Storage driver options are configured in /etc/con
Print the version
## SEE ALSO
## COMMANDS
| Command | Description |
| --------------------- | --------------------------------------------------- |
@ -93,6 +106,11 @@ Print the version
| buildah-tag(1) | Add an additional name to a local image. |
| buildah-umount(1) | Unmount a working container's root file system. |
| buildah-version(1) | Display the Buildah Version Information |
| storage.conf(5) | Syntax of Container Storage configuration file
|
| | |
| storage.conf(5) | Syntax of Container Storage configuration file |
## SEE ALSO
podman(1)
## HISTORY
December 2017, Originally compiled by Tom Sweeney <tsweeney@redhat.com>