@pulumi/docker 4.4.0-alpha.1692941676 → 4.4.0-alpha.1693328620

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/image.d.ts CHANGED
@@ -6,6 +6,16 @@ import * as inputs from "./types/input";
6
6
  *
7
7
  * Note: This resource does not delete tags, locally or remotely, when destroyed.
8
8
  *
9
+ * ## Image name
10
+ *
11
+ * The Image resource uses `imageName` to refer to a fully qualified Docker image name, by the format `repository:tag`.
12
+ * Note that this does not include any digest information and thus will not cause any updates when passed to dependencies,
13
+ * even when using `latest` tag. To trigger such updates, e.g. when referencing pushed images in container orchestration
14
+ * and management resources, please use the `repoDigest` Output instead, which is of the format
15
+ * `repository@<algorithm>:<hash>` and unique per build/push.
16
+ * Note that `repoDigest` is not available for local Images. For a local Image not pushed to a registry, you may want to
17
+ * give `imageName` a unique tag per pulumi update.
18
+ *
9
19
  * ## Cross-platform builds
10
20
  *
11
21
  * The Image resource supports cross-platform builds when the [Docker engine has cross-platform support enabled via emulators](https://docs.docker.com/build/building/multi-platform/#building-multi-platform-images).
@@ -27,6 +37,9 @@ import * as inputs from "./types/input";
27
37
  *
28
38
  * const demoImage = new docker.Image("demo-image", {
29
39
  * build: {
40
+ * args: {
41
+ * platform: "linux/amd64",
42
+ * },
30
43
  * context: ".",
31
44
  * dockerfile: "Dockerfile",
32
45
  * },
@@ -35,6 +48,22 @@ import * as inputs from "./types/input";
35
48
  * });
36
49
  * export const imageName = demoImage.imageName;
37
50
  * ```
51
+ * ### A Docker image build and push
52
+ *
53
+ * ```typescript
54
+ * import * as pulumi from "@pulumi/pulumi";
55
+ * import * as docker from "@pulumi/docker";
56
+ *
57
+ * const demoPushImage = new docker.Image("demo-push-image", {
58
+ * build: {
59
+ * context: ".",
60
+ * dockerfile: "Dockerfile",
61
+ * },
62
+ * imageName: "docker.io/username/push-image:tag1",
63
+ * });
64
+ * export const imageName = demoPushImage.imageName;
65
+ * export const repoDigest = demoPushImage.repoDigest;
66
+ * ```
38
67
  * ### Docker image build using caching with AWS Elastic Container Registry
39
68
  *
40
69
  * ```typescript
@@ -102,7 +131,10 @@ export declare class Image extends pulumi.CustomResource {
102
131
  */
103
132
  readonly registryServer: pulumi.Output<string>;
104
133
  /**
105
- * The digest of the manifest pushed to the registry, e.g.: repo[:tag]@<algorithm>:<hash>
134
+ * The manifest digest of an image pushed to a registry, of the format repository@<algorithm>:<hash>, e.g. `username/demo-image@sha256:a6ae6dd8d39c5bb02320e41abf00cd4cb35905fec540e37d306c878be8d38bd3`.
135
+ * This reference is unique per image build and push.
136
+ * Only available for images pushed to a registry.
137
+ * Use when passing a reference to a pushed image to container management resources.
106
138
  */
107
139
  readonly repoDigest: pulumi.Output<string | undefined>;
108
140
  /**
@@ -123,7 +155,8 @@ export interface ImageArgs {
123
155
  */
124
156
  build?: pulumi.Input<inputs.DockerBuild>;
125
157
  /**
126
- * The image name
158
+ * The image name, of the format repository[:tag], e.g. `docker.io/username/demo-image:v1`.
159
+ * This reference is not unique to each build and push.For the unique manifest SHA of a pushed docker image, please use `repoDigest`.
127
160
  */
128
161
  imageName: pulumi.Input<string>;
129
162
  /**
package/image.js CHANGED
@@ -12,6 +12,16 @@ const utilities = require("./utilities");
12
12
  *
13
13
  * Note: This resource does not delete tags, locally or remotely, when destroyed.
14
14
  *
15
+ * ## Image name
16
+ *
17
+ * The Image resource uses `imageName` to refer to a fully qualified Docker image name, by the format `repository:tag`.
18
+ * Note that this does not include any digest information and thus will not cause any updates when passed to dependencies,
19
+ * even when using `latest` tag. To trigger such updates, e.g. when referencing pushed images in container orchestration
20
+ * and management resources, please use the `repoDigest` Output instead, which is of the format
21
+ * `repository@<algorithm>:<hash>` and unique per build/push.
22
+ * Note that `repoDigest` is not available for local Images. For a local Image not pushed to a registry, you may want to
23
+ * give `imageName` a unique tag per pulumi update.
24
+ *
15
25
  * ## Cross-platform builds
16
26
  *
17
27
  * The Image resource supports cross-platform builds when the [Docker engine has cross-platform support enabled via emulators](https://docs.docker.com/build/building/multi-platform/#building-multi-platform-images).
@@ -33,6 +43,9 @@ const utilities = require("./utilities");
33
43
  *
34
44
  * const demoImage = new docker.Image("demo-image", {
35
45
  * build: {
46
+ * args: {
47
+ * platform: "linux/amd64",
48
+ * },
36
49
  * context: ".",
37
50
  * dockerfile: "Dockerfile",
38
51
  * },
@@ -41,6 +54,22 @@ const utilities = require("./utilities");
41
54
  * });
42
55
  * export const imageName = demoImage.imageName;
43
56
  * ```
57
+ * ### A Docker image build and push
58
+ *
59
+ * ```typescript
60
+ * import * as pulumi from "@pulumi/pulumi";
61
+ * import * as docker from "@pulumi/docker";
62
+ *
63
+ * const demoPushImage = new docker.Image("demo-push-image", {
64
+ * build: {
65
+ * context: ".",
66
+ * dockerfile: "Dockerfile",
67
+ * },
68
+ * imageName: "docker.io/username/push-image:tag1",
69
+ * });
70
+ * export const imageName = demoPushImage.imageName;
71
+ * export const repoDigest = demoPushImage.repoDigest;
72
+ * ```
44
73
  * ### Docker image build using caching with AWS Elastic Container Registry
45
74
  *
46
75
  * ```typescript
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;AACzC,wCAAwC;AAGxC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;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;IA2BD;;;;;;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,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC3I,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,SAAS,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC9C,cAAc,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACjD,cAAc,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACrD,cAAc,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SACpD;aAAM;YACH,cAAc,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACpD,cAAc,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC9C,cAAc,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACjD,cAAc,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAChD,cAAc,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACrD,cAAc,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SACpD;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;;AAvFL,sBAwFC;AA3EG,gBAAgB;AACO,kBAAY,GAAG,0BAA0B,CAAC"}
1
+ {"version":3,"file":"image.js","sourceRoot":"","sources":["../image.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AACzC,wCAAwC;AAGxC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8FG;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;IA8BD;;;;;;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,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,0BAA0B,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC3I,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,SAAS,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC9C,cAAc,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACjD,cAAc,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACrD,cAAc,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SACpD;aAAM;YACH,cAAc,CAAC,eAAe,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACpD,cAAc,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC9C,cAAc,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACjD,cAAc,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAChD,cAAc,CAAC,gBAAgB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YACrD,cAAc,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SACpD;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;;AA1FL,sBA2FC;AA9EG,gBAAgB;AACO,kBAAY,GAAG,0BAA0B,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@pulumi/docker",
3
- "version": "v4.4.0-alpha.1692941676+d8365922",
3
+ "version": "v4.4.0-alpha.1693328620+0c6b7105",
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.4.0-alpha.1692941676+d8365922"
14
+ "install": "node scripts/install-pulumi-plugin.js resource docker v4.4.0-alpha.1693328620+0c6b7105"
15
15
  },
16
16
  "dependencies": {
17
17
  "@pulumi/pulumi": "^3.0.0",