Repository navigation
Expand file tree
/
Copy pathImageInspect.php
More file actions
636 lines (576 loc) · 19.5 KB
/
Copy pathImageInspect.php
File metadata and controls
636 lines (576 loc) · 19.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
<?php
declare(strict_types=1);
namespace Docker\API\Model;
use Docker\API\Runtime\AdditionalAndPatternProperties;
use Docker\API\Runtime\AdditionalPropertiesInterface;
class ImageInspect implements AdditionalPropertiesInterface
{
use AdditionalAndPatternProperties;
/**
* @var array
*/
protected $initialized = [];
public function isInitialized($property): bool
{
return \array_key_exists($property, $this->initialized);
}
/**
* ID is the content-addressable ID of an image.
*
* This identifier is a content-addressable digest calculated from the
* image's configuration (which includes the digests of layers used by
* the image).
*
* Note that this digest differs from the `RepoDigests` below, which
* holds digests of image manifests that reference the image.
*
* @var string|null
*/
protected $id;
/**
* A descriptor struct containing digest, media type, and size, as defined in
* the [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
*
* @var OCIDescriptor|null
*/
protected $descriptor;
/**
* Manifests is a list of image manifests available in this image. It
* provides a more detailed view of the platform-specific image manifests or
* other image-attached data like build attestations.
*
* Only available if the daemon provides a multi-platform image store
* and the `manifests` option is set in the inspect request.
*
* WARNING: This is experimental and may change at any time without any backward
* compatibility.
*
* @var list<ImageManifestSummary>|null
*/
protected $manifests;
/**
* Identity holds information about the identity and origin of the image.
* This is trusted information verified by the daemon and cannot be modified
* by tagging an image to a different name.
*
* @var Identity|null
*/
protected $identity;
/**
* List of image names/tags in the local image cache that reference this
* image.
*
* Multiple image tags can refer to the same image, and this list may be
* empty if no tags reference the image, in which case the image is
* "untagged", in which case it can still be referenced by its ID.
*
* @var list<string>|null
*/
protected $repoTags;
/**
* List of content-addressable digests of locally available image manifests
* that the image is referenced from. Multiple manifests can refer to the
* same image.
*
* These digests are usually only available if the image was either pulled
* from a registry, or if the image was pushed to a registry, which is when
* the manifest is generated and its digest calculated.
*
* @var list<string>|null
*/
protected $repoDigests;
/**
* Optional message that was set when committing or importing the image.
*
* @var string|null
*/
protected $comment;
/**
* Date and time at which the image was created, formatted in
* [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
*
* This information is only available if present in the image,
* and omitted otherwise.
*
* @var string|null
*/
protected $created;
/**
* Name of the author that was specified when committing the image, or as
* specified through MAINTAINER (deprecated) in the Dockerfile.
*
* @var string|null
*/
protected $author;
/**
* Configuration of the image. These fields are used as defaults
* when starting a container from the image.
*
* @var ImageConfig|null
*/
protected $config;
/**
* Hardware CPU architecture that the image runs on.
*
* @var string|null
*/
protected $architecture;
/**
* CPU architecture variant (presently ARM-only).
*
* @var string|null
*/
protected $variant;
/**
* Operating System the image is built to run on.
*
* @var string|null
*/
protected $os;
/**
* Operating System version the image is built to run on (especially
* for Windows).
*
* @var string|null
*/
protected $osVersion;
/**
* Total size of the image variant, including all layers it is composed of.
*
* For multi-platform images, this is the size of the platform variant
* selected by the `platform` query parameter. If no platform is specified,
* the daemon selects a platform as described in the `platform` parameter.
*
* When using the containerd image store, this includes both the image content
* that's present locally and the unpacked snapshot data for the selected
* variant.
*
* Image data may be shared between images, so this size does not indicate
* how much space would be reclaimed by deleting the image.
*
* @var int|null
*/
protected $size;
/**
* Information about the storage driver used to store the container's and
* image's filesystem.
*
* @var DriverData|null
*/
protected $graphDriver;
/**
* Information about the image's RootFS, including the layer IDs.
*
* @var ImageInspectRootFS|null
*/
protected $rootFS;
/**
* Additional metadata of the image in the local cache. This information
* is local to the daemon, and not part of the image itself.
*
* @var ImageInspectMetadata|null
*/
protected $metadata;
/**
* ID is the content-addressable ID of an image.
*
* This identifier is a content-addressable digest calculated from the
* image's configuration (which includes the digests of layers used by
* the image).
*
* Note that this digest differs from the `RepoDigests` below, which
* holds digests of image manifests that reference the image.
*/
public function getId(): ?string
{
return $this->id;
}
/**
* ID is the content-addressable ID of an image.
*
* This identifier is a content-addressable digest calculated from the
* image's configuration (which includes the digests of layers used by
* the image).
*
* Note that this digest differs from the `RepoDigests` below, which
* holds digests of image manifests that reference the image.
*/
public function setId(?string $id): self
{
$this->initialized['id'] = true;
$this->id = $id;
return $this;
}
/**
* A descriptor struct containing digest, media type, and size, as defined in
* the [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
*/
public function getDescriptor(): ?OCIDescriptor
{
return $this->descriptor;
}
/**
* A descriptor struct containing digest, media type, and size, as defined in
* the [OCI Content Descriptors Specification](https://github.com/opencontainers/image-spec/blob/v1.0.1/descriptor.md).
*/
public function setDescriptor(?OCIDescriptor $descriptor): self
{
$this->initialized['descriptor'] = true;
$this->descriptor = $descriptor;
return $this;
}
/**
* Manifests is a list of image manifests available in this image. It
* provides a more detailed view of the platform-specific image manifests or
* other image-attached data like build attestations.
*
* Only available if the daemon provides a multi-platform image store
* and the `manifests` option is set in the inspect request.
*
* WARNING: This is experimental and may change at any time without any backward
* compatibility.
*
* @return list<ImageManifestSummary>|null
*/
public function getManifests(): ?array
{
return $this->manifests;
}
/**
* Manifests is a list of image manifests available in this image. It
* provides a more detailed view of the platform-specific image manifests or
* other image-attached data like build attestations.
*
* Only available if the daemon provides a multi-platform image store
* and the `manifests` option is set in the inspect request.
*
* WARNING: This is experimental and may change at any time without any backward
* compatibility.
*
* @param list<ImageManifestSummary>|null $manifests
*/
public function setManifests(?array $manifests): self
{
$this->initialized['manifests'] = true;
$this->manifests = $manifests;
return $this;
}
/**
* Identity holds information about the identity and origin of the image.
* This is trusted information verified by the daemon and cannot be modified
* by tagging an image to a different name.
*/
public function getIdentity(): ?Identity
{
return $this->identity;
}
/**
* Identity holds information about the identity and origin of the image.
* This is trusted information verified by the daemon and cannot be modified
* by tagging an image to a different name.
*/
public function setIdentity(?Identity $identity): self
{
$this->initialized['identity'] = true;
$this->identity = $identity;
return $this;
}
/**
* List of image names/tags in the local image cache that reference this
* image.
*
* Multiple image tags can refer to the same image, and this list may be
* empty if no tags reference the image, in which case the image is
* "untagged", in which case it can still be referenced by its ID.
*
* @return list<string>|null
*/
public function getRepoTags(): ?array
{
return $this->repoTags;
}
/**
* List of image names/tags in the local image cache that reference this
* image.
*
* Multiple image tags can refer to the same image, and this list may be
* empty if no tags reference the image, in which case the image is
* "untagged", in which case it can still be referenced by its ID.
*
* @param list<string>|null $repoTags
*/
public function setRepoTags(?array $repoTags): self
{
$this->initialized['repoTags'] = true;
$this->repoTags = $repoTags;
return $this;
}
/**
* List of content-addressable digests of locally available image manifests
* that the image is referenced from. Multiple manifests can refer to the
* same image.
*
* These digests are usually only available if the image was either pulled
* from a registry, or if the image was pushed to a registry, which is when
* the manifest is generated and its digest calculated.
*
* @return list<string>|null
*/
public function getRepoDigests(): ?array
{
return $this->repoDigests;
}
/**
* List of content-addressable digests of locally available image manifests
* that the image is referenced from. Multiple manifests can refer to the
* same image.
*
* These digests are usually only available if the image was either pulled
* from a registry, or if the image was pushed to a registry, which is when
* the manifest is generated and its digest calculated.
*
* @param list<string>|null $repoDigests
*/
public function setRepoDigests(?array $repoDigests): self
{
$this->initialized['repoDigests'] = true;
$this->repoDigests = $repoDigests;
return $this;
}
/**
* Optional message that was set when committing or importing the image.
*/
public function getComment(): ?string
{
return $this->comment;
}
/**
* Optional message that was set when committing or importing the image.
*/
public function setComment(?string $comment): self
{
$this->initialized['comment'] = true;
$this->comment = $comment;
return $this;
}
/**
* Date and time at which the image was created, formatted in
* [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
*
* This information is only available if present in the image,
* and omitted otherwise.
*/
public function getCreated(): ?string
{
return $this->created;
}
/**
* Date and time at which the image was created, formatted in
* [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format with nano-seconds.
*
* This information is only available if present in the image,
* and omitted otherwise.
*/
public function setCreated(?string $created): self
{
$this->initialized['created'] = true;
$this->created = $created;
return $this;
}
/**
* Name of the author that was specified when committing the image, or as
* specified through MAINTAINER (deprecated) in the Dockerfile.
*/
public function getAuthor(): ?string
{
return $this->author;
}
/**
* Name of the author that was specified when committing the image, or as
* specified through MAINTAINER (deprecated) in the Dockerfile.
*/
public function setAuthor(?string $author): self
{
$this->initialized['author'] = true;
$this->author = $author;
return $this;
}
/**
* Configuration of the image. These fields are used as defaults
* when starting a container from the image.
*/
public function getConfig(): ?ImageConfig
{
return $this->config;
}
/**
* Configuration of the image. These fields are used as defaults
* when starting a container from the image.
*/
public function setConfig(?ImageConfig $config): self
{
$this->initialized['config'] = true;
$this->config = $config;
return $this;
}
/**
* Hardware CPU architecture that the image runs on.
*/
public function getArchitecture(): ?string
{
return $this->architecture;
}
/**
* Hardware CPU architecture that the image runs on.
*/
public function setArchitecture(?string $architecture): self
{
$this->initialized['architecture'] = true;
$this->architecture = $architecture;
return $this;
}
/**
* CPU architecture variant (presently ARM-only).
*/
public function getVariant(): ?string
{
return $this->variant;
}
/**
* CPU architecture variant (presently ARM-only).
*/
public function setVariant(?string $variant): self
{
$this->initialized['variant'] = true;
$this->variant = $variant;
return $this;
}
/**
* Operating System the image is built to run on.
*/
public function getOs(): ?string
{
return $this->os;
}
/**
* Operating System the image is built to run on.
*/
public function setOs(?string $os): self
{
$this->initialized['os'] = true;
$this->os = $os;
return $this;
}
/**
* Operating System version the image is built to run on (especially
* for Windows).
*/
public function getOsVersion(): ?string
{
return $this->osVersion;
}
/**
* Operating System version the image is built to run on (especially
* for Windows).
*/
public function setOsVersion(?string $osVersion): self
{
$this->initialized['osVersion'] = true;
$this->osVersion = $osVersion;
return $this;
}
/**
* Total size of the image variant, including all layers it is composed of.
*
* For multi-platform images, this is the size of the platform variant
* selected by the `platform` query parameter. If no platform is specified,
* the daemon selects a platform as described in the `platform` parameter.
*
* When using the containerd image store, this includes both the image content
* that's present locally and the unpacked snapshot data for the selected
* variant.
*
* Image data may be shared between images, so this size does not indicate
* how much space would be reclaimed by deleting the image.
*/
public function getSize(): ?int
{
return $this->size;
}
/**
* Total size of the image variant, including all layers it is composed of.
*
* For multi-platform images, this is the size of the platform variant
* selected by the `platform` query parameter. If no platform is specified,
* the daemon selects a platform as described in the `platform` parameter.
*
* When using the containerd image store, this includes both the image content
* that's present locally and the unpacked snapshot data for the selected
* variant.
*
* Image data may be shared between images, so this size does not indicate
* how much space would be reclaimed by deleting the image.
*/
public function setSize(?int $size): self
{
$this->initialized['size'] = true;
$this->size = $size;
return $this;
}
/**
* Information about the storage driver used to store the container's and
* image's filesystem.
*/
public function getGraphDriver(): ?DriverData
{
return $this->graphDriver;
}
/**
* Information about the storage driver used to store the container's and
* image's filesystem.
*/
public function setGraphDriver(?DriverData $graphDriver): self
{
$this->initialized['graphDriver'] = true;
$this->graphDriver = $graphDriver;
return $this;
}
/**
* Information about the image's RootFS, including the layer IDs.
*/
public function getRootFS(): ?ImageInspectRootFS
{
return $this->rootFS;
}
/**
* Information about the image's RootFS, including the layer IDs.
*/
public function setRootFS(?ImageInspectRootFS $rootFS): self
{
$this->initialized['rootFS'] = true;
$this->rootFS = $rootFS;
return $this;
}
/**
* Additional metadata of the image in the local cache. This information
* is local to the daemon, and not part of the image itself.
*/
public function getMetadata(): ?ImageInspectMetadata
{
return $this->metadata;
}
/**
* Additional metadata of the image in the local cache. This information
* is local to the daemon, and not part of the image itself.
*/
public function setMetadata(?ImageInspectMetadata $metadata): self
{
$this->initialized['metadata'] = true;
$this->metadata = $metadata;
return $this;
}
public function definedProperties(): array
{
return ['id' => ['Id', 'getId', 'setId'], 'descriptor' => ['Descriptor', 'getDescriptor', 'setDescriptor'], 'manifests' => ['Manifests', 'getManifests', 'setManifests'], 'identity' => ['Identity', 'getIdentity', 'setIdentity'], 'repoTags' => ['RepoTags', 'getRepoTags', 'setRepoTags'], 'repoDigests' => ['RepoDigests', 'getRepoDigests', 'setRepoDigests'], 'comment' => ['Comment', 'getComment', 'setComment'], 'created' => ['Created', 'getCreated', 'setCreated'], 'author' => ['Author', 'getAuthor', 'setAuthor'], 'config' => ['Config', 'getConfig', 'setConfig'], 'architecture' => ['Architecture', 'getArchitecture', 'setArchitecture'], 'variant' => ['Variant', 'getVariant', 'setVariant'], 'os' => ['Os', 'getOs', 'setOs'], 'osVersion' => ['OsVersion', 'getOsVersion', 'setOsVersion'], 'size' => ['Size', 'getSize', 'setSize'], 'graphDriver' => ['GraphDriver', 'getGraphDriver', 'setGraphDriver'], 'rootFS' => ['RootFS', 'getRootFS', 'setRootFS'], 'metadata' => ['Metadata', 'getMetadata', 'setMetadata']];
}
}