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