docs(kube play): clarify --annotation flag only affects containers, not pods #26723
Conversation
openshift-ci
bot
added
the
do-not-merge/release-note-label-needed
openshift-ci
bot
added
release-note
and removed
do-not-merge/release-note-label-needed
|
commit message should contain |
That shouldn't be the case anymore. @Luap99 correct me if i'm wrong. |
Yes it has no effect on CI, we have to use the label |
| @@ -5,3 +5,5 @@ | |||
| #### **--annotation**=*key=value* | |||
|
|
|||
| Add an annotation to the container<<| or pod>>. This option can be set multiple times. | |||
|
|
|||
| For `podman kube play`, this 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, volumes-from, and other container behaviors. | |||
There was a problem hiding this comment.
We should not add this to the general options description as this will also be shows for podman run/create.
The chnage you did in podman-kube-play.1.md.in should be sufficient I would say
There was a problem hiding this comment.
updated and u were right its create confusion and is incorrect
…ot pods Signed-off-by: shiavm006 <[email protected]>
shiavm006
force-pushed
the
docs-fix-kube-play-annotation-flag
branch
from
5ddd864 to
5ab92a7
Compare
openshift-ci
bot
added
the
approved
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: lsm5, Luap99, shiavm006 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
openshift-merge-bot
bot
merged commit 8e5ed09
into
containers:main
This PR updates the documentation and help text for the
--annotationflag inpodman kube play:Makes it clear that the flag only adds Podman-specific annotations to containers in the created pods, not to the Kubernetes Pod object. Notes that the infra container does not receive the annotation. Addresses confusion reported in #26450 and related discussions.
No code behavior is changed; this is a documentation and UX clarification only.
fixes : #26448