diff options
| author | Ashley Cui <acui@redhat.com> | 2021-03-16 16:12:32 -0400 |
|---|---|---|
| committer | Ashley Cui <acui@redhat.com> | 2021-03-16 16:18:58 -0400 |
| commit | 3d01d42f26166cb9c5ae524cf80979d82a9f2ebd (patch) | |
| tree | 6cf7ce947a9d9a325f713038e672e18850e32bc9 /docs | |
| parent | 604459b404ed190f51e8b368c619323317078232 (diff) | |
| download | podman-3d01d42f26166cb9c5ae524cf80979d82a9f2ebd.tar.gz podman-3d01d42f26166cb9c5ae524cf80979d82a9f2ebd.tar.bz2 podman-3d01d42f26166cb9c5ae524cf80979d82a9f2ebd.zip | |
Docs: removing secrets is safe for in-use secrets
Add docs explaining that it is safe to remove a secret that is in use by
a container: secrets are copied and mounted into the container at
creation
Signed-off-by: Ashley Cui <acui@redhat.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/markdown/podman-create.1.md | 5 | ||||
| -rw-r--r-- | docs/source/markdown/podman-run.1.md | 5 | ||||
| -rw-r--r-- | docs/source/markdown/podman-secret-rm.1.md | 6 |
3 files changed, 16 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-create.1.md b/docs/source/markdown/podman-create.1.md index d6b90e17a..5c53f8601 100644 --- a/docs/source/markdown/podman-create.1.md +++ b/docs/source/markdown/podman-create.1.md @@ -833,6 +833,11 @@ 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). +Secrets are copied and mounted into the container when a container is created. If a secret is deleted using +`podman secret rm`, the container will still have access to the secret. If a secret is deleted and +another secret is created with the same name, the secret inside the container will not change; the old +secret value will still remain. + Secrets are managed using the `podman secret` command. #### **--security-opt**=*option* diff --git a/docs/source/markdown/podman-run.1.md b/docs/source/markdown/podman-run.1.md index 78b036cee..f61344099 100644 --- a/docs/source/markdown/podman-run.1.md +++ b/docs/source/markdown/podman-run.1.md @@ -885,6 +885,11 @@ 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). +Secrets are copied and mounted into the container when a container is created. If a secret is deleted using +`podman secret rm`, the container will still have access to the secret. If a secret is deleted and +another secret is created with the same name, the secret inside the container will not change; the old +secret value will still remain. + Secrets are managed using the `podman secret` command #### **--security-opt**=*option* diff --git a/docs/source/markdown/podman-secret-rm.1.md b/docs/source/markdown/podman-secret-rm.1.md index 5169626dc..c6f5079ba 100644 --- a/docs/source/markdown/podman-secret-rm.1.md +++ b/docs/source/markdown/podman-secret-rm.1.md @@ -10,6 +10,12 @@ podman\-secret\-rm - Remove one or more secrets Removes one or more secrets. +`podman secret rm` is safe to use on secrets that are in use by a container. +The created container will still have access to the secret data because secrets are +copied and mounted into the container when a container is created. If a secret is deleted and +another secret is created with the same name, the secret inside the container will not change; +the old secret value will still remain. + ## OPTIONS #### **--all**, **-a** |