pulumi-docker-build 0.0.1__py3-none-any.whl → 0.0.1a3__py3-none-any.whl

pulumi_docker_build/_utilities.py

@@ -288,4 +288,4 @@ async def _await_output(o: pulumi.Output[typing.Any]) -> typing.Tuple[object, bo
     )
 
 def get_plugin_download_url():
-	return None
+	return "github.com/pulumi/pulumi-docker-build"

pulumi_docker_build/image.py

@@ -53,17 +53,20 @@ class ImageArgs:
                if these arguments are sensitive.
                
                Equivalent to Docker's `--build-arg` flag.
-        :param pulumi.Input[bool] build_on_preview: Setting this to `false` will always skip image builds during previews,
-               and setting it to `true` will always build images during previews.
+        :param pulumi.Input[bool] build_on_preview: By default, preview behavior depends on the execution environment. If
+               Pulumi detects the operation is running on a CI system (GitHub Actions,
+               Travis CI, Azure Pipelines, etc.) then it will build images during
+               previews as a safeguard. Otherwise, if not running on CI, previews will
+               not build images.
+               
+               Setting this to `false` forces previews to never perform builds, and
+               setting it to `true` will always build the image during previews.
                
                Images built during previews are never exported to registries, however
                cache manifests are still exported.
                
                On-disk Dockerfiles are always validated for syntactic correctness
                regardless of this setting.
-               
-               Defaults to `true` as a safeguard against broken images merging as part
-               of CI pipelines.
         :param pulumi.Input['BuilderConfigArgs'] builder: Builder configuration.
         :param pulumi.Input[Sequence[pulumi.Input['CacheFromArgs']]] cache_from: Cache export configuration.
                
@@ -168,8 +171,6 @@ class ImageArgs:
             pulumi.set(__self__, "add_hosts", add_hosts)
         if build_args is not None:
             pulumi.set(__self__, "build_args", build_args)
-        if build_on_preview is None:
-            build_on_preview = True
         if build_on_preview is not None:
             pulumi.set(__self__, "build_on_preview", build_on_preview)
         if builder is not None:
@@ -251,17 +252,20 @@ class ImageArgs:
     @pulumi.getter(name="buildOnPreview")
     def build_on_preview(self) -> Optional[pulumi.Input[bool]]:
         """
-        Setting this to `false` will always skip image builds during previews,
-        and setting it to `true` will always build images during previews.
+        By default, preview behavior depends on the execution environment. If
+        Pulumi detects the operation is running on a CI system (GitHub Actions,
+        Travis CI, Azure Pipelines, etc.) then it will build images during
+        previews as a safeguard. Otherwise, if not running on CI, previews will
+        not build images.
+
+        Setting this to `false` forces previews to never perform builds, and
+        setting it to `true` will always build the image during previews.
 
         Images built during previews are never exported to registries, however
         cache manifests are still exported.
 
         On-disk Dockerfiles are always validated for syntactic correctness
         regardless of this setting.
-
-        Defaults to `true` as a safeguard against broken images merging as part
-        of CI pipelines.
         """
         return pulumi.get(self, "build_on_preview")
 
@@ -612,14 +616,20 @@ class Image(pulumi.CustomResource):
 
         ## Stability
 
-        **This resource is pre-1.0 and in public preview.**
+        **This resource is experimental and subject to change.**
+
+        API types are unstable. Subsequent releases _may_ require manual edits
+        to your state file(s) in order to adopt API changes.
+
+        `retainOnDelete: true` is recommended with this resource until it is
+        stable. This enables future API changes to be adopted more easily by renaming
+        resources.
 
-        We will strive to keep APIs and behavior as stable as possible, but we
-        cannot guarantee stability until version 1.0.
+        Only use this resource if you understand and accept the risks.
 
-        ## Migrating Pulumi Docker v3 and v4 Image resources
+        ## Migrating v3 and v4 Image resources
 
-        This provider's `Image` resource provides a superset of functionality over the `Image` resources available in versions 3 and 4 of the Pulumi Docker provider.
+        The `Image` resource provides a superset of functionality over the `Image` resources available in versions 3 and 4 of the Pulumi Docker provider.
         Existing `Image` resources can be converted to the docker-build `Image` resources with minor modifications.
 
         ### Behavioral differences
@@ -633,17 +643,19 @@ class Image(pulumi.CustomResource):
 
         Version `4.x` changed build-on-preview behavior to be opt-in.
         By default, `v4.x` `Image` resources do _not_ build during previews, but this behavior can be toggled with the `buildOnPreview` option.
-        Several users reported outages due to the default behavior allowing bad images to accidentally sneak through CI.
+        Some users felt this made previews in CI less helpful because they no longer detected bad images by default.
 
-        The default behavior of this provider's `Image` resource is similar to `3.x` and will build images during previews.
-        This behavior can be changed by specifying `buildOnPreview`.
+        The default behavior of the `Image` resource has been changed to strike a better balance between CI use cases and manual updates.
+        By default, Pulumi will now only build `Image` resources during previews when it detects a CI environment like GitHub Actions.
+        Previews run in non-CI environments will not build images.
+        This behavior is still configurable with `buildOnPreview`.
 
         #### Push behavior
 
         Versions `3.x` and `4.x` of the Pulumi Docker provider attempt to push images to remote registries by default.
         They expose a `skipPush: true` option to disable pushing.
 
-        This provider's `Image` resource matches the Docker CLI's behavior and does not push images anywhere by default.
+        The `Image` resource matches the Docker CLI's behavior and does not push images anywhere by default.
 
         To push images to a registry you can include `push: true` (equivalent to Docker's `--push` flag) or configure an `export` of type `registry` (equivalent to Docker's `--output type=registry`).
         Like Docker, if an image is configured without exports you will see a warning with instructions for how to enable pushing, but the build will still proceed normally.
@@ -714,28 +726,28 @@ class Image(pulumi.CustomResource):
         ```python
         import pulumi
         import pulumi_aws as aws
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
         ecr_repository = aws.ecr.Repository("ecr-repository")
         auth_token = aws.ecr.get_authorization_token_output(registry_id=ecr_repository.registry_id)
-        my_image = docker_build.Image("my-image",
-            cache_from=[docker_build.CacheFromArgs(
-                registry=docker_build.CacheFromRegistryArgs(
+        my_image = dockerbuild.Image("my-image",
+            cache_from=[dockerbuild.CacheFromArgs(
+                registry=dockerbuild.CacheFromRegistryArgs(
                     ref=ecr_repository.repository_url.apply(lambda repository_url: f"{repository_url}:cache"),
                 ),
             )],
-            cache_to=[docker_build.CacheToArgs(
-                registry=docker_build.CacheToRegistryArgs(
+            cache_to=[dockerbuild.CacheToArgs(
+                registry=dockerbuild.CacheToRegistryArgs(
                     image_manifest=True,
                     oci_media_types=True,
                     ref=ecr_repository.repository_url.apply(lambda repository_url: f"{repository_url}:cache"),
                 ),
             )],
-            context=docker_build.BuildContextArgs(
+            context=dockerbuild.BuildContextArgs(
                 location="./app",
             ),
             push=True,
-            registries=[docker_build.RegistryArgs(
+            registries=[dockerbuild.RegistryArgs(
                 address=ecr_repository.repository_url,
                 password=auth_token.password,
                 username=auth_token.user_name,
@@ -746,28 +758,28 @@ class Image(pulumi.CustomResource):
         ### Multi-platform image
         ```python
         import pulumi
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
-        image = docker_build.Image("image",
-            context=docker_build.BuildContextArgs(
+        image = dockerbuild.Image("image",
+            context=dockerbuild.BuildContextArgs(
                 location="app",
             ),
             platforms=[
-                docker_build.Platform.PLAN9_AMD64,
-                docker_build.Platform.PLAN9_386,
+                dockerbuild.Platform.PLAN9_AMD64,
+                dockerbuild.Platform.PLAN9_386,
             ])
         ```
         ### Registry export
         ```python
         import pulumi
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
-        image = docker_build.Image("image",
-            context=docker_build.BuildContextArgs(
+        image = dockerbuild.Image("image",
+            context=dockerbuild.BuildContextArgs(
                 location="app",
             ),
             push=True,
-            registries=[docker_build.RegistryArgs(
+            registries=[dockerbuild.RegistryArgs(
                 address="docker.io",
                 password=docker_hub_password,
                 username="pulumibot",
@@ -778,34 +790,34 @@ class Image(pulumi.CustomResource):
         ### Caching
         ```python
         import pulumi
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
-        image = docker_build.Image("image",
-            cache_from=[docker_build.CacheFromArgs(
-                local=docker_build.CacheFromLocalArgs(
+        image = dockerbuild.Image("image",
+            cache_from=[dockerbuild.CacheFromArgs(
+                local=dockerbuild.CacheFromLocalArgs(
                     src="tmp/cache",
                 ),
             )],
-            cache_to=[docker_build.CacheToArgs(
-                local=docker_build.CacheToLocalArgs(
+            cache_to=[dockerbuild.CacheToArgs(
+                local=dockerbuild.CacheToLocalArgs(
                     dest="tmp/cache",
-                    mode=docker_build.CacheMode.MAX,
+                    mode=dockerbuild.CacheMode.MAX,
                 ),
             )],
-            context=docker_build.BuildContextArgs(
+            context=dockerbuild.BuildContextArgs(
                 location="app",
             ))
         ```
         ### Docker Build Cloud
         ```python
         import pulumi
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
-        image = docker_build.Image("image",
-            builder=docker_build.BuilderConfigArgs(
+        image = dockerbuild.Image("image",
+            builder=dockerbuild.BuilderConfigArgs(
                 name="cloud-builder-name",
             ),
-            context=docker_build.BuildContextArgs(
+            context=dockerbuild.BuildContextArgs(
                 location="app",
             ),
             exec_=True)
@@ -813,23 +825,23 @@ class Image(pulumi.CustomResource):
         ### Build arguments
         ```python
         import pulumi
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
-        image = docker_build.Image("image",
+        image = dockerbuild.Image("image",
             build_args={
                 "SET_ME_TO_TRUE": "true",
             },
-            context=docker_build.BuildContextArgs(
+            context=dockerbuild.BuildContextArgs(
                 location="app",
             ))
         ```
         ### Build target
         ```python
         import pulumi
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
-        image = docker_build.Image("image",
-            context=docker_build.BuildContextArgs(
+        image = dockerbuild.Image("image",
+            context=dockerbuild.BuildContextArgs(
                 location="app",
             ),
             target="build-me")
@@ -837,12 +849,12 @@ class Image(pulumi.CustomResource):
         ### Named contexts
         ```python
         import pulumi
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
-        image = docker_build.Image("image", context=docker_build.BuildContextArgs(
+        image = dockerbuild.Image("image", context=dockerbuild.BuildContextArgs(
             location="app",
             named={
-                "golang:latest": docker_build.ContextArgs(
+                "golang:latest": dockerbuild.ContextArgs(
                     location="docker-image://golang@sha256:b8e62cf593cdaff36efd90aa3a37de268e6781a2e68c6610940c48f7cdf36984",
                 ),
             },
@@ -851,22 +863,22 @@ class Image(pulumi.CustomResource):
         ### Remote context
         ```python
         import pulumi
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
-        image = docker_build.Image("image", context=docker_build.BuildContextArgs(
+        image = dockerbuild.Image("image", context=dockerbuild.BuildContextArgs(
             location="https://raw.githubusercontent.com/pulumi/pulumi-docker/api-types/provider/testdata/Dockerfile",
         ))
         ```
         ### Inline Dockerfile
         ```python
         import pulumi
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
-        image = docker_build.Image("image",
-            context=docker_build.BuildContextArgs(
+        image = dockerbuild.Image("image",
+            context=dockerbuild.BuildContextArgs(
                 location="app",
             ),
-            dockerfile=docker_build.DockerfileArgs(
+            dockerfile=dockerbuild.DockerfileArgs(
                 inline=\"\"\"FROM busybox
         COPY hello.c ./
         \"\"\",
@@ -875,27 +887,27 @@ class Image(pulumi.CustomResource):
         ### Remote context
         ```python
         import pulumi
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
-        image = docker_build.Image("image",
-            context=docker_build.BuildContextArgs(
+        image = dockerbuild.Image("image",
+            context=dockerbuild.BuildContextArgs(
                 location="https://github.com/docker-library/hello-world.git",
             ),
-            dockerfile=docker_build.DockerfileArgs(
+            dockerfile=dockerbuild.DockerfileArgs(
                 location="app/Dockerfile",
             ))
         ```
         ### Local export
         ```python
         import pulumi
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
-        image = docker_build.Image("image",
-            context=docker_build.BuildContextArgs(
+        image = dockerbuild.Image("image",
+            context=dockerbuild.BuildContextArgs(
                 location="app",
             ),
-            exports=[docker_build.ExportArgs(
-                docker=docker_build.ExportDockerArgs(
+            exports=[dockerbuild.ExportArgs(
+                docker=dockerbuild.ExportDockerArgs(
                     tar=True,
                 ),
             )])
@@ -915,17 +927,20 @@ class Image(pulumi.CustomResource):
                if these arguments are sensitive.
                
                Equivalent to Docker's `--build-arg` flag.
-        :param pulumi.Input[bool] build_on_preview: Setting this to `false` will always skip image builds during previews,
-               and setting it to `true` will always build images during previews.
+        :param pulumi.Input[bool] build_on_preview: By default, preview behavior depends on the execution environment. If
+               Pulumi detects the operation is running on a CI system (GitHub Actions,
+               Travis CI, Azure Pipelines, etc.) then it will build images during
+               previews as a safeguard. Otherwise, if not running on CI, previews will
+               not build images.
+               
+               Setting this to `false` forces previews to never perform builds, and
+               setting it to `true` will always build the image during previews.
                
                Images built during previews are never exported to registries, however
                cache manifests are still exported.
                
                On-disk Dockerfiles are always validated for syntactic correctness
                regardless of this setting.
-               
-               Defaults to `true` as a safeguard against broken images merging as part
-               of CI pipelines.
         :param pulumi.Input[pulumi.InputType['BuilderConfigArgs']] builder: Builder configuration.
         :param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['CacheFromArgs']]]] cache_from: Cache export configuration.
                
@@ -1038,14 +1053,20 @@ class Image(pulumi.CustomResource):
 
         ## Stability
 
-        **This resource is pre-1.0 and in public preview.**
+        **This resource is experimental and subject to change.**
+
+        API types are unstable. Subsequent releases _may_ require manual edits
+        to your state file(s) in order to adopt API changes.
 
-        We will strive to keep APIs and behavior as stable as possible, but we
-        cannot guarantee stability until version 1.0.
+        `retainOnDelete: true` is recommended with this resource until it is
+        stable. This enables future API changes to be adopted more easily by renaming
+        resources.
 
-        ## Migrating Pulumi Docker v3 and v4 Image resources
+        Only use this resource if you understand and accept the risks.
 
-        This provider's `Image` resource provides a superset of functionality over the `Image` resources available in versions 3 and 4 of the Pulumi Docker provider.
+        ## Migrating v3 and v4 Image resources
+
+        The `Image` resource provides a superset of functionality over the `Image` resources available in versions 3 and 4 of the Pulumi Docker provider.
         Existing `Image` resources can be converted to the docker-build `Image` resources with minor modifications.
 
         ### Behavioral differences
@@ -1059,17 +1080,19 @@ class Image(pulumi.CustomResource):
 
         Version `4.x` changed build-on-preview behavior to be opt-in.
         By default, `v4.x` `Image` resources do _not_ build during previews, but this behavior can be toggled with the `buildOnPreview` option.
-        Several users reported outages due to the default behavior allowing bad images to accidentally sneak through CI.
+        Some users felt this made previews in CI less helpful because they no longer detected bad images by default.
 
-        The default behavior of this provider's `Image` resource is similar to `3.x` and will build images during previews.
-        This behavior can be changed by specifying `buildOnPreview`.
+        The default behavior of the `Image` resource has been changed to strike a better balance between CI use cases and manual updates.
+        By default, Pulumi will now only build `Image` resources during previews when it detects a CI environment like GitHub Actions.
+        Previews run in non-CI environments will not build images.
+        This behavior is still configurable with `buildOnPreview`.
 
         #### Push behavior
 
         Versions `3.x` and `4.x` of the Pulumi Docker provider attempt to push images to remote registries by default.
         They expose a `skipPush: true` option to disable pushing.
 
-        This provider's `Image` resource matches the Docker CLI's behavior and does not push images anywhere by default.
+        The `Image` resource matches the Docker CLI's behavior and does not push images anywhere by default.
 
         To push images to a registry you can include `push: true` (equivalent to Docker's `--push` flag) or configure an `export` of type `registry` (equivalent to Docker's `--output type=registry`).
         Like Docker, if an image is configured without exports you will see a warning with instructions for how to enable pushing, but the build will still proceed normally.
@@ -1140,28 +1163,28 @@ class Image(pulumi.CustomResource):
         ```python
         import pulumi
         import pulumi_aws as aws
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
         ecr_repository = aws.ecr.Repository("ecr-repository")
         auth_token = aws.ecr.get_authorization_token_output(registry_id=ecr_repository.registry_id)
-        my_image = docker_build.Image("my-image",
-            cache_from=[docker_build.CacheFromArgs(
-                registry=docker_build.CacheFromRegistryArgs(
+        my_image = dockerbuild.Image("my-image",
+            cache_from=[dockerbuild.CacheFromArgs(
+                registry=dockerbuild.CacheFromRegistryArgs(
                     ref=ecr_repository.repository_url.apply(lambda repository_url: f"{repository_url}:cache"),
                 ),
             )],
-            cache_to=[docker_build.CacheToArgs(
-                registry=docker_build.CacheToRegistryArgs(
+            cache_to=[dockerbuild.CacheToArgs(
+                registry=dockerbuild.CacheToRegistryArgs(
                     image_manifest=True,
                     oci_media_types=True,
                     ref=ecr_repository.repository_url.apply(lambda repository_url: f"{repository_url}:cache"),
                 ),
             )],
-            context=docker_build.BuildContextArgs(
+            context=dockerbuild.BuildContextArgs(
                 location="./app",
             ),
             push=True,
-            registries=[docker_build.RegistryArgs(
+            registries=[dockerbuild.RegistryArgs(
                 address=ecr_repository.repository_url,
                 password=auth_token.password,
                 username=auth_token.user_name,
@@ -1172,28 +1195,28 @@ class Image(pulumi.CustomResource):
         ### Multi-platform image
         ```python
         import pulumi
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
-        image = docker_build.Image("image",
-            context=docker_build.BuildContextArgs(
+        image = dockerbuild.Image("image",
+            context=dockerbuild.BuildContextArgs(
                 location="app",
             ),
             platforms=[
-                docker_build.Platform.PLAN9_AMD64,
-                docker_build.Platform.PLAN9_386,
+                dockerbuild.Platform.PLAN9_AMD64,
+                dockerbuild.Platform.PLAN9_386,
             ])
         ```
         ### Registry export
         ```python
         import pulumi
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
-        image = docker_build.Image("image",
-            context=docker_build.BuildContextArgs(
+        image = dockerbuild.Image("image",
+            context=dockerbuild.BuildContextArgs(
                 location="app",
             ),
             push=True,
-            registries=[docker_build.RegistryArgs(
+            registries=[dockerbuild.RegistryArgs(
                 address="docker.io",
                 password=docker_hub_password,
                 username="pulumibot",
@@ -1204,34 +1227,34 @@ class Image(pulumi.CustomResource):
         ### Caching
         ```python
         import pulumi
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
-        image = docker_build.Image("image",
-            cache_from=[docker_build.CacheFromArgs(
-                local=docker_build.CacheFromLocalArgs(
+        image = dockerbuild.Image("image",
+            cache_from=[dockerbuild.CacheFromArgs(
+                local=dockerbuild.CacheFromLocalArgs(
                     src="tmp/cache",
                 ),
             )],
-            cache_to=[docker_build.CacheToArgs(
-                local=docker_build.CacheToLocalArgs(
+            cache_to=[dockerbuild.CacheToArgs(
+                local=dockerbuild.CacheToLocalArgs(
                     dest="tmp/cache",
-                    mode=docker_build.CacheMode.MAX,
+                    mode=dockerbuild.CacheMode.MAX,
                 ),
             )],
-            context=docker_build.BuildContextArgs(
+            context=dockerbuild.BuildContextArgs(
                 location="app",
             ))
         ```
         ### Docker Build Cloud
         ```python
         import pulumi
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
-        image = docker_build.Image("image",
-            builder=docker_build.BuilderConfigArgs(
+        image = dockerbuild.Image("image",
+            builder=dockerbuild.BuilderConfigArgs(
                 name="cloud-builder-name",
             ),
-            context=docker_build.BuildContextArgs(
+            context=dockerbuild.BuildContextArgs(
                 location="app",
             ),
             exec_=True)
@@ -1239,23 +1262,23 @@ class Image(pulumi.CustomResource):
         ### Build arguments
         ```python
         import pulumi
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
-        image = docker_build.Image("image",
+        image = dockerbuild.Image("image",
             build_args={
                 "SET_ME_TO_TRUE": "true",
             },
-            context=docker_build.BuildContextArgs(
+            context=dockerbuild.BuildContextArgs(
                 location="app",
             ))
         ```
         ### Build target
         ```python
         import pulumi
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
-        image = docker_build.Image("image",
-            context=docker_build.BuildContextArgs(
+        image = dockerbuild.Image("image",
+            context=dockerbuild.BuildContextArgs(
                 location="app",
             ),
             target="build-me")
@@ -1263,12 +1286,12 @@ class Image(pulumi.CustomResource):
         ### Named contexts
         ```python
         import pulumi
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
-        image = docker_build.Image("image", context=docker_build.BuildContextArgs(
+        image = dockerbuild.Image("image", context=dockerbuild.BuildContextArgs(
             location="app",
             named={
-                "golang:latest": docker_build.ContextArgs(
+                "golang:latest": dockerbuild.ContextArgs(
                     location="docker-image://golang@sha256:b8e62cf593cdaff36efd90aa3a37de268e6781a2e68c6610940c48f7cdf36984",
                 ),
             },
@@ -1277,22 +1300,22 @@ class Image(pulumi.CustomResource):
         ### Remote context
         ```python
         import pulumi
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
-        image = docker_build.Image("image", context=docker_build.BuildContextArgs(
+        image = dockerbuild.Image("image", context=dockerbuild.BuildContextArgs(
             location="https://raw.githubusercontent.com/pulumi/pulumi-docker/api-types/provider/testdata/Dockerfile",
         ))
         ```
         ### Inline Dockerfile
         ```python
         import pulumi
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
-        image = docker_build.Image("image",
-            context=docker_build.BuildContextArgs(
+        image = dockerbuild.Image("image",
+            context=dockerbuild.BuildContextArgs(
                 location="app",
             ),
-            dockerfile=docker_build.DockerfileArgs(
+            dockerfile=dockerbuild.DockerfileArgs(
                 inline=\"\"\"FROM busybox
         COPY hello.c ./
         \"\"\",
@@ -1301,27 +1324,27 @@ class Image(pulumi.CustomResource):
         ### Remote context
         ```python
         import pulumi
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
-        image = docker_build.Image("image",
-            context=docker_build.BuildContextArgs(
+        image = dockerbuild.Image("image",
+            context=dockerbuild.BuildContextArgs(
                 location="https://github.com/docker-library/hello-world.git",
             ),
-            dockerfile=docker_build.DockerfileArgs(
+            dockerfile=dockerbuild.DockerfileArgs(
                 location="app/Dockerfile",
             ))
         ```
         ### Local export
         ```python
         import pulumi
-        import pulumi_docker_build as docker_build
+        import pulumi_dockerbuild as dockerbuild
 
-        image = docker_build.Image("image",
-            context=docker_build.BuildContextArgs(
+        image = dockerbuild.Image("image",
+            context=dockerbuild.BuildContextArgs(
                 location="app",
             ),
-            exports=[docker_build.ExportArgs(
-                docker=docker_build.ExportDockerArgs(
+            exports=[dockerbuild.ExportArgs(
+                docker=dockerbuild.ExportDockerArgs(
                     tar=True,
                 ),
             )])
@@ -1375,8 +1398,6 @@ class Image(pulumi.CustomResource):
 
             __props__.__dict__["add_hosts"] = add_hosts
             __props__.__dict__["build_args"] = build_args
-            if build_on_preview is None:
-                build_on_preview = True
             __props__.__dict__["build_on_preview"] = build_on_preview
             __props__.__dict__["builder"] = builder
             __props__.__dict__["cache_from"] = cache_from
@@ -1481,17 +1502,20 @@ class Image(pulumi.CustomResource):
     @pulumi.getter(name="buildOnPreview")
     def build_on_preview(self) -> pulumi.Output[Optional[bool]]:
         """
-        Setting this to `false` will always skip image builds during previews,
-        and setting it to `true` will always build images during previews.
+        By default, preview behavior depends on the execution environment. If
+        Pulumi detects the operation is running on a CI system (GitHub Actions,
+        Travis CI, Azure Pipelines, etc.) then it will build images during
+        previews as a safeguard. Otherwise, if not running on CI, previews will
+        not build images.
+
+        Setting this to `false` forces previews to never perform builds, and
+        setting it to `true` will always build the image during previews.
 
         Images built during previews are never exported to registries, however
         cache manifests are still exported.
 
         On-disk Dockerfiles are always validated for syntactic correctness
         regardless of this setting.
-
-        Defaults to `true` as a safeguard against broken images merging as part
-        of CI pipelines.
         """
         return pulumi.get(self, "build_on_preview")
 

pulumi_docker_build/index.py

@@ -104,25 +104,13 @@ class Index(pulumi.CustomResource):
                  tag: Optional[pulumi.Input[str]] = None,
                  __props__=None):
         """
-        A wrapper around `docker buildx imagetools create` to create an index
-        (or manifest list) referencing one or more existing images.
+        An index (or manifest list) referencing one or more existing images.
 
-        In most cases you do not need an `Index` to build a multi-platform
-        image -- specifying multiple platforms on the `Image` will handle this
-        for you automatically.
+        Useful for crafting a multi-platform image from several
+        platform-specific images.
 
-        However, as of April 2024, building multi-platform images _with
-        caching_ will only export a cache for one platform at a time (see [this
-        discussion](https://github.com/docker/buildx/discussions/1382) for more
-        details).
-
-        Therefore this resource can be helpful if you are building
-        multi-platform images with caching: each platform can be built and
-        cached separately, and an `Index` can join them all together. An
-        example of this is shown below.
-
-        This resource creates an OCI image index or a Docker manifest list
-        depending on the media types of the source images.
+        This creates an OCI image index or a Docker manifest list depending on
+        the media types of the source images.
 
         ## Example Usage
         ### Multi-platform registry caching
@@ -191,25 +179,13 @@ class Index(pulumi.CustomResource):
                  args: IndexArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        A wrapper around `docker buildx imagetools create` to create an index
-        (or manifest list) referencing one or more existing images.
-
-        In most cases you do not need an `Index` to build a multi-platform
-        image -- specifying multiple platforms on the `Image` will handle this
-        for you automatically.
-
-        However, as of April 2024, building multi-platform images _with
-        caching_ will only export a cache for one platform at a time (see [this
-        discussion](https://github.com/docker/buildx/discussions/1382) for more
-        details).
+        An index (or manifest list) referencing one or more existing images.
 
-        Therefore this resource can be helpful if you are building
-        multi-platform images with caching: each platform can be built and
-        cached separately, and an `Index` can join them all together. An
-        example of this is shown below.
+        Useful for crafting a multi-platform image from several
+        platform-specific images.
 
-        This resource creates an OCI image index or a Docker manifest list
-        depending on the media types of the source images.
+        This creates an OCI image index or a Docker manifest list depending on
+        the media types of the source images.
 
         ## Example Usage
         ### Multi-platform registry caching

pulumi_docker_build/pulumi-plugin.json

@@ -1,4 +1,5 @@
 {
   "resource": true,
-  "name": "docker-build"
+  "name": "docker-build",
+  "server": "github.com/pulumi/pulumi-docker-build"
 }

pulumi_docker_build-0.0.1a3.dist-info/METADATA

@@ -0,0 +1,120 @@
+Metadata-Version: 2.1
+Name: pulumi_docker_build
+Version: 0.0.1a3
+Summary: A Pulumi provider for Docker buildx
+License: Apache-2.0
+Project-URL: Homepage, https://pulumi.io
+Project-URL: Repository, https://github.com/pulumi/pulumi-docker-build
+Keywords: docker,buildkit,buildx
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: parver >=0.2.1
+Requires-Dist: pulumi <4.0.0,>=3.0.0
+Requires-Dist: semver >=2.8.1
+
+# Pulumi Native Provider Boilerplate
+
+This repository is a boilerplate showing how to create and locally test a native Pulumi provider.
+
+## Authoring a Pulumi Native Provider
+
+This boilerplate creates a working Pulumi-owned provider named `xyz`.
+It implements a random number generator that you can [build and test out for yourself](#test-against-the-example) and then replace the Random code with code specific to your provider.
+
+
+### Prerequisites
+
+Prerequisites for this repository are already satisfied by the [Pulumi Devcontainer](https://github.com/pulumi/devcontainer) if you are using Github Codespaces, or VSCode.
+
+If you are not using VSCode, you will need to ensure the following tools are installed and present in your `$PATH`:
+
+* [`pulumictl`](https://github.com/pulumi/pulumictl#installation)
+* [Go 1.21](https://golang.org/dl/) or 1.latest
+* [NodeJS](https://nodejs.org/en/) 14.x.  We recommend using [nvm](https://github.com/nvm-sh/nvm) to manage NodeJS installations.
+* [Yarn](https://yarnpkg.com/)
+* [TypeScript](https://www.typescriptlang.org/)
+* [Python](https://www.python.org/downloads/) (called as `python3`).  For recent versions of MacOS, the system-installed version is fine.
+* [.NET](https://dotnet.microsoft.com/download)
+
+
+### Build & test the boilerplate XYZ provider
+
+1. Create a new Github CodeSpaces environment using this repository.
+1. Open a terminal in the CodeSpaces environment.
+1. Run `make build install` to build and install the provider.
+1. Run `make gen_examples` to generate the example programs in `examples/` off of the source `examples/yaml` example program.
+1. Run `make up` to run the example program in `examples/yaml`.
+1. Run `make down` to tear down the example program.
+
+### Creating a new provider repository
+
+Pulumi offers this repository as a [GitHub template repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) for convenience.  From this repository:
+
+1. Click "Use this template".
+1. Set the following options:
+   * Owner: pulumi 
+   * Repository name: pulumi-xyz-native (replace "xyz" with the name of your provider)
+   * Description: Pulumi provider for xyz
+   * Repository type: Public
+1. Clone the generated repository.
+
+From the templated repository:
+
+1. Search-replace `xyz` with the name of your desired provider.
+
+#### Build the provider and install the plugin
+
+   ```bash
+   $ make build install
+   ```
+   
+This will:
+
+1. Create the SDK codegen binary and place it in a `./bin` folder (gitignored)
+2. Create the provider binary and place it in the `./bin` folder (gitignored)
+3. Generate the dotnet, Go, Node, and Python SDKs and place them in the `./sdk` folder
+4. Install the provider on your machine.
+
+#### Test against the example
+   
+```bash
+$ cd examples/simple
+$ yarn link @pulumi/xyz
+$ yarn install
+$ pulumi stack init test
+$ pulumi up
+```
+
+Now that you have completed all of the above steps, you have a working provider that generates a random string for you.
+
+#### A brief repository overview
+
+You now have:
+
+1. A `provider/` folder containing the building and implementation logic
+    1. `cmd/pulumi-resource-xyz/main.go` - holds the provider's sample implementation logic.
+2. `deployment-templates` - a set of files to help you around deployment and publication
+3. `sdk` - holds the generated code libraries created by `pulumi-gen-xyz/main.go`
+4. `examples` a folder of Pulumi programs to try locally and/or use in CI.
+5. A `Makefile` and this `README`.
+
+#### Additional Details
+
+This repository depends on the pulumi-go-provider library. For more details on building providers, please check
+the [Pulumi Go Provider docs](https://github.com/pulumi/pulumi-go-provider).
+
+### Build Examples
+
+Create an example program using the resources defined in your provider, and place it in the `examples/` folder.
+
+You can now repeat the steps for [build, install, and test](#test-against-the-example).
+
+## Configuring CI and releases
+
+1. Follow the instructions laid out in the [deployment templates](./deployment-templates/README-DEPLOYMENT.md).
+
+## References
+
+Other resources/examples for implementing providers:
+* [Pulumi Command provider](https://github.com/pulumi/pulumi-command/blob/master/provider/pkg/provider/provider.go)
+* [Pulumi Go Provider repository](https://github.com/pulumi/pulumi-go-provider)

{pulumi_docker_build-0.0.1.dist-info → pulumi_docker_build-0.0.1a3.dist-info}/RECORD

@@ -1,17 +1,17 @@
 pulumi_docker_build/__init__.py,sha256=jbA6SMpisvwJDycUKuo4IXVJ5_qjIao_1iPP9lcZ-Vw,983
 pulumi_docker_build/_enums.py,sha256=yfsDmimBobvf70zx6VAR_6ABp50Dan452rpIFVs8jkA,1928
 pulumi_docker_build/_inputs.py,sha256=L_v8wgNW_tjfh4caAatNqLUzqJwmPRbFSFFXrAs0h88,97964
-pulumi_docker_build/_utilities.py,sha256=GzGkkcCHl56rhrwBOUvVkUvrjPsBOA37ZH6NsPQOiKI,9230
-pulumi_docker_build/image.py,sha256=fsF_y3EFFqMPDZ5_a0HBNKlbREwFNKHHsl8LW2U1sIQ,75070
-pulumi_docker_build/index.py,sha256=UovlVuMLsHogF2-U0-Lzxu1gi8LLixPQHTOgP-YYZ60,14598
+pulumi_docker_build/_utilities.py,sha256=rA8XvgybOPKFzEaIJx85muKv85tzLL5lEBQ58eVLEzs,9265
+pulumi_docker_build/image.py,sha256=AXN-kxI63aLrYFwbwTYjIuRf8XiPaC-YDtmh7jmqUpo,76626
+pulumi_docker_build/index.py,sha256=KHTpB_4i7e3b2no1batLV7KyhYJrWUj-bEdKh9VEYYQ,13254
 pulumi_docker_build/outputs.py,sha256=l9VIy-AMXUdQffKVpYcR-KCdtc7huWQ2qCDhv_hgHVs,83253
 pulumi_docker_build/provider.py,sha256=5f1FtyHXjxcCA3nouMG5HVJyrBEdCB452ezcNt53NmQ,4780
-pulumi_docker_build/pulumi-plugin.json,sha256=zQHHpPYv356aVJ950hUzazofky15CPTYmwyqA82kHYI,49
+pulumi_docker_build/pulumi-plugin.json,sha256=aNWnPPkTjPtNuWio8hIVyGOPhfmTF0knTyxRragQ0dQ,102
 pulumi_docker_build/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pulumi_docker_build/config/__init__.py,sha256=YdGLR92OvYD0CYDgt_FTaHJOb_VzW8fto_Cgx6fLd3k,267
 pulumi_docker_build/config/__init__.pyi,sha256=2lJs0q5nxrEi63kCCpe7M23-j-0NiQu9UpKaYAWe5TM,441
 pulumi_docker_build/config/vars.py,sha256=6g1SHA-v-YBMxDX9KwlhaZZ3Yk7DzC5_EB2xz0FQiKo,756
-pulumi_docker_build-0.0.1.dist-info/METADATA,sha256=OCBD-1gS6-qtwodFUXrChup0hJlegNm_qFzC00Fo70s,2546
-pulumi_docker_build-0.0.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-pulumi_docker_build-0.0.1.dist-info/top_level.txt,sha256=-O-MiPQ61mhil3wD9QdYf8yA4r5vNPmBgSGdi9cOQ18,20
-pulumi_docker_build-0.0.1.dist-info/RECORD,,
+pulumi_docker_build-0.0.1a3.dist-info/METADATA,sha256=IeBXqw170V8JSN9pgBeD4VtD4Gp2rW0_bgDB6WLEIi0,4791
+pulumi_docker_build-0.0.1a3.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+pulumi_docker_build-0.0.1a3.dist-info/top_level.txt,sha256=-O-MiPQ61mhil3wD9QdYf8yA4r5vNPmBgSGdi9cOQ18,20
+pulumi_docker_build-0.0.1a3.dist-info/RECORD,,

pulumi_docker_build-0.0.1.dist-info/METADATA

@@ -1,37 +0,0 @@
-Metadata-Version: 2.1
-Name: pulumi_docker_build
-Version: 0.0.1
-Summary: A Pulumi provider for building modern Docker images with buildx and BuildKit.
-License: Apache-2.0
-Project-URL: Homepage, https://pulumi.com
-Project-URL: Repository, https://github.com/pulumi/pulumi-docker-build
-Keywords: docker,buildkit,buildx,kind/native
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Requires-Dist: parver >=0.2.1
-Requires-Dist: pulumi <4.0.0,>=3.0.0
-Requires-Dist: semver >=2.8.1
-
-[![Slack](http://www.pulumi.com/images/docs/badges/slack.svg)](https://slack.pulumi.com)
-[![NPM version](https://badge.fury.io/js/%40pulumi%2fdocker-build.svg)](https://www.npmjs.com/package/@pulumi/docker-build)
-[![Python version](https://badge.fury.io/py/pulumi-docker-build.svg)](https://pypi.org/project/pulumi-docker-build)
-[![NuGet version](https://badge.fury.io/nu/pulumi.dockerbuild.svg)](https://badge.fury.io/nu/pulumi.dockerbuild)
-[![PkgGoDev](https://pkg.go.dev/badge/github.com/pulumi/pulumi-docker-build/sdk/go)](https://pkg.go.dev/github.com/pulumi/pulumi-docker-build/sdk/go)
-[![License](https://img.shields.io/npm/l/%40pulumi%2Fpulumi.svg)](https://github.com/pulumi/pulumi-docker-build/blob/main/LICENSE)
-
-# Docker-Build Resource Provider
-
-A [Pulumi](http://pulumi.com) provider for building modern Docker images with [buildx](https://docs.docker.com/build/architecture/) and [BuildKit](https://docs.docker.com/build/buildkit/).
-
-Not to be confused with the earlier
-[Docker](http://github.com/pulumi/pulumi-docker) provider, which is still
-appropriate for managing resources unrelated to building images.
-
-| Provider               | Use cases                                                                                                                                                |
-| ----------------       | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `@pulumi/docker-build` | Anything related to building images with `docker build`.                                                                                                 |
-| `@pulumi/docker`       | Everything else -- including running containers and creating networks.                                                                                   |
-
-## Reference
-
-For more information, including examples and migration guidance, please see the Docker-Build provider's detailed [API documentation](https://www.pulumi.com/registry/packages/docker-build/).