1podman-search(1) General Commands Manual podman-search(1)
2
6 podman-search - Search a registry for an image
7
10 podman search [options] term
11
14 podman search searches a registry or a list of registries for a
15 matching image. The user can specify which registry to search by
16 prefixing the registry in the search term (example
17 registry.fedoraproject.org/fedora), default is the registries in the
18 registries.search table in the config file -
19 /etc/containers/registries.conf. 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 podman [GLOBAL OPTIONS]
30 podman search [GLOBAL OPTIONS]
33 podman search [OPTIONS] TERM
36
39 --authfile
40 Path of the authentication file. Default is
43 ${XDG_\RUNTIME_DIR}/containers/auth.json (Not available for remote
44 commands)
45 Note: You can also override the default path of the authentication file
48 by setting the REGISTRY_AUTH_FILE environment variable. export
49 REGISTRY_AUTH_FILE=path
50 --filter, -f
53 Filter output based on conditions provided (default [])
56 Supported filters are:
59 · stars (int - number of stars the image has)
62 · is-automated (boolean - true | false) - is the image automated
64 or not
65 · is-official (boolean - true | false) - is the image official
67 or not
68 --format
72 Change the output format to a Go template
75 Valid placeholders for the Go template are listed below:
78 ┌──────────────┬──────────────────────────────┐
81 │Placeholder │ Description │
82 ├──────────────┼──────────────────────────────┤
83 │.Index │ Registry │
84 ├──────────────┼──────────────────────────────┤
85 │.Name │ Image name │
86 ├──────────────┼──────────────────────────────┤
87 │.Descriptions │ Image description │
88 ├──────────────┼──────────────────────────────┤
89 │.Stars │ Star count of image │
90 ├──────────────┼──────────────────────────────┤
91 │.Official │ "[OK]" if image is official │
92 ├──────────────┼──────────────────────────────┤
93 │.Automated │ "[OK]" if image is automated │
94 └──────────────┴──────────────────────────────┘
95 --limit
97 Limit the number of results Note: The results from each registry will
100 be limited to this value. Example if limit is 10 and two registries
101 are being searched, the total number of results will be 20, 10 from
102 each (if there are at least 10 matches in each). The order of the
103 search results is the order in which the API endpoint returns the
104 results.
105 --no-trunc
108 Do not truncate the output
111 --tls-verify
114 Require HTTPS and verify certificates when contacting registries
117 (default: true). If explicitly set to true, then TLS verification will
118 be used. If set to false, then TLS verification will not be used if
119 needed. If not specified, default registries will be searched through
120 (in /etc/containers/registries.conf), and TLS will be skipped if a
121 default registry is listed in the insecure registries. (Not available
122 for remote commands)
123 --help, -h
126 Print usage statement
129
132 $ podman search --limit 3 rhel
133 INDEX NAME DESCRIPTION STARS OFFICIAL AUTOMATED
134 docker.io docker.io/richxsl/rhel7 RHEL 7 image with minimal installation 9
135 docker.io docker.io/bluedata/rhel7 RHEL-7.x base container images 1
136 docker.io docker.io/gidikern/rhel-oracle-jre RHEL7 with jre8u60 5 [OK]
137 redhat.com redhat.com/rhel This platform image provides a minimal runti... 0
138 redhat.com redhat.com/rhel6 This platform image provides a minimal runti... 0
139 redhat.com redhat.com/rhel6.5 This platform image provides a minimal runti... 0
140 $ podman search alpine
144 INDEX NAME DESCRIPTION STARS OFFICIAL AUTOMATED
145 docker.io docker.io/library/alpine A minimal Docker image based on Alpine Linux... 3009 [OK]
146 docker.io docker.io/mhart/alpine-node Minimal Node.js built on Alpine Linux 332
147 docker.io docker.io/anapsix/alpine-java Oracle Java 8 (and 7) with GLIBC 2.23 over A... 272 [OK]
148 docker.io docker.io/tenstartups/alpine Alpine linux base docker image with useful p... 5 [OK]
149 $ podman search registry.fedoraproject.org/fedora
153 INDEX NAME DESCRIPTION STARS OFFICIAL AUTOMATED
154 fedoraproject.org fedoraproject.org/fedora 0
155 fedoraproject.org fedoraproject.org/fedora-minimal 0
156 $ podman search --filter=is-official alpine
160 INDEX NAME DESCRIPTION STARS OFFICIAL AUTOMATED
161 docker.io docker.io/library/alpine A minimal Docker image based on Alpine Linux... 3009 [OK]
162 $ podman search --format "table {{.Index}} {{.Name}}" registry.fedoraproject.org/fedora
166 INDEX NAME
167 fedoraproject.org fedoraproject.org/fedora
168 fedoraproject.org fedoraproject.org/fedora-minimal
169 $ podman search registry.fedoraproject.org/
173 INDEX NAME DESCRIPTION STARS OFFICIAL AUTOMATED
174 fedoraproject.org registry.fedoraproject.org/f25/cockpit 0
175 fedoraproject.org registry.fedoraproject.org/f25/container-engine 0
176 fedoraproject.org registry.fedoraproject.org/f25/docker 0
177 fedoraproject.org registry.fedoraproject.org/f25/etcd 0
178 fedoraproject.org registry.fedoraproject.org/f25/flannel 0
179 fedoraproject.org registry.fedoraproject.org/f25/httpd 0
180 fedoraproject.org registry.fedoraproject.org/f25/kubernetes-apiserver 0
181 fedoraproject.org registry.fedoraproject.org/f25/kubernetes-controller-manager 0
182 fedoraproject.org registry.fedoraproject.org/f25/kubernetes-kubelet 0
183 fedoraproject.org registry.fedoraproject.org/f25/kubernetes-master 0
184 fedoraproject.org registry.fedoraproject.org/f25/kubernetes-node 0
185 fedoraproject.org registry.fedoraproject.org/f25/kubernetes-proxy 0
186 fedoraproject.org registry.fedoraproject.org/f25/kubernetes-scheduler 0
187 fedoraproject.org registry.fedoraproject.org/f25/mariadb 0
188 Note: This works only with registries that implement the v2 API. If
192 tried with a v1 registry an error will be returned.
193
196 registries.conf (/etc/containers/registries.conf)
197 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.
200
204 podman(1), containers-registries.conf(5)
205
208 January 2018, Originally compiled by Urvashi Mohnani
209 ⟨umohnani@redhat.com⟩
210 podman-search(1)