Skip to content

Commit 8e5ed09

Browse files
Merge pull request #26723 from shiavm006/docs-fix-kube-play-annotation-flag
docs(kube play): clarify --annotation flag only affects containers, not pods
2 parents 0389651 + 5ab92a7 commit 8e5ed09

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

cmd/podman/kube/play.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ func playFlags(cmd *cobra.Command) {
104104
flags.StringArrayVar(
105105
&playOptions.annotations,
106106
annotationFlagName, []string{},
107-
"Add annotations to pods (key=value)",
107+
"Add Podman-specific annotations to containers and pods created by Podman (key=value)",
108108
)
109109
_ = cmd.RegisterFlagCompletionFunc(annotationFlagName, completion.AutocompleteNone)
110110
credsFlagName := "creds"

docs/source/markdown/podman-kube-play.1.md.in

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,8 @@ An image can be automatically mounted into a container if the annotation `io.pod
201201

202202
@@option annotation.container
203203

204+
Note: For `podman kube play`, the `--annotation` flag adds Podman-specific annotations to the containers and pods created by Podman, not to the Kubernetes YAML itself. These annotations can be used to configure Podman-specific features like user namespaces (`io.podman.annotations.userns`), volumes-from (`io.podman.annotations.volumes-from`), and other container behaviors.
205+
204206
@@option authfile
205207

206208
#### **--build**

0 commit comments

Comments
 (0)