Add HCL Examples & Docs (#852)

Fixes https://github.com/pulumi/pulumi-docker-build/issues/844

Makefile

@@ -58,7 +58,7 @@ test_all:: test_provider test_examples
 gen_examples:
 
 examples: $(shell mkdir -p examples)
-examples: sdk examples/yaml examples/go examples/nodejs examples/python examples/dotnet examples/java
+examples: sdk examples/yaml examples/go examples/nodejs examples/python examples/dotnet examples/java examples/hcl
 
 examples/yaml:
 	rm -rf ${WORKING_DIR}/examples/yaml/app
@@ -84,6 +84,9 @@ examples/java: bin/${PROVIDER} ${WORKING_DIR}/examples/yaml/Pulumi.yaml
 	$(call example,java)
 	@git checkout examples/java/pom.xml
 
+examples/hcl: bin/${PROVIDER} ${WORKING_DIR}/examples/yaml/Pulumi.yaml
+	$(call example,hcl)
+
 define pulumi_login
     export PULUMI_CONFIG_PASSPHRASE=asdfqwerty1234; \
     pulumi login --local;

docs/generate.go

@@ -81,6 +81,7 @@ func markdownExample(description string,
 	csharp string,
 	golang string,
 	yaml string,
+	hcl string,
 	java string,
 ) string {
 	return fmt.Sprintf("{{%% example %%}}\n### %s\n\n"+
@@ -89,9 +90,10 @@ func markdownExample(description string,
 		"```csharp\n%s```\n"+
 		"```go\n%s```\n"+
 		"```yaml\n%s```\n"+
+		"```hcl\n%s```\n"+
 		"```java\n%s```\n"+
 		"{{%% /example %%}}\n",
-		description, typescript, python, csharp, golang, yaml, java)
+		description, typescript, python, csharp, golang, yaml, hcl, java)
 }
 
 func convert(language, tempDir, programFile string) (string, error) {
@@ -186,6 +188,10 @@ func processYaml(path, mdDir string) error {
 			if err != nil {
 				return false, err
 			}
+			hcl, err := convert("hcl", dir, "program.hcl")
+			if err != nil {
+				return false, err
+			}
 
 			yamlContent, err := os.ReadFile(filepath.Clean(filepath.Join(dir, "Pulumi.yaml")))
 			if err != nil {
@@ -193,7 +199,9 @@ func processYaml(path, mdDir string) error {
 			}
 			yaml := string(yamlContent)
 
-			exampleStrings = append(exampleStrings, markdownExample(description, typescript, python, csharp, golang, yaml, java))
+			exampleStrings = append(exampleStrings, markdownExample(
+				description, typescript, python, csharp, golang, yaml, hcl, java,
+			))
 
 			return true, nil
 		}()

docs/yaml/image-examples.yaml

@@ -62,7 +62,7 @@ resources:
           username: pulumibot
           password: ${dockerHubPassword}
 outputs:
-  ref: ${my-image.ref}
+  ref: ${image.ref}
 ---
 name: caching
 runtime: yaml

examples/hcl/.dockerignore

@@ -0,0 +1,2 @@
+command-output
+tmp

examples/hcl/Pulumi.yaml

@@ -0,0 +1,10 @@
+name: provider-docker-build
+runtime: hcl
+config:
+  dockerHubPassword:
+    type: string
+    secret: true
+plugins:
+  providers:
+    - name: docker-build
+      path: ../../bin

examples/hcl/app/Dockerfile

@@ -0,0 +1,2 @@
+FROM alpine
+RUN echo 👍

examples/hcl/app/Dockerfile.buildArgs

@@ -0,0 +1,5 @@
+FROM alpine
+
+ARG SET_ME_TO_TRUE
+RUN [ "$SET_ME_TO_TRUE" = "true" ]
+RUN echo "That's the correct build arg, thanks! 👍"

examples/hcl/app/Dockerfile.emptyContext

@@ -0,0 +1,2 @@
+FROM alpine
+RUN echo "This image doesn't use any local files, so it doesn't need a context parameter 👍"

examples/hcl/app/Dockerfile.extraHosts

@@ -0,0 +1,3 @@
+FROM bash AS base
+
+RUN getent hosts metadata.google.internal

examples/hcl/app/Dockerfile.multiPlatform

@@ -0,0 +1,7 @@
+FROM --platform=$BUILDPLATFORM alpine as build
+RUN echo ${BUILDPLATFORM} > buildplatform
+RUN echo ${TARGETPLATFORM} > targetplatform
+
+FROM build
+RUN cat buildplatform
+RUN cat targetplatform

examples/hcl/app/Dockerfile.namedContexts

@@ -0,0 +1,5 @@
+# syntax=docker/dockerfile:1.4
+FROM golang:latest
+
+RUN version="$(go version)" && echo $version && [ "$version" = "go version go1.21.7 linux/amd64" ]
+RUN echo "This image uses named contexts to pin golang:latest to a specific SHA 👍"

examples/hcl/app/Dockerfile.secrets

@@ -0,0 +1,4 @@
+FROM alpine
+
+RUN --mount=type=secret,id=password [ "$(cat /run/secrets/password)" = "hunter2" ]
+

examples/hcl/app/Dockerfile.sshMount

@@ -0,0 +1,5 @@
+FROM alpine
+
+RUN apk add openssh-client
+
+RUN --mount=type=ssh ssh-add -l

examples/hcl/app/Dockerfile.target

@@ -0,0 +1,8 @@
+FROM alpine as build-me
+RUN echo 👍
+
+FROM build-me as also-build-me
+RUN echo 🤙
+
+FROM build-me as dont-build-me
+RUN [ "true" = "false" ]

examples/hcl/program.hcl

@@ -0,0 +1,171 @@
+pulumi {
+  required_providers {
+    docker-build = {
+      source  = "pulumi/docker-build"
+      version = "0.1.0-alpha.0+dev"
+    }
+  }
+}
+
+resource "docker-build_image" "multiPlatform" {
+  push = false
+  dockerfile = {
+    location = "./app/Dockerfile.multiPlatform"
+  }
+  context = {
+    location = "./app"
+  }
+  platforms = ["plan9/amd64", "plan9/386"]
+}
+resource "docker-build_image" "registryPush" {
+  push = false
+  context = {
+    location = "./app"
+  }
+  tags = ["docker.io/pulumibot/buildkit-e2e:example"]
+  exports {
+    registry = {
+      oci_media_types = true
+      push            = false
+    }
+  }
+  registries {
+    address  = "docker.io"
+    username = "pulumibot"
+    password = var.dockerHubPassword
+  }
+}
+resource "docker-build_image" "cached" {
+  push = false
+  context = {
+    location = "./app"
+  }
+  cache_to {
+    local = {
+      dest = "tmp/cache"
+      mode = "max"
+    }
+  }
+  cache_from {
+    local = {
+      src = "tmp/cache"
+    }
+  }
+}
+resource "docker-build_image" "buildArgs" {
+  push = false
+  dockerfile = {
+    location = "./app/Dockerfile.buildArgs"
+  }
+  context = {
+    location = "./app"
+  }
+  build_args = {
+    "SET_ME_TO_TRUE" = "true"
+  }
+}
+resource "docker-build_image" "extraHosts" {
+  push = false
+  dockerfile = {
+    location = "./app/Dockerfile.extraHosts"
+  }
+  context = {
+    location = "./app"
+  }
+  add_hosts = ["metadata.google.internal:169.254.169.254"]
+}
+resource "docker-build_image" "sshMount" {
+  push = false
+  dockerfile = {
+    location = "./app/Dockerfile.sshMount"
+  }
+  context = {
+    location = "./app"
+  }
+  ssh {
+    id = "default"
+  }
+}
+resource "docker-build_image" "secrets" {
+  push = false
+  dockerfile = {
+    location = "./app/Dockerfile.secrets"
+  }
+  context = {
+    location = "./app"
+  }
+  secrets = {
+    "password" = "hunter2"
+  }
+}
+resource "docker-build_image" "labels" {
+  push = false
+  context = {
+    location = "./app"
+  }
+  labels = {
+    "description" = "This image will get a descriptive label 👍"
+  }
+}
+resource "docker-build_image" "target" {
+  push = false
+  dockerfile = {
+    location = "./app/Dockerfile.target"
+  }
+  context = {
+    location = "./app"
+  }
+  target = "build-me"
+}
+resource "docker-build_image" "namedContexts" {
+  push = false
+  dockerfile = {
+    location = "./app/Dockerfile.namedContexts"
+  }
+  context = {
+    location = "./app"
+    named = {
+      "golang:latest" = {
+        location = "docker-image://golang@sha256:b8e62cf593cdaff36efd90aa3a37de268e6781a2e68c6610940c48f7cdf36984"
+      }
+    }
+  }
+}
+resource "docker-build_image" "remoteContext" {
+  push = false
+  context = {
+    location = "https://raw.githubusercontent.com/pulumi/pulumi-docker/api-types/provider/testdata/Dockerfile"
+  }
+}
+resource "docker-build_image" "remoteContextWithInline" {
+  push = false
+  dockerfile = {
+    inline = "FROM busybox\nCOPY hello.c ./\n"
+  }
+  context = {
+    location = "https://github.com/docker-library/hello-world.git"
+  }
+}
+resource "docker-build_image" "inline" {
+  push = false
+  dockerfile = {
+    inline = "FROM alpine\nRUN echo \"This uses an inline Dockerfile! 👍\"\n"
+  }
+}
+resource "docker-build_image" "dockerLoad" {
+  push = false
+  context = {
+    location = "./app"
+  }
+  exports {
+    docker = {
+      tar = true
+    }
+  }
+}
+variable "dockerHubPassword" {
+  type = string
+}
+output "platforms" {
+  value = docker-build_image.multiPlatform.platforms
+}

examples/yaml_test.go

@@ -35,6 +35,20 @@ func TestYAMLExample(t *testing.T) {
 	integration.ProgramTest(t, &test)
 }
 
+func TestHCLExample(t *testing.T) {
+	cwd, err := os.Getwd()
+	require.NoError(t, err)
+
+	test := integration.ProgramTestOptions{
+		Dir: path.Join(cwd, "hcl"),
+		Secrets: map[string]string{
+			"dockerHubPassword": os.Getenv("DOCKER_HUB_PASSWORD"),
+		},
+	}
+
+	integration.ProgramTest(t, &test)
+}
+
 func TestYAMLExampleUpgrade(t *testing.T) {
 	pt := pulumitest.NewPulumiTest(t, "upgrade",
 		opttest.AttachProviderServer("docker-build", providerServerFactory))

mise.toml

@@ -1,2 +0,0 @@
-[tools]
-golangci-lint = "2.7.0"

provider/internal/embed/image-examples.md

@@ -143,7 +143,7 @@ package main
 import (
 	"fmt"
 
-	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ecr"
+	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ecr"
 	"github.com/pulumi/pulumi-docker-build/sdk/go/dockerbuild"
 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 )
@@ -241,6 +241,54 @@ variables:
         fn::aws:ecr:getAuthorizationToken:
             registryId: ${ecr-repository.registryId}
 ```
+```hcl
+pulumi {
+  required_providers {
+    aws = {
+      source  = "pulumi/aws"
+      version = "7.29.0"
+    }
+    docker-build = {
+      source  = "pulumi/docker-build"
+      version = "0.0.15"
+    }
+  }
+}
+
+data "aws_ecr_getauthorizationtoken" "authToken" {
+  registry_id = aws_ecr_repository.ecr-repository.registry_id
+}
+
+resource "aws_ecr_repository" "ecr-repository" {
+}
+resource "docker-build_image" "my-image" {
+  cache_from {
+    registry = {
+      ref ="${aws_ecr_repository.ecr-repository.repository_url}:cache"
+    }
+  }
+  cache_to {
+    registry = {
+      image_manifest  = true
+      oci_media_types = true
+      ref             ="${aws_ecr_repository.ecr-repository.repository_url}:cache"
+    }
+  }
+  context = {
+    location = "./app"
+  }
+  push = true
+  registries {
+    address  = aws_ecr_repository.ecr-repository.repository_url
+    password = data.aws_ecr_getauthorizationtoken.authToken.password
+    username = data.aws_ecr_getauthorizationtoken.authToken.user_name
+  }
+  tags = ["${aws_ecr_repository.ecr-repository.repository_url}:latest"]
+}
+output "ref" {
+  value = docker-build_image.my-image.ref
+}
+```
 ```java
 package generated_program;
 
@@ -258,8 +306,8 @@ import com.pulumi.dockerbuild.inputs.CacheToArgs;
 import com.pulumi.dockerbuild.inputs.CacheToRegistryArgs;
 import com.pulumi.dockerbuild.inputs.BuildContextArgs;
 import com.pulumi.dockerbuild.inputs.RegistryArgs;
-import java.util.List;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
@@ -280,14 +328,14 @@ public class App {
         var myImage = new Image("myImage", ImageArgs.builder()
             .cacheFrom(CacheFromArgs.builder()
                 .registry(CacheFromRegistryArgs.builder()
-                    .ref(ecrRepository.repositoryUrl().applyValue(repositoryUrl -> String.format("%s:cache", repositoryUrl)))
+                    .ref(ecrRepository.repositoryUrl().applyValue(_repositoryUrl -> String.format("%s:cache", _repositoryUrl)))
                     .build())
                 .build())
             .cacheTo(CacheToArgs.builder()
                 .registry(CacheToRegistryArgs.builder()
                     .imageManifest(true)
                     .ociMediaTypes(true)
-                    .ref(ecrRepository.repositoryUrl().applyValue(repositoryUrl -> String.format("%s:cache", repositoryUrl)))
+                    .ref(ecrRepository.repositoryUrl().applyValue(_repositoryUrl -> String.format("%s:cache", _repositoryUrl)))
                     .build())
                 .build())
             .context(BuildContextArgs.builder()
@@ -296,10 +344,10 @@ public class App {
             .push(true)
             .registries(RegistryArgs.builder()
                 .address(ecrRepository.repositoryUrl())
-                .password(authToken.applyValue(getAuthorizationTokenResult -> getAuthorizationTokenResult).applyValue(authToken -> authToken.applyValue(getAuthorizationTokenResult -> getAuthorizationTokenResult.password())))
-                .username(authToken.applyValue(getAuthorizationTokenResult -> getAuthorizationTokenResult).applyValue(authToken -> authToken.applyValue(getAuthorizationTokenResult -> getAuthorizationTokenResult.userName())))
+                .password(authToken.applyValue(_authToken -> _authToken.password()))
+                .username(authToken.applyValue(_authToken -> _authToken.userName()))
                 .build())
-            .tags(ecrRepository.repositoryUrl().applyValue(repositoryUrl -> String.format("%s:latest", repositoryUrl)))
+            .tags(ecrRepository.repositoryUrl().applyValue(_repositoryUrl -> String.format("%s:latest", _repositoryUrl)))
             .build());
 
         ctx.export("ref", myImage.ref());
@@ -406,6 +454,24 @@ resources:
         type: docker-build:Image
 runtime: yaml
 ```
+```hcl
+pulumi {
+  required_providers {
+    docker-build = {
+      source  = "pulumi/docker-build"
+      version = "0.0.15"
+    }
+  }
+}
+
+resource "docker-build_image" "image" {
+  context = {
+    location = "app"
+  }
+  platforms = ["plan9/amd64", "plan9/386"]
+  push      = false
+}
+```
 ```java
 package generated_program;
 
@@ -415,8 +481,8 @@ import com.pulumi.core.Output;
 import com.pulumi.dockerbuild.Image;
 import com.pulumi.dockerbuild.ImageArgs;
 import com.pulumi.dockerbuild.inputs.BuildContextArgs;
-import java.util.List;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
@@ -461,7 +527,7 @@ const image = new docker_build.Image("image", {
     }],
     tags: ["docker.io/pulumi/pulumi:3.107.0"],
 });
-export const ref = myImage.ref;
+export const ref = image.ref;
 ```
 ```python
 import pulumi
@@ -478,7 +544,7 @@ image = docker_build.Image("image",
         "username": "pulumibot",
     }],
     tags=["docker.io/pulumi/pulumi:3.107.0"])
-pulumi.export("ref", my_image["ref"])
+pulumi.export("ref", image.ref)
 ```
 ```csharp
 using System.Collections.Generic;
@@ -512,7 +578,7 @@ return await Deployment.RunAsync(() =>
 
     return new Dictionary<string, object?>
     {
-        ["ref"] = myImage.Ref,
+        ["ref"] = image.Ref,
     };
 });
 
@@ -527,7 +593,7 @@ import (
 
 func main() {
 	pulumi.Run(func(ctx *pulumi.Context) error {
-		_, err := dockerbuild.NewImage(ctx, "image", &dockerbuild.ImageArgs{
+		image, err := dockerbuild.NewImage(ctx, "image", &dockerbuild.ImageArgs{
 			Context: &dockerbuild.BuildContextArgs{
 				Location: pulumi.String("app"),
 			},
@@ -546,7 +612,7 @@ func main() {
 		if err != nil {
 			return err
 		}
-		ctx.Export("ref", myImage.Ref)
+		ctx.Export("ref", image.Ref)
 		return nil
 	})
 }
@@ -555,7 +621,7 @@ func main() {
 description: Registry export
 name: registry
 outputs:
-    ref: ${my-image.ref}
+    ref: ${image.ref}
 resources:
     image:
         properties:
@@ -571,6 +637,32 @@ resources:
         type: docker-build:Image
 runtime: yaml
 ```
+```hcl
+pulumi {
+  required_providers {
+    docker-build = {
+      source  = "pulumi/docker-build"
+      version = "0.0.15"
+    }
+  }
+}
+
+resource "docker-build_image" "image" {
+  context = {
+    location = "app"
+  }
+  push = true
+  registries {
+    address  = "docker.io"
+    password = dockerHubPassword
+    username = "pulumibot"
+  }
+  tags = ["docker.io/pulumi/pulumi:3.107.0"]
+}
+output "ref" {
+  value = docker-build_image.image.ref
+}
+```
 ```java
 package generated_program;
 
@@ -581,8 +673,8 @@ import com.pulumi.dockerbuild.Image;
 import com.pulumi.dockerbuild.ImageArgs;
 import com.pulumi.dockerbuild.inputs.BuildContextArgs;
 import com.pulumi.dockerbuild.inputs.RegistryArgs;
-import java.util.List;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
@@ -607,7 +699,7 @@ public class App {
             .tags("docker.io/pulumi/pulumi:3.107.0")
             .build());
 
-        ctx.export("ref", myImage.ref());
+        ctx.export("ref", image.ref());
     }
 }
 ```
@@ -756,6 +848,34 @@ resources:
         type: docker-build:Image
 runtime: yaml
 ```
+```hcl
+pulumi {
+  required_providers {
+    docker-build = {
+      source  = "pulumi/docker-build"
+      version = "0.0.15"
+    }
+  }
+}
+
+resource "docker-build_image" "image" {
+  cache_from {
+    local = {
+      src = "tmp/cache"
+    }
+  }
+  cache_to {
+    local = {
+      dest = "tmp/cache"
+      mode = "max"
+    }
+  }
+  context = {
+    location = "app"
+  }
+  push = false
+}
+```
 ```java
 package generated_program;
 
@@ -769,8 +889,8 @@ import com.pulumi.dockerbuild.inputs.CacheFromLocalArgs;
 import com.pulumi.dockerbuild.inputs.CacheToArgs;
 import com.pulumi.dockerbuild.inputs.CacheToLocalArgs;
 import com.pulumi.dockerbuild.inputs.BuildContextArgs;
-import java.util.List;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
@@ -903,6 +1023,27 @@ resources:
         type: docker-build:Image
 runtime: yaml
 ```
+```hcl
+pulumi {
+  required_providers {
+    docker-build = {
+      source  = "pulumi/docker-build"
+      version = "0.0.15"
+    }
+  }
+}
+
+resource "docker-build_image" "image" {
+  builder = {
+    name = "cloud-builder-name"
+  }
+  context = {
+    location = "app"
+  }
+  exec = true
+  push = false
+}
+```
 ```java
 package generated_program;
 
@@ -913,8 +1054,8 @@ import com.pulumi.dockerbuild.Image;
 import com.pulumi.dockerbuild.ImageArgs;
 import com.pulumi.dockerbuild.inputs.BuilderConfigArgs;
 import com.pulumi.dockerbuild.inputs.BuildContextArgs;
-import java.util.List;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
@@ -1035,6 +1176,26 @@ resources:
         type: docker-build:Image
 runtime: yaml
 ```
+```hcl
+pulumi {
+  required_providers {
+    docker-build = {
+      source  = "pulumi/docker-build"
+      version = "0.0.15"
+    }
+  }
+}
+
+resource "docker-build_image" "image" {
+  build_args = {
+    "SET_ME_TO_TRUE" = "true"
+  }
+  context = {
+    location = "app"
+  }
+  push = false
+}
+```
 ```java
 package generated_program;
 
@@ -1044,8 +1205,8 @@ import com.pulumi.core.Output;
 import com.pulumi.dockerbuild.Image;
 import com.pulumi.dockerbuild.ImageArgs;
 import com.pulumi.dockerbuild.inputs.BuildContextArgs;
-import java.util.List;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
@@ -1153,6 +1314,24 @@ resources:
         type: docker-build:Image
 runtime: yaml
 ```
+```hcl
+pulumi {
+  required_providers {
+    docker-build = {
+      source  = "pulumi/docker-build"
+      version = "0.0.15"
+    }
+  }
+}
+
+resource "docker-build_image" "image" {
+  context = {
+    location = "app"
+  }
+  push   = false
+  target = "build-me"
+}
+```
 ```java
 package generated_program;
 
@@ -1162,8 +1341,8 @@ import com.pulumi.core.Output;
 import com.pulumi.dockerbuild.Image;
 import com.pulumi.dockerbuild.ImageArgs;
 import com.pulumi.dockerbuild.inputs.BuildContextArgs;
-import java.util.List;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
@@ -1291,6 +1470,28 @@ resources:
         type: docker-build:Image
 runtime: yaml
 ```
+```hcl
+pulumi {
+  required_providers {
+    docker-build = {
+      source  = "pulumi/docker-build"
+      version = "0.0.15"
+    }
+  }
+}
+
+resource "docker-build_image" "image" {
+  context = {
+    location = "app"
+    named = {
+      "golang:latest" = {
+        location = "docker-image://golang@sha256:b8e62cf593cdaff36efd90aa3a37de268e6781a2e68c6610940c48f7cdf36984"
+      }
+    }
+  }
+  push = false
+}
+```
 ```java
 package generated_program;
 
@@ -1300,8 +1501,8 @@ import com.pulumi.core.Output;
 import com.pulumi.dockerbuild.Image;
 import com.pulumi.dockerbuild.ImageArgs;
 import com.pulumi.dockerbuild.inputs.BuildContextArgs;
-import java.util.List;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
@@ -1316,12 +1517,13 @@ public class App {
         var image = new Image("image", ImageArgs.builder()
             .context(BuildContextArgs.builder()
                 .location("app")
-                .named(Map.of("golang:latest", Map.of("location", "docker-image://golang@sha256:b8e62cf593cdaff36efd90aa3a37de268e6781a2e68c6610940c48f7cdf36984")))
-                .build())
-            .push(false)
-            .build());
+                .named(Map.of("golang:latest", ContextArgs.builder()
+%!v(PANIC=Format method: interface conversion: model.Expression is *model.TemplateExpression, not *model.LiteralValueExpression)))
+                    .build())
+                .push(false)
+                .build());
 
-    }
+        }
 }
 ```
 {{% /example %}}
@@ -1404,6 +1606,23 @@ resources:
         type: docker-build:Image
 runtime: yaml
 ```
+```hcl
+pulumi {
+  required_providers {
+    docker-build = {
+      source  = "pulumi/docker-build"
+      version = "0.0.15"
+    }
+  }
+}
+
+resource "docker-build_image" "image" {
+  context = {
+    location = "https://raw.githubusercontent.com/pulumi/pulumi-docker/api-types/provider/testdata/Dockerfile"
+  }
+  push = false
+}
+```
 ```java
 package generated_program;
 
@@ -1413,8 +1632,8 @@ import com.pulumi.core.Output;
 import com.pulumi.dockerbuild.Image;
 import com.pulumi.dockerbuild.ImageArgs;
 import com.pulumi.dockerbuild.inputs.BuildContextArgs;
-import java.util.List;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
@@ -1539,6 +1758,26 @@ resources:
         type: docker-build:Image
 runtime: yaml
 ```
+```hcl
+pulumi {
+  required_providers {
+    docker-build = {
+      source  = "pulumi/docker-build"
+      version = "0.0.15"
+    }
+  }
+}
+
+resource "docker-build_image" "image" {
+  context = {
+    location = "app"
+  }
+  dockerfile = {
+    inline = "FROM busybox\nCOPY hello.c ./\n"
+  }
+  push = false
+}
+```
 ```java
 package generated_program;
 
@@ -1549,8 +1788,8 @@ import com.pulumi.dockerbuild.Image;
 import com.pulumi.dockerbuild.ImageArgs;
 import com.pulumi.dockerbuild.inputs.BuildContextArgs;
 import com.pulumi.dockerbuild.inputs.DockerfileArgs;
-import java.util.List;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
@@ -1673,6 +1912,26 @@ resources:
         type: docker-build:Image
 runtime: yaml
 ```
+```hcl
+pulumi {
+  required_providers {
+    docker-build = {
+      source  = "pulumi/docker-build"
+      version = "0.0.15"
+    }
+  }
+}
+
+resource "docker-build_image" "image" {
+  context = {
+    location = "https://github.com/docker-library/hello-world.git"
+  }
+  dockerfile = {
+    location = "app/Dockerfile"
+  }
+  push = false
+}
+```
 ```java
 package generated_program;
 
@@ -1683,8 +1942,8 @@ import com.pulumi.dockerbuild.Image;
 import com.pulumi.dockerbuild.ImageArgs;
 import com.pulumi.dockerbuild.inputs.BuildContextArgs;
 import com.pulumi.dockerbuild.inputs.DockerfileArgs;
-import java.util.List;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
@@ -1819,6 +2078,28 @@ resources:
         type: docker-build:Image
 runtime: yaml
 ```
+```hcl
+pulumi {
+  required_providers {
+    docker-build = {
+      source  = "pulumi/docker-build"
+      version = "0.0.15"
+    }
+  }
+}
+
+resource "docker-build_image" "image" {
+  context = {
+    location = "app"
+  }
+  exports {
+    docker = {
+      tar = true
+    }
+  }
+  push = false
+}
+```
 ```java
 package generated_program;
 
@@ -1830,8 +2111,8 @@ import com.pulumi.dockerbuild.ImageArgs;
 import com.pulumi.dockerbuild.inputs.BuildContextArgs;
 import com.pulumi.dockerbuild.inputs.ExportArgs;
 import com.pulumi.dockerbuild.inputs.ExportDockerArgs;
-import java.util.List;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;

provider/internal/embed/index-examples.md

@@ -327,6 +327,60 @@ resources:
         type: docker-build:Index
 runtime: yaml
 ```
+```hcl
+pulumi {
+  required_providers {
+    docker-build = {
+      source  = "pulumi/docker-build"
+      version = "0.0.15"
+    }
+  }
+}
+
+resource "docker-build_image" "amd64" {
+  cache_from {
+    registry = {
+      ref = "docker.io/pulumi/pulumi:cache-amd64"
+    }
+  }
+  cache_to {
+    registry = {
+      mode = "max"
+      ref  = "docker.io/pulumi/pulumi:cache-amd64"
+    }
+  }
+  context = {
+    location = "app"
+  }
+  platforms = ["linux/amd64"]
+  tags      = ["docker.io/pulumi/pulumi:3.107.0-amd64"]
+}
+resource "docker-build_image" "arm64" {
+  cache_from {
+    registry = {
+      ref = "docker.io/pulumi/pulumi:cache-arm64"
+    }
+  }
+  cache_to {
+    registry = {
+      mode = "max"
+      ref  = "docker.io/pulumi/pulumi:cache-arm64"
+    }
+  }
+  context = {
+    location = "app"
+  }
+  platforms = ["linux/arm64"]
+  tags      = ["docker.io/pulumi/pulumi:3.107.0-arm64"]
+}
+resource "docker-build_index" "index" {
+  sources = [docker-build_image.amd64.ref, docker-build_image.arm64.ref]
+  tag     = "docker.io/pulumi/pulumi:3.107.0"
+}
+output "ref" {
+  value = docker-build_index.index.ref
+}
+```
 ```java
 package generated_program;
 
@@ -342,8 +396,8 @@ import com.pulumi.dockerbuild.inputs.CacheToRegistryArgs;
 import com.pulumi.dockerbuild.inputs.BuildContextArgs;
 import com.pulumi.dockerbuild.Index;
 import com.pulumi.dockerbuild.IndexArgs;
-import java.util.List;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;

sdk/dotnet/Image.cs

@@ -240,7 +240,7 @@ namespace Pulumi.DockerBuild
     /// 
     ///     return new Dictionary<string, object?>
     ///     {
-    ///         ["ref"] = myImage.Ref,
+    ///         ["ref"] = image.Ref,
     ///     };
     /// });
     /// 

sdk/go/dockerbuild/image.go

@@ -124,7 +124,7 @@ import (
 //
 //	"fmt"
 //
-//	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ecr"
+//	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ecr"
 //	"github.com/pulumi/pulumi-docker-build/sdk/go/dockerbuild"
 //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 //
@@ -234,7 +234,7 @@ import (
 //
 //	func main() {
 //		pulumi.Run(func(ctx *pulumi.Context) error {
-//			_, err := dockerbuild.NewImage(ctx, "image", &dockerbuild.ImageArgs{
+//			image, err := dockerbuild.NewImage(ctx, "image", &dockerbuild.ImageArgs{
 //				Context: &dockerbuild.BuildContextArgs{
 //					Location: pulumi.String("app"),
 //				},
@@ -253,7 +253,7 @@ import (
 //			if err != nil {
 //				return err
 //			}
-//			ctx.Export("ref", myImage.Ref)
+//			ctx.Export("ref", image.Ref)
 //			return nil
 //		})
 //	}

sdk/go/dockerbuild/x/image.go

@@ -124,7 +124,7 @@ import (
 //
 //	"fmt"
 //
-//	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ecr"
+//	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ecr"
 //	"github.com/pulumi/pulumi-docker-build/sdk/go/dockerbuild"
 //	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
 //
@@ -234,7 +234,7 @@ import (
 //
 //	func main() {
 //		pulumi.Run(func(ctx *pulumi.Context) error {
-//			_, err := dockerbuild.NewImage(ctx, "image", &dockerbuild.ImageArgs{
+//			image, err := dockerbuild.NewImage(ctx, "image", &dockerbuild.ImageArgs{
 //				Context: &dockerbuild.BuildContextArgs{
 //					Location: pulumi.String("app"),
 //				},
@@ -253,7 +253,7 @@ import (
 //			if err != nil {
 //				return err
 //			}
-//			ctx.Export("ref", myImage.Ref)
+//			ctx.Export("ref", image.Ref)
 //			return nil
 //		})
 //	}

sdk/java/src/main/java/com/pulumi/dockerbuild/Image.java

@@ -148,8 +148,8 @@ import javax.annotation.Nullable;
  * import com.pulumi.dockerbuild.inputs.CacheToRegistryArgs;
  * import com.pulumi.dockerbuild.inputs.BuildContextArgs;
  * import com.pulumi.dockerbuild.inputs.RegistryArgs;
- * import java.util.List;
  * import java.util.ArrayList;
+ * import java.util.Arrays;
  * import java.util.Map;
  * import java.io.File;
  * import java.nio.file.Files;
@@ -170,14 +170,14 @@ import javax.annotation.Nullable;
  *         var myImage = new Image("myImage", ImageArgs.builder()
  *             .cacheFrom(CacheFromArgs.builder()
  *                 .registry(CacheFromRegistryArgs.builder()
- *                     .ref(ecrRepository.repositoryUrl().applyValue(repositoryUrl -> String.format("%s:cache", repositoryUrl)))
+ *                     .ref(ecrRepository.repositoryUrl().applyValue(_repositoryUrl -> String.format("%s:cache", _repositoryUrl)))
  *                     .build())
  *                 .build())
  *             .cacheTo(CacheToArgs.builder()
  *                 .registry(CacheToRegistryArgs.builder()
  *                     .imageManifest(true)
  *                     .ociMediaTypes(true)
- *                     .ref(ecrRepository.repositoryUrl().applyValue(repositoryUrl -> String.format("%s:cache", repositoryUrl)))
+ *                     .ref(ecrRepository.repositoryUrl().applyValue(_repositoryUrl -> String.format("%s:cache", _repositoryUrl)))
  *                     .build())
  *                 .build())
  *             .context(BuildContextArgs.builder()
@@ -186,10 +186,10 @@ import javax.annotation.Nullable;
  *             .push(true)
  *             .registries(RegistryArgs.builder()
  *                 .address(ecrRepository.repositoryUrl())
- *                 .password(authToken.applyValue(getAuthorizationTokenResult -> getAuthorizationTokenResult).applyValue(authToken -> authToken.applyValue(getAuthorizationTokenResult -> getAuthorizationTokenResult.password())))
- *                 .username(authToken.applyValue(getAuthorizationTokenResult -> getAuthorizationTokenResult).applyValue(authToken -> authToken.applyValue(getAuthorizationTokenResult -> getAuthorizationTokenResult.userName())))
+ *                 .password(authToken.applyValue(_authToken -> _authToken.password()))
+ *                 .username(authToken.applyValue(_authToken -> _authToken.userName()))
  *                 .build())
- *             .tags(ecrRepository.repositoryUrl().applyValue(repositoryUrl -> String.format("%s:latest", repositoryUrl)))
+ *             .tags(ecrRepository.repositoryUrl().applyValue(_repositoryUrl -> String.format("%s:latest", _repositoryUrl)))
  *             .build());
  * 
  *         ctx.export("ref", myImage.ref());
@@ -208,8 +208,8 @@ import javax.annotation.Nullable;
  * import com.pulumi.dockerbuild.Image;
  * import com.pulumi.dockerbuild.ImageArgs;
  * import com.pulumi.dockerbuild.inputs.BuildContextArgs;
- * import java.util.List;
  * import java.util.ArrayList;
+ * import java.util.Arrays;
  * import java.util.Map;
  * import java.io.File;
  * import java.nio.file.Files;
@@ -247,8 +247,8 @@ import javax.annotation.Nullable;
  * import com.pulumi.dockerbuild.ImageArgs;
  * import com.pulumi.dockerbuild.inputs.BuildContextArgs;
  * import com.pulumi.dockerbuild.inputs.RegistryArgs;
- * import java.util.List;
  * import java.util.ArrayList;
+ * import java.util.Arrays;
  * import java.util.Map;
  * import java.io.File;
  * import java.nio.file.Files;
@@ -273,7 +273,7 @@ import javax.annotation.Nullable;
  *             .tags("docker.io/pulumi/pulumi:3.107.0")
  *             .build());
  * 
- *         ctx.export("ref", myImage.ref());
+ *         ctx.export("ref", image.ref());
  *     }
  * }
  * }
@@ -293,8 +293,8 @@ import javax.annotation.Nullable;
  * import com.pulumi.dockerbuild.inputs.CacheToArgs;
  * import com.pulumi.dockerbuild.inputs.CacheToLocalArgs;
  * import com.pulumi.dockerbuild.inputs.BuildContextArgs;
- * import java.util.List;
  * import java.util.ArrayList;
+ * import java.util.Arrays;
  * import java.util.Map;
  * import java.io.File;
  * import java.nio.file.Files;
@@ -340,8 +340,8 @@ import javax.annotation.Nullable;
  * import com.pulumi.dockerbuild.ImageArgs;
  * import com.pulumi.dockerbuild.inputs.BuilderConfigArgs;
  * import com.pulumi.dockerbuild.inputs.BuildContextArgs;
- * import java.util.List;
  * import java.util.ArrayList;
+ * import java.util.Arrays;
  * import java.util.Map;
  * import java.io.File;
  * import java.nio.file.Files;
@@ -379,8 +379,8 @@ import javax.annotation.Nullable;
  * import com.pulumi.dockerbuild.Image;
  * import com.pulumi.dockerbuild.ImageArgs;
  * import com.pulumi.dockerbuild.inputs.BuildContextArgs;
- * import java.util.List;
  * import java.util.ArrayList;
+ * import java.util.Arrays;
  * import java.util.Map;
  * import java.io.File;
  * import java.nio.file.Files;
@@ -415,8 +415,8 @@ import javax.annotation.Nullable;
  * import com.pulumi.dockerbuild.Image;
  * import com.pulumi.dockerbuild.ImageArgs;
  * import com.pulumi.dockerbuild.inputs.BuildContextArgs;
- * import java.util.List;
  * import java.util.ArrayList;
+ * import java.util.Arrays;
  * import java.util.Map;
  * import java.io.File;
  * import java.nio.file.Files;
@@ -451,29 +451,30 @@ import javax.annotation.Nullable;
  * import com.pulumi.dockerbuild.Image;
  * import com.pulumi.dockerbuild.ImageArgs;
  * import com.pulumi.dockerbuild.inputs.BuildContextArgs;
- * import java.util.List;
  * import java.util.ArrayList;
+ * import java.util.Arrays;
  * import java.util.Map;
  * import java.io.File;
  * import java.nio.file.Files;
  * import java.nio.file.Paths;
  * 
- * public class App }{{@code
- *     public static void main(String[] args) }{{@code
+ * public class App {
+ *     public static void main(String[] args) {
  *         Pulumi.run(App::stack);
- *     }}{@code
+ *     }
  * 
- *     public static void stack(Context ctx) }{{@code
+ *     public static void stack(Context ctx) {
  *         var image = new Image("image", ImageArgs.builder()
  *             .context(BuildContextArgs.builder()
  *                 .location("app")
- *                 .named(Map.of("golang:latest", Map.of("location", "docker-image://golang}{@literal @}{@code sha256:b8e62cf593cdaff36efd90aa3a37de268e6781a2e68c6610940c48f7cdf36984")))
- *                 .build())
- *             .push(false)
- *             .build());
+ *                 .named(Map.of("golang:latest", ContextArgs.builder()
+ * %!v(PANIC=Format method: interface conversion: model.Expression is *model.TemplateExpression, not *model.LiteralValueExpression)))
+ *                     .build())
+ *                 .push(false)
+ *                 .build());
  * 
- *     }}{@code
- * }}{@code
+ *         }
+ * }
  * }
  * </pre>
  * ### Remote context
@@ -487,8 +488,8 @@ import javax.annotation.Nullable;
  * import com.pulumi.dockerbuild.Image;
  * import com.pulumi.dockerbuild.ImageArgs;
  * import com.pulumi.dockerbuild.inputs.BuildContextArgs;
- * import java.util.List;
  * import java.util.ArrayList;
+ * import java.util.Arrays;
  * import java.util.Map;
  * import java.io.File;
  * import java.nio.file.Files;
@@ -523,8 +524,8 @@ import javax.annotation.Nullable;
  * import com.pulumi.dockerbuild.ImageArgs;
  * import com.pulumi.dockerbuild.inputs.BuildContextArgs;
  * import com.pulumi.dockerbuild.inputs.DockerfileArgs;
- * import java.util.List;
  * import java.util.ArrayList;
+ * import java.util.Arrays;
  * import java.util.Map;
  * import java.io.File;
  * import java.nio.file.Files;
@@ -565,8 +566,8 @@ import javax.annotation.Nullable;
  * import com.pulumi.dockerbuild.ImageArgs;
  * import com.pulumi.dockerbuild.inputs.BuildContextArgs;
  * import com.pulumi.dockerbuild.inputs.DockerfileArgs;
- * import java.util.List;
  * import java.util.ArrayList;
+ * import java.util.Arrays;
  * import java.util.Map;
  * import java.io.File;
  * import java.nio.file.Files;
@@ -605,8 +606,8 @@ import javax.annotation.Nullable;
  * import com.pulumi.dockerbuild.inputs.BuildContextArgs;
  * import com.pulumi.dockerbuild.inputs.ExportArgs;
  * import com.pulumi.dockerbuild.inputs.ExportDockerArgs;
- * import java.util.List;
  * import java.util.ArrayList;
+ * import java.util.Arrays;
  * import java.util.Map;
  * import java.io.File;
  * import java.nio.file.Files;

sdk/java/src/main/java/com/pulumi/dockerbuild/Index.java

@@ -55,8 +55,8 @@ import javax.annotation.Nullable;
  * import com.pulumi.dockerbuild.inputs.BuildContextArgs;
  * import com.pulumi.dockerbuild.Index;
  * import com.pulumi.dockerbuild.IndexArgs;
- * import java.util.List;
  * import java.util.ArrayList;
+ * import java.util.Arrays;
  * import java.util.Map;
  * import java.io.File;
  * import java.nio.file.Files;

sdk/nodejs/image.ts

@@ -312,7 +312,7 @@ import * as utilities from "./utilities";
  *     }],
  *     tags: ["docker.io/pulumi/pulumi:3.107.0"],
  * });
- * export const ref = myImage.ref;
+ * export const ref = image.ref;
  * ```
  * ### Caching
  *

sdk/python/pulumi_docker_build/image.py

@@ -780,7 +780,7 @@ class Image(pulumi.CustomResource):
                 "username": "pulumibot",
             }],
             tags=["docker.io/pulumi/pulumi:3.107.0"])
-        pulumi.export("ref", my_image["ref"])
+        pulumi.export("ref", image.ref)
         ```
         ### Caching
         ```python
@@ -1219,7 +1219,7 @@ class Image(pulumi.CustomResource):
                 "username": "pulumibot",
             }],
             tags=["docker.io/pulumi/pulumi:3.107.0"])
-        pulumi.export("ref", my_image["ref"])
+        pulumi.export("ref", image.ref)
         ```
         ### Caching
         ```python