-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathswagger-latest.yaml
18485 lines (18369 loc) · 714 KB
/
swagger-latest.yaml
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
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
basePath: /
consumes:
- application/json
- application/x-tar
definitions:
AccessMode:
properties:
BlockVolume:
$ref: '#/definitions/TypeBlock'
MountVolume:
$ref: '#/definitions/TypeMount'
Scope:
$ref: '#/definitions/Scope'
Sharing:
$ref: '#/definitions/SharingMode'
title: AccessMode defines the access mode of a volume.
type: object
x-go-package: github.com/docker/docker/api/types/volume
Address:
properties:
Addr:
type: string
PrefixLength:
format: int64
type: integer
title: Address represents an IP address.
type: object
x-go-package: github.com/containers/podman/v5/libpod/define
AttestationProperties:
properties:
For:
$ref: '#/definitions/Digest'
type: object
x-go-package: github.com/docker/docker/api/types/image
AuthConfig:
description: AuthConfig contains authorization information for connecting to a Registry
properties:
auth:
type: string
x-go-name: Auth
email:
description: |-
Email is an optional value associated with the username.
This field is deprecated and will be removed in a later
version of docker.
type: string
x-go-name: Email
identitytoken:
description: |-
IdentityToken is used to authenticate the user and get
an access token for the registry.
type: string
x-go-name: IdentityToken
password:
type: string
x-go-name: Password
registrytoken:
description: RegistryToken is a bearer token to be sent to a registry
type: string
x-go-name: RegistryToken
serveraddress:
type: string
x-go-name: ServerAddress
username:
type: string
x-go-name: Username
type: object
x-go-package: github.com/containers/podman/v5/pkg/domain/entities/types
AuthReport:
description: AuthReport describes the response for authentication check
properties:
IdentityToken:
type: string
Status:
type: string
type: object
x-go-package: github.com/containers/podman/v5/pkg/domain/entities/types
AuthenticateOKBody:
description: AuthenticateOKBody authenticate o k body
properties:
IdentityToken:
description: An opaque token used to authenticate a user after a successful login
type: string
Status:
description: The status of the authentication
type: string
required:
- IdentityToken
- Status
type: object
x-go-package: github.com/docker/docker/api/types/registry
AutoUserNsOptions:
properties:
AdditionalGIDMappings:
description: |-
AdditionalGIDMappings specified additional GID mappings to include in
the generated user namespace.
items:
$ref: '#/definitions/IDMap'
type: array
AdditionalUIDMappings:
description: |-
AdditionalUIDMappings specified additional UID mappings to include in
the generated user namespace.
items:
$ref: '#/definitions/IDMap'
type: array
GroupFile:
description: GroupFile to use if the container uses a volume.
type: string
InitialSize:
description: |-
InitialSize defines the minimum size for the user namespace.
The created user namespace will have at least this size.
format: uint32
type: integer
PasswdFile:
description: PasswdFile to use if the container uses a volume.
type: string
Size:
description: |-
Size defines the size for the user namespace. If it is set to a
value bigger than 0, the user namespace will have exactly this size.
If it is not set, some heuristics will be used to find its size.
format: uint32
type: integer
title: AutoUserNsOptions defines how to automatically create a user namespace.
type: object
x-go-package: github.com/containers/storage/types
Availability:
title: Availability specifies the availability of the volume.
type: string
x-go-package: github.com/docker/docker/api/types/volume
BindOptions:
properties:
CreateMountpoint:
type: boolean
NonRecursive:
type: boolean
Propagation:
$ref: '#/definitions/Propagation'
ReadOnlyForceRecursive:
description: ReadOnlyForceRecursive raises an error if the mount cannot be made recursively read-only.
type: boolean
ReadOnlyNonRecursive:
description: |-
ReadOnlyNonRecursive makes the mount non-recursively read-only, but still leaves the mount recursive
(unless NonRecursive is set to true in conjunction).
type: boolean
title: BindOptions defines options specific to mounts of type "bind".
type: object
x-go-package: github.com/docker/docker/api/types/mount
CPUUsage:
properties:
idlePercent:
format: double
type: number
x-go-name: IdlePercent
systemPercent:
format: double
type: number
x-go-name: SystemPercent
userPercent:
format: double
type: number
x-go-name: UserPercent
type: object
x-go-package: github.com/containers/podman/v5/libpod/define
CapacityRange:
description: |-
CapacityRange describes the minimum and maximum capacity a volume should be
created with
properties:
LimitBytes:
description: |-
LimitBytes specifies that a volume must not be bigger than this. The
value of 0 indicates an unspecified maximum
format: int64
type: integer
RequiredBytes:
description: |-
RequiredBytes specifies that a volume must be at least this big. The
value of 0 indicates an unspecified minimum.
format: int64
type: integer
type: object
x-go-package: github.com/docker/docker/api/types/volume
CgroupSpec:
title: CgroupSpec represents the cgroup to use for the container.
type: string
x-go-package: github.com/docker/docker/api/types/container
CgroupnsMode:
description: CgroupnsMode represents the cgroup namespace mode of the container
type: string
x-go-package: github.com/docker/docker/api/types/container
ChangeType:
description: |-
Can be one of:
`0`: Modified ("C")
`1`: Added ("A")
`2`: Deleted ("D")
format: uint8
title: ChangeType Kind of change
type: integer
x-go-package: github.com/docker/docker/api/types/container
ClusterOptions:
title: ClusterOptions specifies options for a Cluster volume.
type: object
x-go-package: github.com/docker/docker/api/types/mount
ClusterVolume:
description: |-
ClusterVolume contains options and information specific to, and only present
on, Swarm CSI cluster volumes.
properties:
CreatedAt:
format: date-time
type: string
ID:
description: |-
ID is the Swarm ID of the volume. Because cluster volumes are Swarm
objects, they have an ID, unlike non-cluster volumes, which only have a
Name. This ID can be used to refer to the cluster volume.
type: string
Info:
$ref: '#/definitions/Info'
PublishStatus:
description: |-
PublishStatus contains the status of the volume as it pertains to its
publishing on Nodes.
items:
$ref: '#/definitions/PublishStatus'
type: array
Spec:
$ref: '#/definitions/ClusterVolumeSpec'
UpdatedAt:
format: date-time
type: string
Version:
$ref: '#/definitions/Version'
type: object
x-go-package: github.com/docker/docker/api/types/volume
ClusterVolumeSpec:
properties:
AccessMode:
$ref: '#/definitions/AccessMode'
AccessibilityRequirements:
$ref: '#/definitions/TopologyRequirement'
Availability:
$ref: '#/definitions/Availability'
CapacityRange:
$ref: '#/definitions/CapacityRange'
Group:
description: |-
Group defines the volume group of this volume. Volumes belonging to the
same group can be referred to by group name when creating Services.
Referring to a volume by group instructs swarm to treat volumes in that
group interchangeably for the purpose of scheduling. Volumes with an
empty string for a group technically all belong to the same, emptystring
group.
type: string
Secrets:
description: |-
Secrets defines Swarm Secrets that are passed to the CSI storage plugin
when operating on this volume.
items:
$ref: '#/definitions/Secret'
type: array
title: ClusterVolumeSpec contains the spec used to create this volume.
type: object
x-go-package: github.com/docker/docker/api/types/volume
ComponentVersion:
properties:
Details:
additionalProperties:
type: string
type: object
Name:
type: string
Version:
type: string
title: ComponentVersion describes the version information for a specific component.
type: object
x-go-package: github.com/containers/podman/v5/pkg/domain/entities/types
Config:
description: |-
It should hold only portable information about the container.
Here, "portable" means "independent from the host we are running on".
Non-portable information *should* appear in HostConfig.
All fields added to this struct must be marked `omitempty` to keep getting
predictable hashes from the old `v1Compatibility` configuration.
properties:
ArgsEscaped:
type: boolean
AttachStderr:
type: boolean
AttachStdin:
type: boolean
AttachStdout:
type: boolean
Cmd:
$ref: '#/definitions/StrSlice'
Domainname:
type: string
Entrypoint:
$ref: '#/definitions/StrSlice'
Env:
items:
type: string
type: array
ExposedPorts:
$ref: '#/definitions/PortSet'
Healthcheck:
$ref: '#/definitions/HealthcheckConfig'
Hostname:
type: string
Image:
type: string
Labels:
additionalProperties:
type: string
type: object
MacAddress:
description: |-
Mac Address of the container.
Deprecated: this field is deprecated since API v1.44. Use EndpointSettings.MacAddress instead.
type: string
NetworkDisabled:
type: boolean
OnBuild:
items:
type: string
type: array
OpenStdin:
type: boolean
Shell:
$ref: '#/definitions/StrSlice'
StdinOnce:
type: boolean
StopSignal:
type: string
StopTimeout:
format: int64
type: integer
Tty:
type: boolean
User:
type: string
Volumes:
additionalProperties:
type: object
type: object
WorkingDir:
type: string
title: Config contains the configuration data about a container.
type: object
x-go-package: github.com/docker/docker/api/types/container
ConfigReference:
description: ConfigReference specifies the source which provides a network's configuration
properties:
Network:
type: string
type: object
x-go-package: github.com/docker/docker/api/types/network
ConmonInfo:
description: ConmonInfo describes the conmon executable being used
properties:
package:
type: string
x-go-name: Package
path:
type: string
x-go-name: Path
version:
type: string
x-go-name: Version
type: object
x-go-package: github.com/containers/podman/v5/libpod/define
ConnectOptions:
description: |-
ConnectOptions represents the data to be used to connect a container to the
network.
properties:
Container:
type: string
EndpointConfig:
$ref: '#/definitions/EndpointSettings'
type: object
x-go-package: github.com/docker/docker/api/types/network
Consistency:
title: Consistency represents the consistency requirements of a mount.
type: string
x-go-package: github.com/docker/docker/api/types/mount
Container:
properties:
Command:
type: string
Config:
$ref: '#/definitions/Config'
Created:
format: int64
type: integer
DefaultReadOnlyNonRecursive:
type: boolean
HostConfig:
$ref: '#/definitions/HostConfig'
type: object
Id:
type: string
x-go-name: ID
Image:
type: string
ImageID:
type: string
Labels:
additionalProperties:
type: string
type: object
Mounts:
items:
$ref: '#/definitions/MountPoint'
type: array
Name:
type: string
Names:
items:
type: string
type: array
NetworkSettings:
$ref: '#/definitions/SummaryNetworkSettings'
NetworkingConfig:
$ref: '#/definitions/NetworkingConfig'
Platform:
$ref: '#/definitions/Platform'
Ports:
items:
$ref: '#/definitions/Port'
type: array
SizeRootFs:
format: int64
type: integer
SizeRw:
format: int64
type: integer
State:
type: string
Status:
type: string
type: object
x-go-package: github.com/containers/podman/v5/pkg/api/handlers
ContainerBasicConfig:
properties:
annotations:
additionalProperties:
type: string
description: |-
Annotations are key-value options passed into the container runtime
that can be used to trigger special behavior.
Optional.
type: object
x-go-name: Annotations
command:
description: |-
Command is the container's command.
If not given and Image is specified, this will be populated by the
image's configuration.
Optional.
items:
type: string
type: array
x-go-name: Command
conmon_pid_file:
description: |-
ConmonPidFile is a path at which a PID file for Conmon will be
placed.
If not given, a default location will be used.
Optional.
type: string
x-go-name: ConmonPidFile
containerCreateCommand:
description: |-
ContainerCreateCommand is the command that was used to create this
container.
This will be shown in the output of Inspect() on the container, and
may also be used by some tools that wish to recreate the container
(e.g. `podman generate systemd --new`).
Optional.
items:
type: string
type: array
x-go-name: ContainerCreateCommand
dependencyContainers:
description: |-
DependencyContainers is an array of containers this container
depends on. Dependency containers must be started before this
container. Dependencies can be specified by name or full/partial ID.
Optional.
items:
type: string
type: array
x-go-name: DependencyContainers
entrypoint:
description: |-
Entrypoint is the container's entrypoint.
If not given and Image is specified, this will be populated by the
image's configuration.
Optional.
items:
type: string
type: array
x-go-name: Entrypoint
env:
additionalProperties:
type: string
description: |-
Env is a set of environment variables that will be set in the
container.
Optional.
type: object
x-go-name: Env
env_host:
description: |-
EnvHost indicates that the host environment should be added to container
Optional.
type: boolean
x-go-name: EnvHost
envmerge:
description: |-
EnvMerge takes the specified environment variables from image and preprocess them before injecting them into the
container.
Optional.
items:
type: string
type: array
x-go-name: EnvMerge
group_entry:
description: |-
GroupEntry specifies an arbitrary string to append to the container's /etc/group file.
Optional.
type: string
x-go-name: GroupEntry
hostname:
description: |-
Hostname is the container's hostname. If not set, the hostname will
not be modified (if UtsNS is not private) or will be set to the
container ID (if UtsNS is private).
Conflicts with UtsNS if UtsNS is not set to private.
Optional.
type: string
x-go-name: Hostname
hostusers:
description: |-
HostUsers is a list of host usernames or UIDs to add to the container
etc/passwd file
items:
type: string
type: array
x-go-name: HostUsers
httpproxy:
description: |-
EnvHTTPProxy indicates that the http host proxy environment variables
should be added to container
Optional.
type: boolean
x-go-name: HTTPProxy
init_container_type:
description: |-
InitContainerType describes if this container is an init container
and if so, what type: always or once.
Optional.
type: string
x-go-name: InitContainerType
labels:
additionalProperties:
type: string
description: |-
Labels are key-value pairs that are used to add metadata to
containers.
Optional.
type: object
x-go-name: Labels
log_configuration:
$ref: '#/definitions/LogConfigLibpod'
manage_password:
description: Passwd is a container run option that determines if we are validating users/groups before running the container
type: boolean
x-go-name: Passwd
name:
description: |-
Name is the name the container will be given.
If no name is provided, one will be randomly generated.
Optional.
type: string
x-go-name: Name
oci_runtime:
description: |-
OCIRuntime is the name of the OCI runtime that will be used to create
the container.
If not specified, the default will be used.
Optional.
type: string
x-go-name: OCIRuntime
passwd_entry:
description: |-
PasswdEntry specifies an arbitrary string to append to the container's /etc/passwd file.
Optional.
type: string
x-go-name: PasswdEntry
personality:
$ref: '#/definitions/LinuxPersonality'
pidns:
$ref: '#/definitions/Namespace'
pod:
description: |-
Pod is the ID of the pod the container will join.
Optional.
type: string
x-go-name: Pod
remove:
description: |-
Remove indicates if the container should be removed once it has been started
and exits.
Optional.
type: boolean
x-go-name: Remove
removeImage:
description: |-
RemoveImage indicates that the container should remove the image it
was created from after it exits.
Only allowed if Remove is set to true and Image, not Rootfs, is in
use.
Optional.
type: boolean
x-go-name: RemoveImage
restart_policy:
description: |-
RestartPolicy is the container's restart policy - an action which
will be taken when the container exits.
If not given, the default policy, which does nothing, will be used.
Optional.
type: string
x-go-name: RestartPolicy
restart_tries:
description: |-
RestartRetries is the number of attempts that will be made to restart
the container.
Only available when RestartPolicy is set to "on-failure".
Optional.
format: uint64
type: integer
x-go-name: RestartRetries
sdnotifyMode:
description: |-
Determine how to handle the NOTIFY_SOCKET - do we participate or pass it through
"container" - let the OCI runtime deal with it, advertise conmon's MAINPID
"conmon-only" - advertise conmon's MAINPID, send READY when started, don't pass to OCI
"ignore" - unset NOTIFY_SOCKET
Optional.
type: string
x-go-name: SdNotifyMode
secret_env:
additionalProperties:
type: string
description: |-
EnvSecrets are secrets that will be set as environment variables
Optional.
type: object
x-go-name: EnvSecrets
stdin:
description: |-
Stdin is whether the container will keep its STDIN open.
Optional.
type: boolean
x-go-name: Stdin
stop_signal:
$ref: '#/definitions/Signal'
stop_timeout:
description: |-
StopTimeout is a timeout between the container's stop signal being
sent and SIGKILL being sent.
If not provided, the default will be used.
If 0 is used, stop signal will not be sent, and SIGKILL will be sent
instead.
Optional.
format: uint64
type: integer
x-go-name: StopTimeout
sysctl:
additionalProperties:
type: string
description: Sysctl sets kernel parameters for the container
type: object
x-go-name: Sysctl
systemd:
description: |-
Systemd is whether the container will be started in systemd mode.
Valid options are "true", "false", and "always".
"true" enables this mode only if the binary run in the container is
sbin/init or systemd. "always" unconditionally enables systemd mode.
"false" unconditionally disables systemd mode.
If enabled, mounts and stop signal will be modified.
If set to "always" or set to "true" and conditionally triggered,
conflicts with StopSignal.
If not specified, "false" will be assumed.
Optional.
type: string
x-go-name: Systemd
terminal:
description: |-
Terminal is whether the container will create a PTY.
Optional.
type: boolean
x-go-name: Terminal
timeout:
description: |-
Timeout is a maximum time in seconds the container will run before
main process is sent SIGKILL.
If 0 is used, signal will not be sent. Container can run indefinitely
if they do not stop after the default termination signal.
Optional.
format: uint64
type: integer
x-go-name: Timeout
timezone:
description: |-
Timezone is the timezone inside the container.
Local means it has the same timezone as the host machine
Optional.
type: string
x-go-name: Timezone
unsetenv:
description: |-
UnsetEnv unsets the specified default environment variables from the image or from built-in or containers.conf
Optional.
items:
type: string
type: array
x-go-name: UnsetEnv
unsetenvall:
description: |-
UnsetEnvAll unsetall default environment variables from the image or from built-in or containers.conf
UnsetEnvAll unsets all default environment variables from the image or from built-in
Optional.
type: boolean
x-go-name: UnsetEnvAll
utsns:
$ref: '#/definitions/Namespace'
title: ContainerBasicConfig contains the basic parts of a container.
type: object
x-go-package: github.com/containers/podman/v5/pkg/specgen
ContainerCgroupConfig:
description: |-
ContainerCgroupConfig contains configuration information about a container's
cgroups.
properties:
cgroup_parent:
description: |-
CgroupParent is the container's Cgroup parent.
If not set, the default for the current cgroup driver will be used.
Optional.
type: string
x-go-name: CgroupParent
cgroupns:
$ref: '#/definitions/Namespace'
cgroups_mode:
description: |-
CgroupsMode sets a policy for how cgroups will be created for the
container, including the ability to disable creation entirely.
Optional.
type: string
x-go-name: CgroupsMode
type: object
x-go-package: github.com/containers/podman/v5/pkg/specgen
ContainerCreateResponse:
description: ContainerCreateResponse is the response struct for creating a container
properties:
Id:
description: ID of the container created
type: string
x-go-name: ID
Warnings:
description: Warnings during container creation
items:
type: string
type: array
required:
- Id
- Warnings
type: object
x-go-package: github.com/containers/podman/v5/pkg/domain/entities/types
ContainerHealthCheckConfig:
description: |-
ContainerHealthCheckConfig describes a container healthcheck with attributes
like command, retries, interval, start period, and timeout.
properties:
health_check_on_failure_action:
$ref: '#/definitions/HealthCheckOnFailureAction'
healthLogDestination:
description: HealthLogDestination defines the destination where the log is stored
type: string
x-go-name: HealthLogDestination
healthMaxLogCount:
description: |-
HealthMaxLogCount is maximum number of attempts in the HealthCheck log file.
('0' value means an infinite number of attempts in the log file)
format: uint64
type: integer
x-go-name: HealthMaxLogCount
healthMaxLogSize:
description: |-
HealthMaxLogSize is the maximum length in characters of stored HealthCheck log
("0" value means an infinite log length)
format: uint64
type: integer
x-go-name: HealthMaxLogSize
healthconfig:
$ref: '#/definitions/Schema2HealthConfig'
startupHealthConfig:
$ref: '#/definitions/StartupHealthCheck'
type: object
x-go-package: github.com/containers/podman/v5/pkg/specgen
ContainerJSON:
description: ContainerJSON is newly used struct along with MountPoint
properties:
AppArmorProfile:
type: string
Args:
items:
type: string
type: array
Config:
$ref: '#/definitions/Config'
Created:
type: string
Driver:
type: string
ExecIDs:
items:
type: string
type: array
GraphDriver:
$ref: '#/definitions/GraphDriverData'
HostConfig:
$ref: '#/definitions/HostConfig'
HostnamePath:
type: string
HostsPath:
type: string
Id:
type: string
x-go-name: ID
Image:
type: string
LogPath:
type: string
MountLabel:
type: string
Mounts:
items:
$ref: '#/definitions/MountPoint'
type: array
Name:
type: string
NetworkSettings:
$ref: '#/definitions/NetworkSettings'
Node:
$ref: '#/definitions/ContainerNode'
Path:
type: string
Platform:
type: string
ProcessLabel:
type: string
ResolvConfPath:
type: string
RestartCount:
format: int64
type: integer
SizeRootFs:
format: int64
type: integer
SizeRw:
format: int64
type: integer
State:
$ref: '#/definitions/ContainerState'
type: object
x-go-package: github.com/docker/docker/api/types
ContainerNetworkConfig:
description: |-
ContainerNetworkConfig contains information on a container's network
configuration.
properties:
Networks:
additionalProperties:
$ref: '#/definitions/PerNetworkOptions'
description: |-
Map of networks names or ids that the container should join.
You can request additional settings for each network, you can
set network aliases, static ips, static mac address and the
network interface name for this container on the specific network.
If the map is empty and the bridge network mode is set the container
will be joined to the default network.
Optional.
type: object
base_hosts_file:
description: |-
BaseHostsFile is the base file to create the `/etc/hosts` file inside the container.
This must either be an absolute path to a file on the host system, or one of the
special flags `image` or `none`.
If it is empty it defaults to the base_hosts_file configuration in containers.conf.
Optional.
type: string
x-go-name: BaseHostsFile
cni_networks:
description: |-
CNINetworks is a list of CNI networks to join the container to.
If this list is empty, the default CNI network will be joined
instead. If at least one entry is present, we will not join the
default network (unless it is part of this list).
Only available if NetNS is set to bridge.
Optional.
Deprecated: as of podman 4.0 use "Networks" instead.
items:
type: string
type: array
x-go-name: CNINetworks
dns_option:
description: |-
DNSOptions is a set of DNS options that will be used in the
container's resolv.conf, replacing the host's DNS options which are
used by default.
Conflicts with UseImageResolvConf.
Optional.
items:
type: string
type: array
x-go-name: DNSOptions
dns_search:
description: |-
DNSSearch is a set of DNS search domains that will be used in the
container's resolv.conf, replacing the host's DNS search domains
which are used by default.
Conflicts with UseImageResolvConf.
Optional.
items:
type: string
type: array
x-go-name: DNSSearch
dns_server:
description: |-
DNSServers is a set of DNS servers that will be used in the
container's resolv.conf, replacing the host's DNS Servers which are
used by default.
Conflicts with UseImageResolvConf.
Optional.
items:
type: string
type: array
x-go-name: DNSServers
expose:
description: |-
Expose is a number of ports that will be forwarded to the container
if PublishExposedPorts is set.
Expose is a map of uint16 (port number) to a string representing
protocol i.e map[uint16]string. Allowed protocols are "tcp", "udp", and "sctp", or some
combination of the three separated by commas.
If protocol is set to "" we will assume TCP.
Only available if NetNS is set to Bridge or Slirp, and
PublishExposedPorts is set.
Optional.
x-go-name: Expose
hostadd:
description: |-
HostAdd is a set of hosts which will be added to the container's
etc/hosts file.
Conflicts with UseImageHosts.
Optional.
items:
type: string
type: array
x-go-name: HostAdd
netns:
$ref: '#/definitions/Namespace'
network_options:
additionalProperties:
items:
type: string
type: array
description: |-
NetworkOptions are additional options for each network
Optional.
type: object
x-go-name: NetworkOptions
portmappings:
description: |-
PortBindings is a set of ports to map into the container.
Only available if NetNS is set to bridge, slirp, or pasta.
Optional.