1podman-search(1)() podman-search(1)()
2
3
4
6 podman-search - Search a registry for an image
7
8
10 podman search [options] term
11
12
14 podman search searches a registry or a list of registries for a match‐
15 ing image. The user can specify which registry to search by prefixing
16 the registry in the search term (e.g., registry.fedoraproject.org/fe‐
17 dora). By default, all unqualified-search registries in containers-
18 registries.conf(5) are used.
19
20
21 The default number of results is 25. The number of results can be lim‐
22 ited using the --limit flag. If more than one registry is being
23 searched, the limit will be applied to each registry. The output can be
24 filtered using the --filter flag. To get all available images in a reg‐
25 istry without a specific search term, the user can just enter the reg‐
26 istry name with a trailing "/" (example registry.fedoraproject.org/).
27
28
29 Note that podman search is not a reliable way to determine the presence
30 or existence of an image. The search behavior of the v1 and v2 Docker
31 distribution API is specific to the implementation of each registry.
32 Some registries may not support searching at all. Further note that
33 searching without a search term will only work for registries that im‐
34 plement the v2 API.
35
36
37 podman [GLOBAL OPTIONS]
38
39
40 podman search [GLOBAL OPTIONS]
41
42
43 podman search [OPTIONS] TERM
44
45
47 --authfile=path
48 Path of the authentication file. Default is ${XDG_RUNTIME_DIR}/contain‐
49 ers/auth.json
50
51
52 Note: You can also override the default path of the authentication file
53 by setting the REGISTRY_AUTH_FILE environment variable. export REG‐
54 ISTRY_AUTH_FILE=path
55
56
57 --filter, -f=filter
58 Filter output based on conditions provided (default [])
59
60
61 Supported filters are:
62
63
64 • stars (int - number of stars the image has)
65
66 • is-automated (boolean - true | false) - is the image automated
67 or not
68
69 • is-official (boolean - true | false) - is the image official
70 or not
71
72
73
74 --format=format
75 Change the output format to a Go template
76
77
78 Valid placeholders for the Go template are listed below:
79
80
81 ┌──────────────┬──────────────────────────────┐
82 │Placeholder │ Description │
83 ├──────────────┼──────────────────────────────┤
84 │.Index │ Registry │
85 ├──────────────┼──────────────────────────────┤
86 │.Name │ Image name │
87 ├──────────────┼──────────────────────────────┤
88 │.Descriptions │ Image description │
89 ├──────────────┼──────────────────────────────┤
90 │.Stars │ Star count of image │
91 ├──────────────┼──────────────────────────────┤
92 │.Official │ "[OK]" if image is official │
93 ├──────────────┼──────────────────────────────┤
94 │.Automated │ "[OK]" if image is automated │
95 ├──────────────┼──────────────────────────────┤
96 │.Tag │ Repository tag │
97 └──────────────┴──────────────────────────────┘
98
99 Note: use .Tag only if the --list-tags is set.
100
101
102 --limit=limit
103 Limit the number of results (default 25). Note: The results from each
104 registry will be limited to this value. Example if limit is 10 and two
105 registries are being searched, the total number of results will be 20,
106 10 from each (if there are at least 10 matches in each). The order of
107 the search results is the order in which the API endpoint returns the
108 results.
109
110
111 --list-tags
112 List the available tags in the repository for the specified image.
113 Note: --list-tags requires the search term to be a fully specified im‐
114 age name. The result contains the Image name and its tag, one line for
115 every tag associated with the image.
116
117
118 --no-trunc
119 Do not truncate the output
120
121
122 --tls-verify=true|false
123 Require HTTPS and verify certificates when contacting registries (de‐
124 fault: true). If explicitly set to true, then TLS verification will be
125 used. If set to false, then TLS verification will not be used if
126 needed. If not specified, default registries will be searched through
127 (in /etc/containers/registries.conf), and TLS will be skipped if a de‐
128 fault registry is listed in the insecure registries.
129
130
131 --help, -h
132 Print usage statement
133
134
136 $ podman search --limit 3 rhel
137 INDEX NAME DESCRIPTION STARS OFFICIAL AUTOMATED
138 docker.io docker.io/richxsl/rhel7 RHEL 7 image with minimal installation 9
139 docker.io docker.io/bluedata/rhel7 RHEL-7.x base container images 1
140 docker.io docker.io/gidikern/rhel-oracle-jre RHEL7 with jre8u60 5 [OK]
141 redhat.com redhat.com/rhel This platform image provides a minimal runti... 0
142 redhat.com redhat.com/rhel6 This platform image provides a minimal runti... 0
143 redhat.com redhat.com/rhel6.5 This platform image provides a minimal runti... 0
144
145
146
147 $ podman search alpine
148 INDEX NAME DESCRIPTION STARS OFFICIAL AUTOMATED
149 docker.io docker.io/library/alpine A minimal Docker image based on Alpine Linux... 3009 [OK]
150 docker.io docker.io/mhart/alpine-node Minimal Node.js built on Alpine Linux 332
151 docker.io docker.io/anapsix/alpine-java Oracle Java 8 (and 7) with GLIBC 2.23 over A... 272 [OK]
152 docker.io docker.io/tenstartups/alpine Alpine linux base docker image with useful p... 5 [OK]
153
154
155
156 $ podman search registry.fedoraproject.org/fedora
157 INDEX NAME DESCRIPTION STARS OFFICIAL AUTOMATED
158 fedoraproject.org fedoraproject.org/fedora 0
159 fedoraproject.org fedoraproject.org/fedora-minimal 0
160
161
162
163 $ podman search --filter=is-official alpine
164 INDEX NAME DESCRIPTION STARS OFFICIAL AUTOMATED
165 docker.io docker.io/library/alpine A minimal Docker image based on Alpine Linux... 3009 [OK]
166
167
168
169 $ podman search --format "table {{.Index}} {{.Name}}" registry.fedoraproject.org/fedora
170 INDEX NAME
171 fedoraproject.org fedoraproject.org/fedora
172 fedoraproject.org fedoraproject.org/fedora-minimal
173
174
175
176 $ podman search registry.fedoraproject.org/
177 INDEX NAME DESCRIPTION STARS OFFICIAL AUTOMATED
178 fedoraproject.org registry.fedoraproject.org/f25/cockpit 0
179 fedoraproject.org registry.fedoraproject.org/f25/container-engine 0
180 fedoraproject.org registry.fedoraproject.org/f25/docker 0
181 fedoraproject.org registry.fedoraproject.org/f25/etcd 0
182 fedoraproject.org registry.fedoraproject.org/f25/flannel 0
183 fedoraproject.org registry.fedoraproject.org/f25/httpd 0
184 fedoraproject.org registry.fedoraproject.org/f25/kubernetes-apiserver 0
185 fedoraproject.org registry.fedoraproject.org/f25/kubernetes-controller-manager 0
186 fedoraproject.org registry.fedoraproject.org/f25/kubernetes-kubelet 0
187 fedoraproject.org registry.fedoraproject.org/f25/kubernetes-master 0
188 fedoraproject.org registry.fedoraproject.org/f25/kubernetes-node 0
189 fedoraproject.org registry.fedoraproject.org/f25/kubernetes-proxy 0
190 fedoraproject.org registry.fedoraproject.org/f25/kubernetes-scheduler 0
191 fedoraproject.org registry.fedoraproject.org/f25/mariadb 0
192
193
194
195 $ podman search --list-tags registry.redhat.io/rhel
196 NAME TAG
197 registry.redhat.io/rhel 7.3-74
198 registry.redhat.io/rhel 7.6-301
199 registry.redhat.io/rhel 7.1-9
200
201
202
203 Note: This works only with registries that implement the v2 API. If
204 tried with a v1 registry an error will be returned.
205
206
208 registries.conf (/etc/containers/registries.conf)
209
210
211 registries.conf is the configuration file which specifies which con‐
212 tainer registries should be consulted when completing image names which
213 do not include a registry or domain portion.
214
215
217 podman(1), containers-registries.conf(5)
218
219
221 January 2018, Originally compiled by Urvashi Mohnani umohnani@red‐
222 hat.com ⟨mailto:umohnani@redhat.com⟩
223
224
225
226 podman-search(1)()