summaryrefslogtreecommitdiff
path: root/docs/source/markdown/options/name.container.md
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2022-09-01 23:41:53 +0200
committerGitHub <noreply@github.com>2022-09-01 23:41:53 +0200
commit475cac4432a72052a000e9be91cd721d03e01eb8 (patch)
tree9609877167e03e29a8be9d09e605ba970d0cacd7 /docs/source/markdown/options/name.container.md
parentd0d1af338a500f2ad00d5ce0638901465602817d (diff)
parentc63830166c31e7760f5bf4120cd774dda6683c60 (diff)
downloadpodman-475cac4432a72052a000e9be91cd721d03e01eb8.tar.gz
podman-475cac4432a72052a000e9be91cd721d03e01eb8.tar.bz2
podman-475cac4432a72052a000e9be91cd721d03e01eb8.zip
Merge pull request #15601 from edsantiago/docs_dedup_name
[CI:DOCS] Man pages: refactor common options: --name
Diffstat (limited to 'docs/source/markdown/options/name.container.md')
-rw-r--r--docs/source/markdown/options/name.container.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/source/markdown/options/name.container.md b/docs/source/markdown/options/name.container.md
new file mode 100644
index 000000000..0c3df6ef1
--- /dev/null
+++ b/docs/source/markdown/options/name.container.md
@@ -0,0 +1,14 @@
+#### **--name**=*name*
+
+Assign a name to the container.
+
+The operator can identify a container in three ways:
+
+- UUID long identifier (“f78375b1c487e03c9438c729345e54db9d20cfa2ac1fc3494b6eb60872e74778”);
+- UUID short identifier (“f78375b1c487”);
+- Name (“jonah”).
+
+Podman generates a UUID for each container, and if a name is not assigned
+to the container with **--name** then it will generate a random
+string name. The name is useful any place you need to identify a container.
+This works for both background and foreground containers.