-
Notifications
You must be signed in to change notification settings - Fork 0
/
asyncdocker.nim
3649 lines (3566 loc) · 137 KB
/
asyncdocker.nim
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
#
# Nim's Unofficial Library
# (c) Copyright 2016 Wang Tong
#
# See the file "LICENSE", included in this
# distribution, for details about the copyright.
#
## This module implements an Docker Engine client based on Docker Remotet API. It's
## asynchronous (non-blocking) that it can be used to write web services for deploying
## swarm cluster and containers automatically on cloud environment. Of course, it
## can also be used to write any local deployment tools.
##
## Docker cli vs asyncdocker
## =========================
##
## The docker cli example:
##
## .. code-block:: sh
##
## export DOCKER_HOST=127.0.0.1:2375
## docker create --name hello --hostname 192.168.0.1 \
## ubuntu:14.04 /bin/bash -c 'echo hello'
## docker start hello
##
## And the equivalent asyncdocker example:
##
## .. code-block:: nim
##
## import asyncdocker, asyncdispatch, json
##
## proc main() {.async.} =
## var docker = newAsyncDocker("127.0.0.1", Port(2375))
## var ret = await docker.create(image = "ubuntu:14.04",
## name = "hello",
## hostname = "192.168.0.1",
## cmd = @["/bin/bash", "-c", "echo", "hello"])
## echo "Container Id: ", ret["Id"].getStr()
## await docker.start(name = "hello")
## docker.close()
##
## waitFor main()
##
## Simulate pull image
## ===================
##
## This example simulates the docker cli ``docker pull ubuntu:14.10`` to download
## the image and print progress bars:
##
## .. code-block:: nim
##
## import asyncdocker, asyncdispatch, json
##
## const
## hostname = "127.0.0.1"
## port = Port(2375)
##
## proc pullCb(state: JsonNode): Future[bool] {.async.} =
## if state.hasKey("progress"):
## let current = state["progressDetail"]["current"].getNum()
## let total = state["progressDetail"]["total"].getNum()
## stdout.write("\r")
## stdout.write(state["id"].getStr())
## stdout.write(": ")
## stdout.write(state["status"].getStr())
## stdout.write(" ")
## stdout.write($current & "/" & $total)
## stdout.write(" ")
## stdout.write(state["progress"].getStr())
## if current == total:
## stdout.write("\n")
## stdout.flushFile()
## else:
## if state.hasKey("id"):
## stdout.write(state["id"].getStr())
## stdout.write(": ")
## stdout.write(state["status"].getStr())
## stdout.write("\n")
## else:
## stdout.write(state["status"].getStr())
## stdout.write("\n")
##
## proc main() {.async.} =
## var docker = newAsyncDocker(hostname, port)
## await docker.pull(fromImage = "ubuntu", tag = "14.04", cb = pullCb)
## docker.close()
##
## waitFor main()
##
## output:
##
## .. code-block:: nim
##
## 14.04: Pulling from library/ubuntu
## b0efe5c05b4c: Pulling fs layer
## 0a1f1b169319: Pulling fs layer
## 1ceb0a3c7c48: Pulling fs layer
## a3ed95caeb02: Pulling fs layer
## a3ed95caeb02: Waiting
## 1ceb0a3c7c48: Downloading 682/682 [==================================================>] 682 B/682 B
## 1ceb0a3c7c48: Verifying Checksum
## 1ceb0a3c7c48: Download complete
## a3ed95caeb02: Downloading 32/32 [==================================================>] 32 B/32 BB/77.8 kB
## a3ed95caeb02: Verifying Checksum
## a3ed95caeb02: Download complete
## 0a1f1b169319: Downloading 77797/77797 [==================================================>] 77.8 kB/77.8 kB
## 0a1f1b169319: Verifying Checksum
## 0a1f1b169319: Download complete
## b0efe5c05b4c: Downloading 4848810/68321236 [===> ] 4.849 MB/68.32 MB
##
## Web service
## ===========
##
## You can write a web service with ``asynchttpserver``:
##
## .. code-block:: nim
##
## import asyncdocker, asyncdispatch, asynchttpserver, json
##
## var server = newAsyncHttpServer()
##
## proc cb(req: Request) {.async.} =
## var docker = newAsyncDocker("127.0.0.1", Port(2375))
## var pass = true
## try:
## var ret = await docker.create(image = "ubuntu:14.04",
## name = "hello",
## hostname = "192.168.0.1",
## cmd = @["/bin/bash", "-c", "echo", "hello"])
## echo "Container Id: ", ret["Id"].getStr()
## await docker.start(name = "hello")
## await req.respond(Http201, "OK")
## except:
## pass = false
## if not pass:
## await req.respond(Http500, "Failure")
## docker.close()
##
## waitFor server.serve(Port(8080), cb)
##
## or with ``jester``:
##
## .. code-block:: nim
##
## import asyncdocker, asyncdispatch, asynchttpserver, json, jester
##
## routes:
## post "/containers/@name/run"
## var docker = newAsyncDocker("127.0.0.1", Port(2375))
## var pass = true
## try:
## var ret = await docker.create(image = "ubuntu:14.04",
## name = @"name",
## hostname = "192.168.0.1",
## cmd = @["/bin/bash", "-c", "echo", "hello"])
## echo "Container Id: ", ret["Id"].getStr()
## await docker.start(name = "hello")
## await req.respond(Http201, "OK")
## except:
## pass = false
## if not pass:
## await req.respond(Http500, "Failure")
## docker.close()
##
## Stream support
## ==============
##
## Supports to stream responses from the docker daemon with ``attach``, ``logs``,
## ``execStart``, etc. For example:
##
## .. code-block:: nim
##
## docker logs --follow hello
##
## .. code-block:: nim
##
## proc logsCb(): VndCallback =
## var i = 0
## proc cb(vnd: VndKind, data: string): Future[bool] {.async.} =
## if vnd == vndStdout:
## stdout.write("stdout: " & data)
## if vnd == vndStderr:
## stderr.write("stderr: " & data)
## echo i
## if i == 5:
## result = true ## Close socket to stop receiving logs.
## inc(i)
## result = cb
## await docker.logs("hello", follow = true, cb = logsCb())
##
## Tls verify
## ==========
##
## Supports `--tls` and `--tlsverify` to protect docker daemon socket.
##
## This requires the OpenSSL library, fortunately it's widely used and installed on
## many operating systems. Client will use SSL automatically if you give any of
## the functions a url with the ``https`` schema, for example: ``https://github.com/``,
## you also have to compile with ``ssl`` defined like so: ``nim c -d:ssl ...``.
##
## For `--tls` verification:
##
## .. code-block:: sh
##
## docker --host 127.0.0.1:2376 \
## --tls \
## --tlskey /home/docker/.docker/key.pem \
## --tlscert /home/docker/.docker/cert.pem \
## ps
##
## equivalent to:
##
## .. code-block:: nim
##
## import asyncdocker, asyncdispatch, json, openssl
##
## const
## key = "/home/docker/.docker/key.pem"
## cert = "/home/docker/.docker/cert.pem"
##
## proc main() {.async.}
## var docker = newAsyncDocker("127.0.0.1", Port(2376), nil, key, cert, CVerifyNone)
## var containers = await docker.ps()
##
## waitFor main()
##
## For `--tlsverify` verification:
##
## .. code-block:: sh
##
## docker --host 127.0.0.1:2376 \
## --tlsverify \
## --tlscacert /home/docker/.docker/ca.pem \
## --tlskey /home/docker/.docker/key.pem \
## --tlscert /home/docker/.docker/cert.pem \
## ps
##
## equivalent to:
##
## .. code-block:: nim
##
## import asyncdocker, asyncdispatch, json, openssl
##
## const
## cacert = "/home/docker/.docker/ca.pem"
## key = "/home/docker/.docker/key.pem"
## cert = "/home/docker/.docker/cert.pem"
##
## proc main() {.async.}
## var docker = newAsyncDocker("127.0.0.1", Port(2376), cacert, key, cert, CVerifyPeer)
## var containers = await docker.ps()
##
## waitFor main()
##
## Swarm cluster support
## =====================
##
## The Docker Swarm API is mostly compatible with the Docker Remote API. see `Docker Swarm Reference <https://docs.docker.com/swarm/swarm-api/>`_
import asyncdispatch, asynchttpclient, strutils, json, strtabs, uri, net, streams
import math, nre, base64
export asynchttpclient
when defined(ssl):
import openssl
type
AsyncDocker* = ref object ## Asynchronous docker client.
scheme: string
hostname: string
port: string
httpclient: AsyncHttpClient
ContainerStatus* = enum ## Enumeration of all container status.
statCreated, statRestarting, statRunning, statPaused, statExited
RestartPolicy* = enum ## Enumeration of all restart policy for container.
rpNo = "no", rpOnFailure = "on-failure",
rpAlways = "always", rpUnlessStopped = "unless-stopped"
LogType* = enum ## Enumeration of all available log driver.
logNone = "none", logJsonFile = "json-file", logJournald = "journald",
logGelf = "gelf", logAwslogs = "awslogs", logSplunk = "splunk"
DockerError* = object of IOError ## Requesting to docker daemon has
## an error.
NotModifiedError* = object of DockerError ## `Not modified` from docker daemon,
## response status code is `304`.
BadParameterError* = object of DockerError ## `Bad parameter` from docker daemon,
## response status code is `400`.
ForbiddenError* = object of DockerError ## `Forbidden` from docker daemon,
## response status code is `403`.
NotFoundError* = object of DockerError ## `Not found` from docker daemon,
## response status code is `404`.
NotAcceptableError* = object of DockerError ## `Not acceptable` from docker daemon,
## response status code is `406`.
ConflictError* = object of DockerError ## `Conflict` from docker daemon,
## response status code is `409`.
ServerError* = object of DockerError ## `Server error` from docker daemon,
## response status code is `500`.
VndKind* = enum
vndStdin, vndStdout, vndStderr
VndCallback* = proc(vnd: VndKind, data: string): Future[bool]
JsonCallback* = proc(data: JsonNode): Future[bool]
const
dockerVersion* = "1.23"
userAgent* = "Nim Docker client/0.0.1 (1.23)"
bufferSize* = 8192
proc add(queries: var seq[string]; name, val: string) =
add(queries, name & "=" & val)
template parseUriImpl() {.dirty.} =
result = initUri()
result.scheme = scheme
result.hostname = hostname
result.port = port
result.path = path
proc parseUri(scheme, hostname, port, path: string): Uri =
parseUriImpl()
proc parseUri(scheme, hostname, port, path: string;
queries: openarray[string]): Uri =
parseUriImpl()
result.query = join(queries, "&")
when defined(ssl):
proc newAsyncDocker*(hostname: string; port: Port;
cacert, key, cert: string = nil;
verifyMode = CVerifyPeer): AsyncDocker =
## Creates a new AsyncDocker instance.
new(result)
result.hostname = hostname
result.port = $int(port)
result.scheme = "https"
var ctx = newContext(protTLSv1, verifyMode, cert, key)
if verifyMode == CVerifyPeer and
SSLCTXLoadVerifyLocations(SslCtx(ctx.context), cacert, nil) != 1:
raise newException(SSLError, "invalid ca certificate")
result.httpclient = newAsyncHttpClient(userAgent, ctx)
else:
proc newAsyncDocker*(hostname: string; port: Port): AsyncDocker =
## Creates a new AsyncDocker instance.
new(result)
result.hostname = hostname
result.port = $int(port)
result.scheme = "http"
result.httpclient = newAsyncHttpClient(userAgent)
proc close*(c: AsyncDocker) =
## Closes the socket resource used by ``c``.
close(c.httpclient)
proc add(x: var JsonNode, key: string, list: seq[string]) =
var j = newJArray()
for i in list:
add(j, %i)
add(x, key, j)
proc add(x: var JsonNode, key: string, list: seq[tuple[key, value: string]]) =
var j = newJObject()
for i in list:
add(j, i.key, %i.value)
add(x, key, j)
proc parseVnd(chunk: string): tuple[vnd: VndKind, data: string] =
let buff = chunk[0..7]
let size = ord(buff[4]) * int(pow(2.float64,24.float64)) +
ord(buff[5]) * int(pow(2.float64,16.float64)) +
ord(buff[6]) * int(pow(2.float64,8.float64)) +
ord(buff[7])
let vnd = ord(buff[0])
result.vnd =
if vnd == 0: vndStdin
elif vnd == 1: vndStdout
else: vndStderr
result.data = chunk[8..8+size]
proc vndCb(cb: VndCallback): Callback =
proc callback(chunk: string): Future[bool] =
var vnd: VndKind
var data: string
try:
(vnd, data) = parseVnd(chunk)
except:
raise newException(DockerError, "invalid vnd chunk")
cb(vnd, data)
result = callback
proc jsonCb(cb: JsonCallback): Callback =
proc callback(chunk: string): Future[bool] =
var jdata: JsonNode
try:
jdata = parseJson(chunk)
except:
raise newException(DockerError, "invalid json chunk")
cb(jdata)
result = callback
proc ps*(c: AsyncDocker,
all = false,
size = false,
limit = -1,
since = "",
before = "",
exitedFilters: seq[int] = nil,
statusFilters: seq[ContainerStatus] = nil,
labelFilters: seq[string] = nil): Future[JsonNode] {.async.} =
## List containers. see `Docker Reference <https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#list-containers>`_
##
## ``FutureError`` represents an exception, it may be ``BadParameterError``, ``ServerError``
## or ``DockerError``.
##
## Request parameters:
##
## * ``all`` - Show all containers. Only running containers are shown by default
## (i.e., this defaults to false).
## * ``size`` - Show the containers sizes.
## * ``limit`` - Show limit last created containers, include non-running ones.
## * ``since`` - Show only containers created since Id, include non-running ones.
## * ``before`` - Show only containers created before Id, include non-running ones.
## * ``exitedFilters`` - Filter containers with exit code.
## * ``statusFilters`` - Filter containers with status. Available status:
## `created` | `restarting` | `running` | `paused` | `exited`.
## * ``labelFilters`` - Filter containers with label.
##
## Result is a JSON object, the internal members of which depends on the version of your docker engine.
## For example:
##
## .. code-block:: nim
##
## [
## {
## "Id": "8dfafdbc3a40",
## "Names":["/boring_feynman"],
## "Image": "ubuntu:latest",
## "ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82",
## "Command": "echo 1",
## "Created": 1367854155,
## "Status": "Exit 0",
## "Ports": [{"PrivatePort": 2222, "PublicPort": 3333, "Type": "tcp"}],
## "Labels": {
## "com.example.vendor": "Acme",
## "com.example.license": "GPL",
## "com.example.version": "1.0"
## },
## "SizeRw": 12288,
## "SizeRootFs": 0
## },
## {
## "Id": "9cd87474be90",
## "Names":["/coolName"],
## "Image": "ubuntu:latest",
## "ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82",
## "Command": "echo 222222",
## "Created": 1367854155,
## "Status": "Exit 0",
## "Ports": [],
## "Labels": {},
## "SizeRw": 12288,
## "SizeRootFs": 0
## },
## {
## "Id": "3176a2479c92",
## "Names":["/sleepy_dog"],
## "Image": "ubuntu:latest",
## "ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82",
## "Command": "echo 3333333333333333",
## "Created": 1367854154,
## "Status": "Exit 0",
## "Ports":[],
## "Labels": {},
## "SizeRw":12288,
## "SizeRootFs":0
## },
## {
## "Id": "4cb07b47f9fb",
## "Names":["/running_cat"],
## "Image": "ubuntu:latest",
## "ImageID": "d74508fb6632491cea586a1fd7d748dfc5274cd6fdfedee309ecdcbc2bf5cb82",
## "Command": "echo 444444444444444444444444444444444",
## "Created": 1367854152,
## "Status": "Exit 0",
## "Ports": [],
## "Labels": {},
## "SizeRw": 12288,
## "SizeRootFs": 0
## }
## ]
##
## If you access the docker swarm api, the result will has new field
## ``Node`` added:
##
## .. code-block:: nim
##
## "Node": {
## "Id": "ODAI:IC6Q:MSBL:TPB5:HIEE:6IKC:VCAM:QRNH:PRGX:ERZT:OK46:PMFX",
## "Ip": "0.0.0.0",
## "Addr": "http://0.0.0.0:4243",
## "Name": "vagrant-ubuntu-saucy-64",
## },
##
## see `Docker Reference of Swarm API <https://docs.docker.com/swarm/swarm-api/#endpoints-which-behave-differently>`_
var queries: seq[string] = @[]
if all:
add(queries, "all", "1")
if size:
add(queries, "size", "1")
if limit > -1:
add(queries, "limit", $limit)
if since != nil and since != "":
add(queries, "since", since)
if before != nil and before != "":
add(queries, "before", before)
var filters = newJObject()
if exitedFilters != nil:
var exiteds = newJArray()
for flt in exitedFilters:
add(exiteds, newJString($flt))
add(filters, "exited", exiteds)
if statusFilters != nil:
var statuses = newJArray()
for flt in statusFilters:
add(statuses, newJString(toLower(substr($flt, 4))))
add(filters, "status", statuses)
if labelFilters != nil:
var labels = newJArray()
for flt in labelFilters:
add(labels, newJString(flt))
add(filters, "label", labels)
add(queries, "filters", $filters)
let url = parseUri(c.scheme, c.hostname, c.port,
"/containers/json", queries)
let (res, body) = await request(c.httpclient, httpGET, url)
case res.statusCode:
of 200:
try:
result = parseJson(body)
except:
raise newException(ServerError, getCurrentExceptionMsg())
of 400:
raise newException(BadParameterError, body)
of 500:
raise newException(ServerError, body)
else:
raise newException(DockerError, body)
proc create*(c: AsyncDocker;
image: string;
cmd, entrypoint: seq[string] = nil;
name, hostname, domainname, user = "";
attachStdin, attachStdout, attachStderr = true;
tty, openStdin, stdinOnce = false;
labels: seq[tuple[key, value: string]] = nil;
workingDir, macAddress = "";
stopSignal = "SIGTERM";
networkDisabled = false;
env, exposedPorts, volumes, binds, links: seq[string] = nil;
memory, memorySwap, memoryReservation, kernelMemory = 0;
memorySwappiness = -1;
cpuShares, cpuPeriod, cpuQuota = 0;
cpusetCpus, cpusetMems = "";
blkioWeight = 0;
blkioWeightDevice: seq[tuple[path: string, weight: int]] = nil,
blkioDeviceReadBps: seq[tuple[path: string, rate: int]] = nil,
blkioDeviceWriteBps: seq[tuple[path: string, rate: int]] = nil,
blkioDeviceReadIOps: seq[tuple[path: string, rate: int]] = nil,
blkioDeviceWriteIOps: seq[tuple[path: string, rate: int]] = nil,
oomKillDisable = false,
oomScoreAdj = 0;
networkMode = "bridge";
portBindings: seq[tuple[port: string, hostPort: seq[string]]] = nil,
publishAllPorts, privileged, readonlyRootfs = false;
dns, dnsOptions, dnsSearch: seq[string] = nil;
extraHosts, volumesFrom, capAdd, capDrop: seq[string] = nil;
restartPolicy: tuple[name: RestartPolicy, maximumRetryCount: int] = (rpNo, 0);
securityOpt: seq[string] = nil;
cgroupParent, volumeDriver = "";
shmSize = 0;
ulimits: seq[tuple[name: string, soft: int, hard: int]] = nil;
devices: seq[tuple[pathOnHost, pathInContainer, cgroupPermissions: string]] = nil;
logConfig: tuple[typ: LogType, config: seq[tuple[key, value: string]]] = (logJsonFile, nil)
): Future[JsonNode] {.async.} =
## Create a container. see `Docker Reference <https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container>`_
##
## ``FutureError`` represents an exception, it may be ``NotFoundError``, ``NotAcceptableError``,
## ``ServerError`` or ``DockerError``.
##
## Request parameters:
##
## * ``image`` - A string specifying the image name to use for the container.
## * ``cmd`` - Command to run specified as a string or an array of strings.
## * ``name`` - Assign the specified name or id to the container.
## Must match `/?[a-zA-Z0-9_-]+`.
## * ``hostname`` - A string value containing the hostname to use for the container.
## * ``domainname`` - A string value containing the domain name to use for the container.
## * ``user`` - A string value specifying the user inside the container.
## * ``attachStdin`` - Boolean value, attaches to `stdin`.
## * ``attachStdout`` - Boolean value, attaches to `stdout`.
## * ``attachStderr`` - Boolean value, attaches to `stderr`.
## * ``tty`` - Boolean value, Attach standard streams to a `tty`, including `stdin` if it
## is not closed.
## * ``openStdin`` - Boolean value, opens stdin.
## * ``stdinOnce`` - Boolean value, close `stdin` after the 1 attached client disconnects.
## * ``env`` - A list of environment variables in the form of `@["VAR=value","VAR2=value2"]`.
## * ``entrypoint`` - Set the entry point for the container.
## * ``labels`` - Adds a map of labels to a container. To specify a map:
## `{"key":"value", "key2":"value2"}`.
## * ``workingDir`` - A string specifying the working directory for commands to run in.
## * ``stopSignal`` - Signal to stop a container as a string or unsigned integer. `SIGTERM`
## by default.
## * ``networkDisabled`` - Boolean value, when true disables networking for the container.
## * ``exposedPorts`` - Mapping ports in the form of: `"@["<port>/<tcp|udp>"]`.
## * ``volumes`` - A list of volume that you want mount for this container.
## * ``binds`` - A list of volume bindings for this container. Each volume binding is a
## string in one of these forms:
## * `container_path` to create a new volume for the container.
## * `host_path:container_path` to bind-mount a host path into the container.
## * `host_path:container_path:ro` to make the bind-mount read-only inside the container.
## * ``links`` - A list of links for the container. Each link entry should be in the
## form of `container_name:alias`.
## * ``memory`` - Memory limit in bytes.
## * ``memorySwap`` - Total memory limit (memory + swap); set `-1` to disable swap.
## You must use this with ``Memory`` and make the swap value larger than ``Memory``.
## * ``memoryReservation`` - Memory soft limit in bytes.
## * ``kernelMemory`` - Kernel memory limit in bytes.
## * ``cpuShares`` - An integer value containing the container’s CPU Shares (ie. the
## relative weight vs other containers).
## * ``cpuPeriod`` - The length of a CPU period in microseconds.
## * ``cpuQuota`` - Microseconds of CPU time that the container can get in a CPU period.
## * ``cpuset`` - Deprecated please don’t use. Use ``CpusetCpus`` instead.
## * ``cpusetCpus`` - String value containing the `cgroups CpusetCpus` to use.
## * ``cpusetMems`` - Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only
## effective on NUMA systems.
## * ``blkioWeight`` - Block IO weight (relative weight) accepts a weight value between
## 10 and 1000.
## * ``memorySwappiness`` - Tune a container’s memory swappiness behavior. Accepts an
## integer between 0 and 100.
## * ``blkioWeightDevice`` - Block IO weight (relative device weight) in the form of:
## `@[("Path": "device_path", "Weight": weight)]`.
## * ``blkioDeviceReadBps`` - Limit read rate (bytes per second) from a device in the
## form of: `@[("Path": "device_path", "Rate": rate)]`.
## * ``blkioDeviceWriteBps`` - Limit write rate (bytes per second) to a device in the
## form of: `@[("Path": "device_path", "Rate": rate)]`.
## * ``blkioDeviceReadIOps`` - Limit read rate (IO per second) from a device in the
## form of: `@[("Path": "device_path", "Rate": rate)]`.
## * ``blkioDeviceWriteIOps`` - Limit write rate (IO per second) to a device in the
## form of: `@[("Path": "device_path", "Rate": rate)]`.
## * ``oomKillDisable`` - Boolean value, whether to disable OOM Killer for the container
## or not.
## * ``OomScoreAdj`` - An integer value containing the score given to the container in
## order to tune OOM killer preferences.
## * ``networkMode`` - Sets the networking mode for the container. Supported values are:
## `bridge`, `host`, and `container:<name|id>`.
## * ``portBindings`` - A map of exposed container ports.
## * ``publishAllPorts`` - Allocates a random host port for all of a container’s exposed
## ports.Specified as a boolean value.
## * ``privileged`` - Gives the container full access to the host. Specified as a boolean value.
## * ``readonlyRootfs`` - Mount the container’s root filesystem as read only. Specified as
## a boolean value.
## * ``dns`` - A list of DNS servers for the container to use.
## * ``dnsOptions`` - A list of DNS options.
## * ``dnsSearch`` - A list of DNS search domains
## * ``extraHosts`` - A list of hostnames/IP mappings to add to the container’s `/etc/hosts`
## file. Specified in the form `["hostname:IP"]`.
## * ``volumesFrom`` - A list of volumes to inherit from another container. Specified in the
## form `<container name>[:<ro|rw>]`.
## * ``capAdd`` - A list of kernel capabilities to add to the container.
## * ``capdrop`` - A list of kernel capabilities to drop from the container.
## * ``restartPolicy`` - The behavior to apply when the container exits. The value is an object
## with a `Name` property of either `"always"` to always restart, `"unless-stopped"` to
## restart always except when user has manually stopped the container or `"on-failure"` to
## restart only when the container exit code is non-zero. If `on-failure` is used, `MaximumRetryCount`
## controls the number of times to retry before giving up. The default is not to restart.
## (optional) An ever increasingdelay (double the previous delay, starting at 100mS) is added
## before each restart to prevent flooding the server.
## * ``securityOpt`` - A list of string values to customize labels for MLS systems, such as SELinux.
## * ``cgroupParent`` - Path to `cgroups` under which the container’s `cgroup` is created. If the
## path is not absolute, the path is considered to be relative to the `cgroups` path of the init
## process. Cgroups are created if they do not already exist.
## * ``volumeDriver`` - Driver that this container users to mount volumes.
## * ``ShmSize`` - Size of /dev/shm in bytes. The size must be greater than 0. If omitted the
## system uses 64MB.
## * ``ulimits`` - A list of ulimits to set in the container, specified as
## `( "Name": <name>, "Soft": <soft limit>, "Hard": <hard limit> )`.
## * ``devices`` - A list of devices to add to the container specified in the form
## `( "PathOnHost": "/dev/deviceName", "PathInContainer": "/dev/deviceName", "CgroupPermissions": "mrw")`.
## * ``logConfig`` - Log configuration for the container, specified in the form
## `( "Type": "<driver_name>", "Config": {"key1": "val1"})`. Available types: `json-file`, `syslog`,
## `journald`, `gelf`, `awslogs`, `none`. `json-file` logging driver.
##
## Result is a JSON object, the internal members of which depends on the version of your docker engine.
## For example:
##
## .. code-block:: nim
##
## {
## "Id":"e90e34656806",
## "Warnings":[]
## }
##
## **Note:** the official documentation of ``Mounts`` is invalid. Use ``Volumes`` or ``Binds``
## to mount for your container. For example:
##
## .. code-block:: nim
##
## var ret = await docker.create(image = "ubuntu:14.10",
## cmd = @["/bin/bash", "-c", "echo", "hello"],
## exposedPorts = @["22/tcp"],
## volumes = @["/tmp", "/data"],
## portBindings = @[("5000", @["5000"])])
## echo "Container Id: ", ret["Id"].getStr()
##
## equivalent to:
##
## .. code-block:: nim
##
## docker create --expose 22/tcp \
## --volumes /tmp --volumes /store \
## --publish 5000:5000 \
## ubuntu:14.10 /bin/bash -c 'echo hello'
##
## In the above example, docker engine will copy files from `/tmp` and `/data` to container volumes.
##
## But following example does not copy (just mounting):
##
## .. code-block:: nim
##
## var ret = await docker.create(image = "ubuntu:14.10",
## cmd = @["/bin/bash", "-c", "echo", "hello"],
## exposedPorts = @["22/tcp"],
## binds = @["/tmp:/tmp:ro", "/store:/data:rw"],
## portBindings = @[("5000", @["5000"])])
## echo "Container Id: ", ret["Id"].getStr()
##
## equivalent to:
##
## .. code-block:: nim
##
## docker create --expose 22/tcp \
## --volumes /tmp:/tmp:ro --volumes /store:/data:rw \
## --publish 5000:5000 \
## ubuntu:14.10 /bin/bash -c 'echo hello'
var queries: seq[string] = @[]
if name != nil and name != "":
add(queries, "name", name)
var jbody = newJObject()
add(jbody, "Image", %image)
add(jbody, "Cmd", cmd)
add(jbody, "Hostname", %hostname)
add(jbody, "Domainname", %domainname)
add(jbody, "User", %user)
add(jbody, "AttachStdin", %attachStdin)
add(jbody, "AttachStdout", %attachStdout)
add(jbody, "AttachStderr", %attachStderr)
add(jbody, "Tty", %tty)
add(jbody, "OpenStdin", %openStdin)
add(jbody, "StdinOnce", %stdinOnce)
add(jbody, "Env", env)
add(jbody, "Entrypoint", entrypoint)
add(jbody, "Labels", labels)
add(jbody, "WorkingDir", %workingDir)
add(jbody, "MacAddress", %macAddress)
add(jbody, "StopSignal", %stopSignal)
add(jbody, "NetworkDisabled", %networkDisabled)
var jExposedPorts = newJObject()
for i in exposedPorts:
add(jExposedPorts, i, newJObject())
add(jbody, "ExposedPorts", jExposedPorts)
var jVolumes = newJObject()
for i in volumes:
add(jVolumes, i, newJObject())
add(jbody, "Volumes", jVolumes)
# <HostConfig>
var jHostConfig = newJObject()
add(jHostConfig, "Binds", binds)
add(jHostConfig, "Links", links)
add(jHostConfig, "Memory", %memory)
add(jHostConfig, "MemorySwap", %memorySwap)
add(jHostConfig, "MemoryReservation", %memoryReservation)
add(jHostConfig, "KernelMemory", %kernelMemory)
add(jHostConfig, "CpuShares", %cpuShares)
add(jHostConfig, "CpuPeriod", %cpuPeriod)
add(jHostConfig, "CpuQuota", %cpuQuota)
add(jHostConfig, "BlkioWeight", %blkioWeight)
add(jHostConfig, "CpusetCpus", %cpusetCpus)
add(jHostConfig, "CpusetMems", %cpusetMems)
add(jHostConfig, "MemorySwappiness", %memorySwappiness)
var JBlkioWeightDevice = newJArray()
for i in blkioWeightDevice:
var j = newJObject()
add(j, "Path", %i.path)
add(j, "Weight", %($i.weight))
add(JBlkioWeightDevice, j)
add(jHostConfig, "BlkioWeightDevice", JBlkioWeightDevice)
var jBlkioDeviceReadBps = newJArray()
for i in blkioDeviceReadBps:
var j = newJObject()
add(j, "Path", %i.path)
add(j, "Rate", %($i.rate))
add(jBlkioDeviceReadBps, j)
add(jHostConfig, "BlkioDeviceReadBps", jBlkioDeviceReadBps)
var jBlkioDeviceWriteBps = newJArray()
for i in blkioDeviceWriteBps:
var j = newJObject()
add(j, "Path", %i.path)
add(j, "Rate", %($i.rate))
add(jBlkioDeviceReadBps, j)
add(jHostConfig, "BlkioDeviceWriteBps", jBlkioDeviceWriteBps)
var jBlkioDeviceReadIOps = newJArray()
for i in blkioDeviceReadIOps:
var j = newJObject()
add(j, "Path", %i.path)
add(j, "Rate", %($i.rate))
add(jBlkioDeviceReadIOps, j)
add(jHostConfig, "BlkioDeviceReadIOps", jBlkioDeviceReadIOps)
var jBlkioDeviceWriteIOps = newJArray()
for i in blkioDeviceWriteIOps:
var j = newJObject()
add(j, "Path", %i.path)
add(j, "Rate", %($i.rate))
add(jBlkioDeviceWriteIOps, j)
add(jHostConfig, "BlkioDeviceWiiteIOps", jBlkioDeviceWriteIOps)
add(jHostConfig, "OomKillDisable", %oomKillDisable)
add(jHostConfig, "OomScoreAdj", %oomScoreAdj)
add(jHostConfig, "NetworkMode", %networkMode)
var jPortBindings = newJObject()
for i in portBindings:
var a = newJArray()
for n in i.hostPort:
var b = newJObject()
add(b, "HostPort", %n)
add(a, b)
add(jPortBindings, i.port, a)
add(jHostConfig, "PortBindings", jPortBindings)
add(jHostConfig, "PublishAllPorts", %publishAllPorts)
add(jHostConfig, "Privileged", %privileged)
add(jHostConfig, "ReadonlyRootfs", %readonlyRootfs)
add(jHostConfig, "Dns", dns)
add(jHostConfig, "DnsOptions", dnsOptions)
add(jHostConfig, "DnsSearch", dnsSearch)
add(jHostConfig, "ExtraHosts", extraHosts)
add(jHostConfig, "VolumesFrom", volumesFrom)
add(jHostConfig, "CapAdd", capAdd)
add(jHostConfig, "CapDrop", capDrop)
var jRestartPolicy = newJObject()
add(jRestartPolicy, "Name", %($restartPolicy.name))
add(jRestartPolicy, "MaximumRetryCount", %restartPolicy.maximumRetryCount)
add(jHostConfig, "RestartPolicy", jRestartPolicy)
add(jHostConfig, "SecurityOpt", securityOpt)
add(jHostConfig, "CgroupParent", %cgroupParent)
add(jHostConfig, "VolumeDrive", %volumeDriver)
add(jHostConfig, "ShmSize", %shmSize)
var jUlimits = newJArray()
for i in ulimits:
var j = newJObject()
add(j, "Name", %i.name)
add(j, "Soft", %i.soft)
add(j, "Hard", %i.hard)
add(jUlimits, j)
add(jHostConfig, "Ulimits", jUlimits)
var jDevices = newJArray()
for i in devices:
var j = newJObject()
add(j, "PathOnHost", %i.pathOnHost)
add(j, "PathInContainer", %i.pathInContainer)
add(j, "CgroupPermissions", %i.cgroupPermissions)
add(jDevices, j)
add(jHostConfig, "Devices", jDevices)
var jLogConfig = newJObject()
var jLogConfigCfg = newJObject()
for i in logConfig.config:
var j = newJObject()
add(jLogConfigCfg, i.key, %i.value)
add(jLogConfig, "Type", %($logConfig.typ))
add(jLogConfig, "Config", jLogConfigCfg)
add(jHostConfig, "LogConfig", jLogConfig)
# </HostConfig>
add(jbody, "HostConfig", jHostConfig)
# echo "------------"
# echo pretty(jbody)
# echo "------------"
let reqBody = $jbody
let url = parseUri(c.scheme, c.hostname, c.port,
"/containers/create", queries)
let headers = newStringTable({"Content-Type": "application/json", "Content-Length": $(len(reqBody))})
let (res, body) = await request(c.httpclient, httpPOST, url, headers, reqBody)
case res.statusCode:
of 201:
try:
result = parseJson(body)
except:
raise newException(ServerError, getCurrentExceptionMsg())
of 404:
raise newException(NotFoundError, body)
of 406:
raise newException(NotAcceptableError, body)
of 500:
raise newException(ServerError, body)
else:
raise newException(DockerError, body)
proc inspect*(c: AsyncDocker, name: string, size = false): Future[JsonNode] {.async.} =
## Return low-level information on the container `name` (name or id). see `Docker Reference <https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#inspect-a-container>`_
##
## ``FutureError`` represents an exception, it may be ``NotFoundError``, ``ServerError``
## or ``DockerError``.
##
## Request parameters:
##
## * ``name`` - The container name or id.
## * ``size`` - Return container size information.
##
## Result is a JSON object, the internal members of which depends on the version of your docker engine.
## For example:
##
## .. code-block:: nim
##
## {
## "AppArmorProfile": "",
## "Args": [
## "-c",
## "exit 9"
## ],
## "Config": {
## "AttachStderr": true,
## "AttachStdin": false,
## "AttachStdout": true,
## "Cmd": [
## "/bin/sh",
## "-c",
## "exit 9"
## ],
## "Domainname": "",
## "Entrypoint": null,
## "Env": [
## "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
## ],
## "ExposedPorts": null,
## "Hostname": "ba033ac44011",
## "Image": "ubuntu",
## "Labels": {
## "com.example.vendor": "Acme",
## "com.example.license": "GPL",
## "com.example.version": "1.0"
## },
## "MacAddress": "",
## "NetworkDisabled": false,
## "OnBuild": null,
## "OpenStdin": false,
## "StdinOnce": false,
## "Tty": false,
## "User": "",
## "Volumes": null,
## "WorkingDir": "",
## "StopSignal": "SIGTERM"
## },
## "Created": "2015-01-06T15:47:31.485331387Z",
## "Driver": "devicemapper",
## "ExecDriver": "native-0.2",
## "ExecIDs": null,
## "HostConfig": {
## "Binds": null,
## "BlkioWeight": 0,
## "CapAdd": null,
## "CapDrop": null,
## "ContainerIDFile": "",
## "CpusetCpus": "",
## "CpusetMems": "",
## "CpuShares": 0,
## "CpuPeriod": 100000,
## "Devices": [],
## "Dns": null,
## "DnsOptions": null,
## "DnsSearch": null,
## "ExtraHosts": null,
## "IpcMode": "",
## "Links": null,
## "LxcConf": [],
## "Memory": 0,
## "MemorySwap": 0,
## "MemoryReservation": 0,
## "KernelMemory": 0,
## "OomKillDisable": false,
## "NetworkMode": "bridge",
## "PortBindings": {},
## "Privileged": false,
## "ReadonlyRootfs": false,
## "PublishAllPorts": false,
## "RestartPolicy": {
## "MaximumRetryCount": 2,
## "Name": "on-failure"
## },
## "LogConfig": {
## "Config": null,