forked from withfig/autocomplete
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdocker.ts
5376 lines (5366 loc) · 143 KB
/
docker.ts
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
const postProcessDockerPs: Fig.Generator["postProcess"] = (out) => {
return out.split("\n").map((i) => {
try {
const parsedJSON: Record<string, string> = JSON.parse(i);
return {
name: parsedJSON.ID,
displayName: `${parsedJSON.ID} (${parsedJSON.Image})`,
icon: "fig://icon?type=docker",
};
} catch (error) {
console.error(error);
}
});
};
const sharedPostProcess: Fig.Generator["postProcess"] = (out) => {
return out
.split("\n")
.map((line) => JSON.parse(line))
.map((i) => ({
name: i.Name,
description: i.ID,
icon: "fig://icon?type=docker",
}));
};
const dockerGenerators: Record<string, Fig.Generator> = {
runningDockerContainers: {
script: `docker ps --format '{{ json . }}'`,
postProcess: postProcessDockerPs,
},
allDockerContainers: {
script: `docker ps -a --format '{{ json . }}'`,
postProcess: postProcessDockerPs,
},
pausedDockerContainers: {
script: `docker ps --filter status=paused --format '{{ json . }}'`,
postProcess: postProcessDockerPs,
},
allLocalImages: {
script: `docker image ls --format '{{ json . }}'`,
postProcess: function (out) {
return out
.split("\n")
.map((line) => JSON.parse(line))
.map((i) => ({
name: `${i.ID}`,
displayName: `${i.Repository} - ${i.ID}`,
icon: "fig://icon?type=docker",
}));
},
},
dockerHubSearch: {
script: function (context) {
if (context[context.length - 1] === "") return "";
const searchTerm = context[context.length - 1];
return `docker search ${searchTerm} --format '{{ json . }}'`;
},
postProcess: function (out) {
return out
.split("\n")
.map((line) => JSON.parse(line))
.map((i) => ({
name: `${i.Name}`,
icon: "fig://icon?type=docker",
}));
},
trigger: function () {
return true;
},
},
allDockerContexts: {
script: `docker context list --format '{{ json . }}'`,
postProcess: function (out) {
return out
.split("\n")
.map((line) => JSON.parse(line))
.map((i) => ({
name: i.Name,
description: i.Description,
icon: "fig://icon?type=docker",
}));
},
},
listDockerNetworks: {
script: `docker network list --format '{{ json . }}'`,
postProcess: sharedPostProcess,
},
listDockerSwarmNodes: {
script: `docker node list --format '{{ json . }}'`,
postProcess: function (out) {
return out
.split("\n")
.map((line) => JSON.parse(line))
.map((i) => ({
name: i.ID,
displayName: `${i.ID} - ${i.Hostname}`,
description: i.Status,
icon: "fig://icon?type=docker",
}));
},
},
listDockerPlugins: {
script: `docker plugin list --format '{{ json . }}'`,
postProcess: sharedPostProcess,
},
listDockerSecrets: {
script: `docker secret list --format '{{ json . }}'`,
postProcess: sharedPostProcess,
},
listDockerServices: {
script: `docker service list --format '{{ json . }}'`,
postProcess: function (out) {
return out
.split("\n")
.map((line) => JSON.parse(line))
.map((i) => ({
name: i.Name,
description: i.Image,
icon: "fig://icon?type=docker",
}));
},
},
listDockerServicesReplicas: {
script: `docker service list --format '{{ json . }}'`,
postProcess: function (out) {
return out
.split("\n")
.map((line) => JSON.parse(line))
.map((i) => ({
name: `${i.Name}=`,
description: i.Image,
icon: "fig://icon?type=docker",
}));
},
},
listDockerStacks: {
script: `docker stack list --format '{{ json . }}'`,
postProcess: function (out) {
return out
.split("\n")
.map((line) => JSON.parse(line))
.map((i) => ({
name: i.Name,
icon: "fig://icon?type=docker",
}));
},
},
listDockerVolumes: {
script: `docker volume list --format '{{ json . }}'`,
postProcess: function (out) {
return out
.split("\n")
.map((line) => JSON.parse(line))
.map((i) => ({
name: i.Name,
icon: "fig://icon?type=docker",
}));
},
},
};
const containersArg = {
name: "container",
generators: [dockerGenerators.runningDockerContainers],
};
const imagesArg = {
name: "image",
generators: [dockerGenerators.allLocalImages],
};
const containerAndCommandArgs = [
containersArg,
{
name: "command",
isCommand: true,
},
];
const contextsArg = {
name: "CONTEXT",
generators: [dockerGenerators.allDockerContexts],
};
const sharedCommands: Record<string, Fig.Subcommand> = {
build: {
name: "build",
description: "Build an image from a Dockerfile",
args: {
name: "path",
generators: [
{
template: "folders",
},
],
},
options: [
{
name: "--add-host",
args: {
name: "list",
description: "Add a custom host-to-IP mapping (host:ip)",
},
},
{
name: "--build-arg",
args: {
name: "list",
description: "Set build-time variables",
},
},
{
name: "--cache-from",
args: {
name: "strings",
description: "Images to consider as cache sources",
},
},
{
name: "--disable-content-trust",
description: "Skip image verification (default true)",
},
{
name: ["-f", "--file"],
description: "Name of the Dockerfile (Default is 'PATH/Dockerfile')",
args: {
name: "string",
generators: [
{
template: "filepaths",
},
],
},
},
{
name: "--iidfile",
description: "Write the image ID to the file",
args: {
name: "string",
},
},
{
name: "--isolation",
description: "Container isolation technology",
args: {
name: "string",
},
},
{
name: "--label",
description: "Set metadata for an image",
args: {
name: "list",
},
},
{
name: "--network",
description:
'Set the networking mode for the RUN instructions during build (default "default")',
args: {
name: "string",
},
},
{
name: "--no-cache",
description: "Do not use cache when building the image",
},
{
name: ["-o", "--output"],
description: "Output destination (format: type=local,dest=path)",
args: {
name: "stringArray",
},
},
{
name: "--platform",
description: "Set platform if server is multi-platform capable",
args: {
name: "string",
},
},
{
name: "--progress",
description:
"Set type of progress output (auto, plain, tty). Use plain to show container output",
args: {
name: "string",
suggestions: ["auto", "plain", "tty"].map((i) => ({ name: i })),
},
},
{
name: "--pull",
description: "Always attempt to pull a newer version of the image",
},
{
name: ["-q", "--quiet"],
description: "Suppress the build output and print image ID on success",
},
{
name: "--secret",
description: `Secret file to expose to the build (only if BuildKit enabled): id=mysecret,src=/local/secret`,
args: {
name: "stringArray",
},
},
{
name: "--squash",
description: "Squash newly built layers into a single new layer",
},
{
name: "--ssh",
description: `SSH agent socket or keys to expose to the build (only if BuildKit enabled) (format: default|<id>[=<socket>|<key>[,<key>]])`,
args: {
name: "stringArray",
},
},
{
name: ["-t", "--tag"],
description: "Name and optionally a tag in the 'name:tag' format",
},
{
name: "--target",
description: "Set the target build stage to build",
args: {
name: "target build stage",
generators: [
{
trigger: function () {
return true;
},
script: function (context) {
let fileFlagIndex, dockerfilePath;
if (context.includes("-f")) {
fileFlagIndex = context.indexOf("-f");
dockerfilePath = context[fileFlagIndex + 1];
} else if (context.includes("--file")) {
fileFlagIndex = context.indexOf("--file");
dockerfilePath = context[fileFlagIndex + 1];
} else {
dockerfilePath = "$PWD/Dockerfile";
}
return `grep -iE 'FROM.*AS' "${dockerfilePath}"`;
},
postProcess: function (out) {
// This just searches the Dockerfile for the alias name after AS,
// and due to the grep above, will only match lines where FROM and AS
// are on the same line. This could certainly be made more robust
// down the line.
const imageNameRegexp = /(?:[aA][sS]\s+)([\w:.-]+)/;
return out
.split("\n")
.map((i) => {
const result = imageNameRegexp.exec(i);
if (result) {
return {
name: result[1],
};
}
})
.filter((i) => i !== undefined);
},
},
],
},
},
],
},
create: {
name: "create",
description: "Create a new container",
args: [
{
name: "container",
generators: [dockerGenerators.allLocalImages],
},
{
name: "command",
isCommand: true,
},
],
options: [
{
args: {
name: "list",
},
description: "Add a custom host-to-IP mapping (host:ip)",
name: ["--add-host"],
},
{
args: {
name: "list",
},
description: "Attach to STDIN, STDOUT or STDERR",
name: ["-a", "--attach"],
},
{
args: {
name: "uint16",
},
description:
"Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)",
name: ["--blkio-weight"],
},
{
args: {
name: "list",
},
description: "Block IO weight (relative device weight) (default [])",
name: ["--blkio-weight-device"],
},
{
args: {
name: "list",
},
description: "Add Linux capabilities",
name: ["--cap-add"],
},
{
args: {
name: "list",
},
description: "Drop Linux capabilities",
name: ["--cap-drop"],
},
{
args: {
name: "string",
},
description: "Optional parent cgroup for the container",
name: ["--cgroup-parent"],
},
{
args: {
name: "string",
},
description: "Cgroup namespace to use (host|private)",
name: ["--cgroupns"],
},
{
args: {
name: "string",
},
description: "Write the container ID to the file",
name: ["--cidfile"],
},
{
args: {
name: "int",
},
description: "Limit CPU CFS (Completely Fair Scheduler) period",
name: ["--cpu-period"],
},
{
args: {
name: "int",
},
description: "Limit CPU CFS (Completely Fair Scheduler) quota",
name: ["--cpu-quota"],
},
{
args: {
name: "int",
},
description: "Limit CPU real-time period in microseconds",
name: ["--cpu-rt-period"],
},
{
args: {
name: "int",
},
description: "Limit CPU real-time runtime in microseconds",
name: ["--cpu-rt-runtime"],
},
{
args: {
name: "int",
},
description: "CPU shares (relative weight)",
name: ["-c", "--cpu-shares"],
},
{
args: {
name: "decimal",
},
description: "Number of CPUs",
name: ["--cpus"],
},
{
args: {
name: "string",
},
description: "CPUs in which to allow execution (0-3, 0,1)",
name: ["--cpuset-cpus"],
},
{
args: {
name: "string",
},
description: "MEMs in which to allow execution (0-3, 0,1)",
name: ["--cpuset-mems"],
},
{
args: {
name: "list",
},
description: "Add a host device to the container",
name: ["--device"],
},
{
args: {
name: "list",
},
description: "Add a rule to the cgroup allowed devices list",
name: ["--device-cgroup-rule"],
},
{
args: {
name: "list",
},
description:
"Limit read rate (bytes per second) from a device (default [])",
name: ["--device-read-bps"],
},
{
args: {
name: "list",
},
description:
"Limit read rate (IO per second) from a device (default [])",
name: ["--device-read-iops"],
},
{
args: {
name: "list",
},
description:
"Limit write rate (bytes per second) to a device (default [])",
name: ["--device-write-bps"],
},
{
args: {
name: "list",
},
description:
"Limit write rate (IO per second) to a device (default [])",
name: ["--device-write-iops"],
},
{
description: "Skip image verification (default true)",
name: ["--disable-content-trust"],
},
{
args: {
name: "list",
},
description: "Set custom DNS servers",
name: ["--dns"],
},
{
args: {
name: "list",
},
description: "Set DNS options",
name: ["--dns-option"],
},
{
args: {
name: "list",
},
description: "Set custom DNS search domains",
name: ["--dns-search"],
},
{
args: {
name: "string",
},
description: "Container NIS domain name",
name: ["--domainname"],
},
{
args: {
name: "string",
},
description: "Overwrite the default ENTRYPOINT of the image",
name: ["--entrypoint"],
},
{
args: {
name: "list",
},
description: "Set environment variables",
name: ["-e", "--env"],
},
{
args: {
name: "list",
},
description: "Read in a file of environment variables",
name: ["--env-file"],
},
{
args: {
name: "list",
},
description: "Expose a port or a range of ports",
name: ["--expose"],
},
{
args: {
name: "gpu-request",
},
description:
"GPU devices to add to the container ('all' to pass all GPUs)",
name: ["--gpus"],
},
{
args: {
name: "list",
},
description: "Add additional groups to join",
name: ["--group-add"],
},
{
args: {
name: "string",
},
description: "Command to run to check health",
name: ["--health-cmd"],
},
{
args: {
name: "duration",
},
description: "Time between running the check (ms|s|m|h) (default 0s)",
name: ["--health-interval"],
},
{
args: {
name: "int",
},
description: "Consecutive failures needed to report unhealthy",
name: ["--health-retries"],
},
{
args: {
name: "duration",
},
description:
"Start period for the container to initialize before starting health-retries countdown (ms|s|m|h) (default 0s)",
name: ["--health-start-period"],
},
{
args: {
name: "duration",
},
description:
"Maximum time to allow one check to run (ms|s|m|h) (default 0s)",
name: ["--health-timeout"],
},
{
description: "Print usage",
name: ["--help"],
},
{
args: {
name: "string",
},
description: "Container host name",
name: ["-h", "--hostname"],
},
{
description:
"Run an init inside the container that forwards signals and reaps processes",
name: ["--init"],
},
{
description: "Keep STDIN open even if not attached",
name: ["-i", "--interactive"],
},
{
args: {
name: "string",
},
description: "IPv4 address (e.g., 172.30.100.104)",
name: ["--ip"],
},
{
args: {
name: "string",
},
description: "IPv6 address (e.g., 2001:db8::33)",
name: ["--ip6"],
},
{
args: {
name: "string",
},
description: "IPC mode to use",
name: ["--ipc"],
},
{
args: {
name: "string",
},
description: "Container isolation technology",
name: ["--isolation"],
},
{
args: {
name: "bytes",
},
description: "Kernel memory limit",
name: ["--kernel-memory"],
},
{
args: {
name: "list",
},
description: "Set meta data on a container",
name: ["-l", "--label"],
},
{
args: {
name: "list",
},
description: "Read in a line delimited file of labels",
name: ["--label-file"],
},
{
args: {
name: "list",
},
description: "Add link to another container",
name: ["--link"],
},
{
args: {
name: "list",
},
description: "Container IPv4/IPv6 link-local addresses",
name: ["--link-local-ip"],
},
{
args: {
name: "string",
},
description: "Logging driver for the container",
name: ["--log-driver"],
},
{
args: {
name: "list",
},
description: "Log driver options",
name: ["--log-opt"],
},
{
args: {
name: "string",
},
description: "Container MAC address (e.g., 92:d0:c6:0a:29:33)",
name: ["--mac-address"],
},
{
args: {
name: "bytes",
},
description: "Memory limit",
name: ["-m", "--memory"],
},
{
args: {
name: "bytes",
},
description: "Memory soft limit",
name: ["--memory-reservation"],
},
{
args: {
name: "bytes",
},
description:
"Swap limit equal to memory plus swap: '-1' to enable unlimited swap",
name: ["--memory-swap"],
},
{
args: {
name: "int",
},
description: "Tune container memory swappiness (0 to 100) (default -1)",
name: ["--memory-swappiness"],
},
{
args: {
name: "mount",
},
description: "Attach a filesystem mount to the container",
name: ["--mount"],
},
{
args: {
name: "string",
},
description: "Assign a name to the container",
name: ["--name"],
},
{
args: {
name: "network",
},
description: "Connect a container to a network",
name: ["--network"],
},
{
args: {
name: "list",
},
description: "Add network-scoped alias for the container",
name: ["--network-alias"],
},
{
description: "Disable any container-specified HEALTHCHECK",
name: ["--no-healthcheck"],
},
{
description: "Disable OOM Killer",
name: ["--oom-kill-disable"],
},
{
args: {
name: "int",
},
description: "Tune host's OOM preferences (-1000 to 1000)",
name: ["--oom-score-adj"],
},
{
args: {
name: "string",
},
description: "PID namespace to use",
name: ["--pid"],
},
{
args: {
name: "int",
},
description: "Tune container pids limit (set -1 for unlimited)",
name: ["--pids-limit"],
},
{
args: {
name: "string",
},
description: "Set platform if server is multi-platform capable",
name: ["--platform"],
},
{
description: "Give extended privileges to this container",
name: ["--privileged"],
},
{
args: {
name: "list",
},
description: "Publish a container's port(s) to the host",
name: ["-p", "--publish"],
},
{
description: "Publish all exposed ports to random ports",
name: ["-P", "--publish-all"],
},
{
args: {
name: "string",
},
description:
'Pull image before creating ("always"|"missing"|"never") (default "missing")',
name: ["--pull"],
},
{
description: "Mount the container's root filesystem as read only",
name: ["--read-only"],
},
{
args: {
name: "string",
},
description:
'Restart policy to apply when a container exits (default "no")',
name: ["--restart"],
},
{
description: "Automatically remove the container when it exits",
name: ["--rm"],
},
{
args: {
name: "string",
},
description: "Runtime to use for this container",
name: ["--runtime"],
},
{
args: {
name: "list",
},
description: "Security Options",
name: ["--security-opt"],
},
{
args: {
name: "bytes",
},
description: "Size of /dev/shm",
name: ["--shm-size"],
},
{
args: {
name: "string",
},
description: 'Signal to stop a container (default "SIGTERM")',
name: ["--stop-signal"],
},
{
args: {
name: "int",
},
description: "Timeout (in seconds) to stop a container",
name: ["--stop-timeout"],
},
{
args: {
name: "list",
},
description: "Storage driver options for the container",
name: ["--storage-opt"],
},
{
args: {
name: "map",
},
description: "Sysctl options (default map[])",
name: ["--sysctl"],
},
{
args: {
name: "list",
},
description: "Mount a tmpfs directory",
name: ["--tmpfs"],
},
{
description: "Allocate a pseudo-TTY",
name: ["-t", "--tty"],
},
{
args: {
name: "ulimit",
},
description: "Ulimit options (default [])",
name: ["--ulimit"],
},
{
args: {
name: "string",
},
description: "Username or UID (format: <name|uid>[:<group|gid>])",
name: ["-u", "--user"],
},
{
args: {
name: "string",
},
description: "User namespace to use",
name: ["--userns"],
},
{
args: {
name: "string",
},
description: "UTS namespace to use",
name: ["--uts"],
},
{
args: {
name: "list",
},
description: "Bind mount a volume",
name: ["-v", "--volume"],
},
{
args: {
name: "string",
},
description: "Optional volume driver for the container",
name: ["--volume-driver"],
},
{