[CI:DOCS] podman search: clarify that results depend on implementation #10842
Conversation
Clarify in the man page that podman-search is not generally realiable way of determining the presence/existence of an image. The results of the v1 and the v2 endpoints depend on the implementation of each registry; the semantics are not really specified. Some registries may not support search at all as it's not part of the OCI dist spec. Fixes: https://bugzilla.redhat.com/show_bug.cgi?id=1978556 Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: vrothberg 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-ci
bot
added
the
approved
| Note, searching without a search term will only work for registries that implement the v2 API. | ||
|
|
||
| Note that **podman search** is not a reliable way to determine the presence or existence of an image. | ||
| The search behavior of the v1 and v2 Docker distribution API is specific to the implementation of each registry. |
There was a problem hiding this comment.
Nit Should distribution be capitalized?
@TomSweeneyRedHat PTAL
There was a problem hiding this comment.
I usually say docker/distribution, as in GitHub.com/docker/distribution.
Alternatively we could perhaps say “container registry API” (unlike that discussion in c/image/openshift, where we needed to make a specific distinction).
Or maybe focus not on the implementation reasons but on user-visible outcomes:
| The search behavior of the v1 and v2 Docker distribution API is specific to the implementation of each registry. | |
| The search behavior (interpretation of the search term, availability and order of results) is specific to the specific registry implementation. |
There was a problem hiding this comment.
Should we even mention specifics here? Just saying that "The behavior of search is dependent on the implementation of each registry" might be enough?
There was a problem hiding this comment.
This started with a user unhappy that the search syntax is undefined, so explicitly admitting that might at least give us something to point at.
|
/lgtm |
github-actions
bot
added
the
locked - please file new issue/PR
Clarify in the man page that podman-search is not generally realiable
way of determining the presence/existence of an image. The results of
the v1 and the v2 endpoints depend on the implementation of each
registry; the semantics are not really specified. Some registries may
not support search at all as it's not part of the OCI dist spec.
Fixes: https://bugzilla.redhat.com/show_bug.cgi?id=1978556
Signed-off-by: Valentin Rothberg rothberg@redhat.com
@mtrmac @rhatdan PTAL