-
-
Notifications
You must be signed in to change notification settings - Fork 590
/
Copy pathopenapi.yaml
11527 lines (11308 loc) · 394 KB
/
openapi.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
openapi: 3.0.0
servers:
- url: /v1.33
- url: https://docker.com/{version}
variables:
version:
default: "1.33"
info:
description: |
The Engine API is an HTTP API served by Docker Engine. It is the API the Docker client uses to communicate with the Engine, so everything the Docker client can do can be done with the API.
Most of the client's commands map directly to API endpoints (e.g. `docker ps` is `GET /containers/json`). The notable exception is running containers, which consists of several API calls.
# Errors
The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format:
```
{
"message": "page not found"
}
```
# Versioning
The API is usually changed in each release of Docker, so API calls are versioned to ensure that clients don't break.
For Docker Engine 17.09, the API version is 1.32. To lock to this version, you prefix the URL with `/v1.32`. For example, calling `/info` is the same as calling `/v1.32/info`.
Engine releases in the near future should support this version of the API, so your client will continue to work even if it is talking to a newer Engine.
In previous versions of Docker, it was possible to access the API without providing a version. This behaviour is now deprecated will be removed in a future version of Docker.
The API uses an open schema model, which means server may add extra properties to responses. Likewise, the server will ignore any extra query parameters and request body properties. When you write clients, you need to ignore additional properties in responses to ensure they do not break when talking to newer Docker daemons.
This documentation is for version 1.33 of the API. Use this table to find documentation for previous versions of the API:
Docker version | API version | Changes
----------------|-------------|---------
17.09.x | [1.31](https://docs.docker.com/engine/api/v1.32/) | [API changes](https://docs.docker.com/engine/api/version-history/#v1-32-api-changes)
17.07.x | [1.31](https://docs.docker.com/engine/api/v1.31/) | [API changes](https://docs.docker.com/engine/api/version-history/#v1-31-api-changes)
17.06.x | [1.30](https://docs.docker.com/engine/api/v1.30/) | [API changes](https://docs.docker.com/engine/api/version-history/#v1-30-api-changes)
17.05.x | [1.29](https://docs.docker.com/engine/api/v1.29/) | [API changes](https://docs.docker.com/engine/api/version-history/#v1-29-api-changes)
17.04.x | [1.28](https://docs.docker.com/engine/api/v1.28/) | [API changes](https://docs.docker.com/engine/api/version-history/#v1-28-api-changes)
17.03.1 | [1.27](https://docs.docker.com/engine/api/v1.27/) | [API changes](https://docs.docker.com/engine/api/version-history/#v1-27-api-changes)
1.13.1 & 17.03.0 | [1.26](https://docs.docker.com/engine/api/v1.26/) | [API changes](https://docs.docker.com/engine/api/version-history/#v1-26-api-changes)
1.13.0 | [1.25](https://docs.docker.com/engine/api/v1.25/) | [API changes](https://docs.docker.com/engine/api/version-history/#v1-25-api-changes)
1.12.x | [1.24](https://docs.docker.com/engine/api/v1.24/) | [API changes](https://docs.docker.com/engine/api/version-history/#v1-24-api-changes)
1.11.x | [1.23](https://docs.docker.com/engine/api/v1.23/) | [API changes](https://docs.docker.com/engine/api/version-history/#v1-23-api-changes)
1.10.x | [1.22](https://docs.docker.com/engine/api/v1.22/) | [API changes](https://docs.docker.com/engine/api/version-history/#v1-22-api-changes)
1.9.x | [1.21](https://docs.docker.com/engine/api/v1.21/) | [API changes](https://docs.docker.com/engine/api/version-history/#v1-21-api-changes)
1.8.x | [1.20](https://docs.docker.com/engine/api/v1.20/) | [API changes](https://docs.docker.com/engine/api/version-history/#v1-20-api-changes)
1.7.x | [1.19](https://docs.docker.com/engine/api/v1.19/) | [API changes](https://docs.docker.com/engine/api/version-history/#v1-19-api-changes)
1.6.x | [1.18](https://docs.docker.com/engine/api/v1.18/) | [API changes](https://docs.docker.com/engine/api/version-history/#v1-18-api-changes)
# Authentication
Authentication for registries is handled client side. The client has to send authentication details to various endpoints that need to communicate with registries, such as `POST /images/(name)/push`. These are sent as `X-Registry-Auth` header as a Base64 encoded (JSON) string with the following structure:
```
{
"username": "string",
"password": "string",
"email": "string",
"serveraddress": "string"
}
```
The `serveraddress` is a domain/IP without a protocol. Throughout this structure, double quotes are required.
If you have already got an identity token from the [`/auth` endpoint](#operation/SystemAuth), you can just pass this instead of credentials:
```
{
"identitytoken": "9cbaf023786cd7..."
}
```
title: Docker Engine API
version: "1.33"
x-apisguru-categories:
- developer_tools
x-logo:
url: https://docs.docker.com/images/logo-docker-main.png
x-origin:
- format: openapi
url: https://raw.githubusercontent.com/docker/go-docker/master/api/swagger.yaml
version: "3.0"
x-providerName: docker.com
x-serviceName: engine
tags:
- description: |
Create and manage containers.
name: Container
x-displayName: Containers
- name: Image
x-displayName: Images
- description: |
Networks are user-defined networks that containers can be attached to. See the [networking documentation](https://docs.docker.com/engine/userguide/networking/) for more information.
name: Network
x-displayName: Networks
- description: |
Create and manage persistent storage that can be attached to containers.
name: Volume
x-displayName: Volumes
- description: |
Run new commands inside running containers. See the [command-line reference](https://docs.docker.com/engine/reference/commandline/exec/) for more information.
To exec a command in a container, you first need to create an exec instance, then start it. These two API endpoints are wrapped up in a single command-line command, `docker exec`.
name: Exec
x-displayName: Exec
- description: |
Engines can be clustered together in a swarm. See [the swarm mode documentation](https://docs.docker.com/engine/swarm/) for more information.
name: Swarm
x-displayName: Swarm
- description: |
Nodes are instances of the Engine participating in a swarm. Swarm mode must be enabled for these endpoints to work.
name: Node
x-displayName: Nodes
- description: |
Services are the definitions of tasks to run on a swarm. Swarm mode must be enabled for these endpoints to work.
name: Service
x-displayName: Services
- description: |
A task is a container running on a swarm. It is the atomic scheduling unit of swarm. Swarm mode must be enabled for these endpoints to work.
name: Task
x-displayName: Tasks
- description: |
Secrets are sensitive data that can be used by services. Swarm mode must be enabled for these endpoints to work.
name: Secret
x-displayName: Secrets
- description: |
Configs are application configurations that can be used by services. Swarm mode must be enabled for these endpoints to work.
name: Config
x-displayName: Configs
- name: Plugin
x-displayName: Plugins
- name: System
x-displayName: System
paths:
/_ping:
get:
description: This is a dummy endpoint you can use to test if the server is accessible.
operationId: SystemPing
responses:
"200":
content:
text/plain:
schema:
example: OK
type: string
description: no error
headers:
API-Version:
description: Max API Version the server supports
schema:
type: string
Docker-Experimental:
description: If the server is running with experimental mode enabled
schema:
type: boolean
"500":
content:
text/plain:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: server error
summary: Ping
tags:
- System
/auth:
post:
description: Validate credentials for a registry and, if available, get an identity token for accessing the registry without password.
operationId: SystemAuth
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/AuthConfig"
description: Authentication to check
responses:
"200":
content:
application/json:
examples:
response:
value:
IdentityToken: 9cbaf023786cd7...
Status: Login Succeeded
schema:
properties:
IdentityToken:
description: An opaque token used to authenticate a user after a successful login
nullable: false
type: string
Status:
description: The status of the authentication
nullable: false
type: string
required:
- Status
type: object
description: An identity token was generated successfully.
"204":
description: No error
"500":
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: Server error
summary: Check auth configuration
tags:
- System
/build:
post:
description: |
Build an image from a tar archive with a `Dockerfile` in it.
The `Dockerfile` specifies how the image is built from the tar archive. It is typically in the archive's root, but can be at a different path or have a different name by specifying the `dockerfile` parameter. [See the `Dockerfile` reference for more information](https://docs.docker.com/engine/reference/builder/).
The Docker daemon performs a preliminary validation of the `Dockerfile` before starting the build, and returns an error if the syntax is incorrect. After that, each instruction is run one-by-one until the ID of the new image is output.
The build is canceled if the client drops the connection by quitting or being killed.
operationId: ImageBuild
parameters:
- description: Path within the build context to the `Dockerfile`. This is ignored if `remote` is specified and points to an external `Dockerfile`.
in: query
name: dockerfile
schema:
default: Dockerfile
type: string
- description: A name and optional tag to apply to the image in the `name:tag` format. If you omit the tag the default `latest` value is assumed. You can provide several `t` parameters.
in: query
name: t
schema:
type: string
- description: Extra hosts to add to /etc/hosts
in: query
name: extrahosts
schema:
type: string
- description: A Git repository URI or HTTP/HTTPS context URI. If the URI points to a single text file, the file’s contents are placed into a file called `Dockerfile` and the image is built from that file. If the URI points to a tarball, the file is downloaded by the daemon and the contents therein used as the context for the build. If the URI points to a tarball and the `dockerfile` parameter is also specified, there must be a file with the corresponding path inside the tarball.
in: query
name: remote
schema:
type: string
- description: Suppress verbose build output.
in: query
name: q
schema:
default: false
type: boolean
- description: Do not use the cache when building the image.
in: query
name: nocache
schema:
default: false
type: boolean
- description: JSON array of images used for build cache resolution.
in: query
name: cachefrom
schema:
type: string
- description: Attempt to pull the image even if an older image exists locally.
in: query
name: pull
schema:
type: string
- description: Remove intermediate containers after a successful build.
in: query
name: rm
schema:
default: true
type: boolean
- description: Always remove intermediate containers, even upon failure.
in: query
name: forcerm
schema:
default: false
type: boolean
- description: Set memory limit for build.
in: query
name: memory
schema:
type: integer
- description: Total memory (memory + swap). Set as `-1` to disable swap.
in: query
name: memswap
schema:
type: integer
- description: CPU shares (relative weight).
in: query
name: cpushares
schema:
type: integer
- description: CPUs in which to allow execution (e.g., `0-3`, `0,1`).
in: query
name: cpusetcpus
schema:
type: string
- description: The length of a CPU period in microseconds.
in: query
name: cpuperiod
schema:
type: integer
- description: Microseconds of CPU time that the container can get in a CPU period.
in: query
name: cpuquota
schema:
type: integer
- description: JSON map of string pairs for build-time variables. Users pass these values at build-time. Docker uses the buildargs as the environment context for commands run via the `Dockerfile` RUN instruction, or for variable expansion in other `Dockerfile` instructions. This is not meant for passing secret values. [Read more about the buildargs instruction.](https://docs.docker.com/engine/reference/builder/#arg)
in: query
name: buildargs
schema:
type: integer
- description: Size of `/dev/shm` in bytes. The size must be greater than 0. If omitted the system uses 64MB.
in: query
name: shmsize
schema:
type: integer
- description: Squash the resulting images layers into a single layer. *(Experimental release only.)*
in: query
name: squash
schema:
type: boolean
- description: Arbitrary key/value labels to set on the image, as a JSON map of string pairs.
in: query
name: labels
schema:
type: string
- description: "Sets the networking mode for the run commands during build. Supported standard values are: `bridge`, `host`, `none`, and `container:<name|id>`. Any other value is taken as a custom network's name to which this container should connect to."
in: query
name: networkmode
schema:
type: string
- in: header
name: Content-type
schema:
default: application/x-tar
enum:
- application/x-tar
type: string
- description: |
This is a base64-encoded JSON object with auth configurations for multiple registries that a build may refer to.
The key is a registry URL, and the value is an auth configuration object, [as described in the authentication section](#section/Authentication). For example:
```
{
"docker.example.com": {
"username": "janedoe",
"password": "hunter2"
},
"https://index.docker.io/v1/": {
"username": "mobydock",
"password": "conta1n3rize14"
}
}
```
Only the registry domain name (and port if not the default 443) are required. However, for legacy reasons, the Docker Hub registry must be specified with both a `https://` prefix and a `/v1/` suffix even though Docker will prefer to use the v2 registry API.
in: header
name: X-Registry-Config
schema:
type: string
requestBody:
content:
application/octet-stream:
schema:
format: binary
type: string
description: "A tar archive compressed with one of the following algorithms: identity (no compression), gzip, bzip2, xz."
responses:
"200":
description: no error
"400":
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: Bad parameter
"500":
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: server error
summary: Build an image
tags:
- Image
/build/prune:
post:
operationId: BuildPrune
responses:
"200":
content:
application/json:
schema:
properties:
SpaceReclaimed:
description: Disk space reclaimed in bytes
format: int64
type: integer
type: object
description: No error
"500":
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: Server error
summary: Delete builder cache
tags:
- Image
/commit:
post:
operationId: ImageCommit
parameters:
- description: The ID or name of the container to commit
in: query
name: container
schema:
type: string
- description: Repository name for the created image
in: query
name: repo
schema:
type: string
- description: Tag name for the create image
in: query
name: tag
schema:
type: string
- description: Commit message
in: query
name: comment
schema:
type: string
- description: Author of the image (e.g., `John Hannibal Smith <[email protected]>`)
in: query
name: author
schema:
type: string
- description: Whether to pause the container before committing
in: query
name: pause
schema:
default: true
type: boolean
- description: "`Dockerfile` instructions to apply while committing"
in: query
name: changes
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ContainerConfig"
description: The container configuration
responses:
"201":
content:
application/json:
schema:
$ref: "#/components/schemas/IdResponse"
description: no error
"404":
content:
application/json:
examples:
response:
value:
message: "No such container: c2ada9df5af8"
schema:
$ref: "#/components/schemas/ErrorResponse"
description: no such container
"500":
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: server error
summary: Create a new image from a container
tags:
- Image
/configs:
get:
operationId: ConfigList
parameters:
- description: |
A JSON encoded value of the filters (a `map[string][]string`) to process on the configs list. Available filters:
- `id=<config id>`
- `label=<key> or label=<key>=value`
- `name=<config name>`
- `names=<config name>`
in: query
name: filters
schema:
type: string
responses:
"200":
content:
application/json:
schema:
example:
- CreatedAt: 2016-11-05T01:20:17.327670065Z
ID: ktnbjxoalbkvbvedmg1urrz8h
Spec:
Name: server.conf
UpdatedAt: 2016-11-05T01:20:17.327670065Z
Version:
Index: 11
items:
$ref: "#/components/schemas/Config"
type: array
description: no error
"500":
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: server error
"503":
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: node is not part of a swarm
summary: List configs
tags:
- Config
/configs/create:
post:
operationId: ConfigCreate
requestBody:
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ConfigSpec"
- example:
Data: VEhJUyBJUyBOT1QgQSBSRUFMIENFUlRJRklDQVRFCg==
Labels:
foo: bar
Name: server.conf
type: object
responses:
"201":
content:
application/json:
schema:
example:
ID: ktnbjxoalbkvbvedmg1urrz8h
properties:
ID:
description: The ID of the created config.
type: string
type: object
description: no error
"409":
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: name conflicts with an existing object
"500":
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: server error
"503":
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: node is not part of a swarm
summary: Create a config
tags:
- Config
"/configs/{id}":
delete:
operationId: ConfigDelete
parameters:
- description: ID of the config
in: path
name: id
required: true
schema:
type: string
responses:
"204":
description: no error
"404":
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: config not found
"500":
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: server error
"503":
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: node is not part of a swarm
summary: Delete a config
tags:
- Config
get:
operationId: ConfigInspect
parameters:
- description: ID of the config
in: path
name: id
required: true
schema:
type: string
responses:
"200":
content:
application/json:
examples:
response:
value:
CreatedAt: 2016-11-05T01:20:17.327670065Z
ID: ktnbjxoalbkvbvedmg1urrz8h
Spec:
Name: app-dev.crt
UpdatedAt: 2016-11-05T01:20:17.327670065Z
Version:
Index: 11
schema:
$ref: "#/components/schemas/Config"
description: no error
"404":
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: config not found
"500":
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: server error
"503":
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: node is not part of a swarm
summary: Inspect a config
tags:
- Config
"/configs/{id}/update":
post:
operationId: ConfigUpdate
parameters:
- description: The ID or name of the config
in: path
name: id
required: true
schema:
type: string
- description: The version number of the config object being updated. This is required to avoid conflicting writes.
in: query
name: version
required: true
schema:
format: int64
type: integer
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ConfigSpec"
text/plain:
schema:
$ref: "#/components/schemas/ConfigSpec"
description: The spec of the config to update. Currently, only the Labels field can be updated. All other fields must remain unchanged from the [ConfigInspect endpoint](#operation/ConfigInspect) response values.
responses:
"200":
description: no error
"400":
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
text/plain:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: bad parameter
"404":
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
text/plain:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: no such config
"500":
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
text/plain:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: server error
"503":
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
text/plain:
schema:
$ref: "#/components/schemas/ErrorResponse"
description: node is not part of a swarm
summary: Update a Config
tags:
- Config
/containers/create:
post:
operationId: ContainerCreate
parameters:
- description: Assign the specified name to the container. Must match `/?[a-zA-Z0-9_-]+`.
in: query
name: name
schema:
pattern: /?[a-zA-Z0-9_-]+
type: string
requestBody:
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/ContainerConfig"
- properties:
HostConfig:
$ref: "#/components/schemas/HostConfig"
NetworkingConfig:
description: This container's networking configuration.
properties:
EndpointsConfig:
additionalProperties:
$ref: "#/components/schemas/EndpointSettings"
description: A mapping of network name to endpoint configuration for that network.
type: object
type: object
type: object
example:
AttachStderr: true
AttachStdin: false
AttachStdout: true
Cmd:
- date
Domainname: ""
Entrypoint: ""
Env:
- FOO=bar
- BAZ=quux
ExposedPorts:
22/tcp: {}
HostConfig:
AutoRemove: true
Binds:
- /tmp:/tmp
BlkioDeviceReadBps:
- {}
BlkioDeviceReadIOps:
- {}
BlkioDeviceWriteBps:
- {}
BlkioDeviceWriteIOps:
- {}
BlkioWeight: 300
BlkioWeightDevice:
- {}
CapAdd:
- NET_ADMIN
CapDrop:
- MKNOD
CgroupParent: ""
CpuPercent: 80
CpuPeriod: 100000
CpuQuota: 50000
CpuRealtimePeriod: 1000000
CpuRealtimeRuntime: 10000
CpuShares: 512
CpusetCpus: 0,1
CpusetMems: 0,1
Devices: []
Dns:
- 8.8.8.8
DnsOptions:
- ""
DnsSearch:
- ""
GroupAdd:
- newgroup
KernelMemory: 0
Links:
- redis3:redis
LogConfig:
Config: {}
Type: json-file
MaximumIOBps: 0
MaximumIOps: 0
Memory: 0
MemoryReservation: 0
MemorySwap: 0
MemorySwappiness: 60
NanoCPUs: 500000
NetworkMode: bridge
OomKillDisable: false
OomScoreAdj: 500
PidMode: ""
PidsLimit: -1
PortBindings:
22/tcp:
- HostPort: "11022"
Privileged: false
PublishAllPorts: false
ReadonlyRootfs: false
RestartPolicy:
MaximumRetryCount: 0
Name: ""
SecurityOpt: []
ShmSize: 67108864
StorageOpt: {}
Ulimits:
- {}
VolumeDriver: ""
VolumesFrom:
- parent
- other:ro
Hostname: ""
Image: ubuntu
Labels:
com.example.license: GPL
com.example.vendor: Acme
com.example.version: "1.0"
MacAddress: 12:34:56:78:9a:bc
NetworkDisabled: false
NetworkingConfig:
EndpointsConfig:
isolated_nw:
Aliases:
- server_x
- server_y
IPAMConfig:
IPv4Address: 172.20.30.33
IPv6Address: 2001:db8:abcd::3033
LinkLocalIPs:
- 169.254.34.68
- fe80::3468
Links:
- container_1
- container_2
OpenStdin: false
StdinOnce: false
StopSignal: SIGTERM
StopTimeout: 10
Tty: false
User: ""
Volumes:
/volumes/data: {}
WorkingDir: ""
application/octet-stream:
schema:
allOf:
- $ref: "#/components/schemas/ContainerConfig"
- properties:
HostConfig:
$ref: "#/components/schemas/HostConfig"
NetworkingConfig:
description: This container's networking configuration.
properties:
EndpointsConfig:
additionalProperties:
$ref: "#/components/schemas/EndpointSettings"
description: A mapping of network name to endpoint configuration for that network.
type: object
type: object
type: object
example:
AttachStderr: true
AttachStdin: false
AttachStdout: true
Cmd:
- date
Domainname: ""
Entrypoint: ""
Env:
- FOO=bar
- BAZ=quux
ExposedPorts:
22/tcp: {}
HostConfig:
AutoRemove: true
Binds:
- /tmp:/tmp
BlkioDeviceReadBps:
- {}
BlkioDeviceReadIOps:
- {}
BlkioDeviceWriteBps:
- {}
BlkioDeviceWriteIOps:
- {}
BlkioWeight: 300
BlkioWeightDevice:
- {}
CapAdd:
- NET_ADMIN
CapDrop:
- MKNOD
CgroupParent: ""
CpuPercent: 80
CpuPeriod: 100000
CpuQuota: 50000
CpuRealtimePeriod: 1000000
CpuRealtimeRuntime: 10000
CpuShares: 512
CpusetCpus: 0,1
CpusetMems: 0,1
Devices: []
Dns:
- 8.8.8.8
DnsOptions:
- ""
DnsSearch:
- ""
GroupAdd:
- newgroup
KernelMemory: 0
Links:
- redis3:redis
LogConfig:
Config: {}
Type: json-file
MaximumIOBps: 0
MaximumIOps: 0
Memory: 0
MemoryReservation: 0
MemorySwap: 0
MemorySwappiness: 60
NanoCPUs: 500000
NetworkMode: bridge
OomKillDisable: false
OomScoreAdj: 500
PidMode: ""
PidsLimit: -1
PortBindings:
22/tcp:
- HostPort: "11022"
Privileged: false
PublishAllPorts: false
ReadonlyRootfs: false
RestartPolicy:
MaximumRetryCount: 0
Name: ""
SecurityOpt: []
ShmSize: 67108864
StorageOpt: {}
Ulimits:
- {}
VolumeDriver: ""
VolumesFrom:
- parent
- other:ro
Hostname: ""
Image: ubuntu
Labels:
com.example.license: GPL
com.example.vendor: Acme
com.example.version: "1.0"
MacAddress: 12:34:56:78:9a:bc
NetworkDisabled: false
NetworkingConfig:
EndpointsConfig:
isolated_nw:
Aliases:
- server_x
- server_y
IPAMConfig:
IPv4Address: 172.20.30.33
IPv6Address: 2001:db8:abcd::3033
LinkLocalIPs:
- 169.254.34.68