@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/volume.d.ts CHANGED
@@ -1,9 +1,8 @@
1
1
  import * as pulumi from "@pulumi/pulumi";
2
2
  import { input as inputs, output as outputs } from "./types";
3
3
  /**
4
- * Creates and destroys a volume in Docker. This can be used alongside
5
- * [docker\_container](https://www.terraform.io/docs/providers/docker/r/container.html)
6
- * to prepare volumes that can be shared across containers.
4
+ * <!-- Bug: Type and Name are switched -->
5
+ * Creates and destroys a volume in Docker. This can be used alongside docker.Container to prepare volumes that can be shared across containers.
7
6
  *
8
7
  * ## Example Usage
9
8
  *
@@ -11,16 +10,40 @@ import { input as inputs, output as outputs } from "./types";
11
10
  * import * as pulumi from "@pulumi/pulumi";
12
11
  * import * as docker from "@pulumi/docker";
13
12
  *
14
- * // Creates a docker volume "shared_volume".
15
13
  * const sharedVolume = new docker.Volume("shared_volume", {});
16
14
  * ```
17
15
  *
16
+ * <!-- schema generated by tfplugindocs -->
17
+ * ## Schema
18
+ *
19
+ * ### Optional
20
+ *
21
+ * - **driver** (String) Driver type for the volume. Defaults to `local`.
22
+ * - **driver_opts** (Map of String) Options specific to the driver.
23
+ * - **id** (String) The ID of this resource.
24
+ * - **labels** (Block Set) User-defined key/value metadata (see below for nested schema)
25
+ * - **name** (String) The name of the Docker volume (will be generated if not provided).
26
+ *
27
+ * ### Read-Only
28
+ *
29
+ * - **mountpoint** (String) The mountpoint of the volume.
30
+ *
31
+ * <a id="nestedblock--labels"></a>
32
+ * ### Nested Schema for `labels`
33
+ *
34
+ * Required:
35
+ *
36
+ * - **label** (String) Name of the label
37
+ * - **value** (String) Value of the label
38
+ *
18
39
  * ## Import
19
40
  *
20
- * Docker volume can be imported using the long id, e.g. for a volume with the short id `ecae276c5`
41
+ * ### Example Assuming you created a `volume` as follows #!/bin/bash docker volume create # prints the long ID 524b0457aa2a87dd2b75c74c3e4e53f406974249e63ab3ed9bf21e5644f9dc7d you provide the definition for the resource as follows terraform resource "docker_volume" "foo" {
42
+ *
43
+ * name = "524b0457aa2a87dd2b75c74c3e4e53f406974249e63ab3ed9bf21e5644f9dc7d" } then the import command is as follows #!/bin/bash
21
44
  *
22
45
  * ```sh
23
- * $ pulumi import docker:index/volume:Volume foo $(docker volume inspect -f {{.ID}} eca)
46
+ * $ pulumi import docker:index/volume:Volume foo 524b0457aa2a87dd2b75c74c3e4e53f406974249e63ab3ed9bf21e5644f9dc7d
24
47
  * ```
25
48
  */
26
49
  export declare class Volume extends pulumi.CustomResource {
@@ -40,7 +63,7 @@ export declare class Volume extends pulumi.CustomResource {
40
63
  */
41
64
  static isInstance(obj: any): obj is Volume;
42
65
  /**
43
- * Driver type for the volume (defaults to local).
66
+ * Driver type for the volume. Defaults to `local`.
44
67
  */
45
68
  readonly driver: pulumi.Output<string>;
46
69
  /**
@@ -50,13 +73,15 @@ export declare class Volume extends pulumi.CustomResource {
50
73
  [key: string]: any;
51
74
  } | undefined>;
52
75
  /**
53
- * User-defined key/value metadata.
76
+ * User-defined key/value metadata
54
77
  */
55
78
  readonly labels: pulumi.Output<outputs.VolumeLabel[] | undefined>;
79
+ /**
80
+ * The mountpoint of the volume.
81
+ */
56
82
  readonly mountpoint: pulumi.Output<string>;
57
83
  /**
58
- * The name of the Docker volume (generated if not
59
- * provided).
84
+ * The name of the Docker volume (will be generated if not provided).
60
85
  */
61
86
  readonly name: pulumi.Output<string>;
62
87
  /**
@@ -73,7 +98,7 @@ export declare class Volume extends pulumi.CustomResource {
73
98
  */
74
99
  export interface VolumeState {
75
100
  /**
76
- * Driver type for the volume (defaults to local).
101
+ * Driver type for the volume. Defaults to `local`.
77
102
  */
78
103
  readonly driver?: pulumi.Input<string>;
79
104
  /**
@@ -83,13 +108,15 @@ export interface VolumeState {
83
108
  [key: string]: any;
84
109
  }>;
85
110
  /**
86
- * User-defined key/value metadata.
111
+ * User-defined key/value metadata
87
112
  */
88
113
  readonly labels?: pulumi.Input<pulumi.Input<inputs.VolumeLabel>[]>;
114
+ /**
115
+ * The mountpoint of the volume.
116
+ */
89
117
  readonly mountpoint?: pulumi.Input<string>;
90
118
  /**
91
- * The name of the Docker volume (generated if not
92
- * provided).
119
+ * The name of the Docker volume (will be generated if not provided).
93
120
  */
94
121
  readonly name?: pulumi.Input<string>;
95
122
  }
@@ -98,7 +125,7 @@ export interface VolumeState {
98
125
  */
99
126
  export interface VolumeArgs {
100
127
  /**
101
- * Driver type for the volume (defaults to local).
128
+ * Driver type for the volume. Defaults to `local`.
102
129
  */
103
130
  readonly driver?: pulumi.Input<string>;
104
131
  /**
@@ -108,12 +135,11 @@ export interface VolumeArgs {
108
135
  [key: string]: any;
109
136
  }>;
110
137
  /**
111
- * User-defined key/value metadata.
138
+ * User-defined key/value metadata
112
139
  */
113
140
  readonly labels?: pulumi.Input<pulumi.Input<inputs.VolumeLabel>[]>;
114
141
  /**
115
- * The name of the Docker volume (generated if not
116
- * provided).
142
+ * The name of the Docker volume (will be generated if not provided).
117
143
  */
118
144
  readonly name?: pulumi.Input<string>;
119
145
  }
package/volume.js CHANGED
@@ -5,9 +5,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
5
5
  const pulumi = require("@pulumi/pulumi");
6
6
  const utilities = require("./utilities");
7
7
  /**
8
- * Creates and destroys a volume in Docker. This can be used alongside
9
- * [docker\_container](https://www.terraform.io/docs/providers/docker/r/container.html)
10
- * to prepare volumes that can be shared across containers.
8
+ * <!-- Bug: Type and Name are switched -->
9
+ * Creates and destroys a volume in Docker. This can be used alongside docker.Container to prepare volumes that can be shared across containers.
11
10
  *
12
11
  * ## Example Usage
13
12
  *
@@ -15,16 +14,40 @@ const utilities = require("./utilities");
15
14
  * import * as pulumi from "@pulumi/pulumi";
16
15
  * import * as docker from "@pulumi/docker";
17
16
  *
18
- * // Creates a docker volume "shared_volume".
19
17
  * const sharedVolume = new docker.Volume("shared_volume", {});
20
18
  * ```
21
19
  *
20
+ * <!-- schema generated by tfplugindocs -->
21
+ * ## Schema
22
+ *
23
+ * ### Optional
24
+ *
25
+ * - **driver** (String) Driver type for the volume. Defaults to `local`.
26
+ * - **driver_opts** (Map of String) Options specific to the driver.
27
+ * - **id** (String) The ID of this resource.
28
+ * - **labels** (Block Set) User-defined key/value metadata (see below for nested schema)
29
+ * - **name** (String) The name of the Docker volume (will be generated if not provided).
30
+ *
31
+ * ### Read-Only
32
+ *
33
+ * - **mountpoint** (String) The mountpoint of the volume.
34
+ *
35
+ * <a id="nestedblock--labels"></a>
36
+ * ### Nested Schema for `labels`
37
+ *
38
+ * Required:
39
+ *
40
+ * - **label** (String) Name of the label
41
+ * - **value** (String) Value of the label
42
+ *
22
43
  * ## Import
23
44
  *
24
- * Docker volume can be imported using the long id, e.g. for a volume with the short id `ecae276c5`
45
+ * ### Example Assuming you created a `volume` as follows #!/bin/bash docker volume create # prints the long ID 524b0457aa2a87dd2b75c74c3e4e53f406974249e63ab3ed9bf21e5644f9dc7d you provide the definition for the resource as follows terraform resource "docker_volume" "foo" {
46
+ *
47
+ * name = "524b0457aa2a87dd2b75c74c3e4e53f406974249e63ab3ed9bf21e5644f9dc7d" } then the import command is as follows #!/bin/bash
25
48
  *
26
49
  * ```sh
27
- * $ pulumi import docker:index/volume:Volume foo $(docker volume inspect -f {{.ID}} eca)
50
+ * $ pulumi import docker:index/volume:Volume foo 524b0457aa2a87dd2b75c74c3e4e53f406974249e63ab3ed9bf21e5644f9dc7d
28
51
  * ```
29
52
  */
30
53
  class Volume extends pulumi.CustomResource {
package/volume.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"volume.js","sourceRoot":"","sources":["../volume.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;AAEjF,yCAAyC;AAEzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAa,MAAO,SAAQ,MAAM,CAAC,cAAc;IAuD7C,YAAY,IAAY,EAAE,WAAsC,EAAE,IAAmC;QACjG,IAAI,MAAM,GAAkB,EAAE,CAAC;QAC/B,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAsC,CAAC;YACrD,MAAM,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YACpD,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,MAAM,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YACpD,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,MAAM,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;SACnD;aAAM;YACH,MAAM,IAAI,GAAG,WAAqC,CAAC;YACnD,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAClD,MAAM,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAClD,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9C,MAAM,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SAC5C;QACD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACf,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,SAAS,CAAC,UAAU,EAAE,EAAC,CAAC,CAAC;SACxE;QACD,KAAK,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;IA5ED;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAmB,EAAE,IAAmC;QACjH,OAAO,IAAI,MAAM,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC7D,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,MAAM,CAAC,YAAY,CAAC;IACvD,CAAC;;AA1BL,wBA8EC;AAhEG,gBAAgB;AACO,mBAAY,GAAG,4BAA4B,CAAC"}
1
+ {"version":3,"file":"volume.js","sourceRoot":"","sources":["../volume.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;AAEjF,yCAAyC;AAEzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAa,MAAO,SAAQ,MAAM,CAAC,cAAc;IAyD7C,YAAY,IAAY,EAAE,WAAsC,EAAE,IAAmC;QACjG,IAAI,MAAM,GAAkB,EAAE,CAAC;QAC/B,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAsC,CAAC;YACrD,MAAM,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YACpD,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,MAAM,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YACpD,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,MAAM,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;SACnD;aAAM;YACH,MAAM,IAAI,GAAG,WAAqC,CAAC;YACnD,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAClD,MAAM,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1D,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;YAClD,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9C,MAAM,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SAC5C;QACD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACf,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,SAAS,CAAC,UAAU,EAAE,EAAC,CAAC,CAAC;SACxE;QACD,KAAK,CAAC,MAAM,CAAC,YAAY,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;IA9ED;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAAmB,EAAE,IAAmC;QACjH,OAAO,IAAI,MAAM,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAC7D,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,MAAM,CAAC,YAAY,CAAC;IACvD,CAAC;;AA1BL,wBAgFC;AAlEG,gBAAgB;AACO,mBAAY,GAAG,4BAA4B,CAAC"}