pulumi-docker-kotlin/com.pulumi.docker.kotlin/RemoteImage

RemoteImage

class RemoteImage : KotlinCustomResource

Pulls a Docker image to a given Docker host from a Docker Registry. This resource will not pull new layers of the image automatically unless used in conjunction with docker.RegistryImage data source to update the pull_triggers field.

Example Usage

Basic

Finds and downloads the latest ubuntu:precise image but does not check for further updates of the image

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.docker.RemoteImage;
import com.pulumi.docker.RemoteImageArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var ubuntu = new RemoteImage("ubuntu", RemoteImageArgs.builder()
            .name("ubuntu:precise")
            .build());
    }
}

Dynamic updates

To be able to update an image dynamically when the sha256 sum changes, you need to use it in combination with docker.RegistryImage as follows:

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.docker.DockerFunctions;
import com.pulumi.docker.inputs.GetRegistryImageArgs;
import com.pulumi.docker.RemoteImage;
import com.pulumi.docker.RemoteImageArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var ubuntuRegistryImage = DockerFunctions.getRegistryImage(GetRegistryImageArgs.builder()
            .name("ubuntu:precise")
            .build());
        var ubuntuRemoteImage = new RemoteImage("ubuntuRemoteImage", RemoteImageArgs.builder()
            .name(ubuntuRegistryImage.applyValue(getRegistryImageResult -> getRegistryImageResult.name()))
            .pullTriggers(ubuntuRegistryImage.applyValue(getRegistryImageResult -> getRegistryImageResult.sha256Digest()))
            .build());
    }
}

Properties

build

val build: Output<RemoteImageBuild>?

Configuration to build an image. Please see docker build command reference too.

forceRemove

val forceRemove: Output<Boolean>?

If true, then the image is removed forcibly when the resource is destroyed.

val id: Output<String>

imageId

val imageId: Output<String>

The ID of the image (as seen when executing docker inspect on the image). Can be used to reference the image via its ID in other resources.

keepLocally

val keepLocally: Output<Boolean>?

If true, then the Docker image won't be deleted on destroy operation. If this is false, it will delete the image from the docker local storage on destroy operation.

latest

val ~~latest~~: Output<String>

The ID of the image in the form of sha256:<hash> image digest. Do not confuse it with the default latest tag.

name

val name: Output<String>

The name of the Docker image, including any tags or SHA256 repo digests.

output

val ~~output~~: Output<String>

pullTrigger

val ~~pullTrigger~~: Output<String>?

A value which cause an image pull when changed

pullTriggers

val pullTriggers: Output<List<String>>?

List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the dockerregistryimage.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

repoDigest

val repoDigest: Output<String>

The image sha256 digest in the form of repo[:tag]@sha256:<hash>.

triggers

val triggers: Output<Map<String, Any>>?

A map of arbitrary strings that, when changed, will force the docker.RemoteImage resource to be replaced. This can be used to rebuild an image when contents of source code folders change

urn

val urn: Output<String>