1podman-search(1)()                                          podman-search(1)()
2
3
4

NAME

6       podman-search - Search a registry for an image
7
8

SYNOPSIS

10       podman search [options] term
11
12

DESCRIPTION

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

OPTIONS

39       --authfile=path
40
41
42       Path of the authentication file. Default is ${XDG_RUNTIME_DIR}/contain‐
43       ers/auth.json (Not available for remote commands)
44
45
46       Note: You can also override the default path of the authentication file
47       by  setting  the  REGISTRY_AUTH_FILE  environment variable. export REG‐
48       ISTRY_AUTH_FILE=path
49
50
51       --filter, -f=filter
52
53
54       Filter output based on conditions provided (default [])
55
56
57       Supported filters are:
58
59
60              · stars (int - number of stars the image has)
61
62              · is-automated (boolean - true | false) - is the image automated
63                or not
64
65              · is-official  (boolean  - true | false) - is the image official
66                or not
67
68
69
70       --format=format
71
72
73       Change the output format to a Go template
74
75
76       Valid placeholders for the Go template are listed below:
77
78
79       ┌──────────────┬──────────────────────────────┐
80Placeholder   Description                  
81       ├──────────────┼──────────────────────────────┤
82       │.Index        │ Registry                     │
83       ├──────────────┼──────────────────────────────┤
84       │.Name         │ Image name                   │
85       ├──────────────┼──────────────────────────────┤
86       │.Descriptions │ Image description            │
87       ├──────────────┼──────────────────────────────┤
88       │.Stars        │ Star count of image          │
89       ├──────────────┼──────────────────────────────┤
90       │.Official     │ "[OK]" if image is official  │
91       ├──────────────┼──────────────────────────────┤
92       │.Automated    │ "[OK]" if image is automated │
93       └──────────────┴──────────────────────────────┘
94
95       --limit=limit
96
97
98       Limit the number of results Note: The results from each  registry  will
99       be  limited  to  this value.  Example if limit is 10 and two registries
100       are being searched, the total number of results will  be  20,  10  from
101       each  (if  there  are  at  least 10 matches in each).  The order of the
102       search results is the order in  which  the  API  endpoint  returns  the
103       results.
104
105
106       --no-trunc
107
108
109       Do not truncate the output
110
111
112       --tls-verify=true|false
113
114
115       Require  HTTPS  and  verify  certificates  when  contacting  registries
116       (default: true). If explicitly set to true, then TLS verification  will
117       be  used.  If  set  to false, then TLS verification will not be used if
118       needed. If not specified, default registries will be  searched  through
119       (in  /etc/containers/registries.conf),  and  TLS  will  be skipped if a
120       default registry is listed in the insecure registries.  (Not  available
121       for remote commands)
122
123
124       --help, -h
125
126
127       Print usage statement
128
129

EXAMPLES

131              $ podman search --limit 3 rhel
132              INDEX        NAME                                 DESCRIPTION                                       STARS   OFFICIAL   AUTOMATED
133              docker.io    docker.io/richxsl/rhel7              RHEL 7 image with minimal installation            9
134              docker.io    docker.io/bluedata/rhel7             RHEL-7.x base container images                    1
135              docker.io    docker.io/gidikern/rhel-oracle-jre   RHEL7 with jre8u60                                5                  [OK]
136              redhat.com   redhat.com/rhel                      This platform image provides a minimal runti...   0
137              redhat.com   redhat.com/rhel6                     This platform image provides a minimal runti...   0
138              redhat.com   redhat.com/rhel6.5                   This platform image provides a minimal runti...   0
139
140
141
142              $ podman search alpine
143              INDEX       NAME                                             DESCRIPTION                                       STARS   OFFICIAL   AUTOMATED
144              docker.io   docker.io/library/alpine                         A minimal Docker image based on Alpine Linux...   3009    [OK]
145              docker.io   docker.io/mhart/alpine-node                      Minimal Node.js built on Alpine Linux             332
146              docker.io   docker.io/anapsix/alpine-java                    Oracle Java 8 (and 7) with GLIBC 2.23 over A...   272                [OK]
147              docker.io   docker.io/tenstartups/alpine                     Alpine linux base docker image with useful p...   5                  [OK]
148
149
150
151              $ podman search registry.fedoraproject.org/fedora
152              INDEX               NAME                               DESCRIPTION   STARS   OFFICIAL   AUTOMATED
153              fedoraproject.org   fedoraproject.org/fedora                         0
154              fedoraproject.org   fedoraproject.org/fedora-minimal                 0
155
156
157
158              $ podman search --filter=is-official alpine
159              INDEX       NAME                       DESCRIPTION                                       STARS   OFFICIAL   AUTOMATED
160              docker.io   docker.io/library/alpine   A minimal Docker image based on Alpine Linux...   3009    [OK]
161
162
163
164              $ podman search --format "table {{.Index}} {{.Name}}" registry.fedoraproject.org/fedora
165              INDEX               NAME
166              fedoraproject.org   fedoraproject.org/fedora
167              fedoraproject.org   fedoraproject.org/fedora-minimal
168
169
170
171              $ podman search registry.fedoraproject.org/
172              INDEX               NAME                                                           DESCRIPTION   STARS   OFFICIAL   AUTOMATED
173              fedoraproject.org   registry.fedoraproject.org/f25/cockpit                                       0
174              fedoraproject.org   registry.fedoraproject.org/f25/container-engine                              0
175              fedoraproject.org   registry.fedoraproject.org/f25/docker                                        0
176              fedoraproject.org   registry.fedoraproject.org/f25/etcd                                          0
177              fedoraproject.org   registry.fedoraproject.org/f25/flannel                                       0
178              fedoraproject.org   registry.fedoraproject.org/f25/httpd                                         0
179              fedoraproject.org   registry.fedoraproject.org/f25/kubernetes-apiserver                          0
180              fedoraproject.org   registry.fedoraproject.org/f25/kubernetes-controller-manager                 0
181              fedoraproject.org   registry.fedoraproject.org/f25/kubernetes-kubelet                            0
182              fedoraproject.org   registry.fedoraproject.org/f25/kubernetes-master                             0
183              fedoraproject.org   registry.fedoraproject.org/f25/kubernetes-node                               0
184              fedoraproject.org   registry.fedoraproject.org/f25/kubernetes-proxy                              0
185              fedoraproject.org   registry.fedoraproject.org/f25/kubernetes-scheduler                          0
186              fedoraproject.org   registry.fedoraproject.org/f25/mariadb                                       0
187
188
189
190       Note:  This  works  only  with registries that implement the v2 API. If
191       tried with a v1 registry an error will be returned.
192
193

FILES

195       registries.conf (/etc/containers/registries.conf)
196
197
198              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.
199
200
201

SEE ALSO

203       podman(1), containers-registries.conf(5)
204
205

HISTORY

207       January 2018, Originally  compiled  by  Urvashi  Mohnani  umohnani@red‐
208       hat.com ⟨mailto:umohnani@redhat.com⟩
209
210
211
212                                                            podman-search(1)()
Impressum