@pulumi/docker 3.1.0-alpha.1626976245 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/types/output.d.ts CHANGED
@@ -1,204 +1,84 @@
1
1
  import { output as outputs } from "../types";
2
2
  export interface ContainerCapabilities {
3
- /**
4
- * list of linux capabilities to add.
5
- */
6
3
  adds?: string[];
7
- /**
8
- * list of linux capabilities to drop.
9
- */
10
4
  drops?: string[];
11
5
  }
12
6
  export interface ContainerDevice {
13
- /**
14
- * The path in the container where the
15
- * device will be binded.
16
- */
17
7
  containerPath?: string;
18
- /**
19
- * The path on the host where the device
20
- * is located.
21
- */
22
8
  hostPath: string;
23
- /**
24
- * The cgroup permissions given to the
25
- * container to access the device.
26
- * Defaults to `rwm`.
27
- */
28
9
  permissions?: string;
29
10
  }
30
11
  export interface ContainerHealthcheck {
31
- /**
32
- * Time between running the check `(ms|s|m|h)`. Default: `0s`.
33
- */
34
12
  interval?: string;
35
- /**
36
- * Consecutive failures needed to report unhealthy. Default: `0`.
37
- */
38
13
  retries?: number;
39
- /**
40
- * Start period for the container to initialize before counting retries towards unstable `(ms|s|m|h)`. Default: `0s`.
41
- */
42
14
  startPeriod?: string;
43
- /**
44
- * Command to run to check health. For example, to run `curl -f http://localhost/health` set the
45
- * command to be `["CMD", "curl", "-f", "http://localhost/health"]`.
46
- */
47
15
  tests: string[];
48
- /**
49
- * Maximum time to allow one check to run `(ms|s|m|h)`. Default: `0s`.
50
- */
51
16
  timeout?: string;
52
17
  }
53
18
  export interface ContainerHost {
54
- /**
55
- * Hostname to add.
56
- */
57
19
  host: string;
58
- /**
59
- * IP address this hostname should resolve to.
60
- */
61
20
  ip: string;
62
21
  }
63
22
  export interface ContainerLabel {
64
- /**
65
- * Name of the label
66
- */
67
23
  label: string;
68
- /**
69
- * Value of the label
70
- */
71
24
  value: string;
72
25
  }
73
26
  export interface ContainerMount {
74
- /**
75
- * Optional configuration for the `bind` type.
76
- */
77
27
  bindOptions?: outputs.ContainerMountBindOptions;
78
- /**
79
- * If true, this volume will be readonly.
80
- * Defaults to false.
81
- */
82
28
  readOnly?: boolean;
83
- /**
84
- * The mount source (e.g., a volume name, a host path)
85
- */
86
29
  source?: string;
87
- /**
88
- * The container path.
89
- */
90
30
  target: string;
91
- /**
92
- * Optional configuration for the `tmpf` type.
93
- */
94
31
  tmpfsOptions?: outputs.ContainerMountTmpfsOptions;
95
- /**
96
- * The mount type: valid values are `bind|volume|tmpfs`.
97
- */
98
32
  type: string;
99
- /**
100
- * Optional configuration for the `volume` type.
101
- */
102
33
  volumeOptions?: outputs.ContainerMountVolumeOptions;
103
34
  }
104
35
  export interface ContainerMountBindOptions {
105
- /**
106
- * A propagation mode with the value.
107
- */
108
36
  propagation?: string;
109
37
  }
110
38
  export interface ContainerMountTmpfsOptions {
111
- /**
112
- * The permission mode for the tmpfs mount in an integer.
113
- */
114
39
  mode?: number;
115
- /**
116
- * The size for the tmpfs mount in bytes.
117
- */
118
40
  sizeBytes?: number;
119
41
  }
120
42
  export interface ContainerMountVolumeOptions {
121
43
  driverName?: string;
122
- /**
123
- * Options for the driver.
124
- */
125
44
  driverOptions?: {
126
45
  [key: string]: string;
127
46
  };
128
- /**
129
- * Adding labels.
130
- */
131
47
  labels?: outputs.ContainerMountVolumeOptionsLabel[];
132
- /**
133
- * Whether to populate volume with data from the target.
134
- */
135
48
  noCopy?: boolean;
136
49
  }
137
50
  export interface ContainerMountVolumeOptionsLabel {
138
- /**
139
- * Name of the label
140
- */
141
51
  label: string;
142
- /**
143
- * Value of the label
144
- */
145
52
  value: string;
146
53
  }
147
54
  export interface ContainerNetworkData {
148
55
  /**
149
- * *Deprecated:* Use `networkData` instead. The network gateway of the container as read from its
150
- * NetworkSettings.
56
+ * @deprecated Use `network_data` instead. The network gateway of the container as read from its NetworkSettings.
151
57
  */
152
58
  gateway: string;
153
59
  globalIpv6Address: string;
154
60
  globalIpv6PrefixLength: number;
155
61
  /**
156
- * *Deprecated:* Use `networkData` instead. The IP address of the container's first network it.
62
+ * @deprecated Use `network_data` instead. The IP address of the container's first network it.
157
63
  */
158
64
  ipAddress: string;
159
65
  /**
160
- * *Deprecated:* Use `networkData` instead. The IP prefix length of the container as read from its
161
- * NetworkSettings.
66
+ * @deprecated Use `network_data` instead. The IP prefix length of the container as read from its NetworkSettings.
162
67
  */
163
68
  ipPrefixLength: number;
164
69
  ipv6Gateway: string;
165
70
  networkName: string;
166
71
  }
167
72
  export interface ContainerNetworksAdvanced {
168
- /**
169
- * The network aliases of the container in the specific network.
170
- */
171
73
  aliases?: string[];
172
- /**
173
- * The IPV4 address of the container in the specific network.
174
- */
175
74
  ipv4Address?: string;
176
- /**
177
- * The IPV6 address of the container in the specific network.
178
- */
179
75
  ipv6Address?: string;
180
- /**
181
- * The name of the network.
182
- */
183
76
  name: string;
184
77
  }
185
78
  export interface ContainerPort {
186
- /**
187
- * Port exposed out of the container. If not given a free random port `>= 32768` will be used.
188
- */
189
79
  external: number;
190
- /**
191
- * Port within the container.
192
- */
193
80
  internal: number;
194
- /**
195
- * IP address this hostname should resolve to.
196
- */
197
81
  ip?: string;
198
- /**
199
- * Protocol that can be used over this port,
200
- * defaults to `tcp`.
201
- */
202
82
  protocol?: string;
203
83
  }
204
84
  export interface ContainerUlimit {
@@ -207,55 +87,18 @@ export interface ContainerUlimit {
207
87
  soft: number;
208
88
  }
209
89
  export interface ContainerUpload {
210
- /**
211
- * Literal string value to use as the object content, which will be uploaded as UTF-8-encoded text.
212
- */
213
90
  content?: string;
214
91
  contentBase64?: string;
215
- /**
216
- * If true, the file will be uploaded with user
217
- * executable permission.
218
- * Defaults to false.
219
- */
220
92
  executable?: boolean;
221
- /**
222
- * path to a file in the container.
223
- */
224
93
  file: string;
225
- /**
226
- * A filename that references a file which will be uploaded as the object content. This allows for large file uploads that do not get stored in state.
227
- */
228
94
  source?: string;
229
- /**
230
- * If using `source`, this will force an update if the file content has updated but the filename has not.
231
- */
232
95
  sourceHash?: string;
233
96
  }
234
97
  export interface ContainerVolume {
235
- /**
236
- * The path in the container where the
237
- * device will be binded.
238
- */
239
98
  containerPath?: string;
240
- /**
241
- * The container where the volume is
242
- * coming from.
243
- */
244
99
  fromContainer?: string;
245
- /**
246
- * The path on the host where the device
247
- * is located.
248
- */
249
100
  hostPath?: string;
250
- /**
251
- * If true, this volume will be readonly.
252
- * Defaults to false.
253
- */
254
101
  readOnly?: boolean;
255
- /**
256
- * The name of the docker volume which
257
- * should be mounted.
258
- */
259
102
  volumeName?: string;
260
103
  }
261
104
  export interface GetNetworkIpamConfig {
@@ -275,13 +118,7 @@ export interface NetworkIpamConfig {
275
118
  subnet?: string;
276
119
  }
277
120
  export interface NetworkLabel {
278
- /**
279
- * Name of the label
280
- */
281
121
  label: string;
282
- /**
283
- * Value of the label
284
- */
285
122
  value: string;
286
123
  }
287
124
  export interface PluginGrantPermission {
@@ -296,191 +133,62 @@ export interface ProviderRegistryAuth {
296
133
  username?: string;
297
134
  }
298
135
  export interface RegistryImageBuild {
299
- /**
300
- * - See AuthConfig below for details
301
- */
302
136
  authConfigs?: outputs.RegistryImageBuildAuthConfig[];
303
- /**
304
- * string pairs for build-time variables
305
- */
306
137
  buildArgs?: {
307
138
  [key: string]: string;
308
139
  };
309
- /**
310
- * - BuildID is an optional identifier that can be passed together with the build request. The same identifier can be used to gracefully cancel the build with the cancel request
311
- */
312
140
  buildId?: string;
313
- /**
314
- * - Images to consider as cache sources
315
- */
316
141
  cacheFroms?: string[];
317
- /**
318
- * - Optional parent cgroup for the container
319
- */
320
142
  cgroupParent?: string;
321
- /**
322
- * - The path to the context folder
323
- */
324
143
  context: string;
325
- /**
326
- * - The length of a CPU period in microseconds
327
- */
328
144
  cpuPeriod?: number;
329
- /**
330
- * - Microseconds of CPU time that the container can get in a CPU period
331
- */
332
145
  cpuQuota?: number;
333
- /**
334
- * - CPUs in which to allow execution (e.g., 0-3, 0,1)
335
- */
336
146
  cpuSetCpus?: string;
337
- /**
338
- * - MEMs in which to allow execution (0-3, 0,1)
339
- */
340
147
  cpuSetMems?: string;
341
- /**
342
- * - CPU shares (relative weight)
343
- */
344
148
  cpuShares?: number;
345
- /**
346
- * - Dockerfile file. Default is "Dockerfile"
347
- */
348
149
  dockerfile?: string;
349
- /**
350
- * - A list of hostnames/IP mappings to add to the container’s /etc/hosts file. Specified in the form ["hostname:IP"]
351
- */
352
150
  extraHosts?: string[];
353
- /**
354
- * - Always remove intermediate containers
355
- */
356
151
  forceRemove?: boolean;
357
- /**
358
- * - Isolation represents the isolation technology of a container. The supported values are platform specific
359
- */
360
152
  isolation?: string;
361
- /**
362
- * string pairs for labels
363
- */
364
153
  labels?: {
365
154
  [key: string]: string;
366
155
  };
367
- /**
368
- * - Set memory limit for build
369
- */
370
156
  memory?: number;
371
- /**
372
- * - Total memory (memory + swap), -1 to enable unlimited swap
373
- */
374
157
  memorySwap?: number;
375
- /**
376
- * - Set the networking mode for the RUN instructions during build
377
- */
378
158
  networkMode?: string;
379
- /**
380
- * - Do not use the cache when building the image
381
- */
382
159
  noCache?: boolean;
383
- /**
384
- * - Set platform if server is multi-platform capable
385
- */
386
160
  platform?: string;
387
- /**
388
- * - Attempt to pull the image even if an older image exists locally
389
- */
390
161
  pullParent?: boolean;
391
- /**
392
- * - A Git repository URI or HTTP/HTTPS context URI
393
- */
394
162
  remoteContext?: string;
395
- /**
396
- * - Remove intermediate containers after a successful build (default behavior)
397
- */
398
163
  remove?: boolean;
399
- /**
400
- * - Security options
401
- */
402
164
  securityOpts?: string[];
403
165
  sessionId?: string;
404
- /**
405
- * - Size of /dev/shm in bytes. The size must be greater than 0
406
- */
407
166
  shmSize?: number;
408
- /**
409
- * - squash the new layers into a new image with a single new layer
410
- */
411
167
  squash?: boolean;
412
- /**
413
- * - Suppress the build output and print image ID on success
414
- */
415
168
  suppressOutput?: boolean;
416
- /**
417
- * - Set the target build stage to build
418
- */
419
169
  target?: string;
420
- /**
421
- * - See Ulimit below for details
422
- */
423
170
  ulimits?: outputs.RegistryImageBuildUlimit[];
424
- /**
425
- * - Version of the unerlying builder to use
426
- */
427
171
  version?: string;
428
172
  }
429
173
  export interface RegistryImageBuildAuthConfig {
430
- /**
431
- * the auth token
432
- */
433
174
  auth?: string;
434
- /**
435
- * the user emal
436
- */
437
175
  email?: string;
438
- /**
439
- * hostname of the registry
440
- */
441
176
  hostName: string;
442
- /**
443
- * the identity token
444
- */
445
177
  identityToken?: string;
446
- /**
447
- * the registry password
448
- */
449
178
  password?: string;
450
- /**
451
- * the registry token
452
- */
453
179
  registryToken?: string;
454
- /**
455
- * the server address
456
- */
457
180
  serverAddress?: string;
458
- /**
459
- * the registry user name
460
- */
461
181
  userName?: string;
462
182
  }
463
183
  export interface RegistryImageBuildUlimit {
464
- /**
465
- * - hard limit
466
- */
467
184
  hard: number;
468
- /**
469
- * type of ulimit, e.g. nofile
470
- */
471
185
  name: string;
472
- /**
473
- * - soft limit
474
- */
475
186
  soft: number;
476
187
  }
477
188
  export interface RemoteImageBuild {
478
189
  buildArg?: {
479
190
  [key: string]: string;
480
191
  };
481
- /**
482
- * default Dockerfile
483
- */
484
192
  dockerfile?: string;
485
193
  forceRemove?: boolean;
486
194
  label?: {
@@ -488,373 +196,129 @@ export interface RemoteImageBuild {
488
196
  };
489
197
  noCache?: boolean;
490
198
  path: string;
491
- /**
492
- * default true
493
- */
494
199
  remove?: boolean;
495
200
  tags?: string[];
496
201
  target?: string;
497
202
  }
498
203
  export interface SecretLabel {
499
- /**
500
- * Name of the label
501
- */
502
204
  label: string;
503
- /**
504
- * Value of the label
505
- */
506
205
  value: string;
507
206
  }
508
207
  export interface ServiceAuth {
509
- /**
510
- * The password to use for authenticating to the registry. If this is blank, the `DOCKER_REGISTRY_PASS` is also be checked.
511
- */
512
208
  password?: string;
513
- /**
514
- * The address of the registry server
515
- */
516
209
  serverAddress: string;
517
- /**
518
- * The username to use for authenticating to the registry. If this is blank, the `DOCKER_REGISTRY_USER` is also be checked.
519
- */
520
210
  username?: string;
521
211
  }
522
212
  export interface ServiceConvergeConfig {
523
- /**
524
- * Time between each the check to check docker endpoint `(ms|s|m|h)`. For example, to check if
525
- * all tasks are up when a service is created, or to check if all tasks are successfully updated on an update. Default: `7s`.
526
- */
527
213
  delay?: string;
528
- /**
529
- * The timeout of the service to reach the desired state `(s|m)`. Default: `3m`.
530
- */
531
214
  timeout?: string;
532
215
  }
533
216
  export interface ServiceEndpointSpec {
534
- /**
535
- * The mode of resolution to use for internal load balancing between tasks. `(vip|dnsrr)`. Default: `vip`.
536
- */
537
217
  mode: string;
538
- /**
539
- * See Ports below for details.
540
- */
541
218
  ports?: outputs.ServiceEndpointSpecPort[];
542
219
  }
543
220
  export interface ServiceEndpointSpecPort {
544
- /**
545
- * The name of the Docker service.
546
- */
547
221
  name?: string;
548
- /**
549
- * Protocol that can be used over this port: `tcp|udp|sctp`. Default: `tcp`.
550
- */
551
222
  protocol?: string;
552
- /**
553
- * Represents the mode in which the port is to be published: `ingress|host`
554
- */
555
223
  publishMode?: string;
556
- /**
557
- * The port on the swarm hosts. If not set the value of `targetPort` will be used.
558
- */
559
224
  publishedPort: number;
560
- /**
561
- * Port inside the container.
562
- */
563
225
  targetPort: number;
564
226
  }
565
227
  export interface ServiceLabel {
566
- /**
567
- * Name of the label
568
- */
569
228
  label: string;
570
- /**
571
- * Value of the label
572
- */
573
229
  value: string;
574
230
  }
575
231
  export interface ServiceMode {
576
- /**
577
- * set it to `true` to run the service in the global mode
578
- */
579
232
  global?: boolean;
580
- /**
581
- * , which contains atm only the amount of `replicas`
582
- */
583
233
  replicated: outputs.ServiceModeReplicated;
584
234
  }
585
235
  export interface ServiceModeReplicated {
586
236
  replicas?: number;
587
237
  }
588
238
  export interface ServiceRollbackConfig {
589
- /**
590
- * Delay between restart attempts `(ms|s|m|h)`
591
- * all tasks are up when a service is created, or to check if all tasks are successfully updated on an update. Default: `7s`.
592
- */
593
239
  delay?: string;
594
- /**
595
- * Action on update failure: `pause|continue|rollback`.
596
- */
597
240
  failureAction?: string;
598
- /**
599
- * The failure rate to tolerate during an update as `float`. **Important:** the `float`need to be wrapped in a `string` to avoid internal
600
- * casting and precision errors.
601
- */
602
241
  maxFailureRatio?: string;
603
- /**
604
- * Duration after each task update to monitor for failure `(ns|us|ms|s|m|h)`
605
- */
606
242
  monitor?: string;
607
- /**
608
- * Update order either 'stop-first' or 'start-first'.
609
- */
610
243
  order?: string;
611
- /**
612
- * The maximum number of tasks to be updated in one iteration simultaneously (0 to update all at once).
613
- */
614
244
  parallelism?: number;
615
245
  }
616
246
  export interface ServiceTaskSpec {
617
- /**
618
- * See ContainerSpec below for details.
619
- */
620
247
  containerSpec: outputs.ServiceTaskSpecContainerSpec;
621
- /**
622
- * A counter that triggers an update even if no relevant parameters have been changed. See [Docker Spec](https://github.com/docker/swarmkit/blob/master/api/specs.proto#L126).
623
- */
624
248
  forceUpdate: number;
625
- /**
626
- * See Log Driver below for details.
627
- */
628
249
  logDriver?: outputs.ServiceTaskSpecLogDriver;
629
- /**
630
- * Ids of the networks in which the container will be put in.
631
- */
632
250
  networks?: string[];
633
- /**
634
- * See Placement below for details.
635
- */
636
251
  placement: outputs.ServiceTaskSpecPlacement;
637
- /**
638
- * See Resources below for details.
639
- */
640
252
  resources: outputs.ServiceTaskSpecResources;
641
- /**
642
- * See Restart Policy below for details.
643
- */
644
253
  restartPolicy: outputs.ServiceTaskSpecRestartPolicy;
645
- /**
646
- * Runtime is the type of runtime specified for the task executor. See [Docker Runtime](https://github.com/moby/moby/blob/master/api/types/swarm/runtime.go).
647
- */
648
254
  runtime: string;
649
255
  }
650
256
  export interface ServiceTaskSpecContainerSpec {
651
- /**
652
- * Arguments to the command.
653
- */
654
257
  args?: string[];
655
- /**
656
- * The command to be run in the image.
657
- */
658
258
  commands?: string[];
659
- /**
660
- * See Configs below for details.
661
- */
662
259
  configs?: outputs.ServiceTaskSpecContainerSpecConfig[];
663
- /**
664
- * The working directory for commands to run in.
665
- */
666
260
  dir?: string;
667
- /**
668
- * See DNS Config below for details.
669
- */
670
261
  dnsConfig: outputs.ServiceTaskSpecContainerSpecDnsConfig;
671
- /**
672
- * A list of environment variables in the form VAR=value.
673
- */
674
262
  env?: {
675
263
  [key: string]: string;
676
264
  };
677
- /**
678
- * A list of additional groups that the container process will run as.
679
- */
680
265
  groups?: string[];
681
- /**
682
- * See Healthcheck below for details.
683
- */
684
266
  healthcheck: outputs.ServiceTaskSpecContainerSpecHealthcheck;
685
- /**
686
- * The hostname to use for the container, as a valid RFC 1123 hostname.
687
- */
688
267
  hostname?: string;
689
268
  hosts?: outputs.ServiceTaskSpecContainerSpecHost[];
690
- /**
691
- * The image used to create the Docker service.
692
- */
693
269
  image: string;
694
- /**
695
- * Isolation technology of the containers running the service. (Windows only). Valid values are: `default|process|hyperv`
696
- */
697
270
  isolation?: string;
698
- /**
699
- * See Labels below for details.
700
- */
701
271
  labels?: outputs.ServiceTaskSpecContainerSpecLabel[];
702
- /**
703
- * See Mounts below for details.
704
- */
705
272
  mounts?: outputs.ServiceTaskSpecContainerSpecMount[];
706
- /**
707
- * See Privileges below for details.
708
- */
709
273
  privileges?: outputs.ServiceTaskSpecContainerSpecPrivileges;
710
- /**
711
- * Mount the container's root filesystem as read only.
712
- */
713
274
  readOnly?: boolean;
714
- /**
715
- * See Secrets below for details.
716
- */
717
275
  secrets?: outputs.ServiceTaskSpecContainerSpecSecret[];
718
- /**
719
- * Amount of time to wait for the container to terminate before forcefully removing it `(ms|s|m|h)`.
720
- */
721
276
  stopGracePeriod: string;
722
- /**
723
- * Signal to stop the container.
724
- */
725
277
  stopSignal?: string;
726
- /**
727
- * The user inside the container.
728
- */
729
278
  user?: string;
730
279
  }
731
280
  export interface ServiceTaskSpecContainerSpecConfig {
732
- /**
733
- * ConfigID represents the ID of the specific config.
734
- */
735
281
  configId: string;
736
- /**
737
- * The name of the config that this references, but internally it is just provided for lookup/display purposes
738
- */
739
282
  configName?: string;
740
- /**
741
- * Represents the file GID. Defaults: `0`
742
- */
743
283
  fileGid?: string;
744
- /**
745
- * Represents the FileMode of the file. Defaults: `0444`
746
- */
747
284
  fileMode?: number;
748
- /**
749
- * Represents the final filename in the filesystem. The specific target file that the config data is written within the docker container, e.g. `/root/config/config.json`
750
- */
751
285
  fileName: string;
752
- /**
753
- * Represents the file UID. Defaults: `0`
754
- */
755
286
  fileUid?: string;
756
287
  }
757
288
  export interface ServiceTaskSpecContainerSpecDnsConfig {
758
- /**
759
- * The IP addresses of the name servers, for example, `8.8.8.8`
760
- */
761
289
  nameservers: string[];
762
- /**
763
- * A list of internal resolver variables to be modified, for example, `debug`, `ndots:3`
764
- */
765
290
  options?: string[];
766
- /**
767
- * A search list for host-name lookup.
768
- */
769
291
  searches?: string[];
770
292
  }
771
293
  export interface ServiceTaskSpecContainerSpecHealthcheck {
772
- /**
773
- * Time between running the check `(ms|s|m|h)`. Default: `0s`.
774
- */
775
294
  interval?: string;
776
- /**
777
- * Consecutive failures needed to report unhealthy. Default: `0`.
778
- */
779
295
  retries?: number;
780
- /**
781
- * Start period for the container to initialize before counting retries towards unstable `(ms|s|m|h)`. Default: `0s`.
782
- */
783
296
  startPeriod?: string;
784
- /**
785
- * Command to run to check health. For example, to run `curl -f http://localhost/health` set the
786
- * command to be `["CMD", "curl", "-f", "http://localhost/health"]`.
787
- */
788
297
  tests: string[];
789
- /**
790
- * Maximum time to allow one check to run `(ms|s|m|h)`. Default: `0s`.
791
- */
792
298
  timeout?: string;
793
299
  }
794
300
  export interface ServiceTaskSpecContainerSpecHost {
795
- /**
796
- * A list of hostname/IP mappings to add to the container's hosts file.
797
- */
798
301
  host: string;
799
- /**
800
- * The ip
801
- */
802
302
  ip: string;
803
303
  }
804
304
  export interface ServiceTaskSpecContainerSpecLabel {
805
- /**
806
- * Name of the label
807
- */
808
305
  label: string;
809
- /**
810
- * Value of the label
811
- */
812
306
  value: string;
813
307
  }
814
308
  export interface ServiceTaskSpecContainerSpecMount {
815
- /**
816
- * Optional configuration for the `bind` type.
817
- */
818
309
  bindOptions?: outputs.ServiceTaskSpecContainerSpecMountBindOptions;
819
- /**
820
- * Mount the container's root filesystem as read only.
821
- */
822
310
  readOnly?: boolean;
823
- /**
824
- * The mount source (e.g., a volume name, a host path)
825
- */
826
311
  source?: string;
827
- /**
828
- * The container path.
829
- */
830
312
  target: string;
831
- /**
832
- * Optional configuration for the `tmpf` type.
833
- */
834
313
  tmpfsOptions?: outputs.ServiceTaskSpecContainerSpecMountTmpfsOptions;
835
- /**
836
- * SELinux type label
837
- */
838
314
  type: string;
839
- /**
840
- * Optional configuration for the `volume` type.
841
- */
842
315
  volumeOptions?: outputs.ServiceTaskSpecContainerSpecMountVolumeOptions;
843
316
  }
844
317
  export interface ServiceTaskSpecContainerSpecMountBindOptions {
845
- /**
846
- * A propagation mode with the value.
847
- */
848
318
  propagation?: string;
849
319
  }
850
320
  export interface ServiceTaskSpecContainerSpecMountTmpfsOptions {
851
- /**
852
- * See Mode below for details.
853
- */
854
321
  mode?: number;
855
- /**
856
- * The size for the tmpfs mount in bytes.
857
- */
858
322
  sizeBytes?: number;
859
323
  }
860
324
  export interface ServiceTaskSpecContainerSpecMountVolumeOptions {
@@ -862,234 +326,81 @@ export interface ServiceTaskSpecContainerSpecMountVolumeOptions {
862
326
  driverOptions?: {
863
327
  [key: string]: string;
864
328
  };
865
- /**
866
- * See Labels below for details.
867
- */
868
329
  labels?: outputs.ServiceTaskSpecContainerSpecMountVolumeOptionsLabel[];
869
- /**
870
- * Whether to populate volume with data from the target.
871
- */
872
330
  noCopy?: boolean;
873
331
  }
874
332
  export interface ServiceTaskSpecContainerSpecMountVolumeOptionsLabel {
875
- /**
876
- * Name of the label
877
- */
878
333
  label: string;
879
- /**
880
- * Value of the label
881
- */
882
334
  value: string;
883
335
  }
884
336
  export interface ServiceTaskSpecContainerSpecPrivileges {
885
- /**
886
- * For managed service account (Windows only)
887
- */
888
337
  credentialSpec?: outputs.ServiceTaskSpecContainerSpecPrivilegesCredentialSpec;
889
- /**
890
- * SELinux labels of the container
891
- */
892
338
  seLinuxContext?: outputs.ServiceTaskSpecContainerSpecPrivilegesSeLinuxContext;
893
339
  }
894
340
  export interface ServiceTaskSpecContainerSpecPrivilegesCredentialSpec {
895
- /**
896
- * Load credential spec from this file.
897
- */
898
341
  file?: string;
899
- /**
900
- * Load credential spec from this value in the Windows registry.
901
- */
902
342
  registry?: string;
903
343
  }
904
344
  export interface ServiceTaskSpecContainerSpecPrivilegesSeLinuxContext {
905
- /**
906
- * Disable SELinux
907
- */
908
345
  disable?: boolean;
909
- /**
910
- * SELinux level label
911
- */
912
346
  level?: string;
913
- /**
914
- * SELinux role label
915
- */
916
347
  role?: string;
917
- /**
918
- * SELinux type label
919
- */
920
348
  type?: string;
921
- /**
922
- * The user inside the container.
923
- */
924
349
  user?: string;
925
350
  }
926
351
  export interface ServiceTaskSpecContainerSpecSecret {
927
- /**
928
- * Represents the file GID. Defaults: `0`
929
- */
930
352
  fileGid?: string;
931
- /**
932
- * Represents the FileMode of the file. Defaults: `0444`
933
- */
934
353
  fileMode?: number;
935
- /**
936
- * Represents the final filename in the filesystem. The specific target file that the secret data is written within the docker container, e.g. `/root/secret/secret.json`
937
- */
938
354
  fileName: string;
939
- /**
940
- * Represents the file UID. Defaults: `0`
941
- */
942
355
  fileUid?: string;
943
- /**
944
- * ConfigID represents the ID of the specific secret.
945
- */
946
356
  secretId: string;
947
- /**
948
- * The name of the secret that this references, but internally it is just provided for lookup/display purposes
949
- */
950
357
  secretName?: string;
951
358
  }
952
359
  export interface ServiceTaskSpecLogDriver {
953
- /**
954
- * The logging driver to use. Either `(none|json-file|syslog|journald|gelf|fluentd|awslogs|splunk|etwlogs|gcplogs)`.
955
- */
956
360
  name: string;
957
- /**
958
- * The options for the logging driver, e.g.
959
- */
960
361
  options?: {
961
362
  [key: string]: string;
962
363
  };
963
364
  }
964
365
  export interface ServiceTaskSpecPlacement {
965
- /**
966
- * An array of constraints. e.g.: `node.role==manager`
967
- */
968
366
  constraints?: string[];
969
- /**
970
- * Maximum number of replicas for per node (default value is 0, which is unlimited)
971
- */
972
367
  maxReplicas?: number;
973
- /**
974
- * Platforms stores all the platforms that the service's image can run on
975
- */
976
368
  platforms?: outputs.ServiceTaskSpecPlacementPlatform[];
977
- /**
978
- * Preferences provide a way to make the scheduler aware of factors such as topology. They are provided in order from highest to lowest precedence, e.g.: `spread=node.role.manager`
979
- */
980
369
  prefs?: string[];
981
370
  }
982
371
  export interface ServiceTaskSpecPlacementPlatform {
983
- /**
984
- * The architecture, e.g., `amd64`
985
- */
986
372
  architecture: string;
987
- /**
988
- * The operation system, e.g., `linux`
989
- */
990
373
  os: string;
991
374
  }
992
375
  export interface ServiceTaskSpecResources {
993
- /**
994
- * Describes the resources which can be advertised by a node and requested by a task.
995
- */
996
376
  limits?: outputs.ServiceTaskSpecResourcesLimits;
997
- /**
998
- * An object describing the resources which can be advertised by a node and requested by a task.
999
- */
1000
377
  reservation?: outputs.ServiceTaskSpecResourcesReservation;
1001
378
  }
1002
379
  export interface ServiceTaskSpecResourcesLimits {
1003
- /**
1004
- * User-defined resources can be either Integer resources (e.g, SSD=3) or String resources (e.g, GPU=UUID1)
1005
- */
1006
- genericResources?: outputs.ServiceTaskSpecResourcesLimitsGenericResources;
1007
- /**
1008
- * The amount of memory in bytes the container allocates
1009
- */
1010
380
  memoryBytes?: number;
1011
- /**
1012
- * CPU shares in units of 1/1e9 (or 10^-9) of the CPU. Should be at least 1000000
1013
- */
1014
381
  nanoCpus?: number;
1015
382
  }
1016
- export interface ServiceTaskSpecResourcesLimitsGenericResources {
1017
- /**
1018
- * The Integer resources, delimited by `=`
1019
- */
1020
- discreteResourcesSpecs?: string[];
1021
- /**
1022
- * The String resources, delimited by `=`
1023
- */
1024
- namedResourcesSpecs?: string[];
1025
- }
1026
383
  export interface ServiceTaskSpecResourcesReservation {
1027
- /**
1028
- * User-defined resources can be either Integer resources (e.g, SSD=3) or String resources (e.g, GPU=UUID1)
1029
- */
1030
384
  genericResources?: outputs.ServiceTaskSpecResourcesReservationGenericResources;
1031
- /**
1032
- * The amount of memory in bytes the container allocates
1033
- */
1034
385
  memoryBytes?: number;
1035
- /**
1036
- * CPU shares in units of 1/1e9 (or 10^-9) of the CPU. Should be at least 1000000
1037
- */
1038
386
  nanoCpus?: number;
1039
387
  }
1040
388
  export interface ServiceTaskSpecResourcesReservationGenericResources {
1041
- /**
1042
- * The Integer resources, delimited by `=`
1043
- */
1044
389
  discreteResourcesSpecs?: string[];
1045
- /**
1046
- * The String resources, delimited by `=`
1047
- */
1048
390
  namedResourcesSpecs?: string[];
1049
391
  }
1050
392
  export interface ServiceTaskSpecRestartPolicy {
1051
- /**
1052
- * Condition for restart: `(none|on-failure|any)`
1053
- */
1054
393
  condition?: string;
1055
- /**
1056
- * Delay between restart attempts `(ms|s|m|h)`
1057
- */
1058
394
  delay?: string;
1059
- /**
1060
- * Maximum attempts to restart a given container before giving up (default value is `0`, which is ignored)
1061
- */
1062
395
  maxAttempts?: number;
1063
- /**
1064
- * The time window used to evaluate the restart policy (default value is `0`, which is unbounded) `(ms|s|m|h)`
1065
- */
1066
396
  window?: string;
1067
397
  }
1068
398
  export interface ServiceUpdateConfig {
1069
- /**
1070
- * Delay between updates `(ns|us|ms|s|m|h)`, e.g. `5s`.
1071
- */
1072
399
  delay?: string;
1073
- /**
1074
- * Action on update failure: `pause|continue|rollback`.
1075
- */
1076
400
  failureAction?: string;
1077
- /**
1078
- * The failure rate to tolerate during an update as `float`. **Important:** the `float`need to be wrapped in a `string` to avoid internal
1079
- * casting and precision errors.
1080
- */
1081
401
  maxFailureRatio?: string;
1082
- /**
1083
- * Duration after each task update to monitor for failure `(ns|us|ms|s|m|h)`
1084
- */
1085
402
  monitor?: string;
1086
- /**
1087
- * Update order either 'stop-first' or 'start-first'.
1088
- */
1089
403
  order?: string;
1090
- /**
1091
- * The maximum number of tasks to be updated in one iteration simultaneously (0 to update all at once).
1092
- */
1093
404
  parallelism?: number;
1094
405
  }
1095
406
  export interface VolumeLabel {