9622d25be9
Somehow the options/secret.md file generated corrupt md which then generated corrupt .man files. Fix, and add a Makefile check to prevent this from happening again. Signed-off-by: Ed Santiago <santiago@redhat.com>
2.4 KiB
####> This option file is used in: ####> podman create, run ####> If file is edited, make sure the changes ####> are applicable to all of those.
--secret=secret[,opt=opt ...]
Give the container access to a secret. Can be specified multiple times.
A secret is a blob of sensitive data which a container needs at runtime but should not be stored in the image or in source control, such as usernames and passwords, TLS certificates and keys, SSH keys or other important generic strings or binary content (up to 500 kb in size).
When secrets are specified as type mount, the secrets are copied and mounted into the container when a container is created.
When secrets are specified as type env, the secret will be set as an environment variable within the container.
Secrets are written in the container at the time of container creation, and modifying the secret using podman secret commands
after the container is created will not affect the secret inside the container.
Secrets and its storage are managed using the podman secret command.
Secret Options
type=mount|env: How the secret will be exposed to the container.mountmounts the secret into the container as a file.envexposes the secret as a environment variable. Defaults tomount.target=target: Target of secret. For mounted secrets, this is the path to the secret inside the container. If a fully qualified path is provided, the secret will be mounted at that location. Otherwise, the secret will be mounted to/run/secrets/target. If target is not set, by default the secret will be mounted to/run/secrets/secretname. For env secrets, this is the environment variable key. Defaults tosecretname.uid=0: UID of secret. Defaults to 0. Mount secret type only.gid=0: GID of secret. Defaults to 0. Mount secret type only.mode=0: Mode of secret. Defaults to 0444. Mount secret type only.
Examples
Mount at /my/location/mysecret with UID 1:
--secret mysecret,target=/my/location/mysecret,uid=1
Mount at /run/secrets/customtarget with mode 0777:
--secret mysecret,target=customtarget,mode=0777
Create a secret environment variable called ENVSEC:
--secret mysecret,type=env,target=ENVSEC