1ATOMIC(1)                          July 2015                         ATOMIC(1)
2
3
4

NAME

6       atomic-images - operations on container images
7
8
9

SYNOPSIS

11       atomic images COMMAND [OPTIONS] [IMAGES...]
12
13
14       atomic images allows the user to view and operate on container images
15       in a docker registry.
16
17
18

COMMANDS

20       delete
21
22
23       Delete the specified container image(s). If you use the --remote option
24       remote disk space will not be freed until the registry
25       garbage-collection command is invoked for the remote registry.
26
27
28       generate
29         Generates a gomtree validation manifest for all images. Gomtree is
30       required for this feature to be available.
31
32
33       help
34
35
36       Displays a help file associated with a container or image.
37
38
39       If a container or image has a help file (in man format) embedded in
40       itself, atomic help will display the help file in a pager similar to
41       man.  The default location for a help file is /image_help.1 but the
42       location of the help can be overridden with the HELP LABEL.  If you
43       choose to override the default location, ensure the path provided is a
44       fully-qualified path that includes the help file itself.
45
46
47       The help file can be written using the middleman markup and the
48       converted using the go-md2man utility as follows:
49
50
51              go-md2man -in image_help.1.md -out image_help.1
52
53
54
55       You can also use any of the many options to create the help file
56       including using native man tagging.
57
58
59       info
60
61
62       Displays the LABEL fields within an image. By default, it will check
63       first for a local image and then all configured registries.
64
65
66       For a system container image, this will also display the environment
67       variables a user can set.
68
69
70       list
71
72
73       List all installed container images on your system.
74
75
76       A  > preceding the image name indicates that the image is used by a
77       container.
78
79
80       A * in the first column indicates a dangling image. Dangling images are
81       images with no name/tag and which are not used by any other images.
82       Since they are not used, they waste system space.  Dangling images can
83       be caused by using 'docker build' to update an image without removing
84       the older version of the image.
85
86
87       prune
88
89
90       Prune/delete all dangling images, freeing wasted disk space.
91
92
93       tag
94
95
96       Tag locally the image with a different name.  The source image won't be
97       modified.
98
99
100       update
101
102
103       Pulls the latest update of the image from the repository. If a
104       container based on this image exists, the container will continue to
105       use the old image. Use --force to remove the container.
106
107
108       verify
109
110
111       Checks whether there is a newer image available.   If the image
112       differs, it will capture any of its relevant information like version
113       (where applicable).
114         Verify will always attempt to use the Version and Release labels to
115       determine if there is a newer version.  If that information is not
116         available, then for 'ostree' images, verify will compare using the
117       manifest digests.  In the case of docker images, it will use the
118       image's ID
119         for comparison.
120
121
122       version
123
124
125       Display image 'Id Name:Version:Release RepoTag' label
126
127
128

delete OPTIONS

130       [-h|--help]
131         Print usage statement
132
133
134       [-f|--force]
135         Force the deletion of specified local images, even if they are in
136       use.
137
138
139       [--remote]
140         Delete images in remote registry.  --force is not supported with this
141       option.
142
143
144       [--storage=[ostree|docker]]
145         Optionally specify the storage from which to delete the image from.
146       Will prompt user to specify if the same image name exists in both
147       ostree and docker, and the user did not specify.
148
149
150

Note:

152       Atomic --assumeyes option can be used
153
154
155       [-y|--assumeyes]
156         Delete image(s) without conformation from the user
157
158
159

info OPTIONS

161       [-h|--help]
162         Print usage statement
163
164
165       [--remote]
166         Ignore all local images, only search configured registries.
167
168
169       [--storage=[ostree|docker]]
170         Optionally specify the storage of the image. Will prompt user to
171       specify if the same image name exists in both ostree and docker, and
172       the user did not specify.
173
174
175

list OPTIONS

177       [-h|--help]
178         Print usage statement
179
180
181       [-a|--all]
182         Show all images, including intermediate images
183
184
185       [-f|--filter]
186         Filter output based on given filters, example usage: '--filter
187       repo=foo' will list all images that has "foo" as part of their
188       repository name.
189
190
191       Filterables: created, id, image, is_dangling, repo, size, tag, type
192
193
194       [-n|--noheading]
195         Do not print heading when listing the images
196
197
198       [--no-trunc]
199         Do not truncate output
200
201
202       [-q|--quiet]
203         Only display image IDs
204
205
206       [--json]
207         Output in the form of JSON.
208
209
210

update OPTIONS

212       [-f|--force]
213         Remove all containers based on this image
214
215
216       [-h|--help]
217         Print usage statement
218
219
220       [-a|--all]
221         Update all the images in a storage.
222
223
224       [--storage=[ostree|docker]]
225         Optionally specify the storage of the image. Defaults to docker.
226
227
228

verify OPTIONS

230       [-h|--help]
231         Print usage statement
232
233
234       [--no-validate]
235         Skip validation of the files contained inside the image.
236
237
238       [--storage=[ostree|docker]]
239         Optionally specify the storage of the image. Will prompt user to
240       specify if the same image name exists in both ostree and docker, and
241       the user did not specify.
242
243
244       [-v|--verbose]
245          Will output the status of each base image that makes up the image
246       being verified.
247
248
249       [-a|--all]
250          Will verify all images in a storage.
251
252
253

version OPTIONS

255       [-h|--help]
256         Print usage statement
257
258
259       [-r|--recurse]
260         Recurse through all layers of the specified image.
261
262
263       [--storage=[ostree|docker]]
264         Optionally specify the storage of the image. Will prompt user to
265       specify if the same image name exists in both ostree and docker, and
266       the user did not specify.
267
268
269

EXAMPLES

271       Verify the Red Hat rsyslog image
272
273
274              # atomic images verify registry.access.redhat.com/rhel7/rsyslog
275              #
276
277
278
279       Verify the Red Hat rsyslog image and show status of each image layer
280
281
282              # atomic images verify -v registry.access.redhat.com/rhel7/rsyslog
283              registry.access.redhat.com/rhel7/rsyslog contains the following images:
284
285               rhel7/rsyslog-7.1-29           rhel7/rsyslog-7.1-29
286               redhat/rhel7-7.1-24            redhat/rhel7-7.1-24
287
288               * = version difference
289
290
291
292       Verify a system image
293
294
295              # sudo atomic images verify busybox
296              validation output for layer a3ed95caeb02ffe68cdd9fd84406680ae93d633cb16422d00e8a7c22955b46d4:
297
298              (no changes detected)
299
300              validation output for layer 8ddc19f16526912237dd8af81971d5e4dd0587907234be2b83e249518d5b673f:
301
302              "etc/shadow": keyword "size": expected 243; got 268
303              "etc/shadow": keyword "sha256digest": expected 22d9cee21ee808c52af44ac...; got 7a07ac69054c2a3533569874c2...
304
305
306
307

HISTORY

309       July 2015, Originally compiled by Daniel Walsh (dwalsh at redhat dot
310       com) July 2016, Updated to reflect images sub-command changes (jhonce
311       at redhat dot com) July 2016, Added sub-commands all, filter and quiet
312       to list (jerzhang at redhat dot com)
313
314
315
316Dan Walsh                       Atomic Man Pages                     ATOMIC(1)
Impressum