@pulumi/docker 4.0.0-alpha.2 → 4.0.0-alpha.4

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.
Files changed (8) hide show
  1. package/image.d.ts +21 -1
  2. package/image.js +22 -0
  3. package/image.js.map +1 -1
  4. package/package.json +2 -2
  5. package/package.json.dev +2 -2
  6. package/types/enums/index.d.ts +1 -1
  7. package/types/input.d.ts +5 -11
  8. package/types/input.js.map +1 -1
package/image.d.ts CHANGED
@@ -2,6 +2,26 @@ import * as pulumi from "@pulumi/pulumi";
2
2
  import * as inputs from "./types/input";
3
3
  /**
4
4
  * Builds a Docker Image and pushes to a Docker registry.
5
+ *
6
+ * ## Example Usage
7
+ * ### A Docker image build
8
+ *
9
+ * ```typescript
10
+ * import * as pulumi from "@pulumi/pulumi";
11
+ * import * as docker from "@pulumi/docker";
12
+ *
13
+ * const demoImage = new docker.Image("demo-image", {
14
+ * build: {
15
+ * context: ".",
16
+ * dockerfile: "Dockerfile",
17
+ * },
18
+ * imageName: "username/image:tag1",
19
+ * skipPush: true,
20
+ * });
21
+ * export const imageName = demoImage.imageName;
22
+ * ```
23
+ *
24
+ * {{% //examples %}}
5
25
  */
6
26
  export declare class Image extends pulumi.CustomResource {
7
27
  /**
@@ -27,7 +47,7 @@ export declare class Image extends pulumi.CustomResource {
27
47
  */
28
48
  readonly imageName: pulumi.Output<string | undefined>;
29
49
  /**
30
- * The URL of the registry server hosting the image.
50
+ * The name of the registry server hosting the image.
31
51
  */
32
52
  readonly registryServer: pulumi.Output<string | undefined>;
33
53
  /**
package/image.js CHANGED
@@ -7,6 +7,26 @@ const pulumi = require("@pulumi/pulumi");
7
7
  const utilities = require("./utilities");
8
8
  /**
9
9
  * Builds a Docker Image and pushes to a Docker registry.
10
+ *
11
+ * ## Example Usage
12
+ * ### A Docker image build
13
+ *
14
+ * ```typescript
15
+ * import * as pulumi from "@pulumi/pulumi";
16
+ * import * as docker from "@pulumi/docker";
17
+ *
18
+ * const demoImage = new docker.Image("demo-image", {
19
+ * build: {
20
+ * context: ".",
21
+ * dockerfile: "Dockerfile",
22
+ * },
23
+ * imageName: "username/image:tag1",
24
+ * skipPush: true,
25
+ * });
26
+ * export const imageName = demoImage.imageName;
27
+ * ```
28
+ *
29
+ * {{% //examples %}}
10
30
  */
11
31
  class Image extends pulumi.CustomResource {
12
32
  /**
@@ -58,6 +78,8 @@ class Image extends pulumi.CustomResource {
58
78
  resourceInputs["registryServer"] = undefined /*out*/;
59
79
  }
60
80
  opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
81
+ const aliasOpts = { aliases: [{ type: "docker:image:Image" }] };
82
+ opts = pulumi.mergeOptions(opts, aliasOpts);
61
83
  super(Image.__pulumiType, name, resourceInputs, opts);
62
84
  }
63
85
  }
package/image.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"image.js","sourceRoot":"","sources":["../image.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAIzC,yCAAyC;AAEzC;;GAEG;AACH,MAAa,KAAM,SAAQ,MAAM,CAAC,cAAc;IAC5C;;;;;;;OAOG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,IAAmC;QAC5F,OAAO,IAAI,KAAK,CAAC,IAAI,EAAE,SAAgB,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAClE,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,KAAK,CAAC,YAAY,CAAC;IACtD,CAAC;IAeD;;;;;;OAMG;IACH,YAAY,IAAY,EAAE,IAAe,EAAE,IAAmC;;QAC1E,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE;YACV,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACtD,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;aAC5D;YACD,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,UAAU,CAAC,GAAG,MAAA,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,mCAAI,KAAK,CAAC;YACzE,cAAc,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACpD,cAAc,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SACxD;aAAM;YACH,cAAc,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACpD,cAAc,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAChD,cAAc,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SACxD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,KAAK,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC1D,CAAC;;AAnEL,sBAoEC;AAvDG,gBAAgB;AACO,kBAAY,GAAG,0BAA0B,CAAC"}
1
+ {"version":3,"file":"image.js","sourceRoot":"","sources":["../image.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAIzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAa,KAAM,SAAQ,MAAM,CAAC,cAAc;IAC5C;;;;;;;OAOG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,IAAmC;QAC5F,OAAO,IAAI,KAAK,CAAC,IAAI,EAAE,SAAgB,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IAClE,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,KAAK,CAAC,YAAY,CAAC;IACtD,CAAC;IAeD;;;;;;OAMG;IACH,YAAY,IAAY,EAAE,IAAe,EAAE,IAAmC;;QAC1E,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE;YACV,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACtD,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;aAC5D;YACD,cAAc,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YACxD,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,UAAU,CAAC,GAAG,MAAA,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC,mCAAI,KAAK,CAAC;YACzE,cAAc,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACpD,cAAc,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SACxD;aAAM;YACH,cAAc,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACpD,cAAc,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAChD,cAAc,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SACxD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,MAAM,SAAS,GAAG,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAAC,EAAE,CAAC;QAChE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QAC5C,KAAK,CAAC,KAAK,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IAC1D,CAAC;;AArEL,sBAsEC;AAzDG,gBAAgB;AACO,kBAAY,GAAG,0BAA0B,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pulumi/docker",
3
- "version": "v4.0.0-alpha.2",
3
+ "version": "v4.0.0-alpha.4",
4
4
  "description": "A Pulumi package for interacting with Docker in Pulumi programs",
5
5
  "keywords": [
6
6
  "pulumi",
@@ -11,7 +11,7 @@
11
11
  "license": "Apache-2.0",
12
12
  "scripts": {
13
13
  "build": "tsc",
14
- "install": "node scripts/install-pulumi-plugin.js resource docker v4.0.0-alpha.2"
14
+ "install": "node scripts/install-pulumi-plugin.js resource docker v4.0.0-alpha.4"
15
15
  },
16
16
  "dependencies": {
17
17
  "@pulumi/pulumi": "^3.0.0",
package/package.json.dev CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pulumi/docker",
3
- "version": "v4.0.0-alpha.2",
3
+ "version": "v4.0.0-alpha.4",
4
4
  "description": "A Pulumi package for interacting with Docker in Pulumi programs",
5
5
  "keywords": [
6
6
  "pulumi",
@@ -11,7 +11,7 @@
11
11
  "license": "Apache-2.0",
12
12
  "scripts": {
13
13
  "build": "tsc",
14
- "install": "node scripts/install-pulumi-plugin.js resource docker v4.0.0-alpha.2"
14
+ "install": "node scripts/install-pulumi-plugin.js resource docker v4.0.0-alpha.4"
15
15
  },
16
16
  "dependencies": {
17
17
  "@pulumi/pulumi": "^3.0.0",
package/types/enums/index.d.ts CHANGED
@@ -9,6 +9,6 @@ export declare const BuilderVersion: {
9
9
  readonly BuilderBuildKit: "BuilderBuildKit";
10
10
  };
11
11
  /**
12
- * The version of the Docker builder
12
+ * The version of the Docker builder.
13
13
  */
14
14
  export type BuilderVersion = (typeof BuilderVersion)[keyof typeof BuilderVersion];
package/types/input.d.ts CHANGED
@@ -258,7 +258,7 @@ export interface ContainerVolume {
258
258
  */
259
259
  export interface DockerBuild {
260
260
  /**
261
- * An optional map of named build-time argument variables to set during the Docker build. This flag allows you to pass built-time variablesthat can be accessed like environment variables inside the RUN instruction.
261
+ * An optional map of named build-time argument variables to set during the Docker build. This flag allows you to pass build-time variablesthat can be accessed like environment variables inside the RUN instruction.
262
262
  */
263
263
  args?: pulumi.Input<{
264
264
  [key: string]: pulumi.Input<string>;
@@ -280,15 +280,9 @@ export interface DockerBuild {
280
280
  */
281
281
  dockerfile?: pulumi.Input<string>;
282
282
  /**
283
- * Environment variables to set on the invocation of docker build, for example to support DOCKER_BUILDKIT=1 docker build.
283
+ * The architecture of the platform you want to build this image for, e.g. `linux/arm64`.
284
284
  */
285
- env?: pulumi.Input<{
286
- [key: string]: pulumi.Input<string>;
287
- }>;
288
- /**
289
- * A bag of extra options to pass on to the docker SDK.
290
- */
291
- extraOptions?: pulumi.Input<pulumi.Input<string>[]>;
285
+ platform?: pulumi.Input<string>;
292
286
  /**
293
287
  * The target of the Dockerfile to build
294
288
  */
@@ -350,7 +344,7 @@ export interface ProviderRegistryAuth {
350
344
  */
351
345
  export interface Registry {
352
346
  /**
353
- * The password to authenticate to the registry
347
+ * The password to authenticate to the registry. Does not cause image rebuild when changed.
354
348
  */
355
349
  password?: pulumi.Input<string>;
356
350
  /**
@@ -358,7 +352,7 @@ export interface Registry {
358
352
  */
359
353
  server?: pulumi.Input<string>;
360
354
  /**
361
- * The username to authenticate to the registry
355
+ * The username to authenticate to the registry. Does not cause image rebuild when changed.
362
356
  */
363
357
  username?: pulumi.Input<string>;
364
358
  }
package/types/input.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"input.js","sourceRoot":"","sources":["../../types/input.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAyTjF;;GAEG;AACH,SAAgB,0BAA0B,CAAC,GAAgB;;IACvD,uCACO,GAAG,KACN,cAAc,EAAE,MAAA,CAAC,GAAG,CAAC,cAAc,CAAC,mCAAI,iBAAiB,EACzD,OAAO,EAAE,MAAA,CAAC,GAAG,CAAC,OAAO,CAAC,mCAAI,GAAG,EAC7B,UAAU,EAAE,MAAA,CAAC,GAAG,CAAC,UAAU,CAAC,mCAAI,YAAY,IAC9C;AACN,CAAC;AAPD,gEAOC"}
1
+ {"version":3,"file":"input.js","sourceRoot":"","sources":["../../types/input.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAqTjF;;GAEG;AACH,SAAgB,0BAA0B,CAAC,GAAgB;;IACvD,uCACO,GAAG,KACN,cAAc,EAAE,MAAA,CAAC,GAAG,CAAC,cAAc,CAAC,mCAAI,iBAAiB,EACzD,OAAO,EAAE,MAAA,CAAC,GAAG,CAAC,OAAO,CAAC,mCAAI,GAAG,EAC7B,UAAU,EAAE,MAAA,CAAC,GAAG,CAAC,UAAU,CAAC,mCAAI,YAAY,IAC9C;AACN,CAAC;AAPD,gEAOC"}