Add HCL Examples & Docs (#852)

Fixes https://github.com/pulumi/pulumi-docker-build/issues/844
This commit is contained in:
Ian Wahbe
2026-05-18 12:11:41 +02:00
committed by GitHub
parent 55d6f8f216
commit a748e088ca
27 changed files with 661 additions and 78 deletions

2
sdk/dotnet/Image.cs generated
View File

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

View File

@@ -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
// })
// }

View File

@@ -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
// })
// }

View File

@@ -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;

View File

@@ -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;

2
sdk/nodejs/image.ts generated
View File

@@ -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
*

View File

@@ -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