Package @pulumi/docker

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-docker repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-docker repo.

var docker = require("@pulumi/docker");

import * as docker from "@pulumi/docker";

Modules

Functions

getNetwork
getRegistryImage

Others

Resources

Resource Container

class Container extends CustomResource

Manages the lifecycle of a Docker container.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as docker from "@pulumi/docker";

// Find the latest Ubuntu precise image.
const ubuntuRemoteImage = new docker.RemoteImage("ubuntu", {
    name: "ubuntu:precise",
});
// Start a container
const ubuntuContainer = new docker.Container("ubuntu", {
    image: ubuntuRemoteImage.latest,
});

constructor

new Container(name: string, args: ContainerArgs, opts?: pulumi.CustomResourceOptions)

Create a Container resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ContainerState, opts?: pulumi.CustomResourceOptions): Container

Get an existing Container resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Container

Returns true if the given object is an instance of Container. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property attach

public attach: pulumi.Output<boolean | undefined>;

If true attach to the container after its creation and waits the end of his execution.

property bridge

public bridge: pulumi.Output<string>;

The network bridge of the container as read from its NetworkSettings.

property command

public command: pulumi.Output<string[]>;

The command to use to start the container. For example, to run /usr/bin/myprogram -f baz.conf set the command to be ["/usr/bin/myprogram", "-f", "baz.conf"].

property containerLogs

public containerLogs: pulumi.Output<string>;

The logs of the container if its execution is done (attach must be disabled).

property cpuSet

public cpuSet: pulumi.Output<string | undefined>;

A comma-separated list or hyphen-separated range of CPUs a container can use, e.g. 0-1.

property cpuShares

public cpuShares: pulumi.Output<number | undefined>;

CPU shares (relative weight) for the container.

property destroyGraceSeconds

public destroyGraceSeconds: pulumi.Output<number | undefined>;

If defined will attempt to stop the container before destroying. Container will be destroyed after n seconds or on successful stop.

property dnsOpts

public dnsOpts: pulumi.Output<string[] | undefined>;

Set of DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.

property dnsSearches

public dnsSearches: pulumi.Output<string[] | undefined>;

Set of DNS search domains that are used when bare unqualified hostnames are used inside of the container.

property entrypoints

public entrypoints: pulumi.Output<string[]>;

The command to use as the Entrypoint for the container. The Entrypoint allows you to configure a container to run as an executable. For example, to run /usr/bin/myprogram when starting a container, set the entrypoint to be ["/usr/bin/myprogram"].

property envs

public envs: pulumi.Output<string[]>;

Environment variables to set.

property exitCode

public exitCode: pulumi.Output<number>;

The exit code of the container if its execution is done (mustRun must be disabled).

property gateway

public gateway: pulumi.Output<string>;

Deprecated: Use networkData instead. The network gateway of the container as read from its NetworkSettings.

property groupAdds

public groupAdds: pulumi.Output<string[] | undefined>;

Add additional groups to run as.

property healthcheck

public healthcheck: pulumi.Output<ContainerHealthcheck | undefined>;

See Healthcheck below for details.

property hostname

public hostname: pulumi.Output<string>;

Hostname of the container.

property hosts

public hosts: pulumi.Output<ContainerHost[] | undefined>;

Hostname to add.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property image

public image: pulumi.Output<string>;

The ID of the image to back this container. The easiest way to get this value is to use the docker..RemoteImage resource as is shown in the example above.

property ipAddress

public ipAddress: pulumi.Output<string>;

Deprecated: Use networkData instead. The IP address of the container’s first network it.

property ipPrefixLength

public ipPrefixLength: pulumi.Output<number>;

Deprecated: Use networkData instead. The IP prefix length of the container as read from its NetworkSettings.

property ipcMode

public ipcMode: pulumi.Output<string>;

IPC sharing mode for the container. Possible values are: none, private, shareable, container:<name|id> or host.

property labels

public labels: pulumi.Output<ContainerLabel[]>;

Adding labels.

property links

public links: pulumi.Output<string[] | undefined>;

Set of links for link based connectivity between containers that are running on the same host.

property logDriver

public logDriver: pulumi.Output<string>;

The logging driver to use for the container. Defaults to “json-file”.

property logOpts

public logOpts: pulumi.Output<{[key: string]: any}>;

Key/value pairs to use as options for the logging driver.

property logs

public logs: pulumi.Output<boolean | undefined>;

Save the container logs (attach must be enabled).

property maxRetryCount

public maxRetryCount: pulumi.Output<number | undefined>;

The maximum amount of times to an attempt a restart when restart is set to “on-failure”

property memory

public memory: pulumi.Output<number | undefined>;

The memory limit for the container in MBs.

property memorySwap

public memorySwap: pulumi.Output<number | undefined>;

property mounts

public mounts: pulumi.Output<ContainerMount[] | undefined>;

See Mounts below for details.

property mustRun

public mustRun: pulumi.Output<boolean | undefined>;

property name

public name: pulumi.Output<string>;

property networkAliases

public networkAliases: pulumi.Output<string[] | undefined>;

Network aliases of the container for user-defined networks only. Deprecated: use networksAdvanced instead.

property networkDatas

public networkDatas: pulumi.Output<ContainerNetworkData[]>;

(Map of a block) The IP addresses of the container on each network. Key are the network names, values are the IP addresses.

property networkMode

public networkMode: pulumi.Output<string | undefined>;

Network mode of the container.

property networks

public networks: pulumi.Output<string[] | undefined>;

Id of the networks in which the container is. Deprecated: use networksAdvanced instead.

property networksAdvanced

public networksAdvanced: pulumi.Output<ContainerNetworksAdvanced[] | undefined>;

See Networks Advanced below for details. If this block has priority to the deprecated networkAlias and network properties.

property pidMode

public pidMode: pulumi.Output<string | undefined>;

The PID (Process) Namespace mode for the container. Either container:<name|id> or host.

property ports

public ports: pulumi.Output<ContainerPort[] | undefined>;

See Ports below for details.

property privileged

public privileged: pulumi.Output<boolean | undefined>;

Run container in privileged mode.

property publishAllPorts

public publishAllPorts: pulumi.Output<boolean | undefined>;

Publish all ports of the container.

property readOnly

public readOnly: pulumi.Output<boolean | undefined>;

If true, this volume will be readonly. Defaults to false.

property restart

public restart: pulumi.Output<string | undefined>;

The restart policy for the container. Must be one of “no”, “on-failure”, “always”, “unless-stopped”.

property rm

public rm: pulumi.Output<boolean | undefined>;

property shmSize

public shmSize: pulumi.Output<number>;

Size of /dev/shm in MBs.

property start

public start: pulumi.Output<boolean | undefined>;

If true, then the Docker container will be started after creation. If false, then the container is only created.

property sysctls

public sysctls: pulumi.Output<{[key: string]: any} | undefined>;

A map of kernel parameters (sysctls) to set in the container.

property tmpfs

public tmpfs: pulumi.Output<{[key: string]: any} | undefined>;

A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options.

property ulimits

public ulimits: pulumi.Output<ContainerUlimit[] | undefined>;

See Ulimits below for details.

property uploads

public uploads: pulumi.Output<ContainerUpload[] | undefined>;

See File Upload below for details.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property user

public user: pulumi.Output<string>;

User used for run the first process. Format is user or user:group which user and group can be passed literraly or by name.

property usernsMode

public usernsMode: pulumi.Output<string | undefined>;

Sets the usernamespace mode for the container when usernamespace remapping option is enabled.

property volumes

public volumes: pulumi.Output<ContainerVolume[] | undefined>;

See Volumes below for details.

property workingDir

public workingDir: pulumi.Output<string | undefined>;

The working directory for commands to run in

Resource Image

class Image extends ComponentResource

A docker.Image resource represents a Docker image built locally which is published and made available via a remote Docker registry. This can be used to ensure that a Docker source directory from a local deployment environment is built and pushed to a cloud-hosted Docker registry as part of a Pulumi deployment, so that it can be referenced as an image input from other cloud services that reference Docker images - including Kubernetes Pods, AWS ECS Tasks, and Azure Container Instances.

constructor

new Image(name: string, args: ImageArgs, opts?: pulumi.ComponentResourceOptions)

method getData

protected getData(): Promise<TData>

Retrieves the data produces by [initialize]. The data is immediately available in a derived class’s constructor after the super(...) call to ComponentResource.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method initialize

protected initialize(args: Inputs): Promise<TData>

Can be overridden by a subclass to asynchronously initialize data for this Component automatically when constructed. The data will be available immediately for subclass constructors to use. To access the data use .getData.

method isInstance

static isInstance(obj: any): obj is ComponentResource

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

method registerOutputs

protected registerOutputs(outputs?: Inputs | Promise<Inputs> | Output<Inputs>): void

registerOutputs registers synthetic outputs that a component has initialized, usually by allocating other child sub-resources and propagating their resulting property values.

ComponentResources can call this at the end of their constructor to indicate that they are done creating child resources. This is not strictly necessary as this will automatically be called after the initialize method completes.

property baseImageName

public baseImageName: pulumi.Output<string>;

The base image name that was built and pushed. This does not include the id annotation, so is not pinned to the specific build performed by this docker.Image.

property digest

DEPRECATED This will have the same value as [imageName], but will be removed in the future. It can be used to get a unique name for this specific image, but is not the actual repository digest value.

public digest: pulumi.Output<string | undefined>;

property id

DEPRECATED This will have the same value as [imageName], but will be removed in the future.

public id: pulumi.Output<string>;

property imageName

public imageName: pulumi.Output<string>;

The unique pinned image name on the remote repository.

property registryServer

public registryServer: pulumi.Output<string | undefined>;

The server the image is located at.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Network

class Network extends CustomResource

Manages a Docker Network. This can be used alongside docker_container to create virtual networks within the docker environment.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as docker from "@pulumi/docker";

// Create a new docker network
const privateNetwork = new docker.Network("privateNetwork", {});

constructor

new Network(name: string, args?: NetworkArgs, opts?: pulumi.CustomResourceOptions)

Create a Network resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkState, opts?: pulumi.CustomResourceOptions): Network

Get an existing Network resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Network

Returns true if the given object is an instance of Network. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property attachable

public attachable: pulumi.Output<boolean | undefined>;

Enable manual container attachment to the network. Defaults to false.

property checkDuplicate

public checkDuplicate: pulumi.Output<boolean | undefined>;

Requests daemon to check for networks with same name.

property driver

public driver: pulumi.Output<string>;

Name of the network driver to use. Defaults to bridge driver.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ingress

public ingress: pulumi.Output<boolean | undefined>;

Create swarm routing-mesh network. Defaults to false.

property internal

public internal: pulumi.Output<boolean>;

Restrict external access to the network. Defaults to false.

property ipamConfigs

public ipamConfigs: pulumi.Output<NetworkIpamConfig[]>;

See IPAM config below for details.

property ipamDriver

public ipamDriver: pulumi.Output<string | undefined>;

Driver used by the custom IP scheme of the network.

property ipv6

public ipv6: pulumi.Output<boolean | undefined>;

Enable IPv6 networking. Defaults to false.

property labels

public labels: pulumi.Output<NetworkLabel[] | undefined>;

See Labels below for details.

property name

public name: pulumi.Output<string>;

The name of the Docker network.

property options

public options: pulumi.Output<{[key: string]: any}>;

Network specific options to be used by the drivers.

property scope

public scope: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Provider

class Provider extends ProviderResource

The provider type for the docker package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

constructor

new Provider(name: string, args?: ProviderArgs, opts?: pulumi.ResourceOptions)

Create a Provider resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Provider

Returns true if the given object is an instance of Provider. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

method register

static register(provider: ProviderResource | undefined): Promise<string | undefined>

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RemoteImage

class RemoteImage extends CustomResource

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..getRegistryImage data source to update the pullTriggers field.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as docker from "@pulumi/docker";

// Find the latest Ubuntu precise image.
const ubuntu = new docker.RemoteImage("ubuntu", {
    name: "ubuntu:precise",
});

Dynamic image

import * as pulumi from "@pulumi/pulumi";
import * as docker from "@pulumi/docker";

const ubuntuRegistryImage = pulumi.output(docker.getRegistryImage({
    name: "ubuntu:precise",
}, { async: true }));
const ubuntuRemoteImage = new docker.RemoteImage("ubuntu", {
    name: ubuntuRegistryImage.name!,
    pullTriggers: [ubuntuRegistryImage.sha256Digest],
});

constructor

new RemoteImage(name: string, args: RemoteImageArgs, opts?: pulumi.CustomResourceOptions)

Create a RemoteImage resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RemoteImageState, opts?: pulumi.CustomResourceOptions): RemoteImage

Get an existing RemoteImage resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is RemoteImage

Returns true if the given object is an instance of RemoteImage. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property keepLocally

public keepLocally: pulumi.Output<boolean | undefined>;

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.

property latest

public latest: pulumi.Output<string>;

property name

public name: pulumi.Output<string>;

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

property pullTrigger

public pullTrigger: pulumi.Output<string | undefined>;

Deprecated, use pullTriggers instead.

property pullTriggers

public pullTriggers: pulumi.Output<string[] | undefined>;

List of values which cause an image pull when changed. This is used to store the image digest from the registry when using the docker..getRegistryImage data source to trigger an image update.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Secret

class Secret extends CustomResource

constructor

new Secret(name: string, args: SecretArgs, opts?: pulumi.CustomResourceOptions)

Create a Secret resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SecretState, opts?: pulumi.CustomResourceOptions): Secret

Get an existing Secret resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Secret

Returns true if the given object is an instance of Secret. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property data

public data: pulumi.Output<string>;

The base64 encoded data of the secret.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<SecretLabel[] | undefined>;

See Labels below for details.

property name

public name: pulumi.Output<string>;

The name of the Docker secret.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Service

class Service extends CustomResource

constructor

new Service(name: string, args: ServiceArgs, opts?: pulumi.CustomResourceOptions)

Create a Service resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceState, opts?: pulumi.CustomResourceOptions): Service

Get an existing Service resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Service

Returns true if the given object is an instance of Service. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property auth

public auth: pulumi.Output<ServiceAuth | undefined>;

See Auth below for details.

property convergeConfig

public convergeConfig: pulumi.Output<ServiceConvergeConfig | undefined>;

See Converge Config below for details.

property endpointSpec

public endpointSpec: pulumi.Output<ServiceEndpointSpec>;

See EndpointSpec below for details.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<ServiceLabel[]>;

See Labels below for details.

property mode

public mode: pulumi.Output<ServiceMode>;

See Mode below for details.

property name

public name: pulumi.Output<string>;

The name of the Docker service.

property rollbackConfig

public rollbackConfig: pulumi.Output<ServiceRollbackConfig | undefined>;

See RollbackConfig below for details.

property taskSpec

public taskSpec: pulumi.Output<ServiceTaskSpec>;

See TaskSpec below for details.

property updateConfig

public updateConfig: pulumi.Output<ServiceUpdateConfig | undefined>;

See UpdateConfig below for details.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ServiceConfig

class ServiceConfig extends CustomResource

Manages the configuration of a Docker service in a swarm.

Basic

import * as pulumi from "@pulumi/pulumi";
import * as docker from "@pulumi/docker";

// Creates a config
const fooConfig = new docker.ServiceConfig("fooConfig", {
    data: "ewogICJzZXJIfQo=",
});

constructor

new ServiceConfig(name: string, args: ServiceConfigArgs, opts?: pulumi.CustomResourceOptions)

Create a ServiceConfig resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceConfigState, opts?: pulumi.CustomResourceOptions): ServiceConfig

Get an existing ServiceConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ServiceConfig

Returns true if the given object is an instance of ServiceConfig. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property data

public data: pulumi.Output<string>;

The base64 encoded data of the config.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the Docker config.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Volume

class Volume extends CustomResource

Creates and destroys a volume in Docker. This can be used alongside docker_container to prepare volumes that can be shared across containers.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as docker from "@pulumi/docker";

// Creates a docker volume "sharedVolume".
const sharedVolume = new docker.Volume("sharedVolume", {});

constructor

new Volume(name: string, args?: VolumeArgs, opts?: pulumi.CustomResourceOptions)

Create a Volume resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: VolumeState, opts?: pulumi.CustomResourceOptions): Volume

Get an existing Volume resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Volume

Returns true if the given object is an instance of Volume. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property driver

public driver: pulumi.Output<string>;

Driver type for the volume (defaults to local).

property driverOpts

public driverOpts: pulumi.Output<{[key: string]: any} | undefined>;

Options specific to the driver.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property labels

public labels: pulumi.Output<VolumeLabel[] | undefined>;

User-defined key/value metadata.

property mountpoint

public mountpoint: pulumi.Output<string>;

property name

public name: pulumi.Output<string>;

The name of the Docker volume (generated if not provided).

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Functions

Function getNetwork

getNetwork(args?: GetNetworkArgs, opts?: pulumi.InvokeOptions): Promise<GetNetworkResult>

Finds a specific docker network and returns information about it.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as docker from "@pulumi/docker";

const main = pulumi.output(docker.getNetwork({
    name: "main",
}, { async: true }));

Function getRegistryImage

getRegistryImage(args?: GetRegistryImageArgs, opts?: pulumi.InvokeOptions): Promise<GetRegistryImageResult>

Reads the image metadata from a Docker Registry. Used in conjunction with the docker_image resource to keep an image up to date on the latest available version of the tag.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as docker from "@pulumi/docker";

const ubuntuRegistryImage = pulumi.output(docker.getRegistryImage({
    name: "ubuntu:precise",
}, { async: true }));
const ubuntuRemoteImage = new docker.RemoteImage("ubuntu", {
    name: ubuntuRegistryImage.name!,
    pullTriggers: [ubuntuRegistryImage.sha256Digest],
});

Others

function buildAndPushImage

buildAndPushImage(imageName: string, pathOrBuild: pulumi.Input<string | DockerBuild>, repositoryUrl: pulumi.Input<string>, logResource: Resource, connectToRegistry?: undefined | () => pulumi.Input<Registry>, skipPush: boolean): pulumi.Output<string>

buildAndPushImage will build and push the Dockerfile and context from [pathOrBuild] into the requested docker repo [repositoryUrl]. It returns the unique target image name for the image in the docker repository. During preview this will build the image, and return the target image name, without pushing. During a normal update, it will do the same, as well as tag and push the image.

function buildAndPushImageAsync

DEPRECATED Use [buildAndPushImage] instead. This function loses the Output resource tracking information from [pathOrBuild] and [repositoryUrl]. [buildAndPushImage] properly keeps track of this in the result.

buildAndPushImageAsync(baseImageName: string, pathOrBuild: pulumi.Input<string | DockerBuild>, repositoryUrl: pulumi.Input<string>, logResource: Resource, connectToRegistry?: undefined | () => pulumi.Input<Registry>, skipPush: boolean): Promise<string>

interface CacheFrom

interface CacheFrom

CacheFrom may be used to specify build stages to use for the Docker build cache. The final image is always implicitly included.

property stages

stages?: pulumi.Input<pulumi.Input<string>[]>;

An optional list of build stages to use for caching. Each build stage in this list will be built explicitly and pushed to the target repository. A given stage’s image will be tagged as “[stage-name]“.

interface ContainerArgs

interface ContainerArgs

The set of arguments for constructing a Container resource.

property attach

attach?: pulumi.Input<boolean>;

If true attach to the container after its creation and waits the end of his execution.

property capabilities

capabilities?: pulumi.Input<ContainerCapabilities>;

See Capabilities below for details.

property command

command?: pulumi.Input<pulumi.Input<string>[]>;

The command to use to start the container. For example, to run /usr/bin/myprogram -f baz.conf set the command to be ["/usr/bin/myprogram", "-f", "baz.conf"].

property cpuSet

cpuSet?: pulumi.Input<string>;

A comma-separated list or hyphen-separated range of CPUs a container can use, e.g. 0-1.

property cpuShares

cpuShares?: pulumi.Input<number>;

CPU shares (relative weight) for the container.

property destroyGraceSeconds

destroyGraceSeconds?: pulumi.Input<number>;

If defined will attempt to stop the container before destroying. Container will be destroyed after n seconds or on successful stop.

property devices

devices?: pulumi.Input<pulumi.Input<ContainerDevice>[]>;

See Devices below for details.

property dns

dns?: pulumi.Input<pulumi.Input<string>[]>;

Set of DNS servers.

property dnsOpts

dnsOpts?: pulumi.Input<pulumi.Input<string>[]>;

Set of DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.

property dnsSearches

dnsSearches?: pulumi.Input<pulumi.Input<string>[]>;

Set of DNS search domains that are used when bare unqualified hostnames are used inside of the container.

property domainname

domainname?: pulumi.Input<string>;

Domain name of the container.

property entrypoints

entrypoints?: pulumi.Input<pulumi.Input<string>[]>;

property envs

envs?: pulumi.Input<pulumi.Input<string>[]>;

Environment variables to set.

property groupAdds

groupAdds?: pulumi.Input<pulumi.Input<string>[]>;

Add additional groups to run as.

property healthcheck

healthcheck?: pulumi.Input<ContainerHealthcheck>;

See Healthcheck below for details.

property hostname

hostname?: pulumi.Input<string>;

Hostname of the container.

property hosts

hosts?: pulumi.Input<pulumi.Input<ContainerHost>[]>;

Hostname to add.

property image

image: pulumi.Input<string>;

The ID of the image to back this container. The easiest way to get this value is to use the docker..RemoteImage resource as is shown in the example above.

property ipcMode

ipcMode?: pulumi.Input<string>;

IPC sharing mode for the container. Possible values are: none, private, shareable, container:<name|id> or host.

property labels

labels?: pulumi.Input<pulumi.Input<ContainerLabel>[]>;

Adding labels.

property links

DEPRECATED The –link flag is a legacy feature of Docker. It may eventually be removed.

links?: pulumi.Input<pulumi.Input<string>[]>;

Set of links for link based connectivity between containers that are running on the same host.

property logDriver

logDriver?: pulumi.Input<string>;

The logging driver to use for the container. Defaults to “json-file”.

property logOpts

logOpts?: pulumi.Input<{[key: string]: any}>;

Key/value pairs to use as options for the logging driver.

property logs

logs?: pulumi.Input<boolean>;

Save the container logs (attach must be enabled).

property maxRetryCount

maxRetryCount?: pulumi.Input<number>;

The maximum amount of times to an attempt a restart when restart is set to “on-failure”

property memory

memory?: pulumi.Input<number>;

The memory limit for the container in MBs.

property memorySwap

memorySwap?: pulumi.Input<number>;

property mounts

mounts?: pulumi.Input<pulumi.Input<ContainerMount>[]>;

See Mounts below for details.

property mustRun

mustRun?: pulumi.Input<boolean>;

property name

name?: pulumi.Input<string>;

property networkAliases

DEPRECATED Use networks_advanced instead. Will be removed in v2.0.0

networkAliases?: pulumi.Input<pulumi.Input<string>[]>;

Network aliases of the container for user-defined networks only. Deprecated: use networksAdvanced instead.

property networkMode

networkMode?: pulumi.Input<string>;

Network mode of the container.

property networks

DEPRECATED Use networks_advanced instead. Will be removed in v2.0.0

networks?: pulumi.Input<pulumi.Input<string>[]>;

Id of the networks in which the container is. Deprecated: use networksAdvanced instead.

property networksAdvanced

networksAdvanced?: pulumi.Input<pulumi.Input<ContainerNetworksAdvanced>[]>;

See Networks Advanced below for details. If this block has priority to the deprecated networkAlias and network properties.

property pidMode

pidMode?: pulumi.Input<string>;

The PID (Process) Namespace mode for the container. Either container:<name|id> or host.

property ports

ports?: pulumi.Input<pulumi.Input<ContainerPort>[]>;

See Ports below for details.

property privileged

privileged?: pulumi.Input<boolean>;

Run container in privileged mode.

property publishAllPorts

publishAllPorts?: pulumi.Input<boolean>;

Publish all ports of the container.

property readOnly

readOnly?: pulumi.Input<boolean>;

If true, this volume will be readonly. Defaults to false.

property restart

restart?: pulumi.Input<string>;

The restart policy for the container. Must be one of “no”, “on-failure”, “always”, “unless-stopped”.

property rm

rm?: pulumi.Input<boolean>;

property shmSize

shmSize?: pulumi.Input<number>;

Size of /dev/shm in MBs.

property start

start?: pulumi.Input<boolean>;

If true, then the Docker container will be started after creation. If false, then the container is only created.

property sysctls

sysctls?: pulumi.Input<{[key: string]: any}>;

A map of kernel parameters (sysctls) to set in the container.

property tmpfs

tmpfs?: pulumi.Input<{[key: string]: any}>;

A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options.

property ulimits

ulimits?: pulumi.Input<pulumi.Input<ContainerUlimit>[]>;

See Ulimits below for details.

property uploads

uploads?: pulumi.Input<pulumi.Input<ContainerUpload>[]>;

See File Upload below for details.

property user

user?: pulumi.Input<string>;

User used for run the first process. Format is user or user:group which user and group can be passed literraly or by name.

property usernsMode

usernsMode?: pulumi.Input<string>;

Sets the usernamespace mode for the container when usernamespace remapping option is enabled.

property volumes

volumes?: pulumi.Input<pulumi.Input<ContainerVolume>[]>;

See Volumes below for details.

property workingDir

workingDir?: pulumi.Input<string>;

The working directory for commands to run in

interface ContainerState

interface ContainerState

Input properties used for looking up and filtering Container resources.

property attach

attach?: pulumi.Input<boolean>;

If true attach to the container after its creation and waits the end of his execution.

property bridge

bridge?: pulumi.Input<string>;

The network bridge of the container as read from its NetworkSettings.

property capabilities

capabilities?: pulumi.Input<ContainerCapabilities>;

See Capabilities below for details.

property command

command?: pulumi.Input<pulumi.Input<string>[]>;

The command to use to start the container. For example, to run /usr/bin/myprogram -f baz.conf set the command to be ["/usr/bin/myprogram", "-f", "baz.conf"].

property containerLogs

containerLogs?: pulumi.Input<string>;

The logs of the container if its execution is done (attach must be disabled).

property cpuSet

cpuSet?: pulumi.Input<string>;

A comma-separated list or hyphen-separated range of CPUs a container can use, e.g. 0-1.

property cpuShares

cpuShares?: pulumi.Input<number>;

CPU shares (relative weight) for the container.

property destroyGraceSeconds

destroyGraceSeconds?: pulumi.Input<number>;

If defined will attempt to stop the container before destroying. Container will be destroyed after n seconds or on successful stop.

property devices

devices?: pulumi.Input<pulumi.Input<ContainerDevice>[]>;

See Devices below for details.

property dns

dns?: pulumi.Input<pulumi.Input<string>[]>;

Set of DNS servers.

property dnsOpts

dnsOpts?: pulumi.Input<pulumi.Input<string>[]>;

Set of DNS options used by the DNS provider(s), see resolv.conf documentation for valid list of options.

property dnsSearches

dnsSearches?: pulumi.Input<pulumi.Input<string>[]>;

Set of DNS search domains that are used when bare unqualified hostnames are used inside of the container.

property domainname

domainname?: pulumi.Input<string>;

Domain name of the container.

property entrypoints

entrypoints?: pulumi.Input<pulumi.Input<string>[]>;

property envs

envs?: pulumi.Input<pulumi.Input<string>[]>;

Environment variables to set.

property exitCode

exitCode?: pulumi.Input<number>;

The exit code of the container if its execution is done (mustRun must be disabled).

property gateway

DEPRECATED Use gateway from ip_adresses_data instead. This field exposes the data of the container's first network.

gateway?: pulumi.Input<string>;

Deprecated: Use networkData instead. The network gateway of the container as read from its NetworkSettings.

property groupAdds

groupAdds?: pulumi.Input<pulumi.Input<string>[]>;

Add additional groups to run as.

property healthcheck

healthcheck?: pulumi.Input<ContainerHealthcheck>;

See Healthcheck below for details.

property hostname

hostname?: pulumi.Input<string>;

Hostname of the container.

property hosts

hosts?: pulumi.Input<pulumi.Input<ContainerHost>[]>;

Hostname to add.

property image

image?: pulumi.Input<string>;

The ID of the image to back this container. The easiest way to get this value is to use the docker..RemoteImage resource as is shown in the example above.

property ipAddress

DEPRECATED Use ip_adresses_data instead. This field exposes the data of the container's first network.

ipAddress?: pulumi.Input<string>;

Deprecated: Use networkData instead. The IP address of the container’s first network it.

property ipPrefixLength

DEPRECATED Use ip_prefix_length from ip_adresses_data instead. This field exposes the data of the container's first network.

ipPrefixLength?: pulumi.Input<number>;

Deprecated: Use networkData instead. The IP prefix length of the container as read from its NetworkSettings.

property ipcMode

ipcMode?: pulumi.Input<string>;

IPC sharing mode for the container. Possible values are: none, private, shareable, container:<name|id> or host.

property labels

labels?: pulumi.Input<pulumi.Input<ContainerLabel>[]>;

Adding labels.

property links

DEPRECATED The –link flag is a legacy feature of Docker. It may eventually be removed.

links?: pulumi.Input<pulumi.Input<string>[]>;

Set of links for link based connectivity between containers that are running on the same host.

property logDriver

logDriver?: pulumi.Input<string>;

The logging driver to use for the container. Defaults to “json-file”.

property logOpts

logOpts?: pulumi.Input<{[key: string]: any}>;

Key/value pairs to use as options for the logging driver.

property logs

logs?: pulumi.Input<boolean>;

Save the container logs (attach must be enabled).

property maxRetryCount

maxRetryCount?: pulumi.Input<number>;

The maximum amount of times to an attempt a restart when restart is set to “on-failure”

property memory

memory?: pulumi.Input<number>;

The memory limit for the container in MBs.

property memorySwap

memorySwap?: pulumi.Input<number>;

property mounts

mounts?: pulumi.Input<pulumi.Input<ContainerMount>[]>;

See Mounts below for details.

property mustRun

mustRun?: pulumi.Input<boolean>;

property name

name?: pulumi.Input<string>;

property networkAliases

DEPRECATED Use networks_advanced instead. Will be removed in v2.0.0

networkAliases?: pulumi.Input<pulumi.Input<string>[]>;

Network aliases of the container for user-defined networks only. Deprecated: use networksAdvanced instead.

property networkDatas

networkDatas?: pulumi.Input<pulumi.Input<ContainerNetworkData>[]>;

(Map of a block) The IP addresses of the container on each network. Key are the network names, values are the IP addresses.

property networkMode

networkMode?: pulumi.Input<string>;

Network mode of the container.

property networks

DEPRECATED Use networks_advanced instead. Will be removed in v2.0.0

networks?: pulumi.Input<pulumi.Input<string>[]>;

Id of the networks in which the container is. Deprecated: use networksAdvanced instead.

property networksAdvanced

networksAdvanced?: pulumi.Input<pulumi.Input<ContainerNetworksAdvanced>[]>;

See Networks Advanced below for details. If this block has priority to the deprecated networkAlias and network properties.

property pidMode

pidMode?: pulumi.Input<string>;

The PID (Process) Namespace mode for the container. Either container:<name|id> or host.

property ports

ports?: pulumi.Input<pulumi.Input<ContainerPort>[]>;

See Ports below for details.

property privileged

privileged?: pulumi.Input<boolean>;

Run container in privileged mode.

property publishAllPorts

publishAllPorts?: pulumi.Input<boolean>;

Publish all ports of the container.

property readOnly

readOnly?: pulumi.Input<boolean>;

If true, this volume will be readonly. Defaults to false.

property restart

restart?: pulumi.Input<string>;

The restart policy for the container. Must be one of “no”, “on-failure”, “always”, “unless-stopped”.

property rm

rm?: pulumi.Input<boolean>;

property shmSize

shmSize?: pulumi.Input<number>;

Size of /dev/shm in MBs.

property start

start?: pulumi.Input<boolean>;

If true, then the Docker container will be started after creation. If false, then the container is only created.

property sysctls

sysctls?: pulumi.Input<{[key: string]: any}>;

A map of kernel parameters (sysctls) to set in the container.

property tmpfs

tmpfs?: pulumi.Input<{[key: string]: any}>;

A map of container directories which should be replaced by tmpfs mounts, and their corresponding mount options.

property ulimits

ulimits?: pulumi.Input<pulumi.Input<ContainerUlimit>[]>;

See Ulimits below for details.

property uploads

uploads?: pulumi.Input<pulumi.Input<ContainerUpload>[]>;

See File Upload below for details.

property user

user?: pulumi.Input<string>;

User used for run the first process. Format is user or user:group which user and group can be passed literraly or by name.

property usernsMode

usernsMode?: pulumi.Input<string>;

Sets the usernamespace mode for the container when usernamespace remapping option is enabled.

property volumes

volumes?: pulumi.Input<pulumi.Input<ContainerVolume>[]>;

See Volumes below for details.

property workingDir

workingDir?: pulumi.Input<string>;

The working directory for commands to run in

interface DockerBuild

interface DockerBuild

DockerBuild may be used to specify detailed instructions about how to build a container.

property args

args?: pulumi.Input<Record<string, pulumi.Input<string>>>;

An optional map of named build-time argument variables to set during the Docker build. This flag allows you to pass built-time variables that can be accessed like environment variables inside the RUN instruction.

property cacheFrom

cacheFrom?: pulumi.Input<boolean | CacheFrom>;

An optional CacheFrom object with information about the build stages to use for the Docker build cache. This parameter maps to the –cache-from argument to the Docker CLI. If this parameter is true, only the final image will be pulled and passed to –cache-from; if it is a CacheFrom object, the stages named therein will also be pulled and passed to –cache-from.

property context

context?: pulumi.Input<string>;

context is a path to a directory to use for the Docker build context, usually the directory in which the Dockerfile resides (although dockerfile may be used to choose a custom location independent of this choice). If not specified, the context defaults to the current working directory; if a relative path is used, it is relative to the current working directory that Pulumi is evaluating.

property dockerfile

dockerfile?: pulumi.Input<string>;

dockerfile may be used to override the default Dockerfile name and/or location. By default, it is assumed to be a file named Dockerfile in the root of the build context.

property env

env?: Record<string, string>;

Environment variables to set on the invocation of docker build, for example to support DOCKER_BUILDKIT=1 docker build.

property extraOptions

extraOptions?: pulumi.Input<pulumi.Input<string>[]>;

An optional catch-all string to provide extra CLI options to the docker build command. For example, use to specify --network host.

property target

target?: pulumi.Input<string>;

The target of the dockerfile to build

function getEnv

getEnv(vars: string[]): string | undefined

function getEnvBoolean

getEnvBoolean(vars: string[]): boolean | undefined

function getEnvNumber

getEnvNumber(vars: string[]): number | undefined

interface GetNetworkArgs

interface GetNetworkArgs

A collection of arguments for invoking getNetwork.

property id

id?: undefined | string;

The id of the Docker network.

property name

name?: undefined | string;

The name of the Docker network.

interface GetNetworkResult

interface GetNetworkResult

A collection of values returned by getNetwork.

property driver

driver: string;

(Optional, string) The driver of the Docker network. Possible values are bridge, host, overlay, macvlan. See [docker docs][networkdocs] for more details.

property id

id?: undefined | string;

property internal

internal: boolean;

property ipamConfigs

ipamConfigs: GetNetworkIpamConfig[];

property name

name?: undefined | string;

property options

options: {[key: string]: any};

(Optional, map) Only available with bridge networks. See [docker docs][bridgeoptionsdocs] for more details. * internal (Optional, bool) Boolean flag for whether the network is internal. * ipamConfig (Optional, map) See IPAM below for details. * scope (Optional, string) Scope of the network. One of swarm, global, or local.

property scope

scope: string;

interface GetRegistryImageArgs

interface GetRegistryImageArgs

A collection of arguments for invoking getRegistryImage.

property name

name?: undefined | string;

The name of the Docker image, including any tags. e.g. alpine:latest

interface GetRegistryImageResult

interface GetRegistryImageResult

A collection of values returned by getRegistryImage.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name?: undefined | string;

property sha256Digest

sha256Digest: string;

function getVersion

getVersion(): string

interface ImageArgs

interface ImageArgs

Arguments for constructing an Image resource.

property build

build: pulumi.Input<string | DockerBuild>;

The Docker build context, as a folder path or a detailed DockerBuild object.

property imageName

imageName: pulumi.Input<string>;

The qualified image name that will be pushed to the remote registry. Must be a supported image name for the target registry user. This name can include a tag at the end. If provided all pushed image resources will contain that tag as well.

Either [imageName] or [localImageName] can have a tag. However, if both have a tag, then those tags must match.

property localImageName

localImageName?: pulumi.Input<string>;

The docker image name to build locally before tagging with imageName. If not provided, it will be given the value of to [imageName]. This name can include a tag at the end. If provided all pushed image resources will contain that tag as well.

Either [imageName] or [localImageName] can have a tag. However, if both have a tag, then those tags must match.

property registry

registry?: pulumi.Input<ImageRegistry>;

Credentials for the docker registry to push to.

property skipPush

skipPush?: undefined | false | true;

Skip push flag.

interface ImageRegistry

interface ImageRegistry

property password

password: pulumi.Input<string>;

Password for login to the target Docker registry.

property server

server: pulumi.Input<string>;

Docker registry server URL to push to. Some common values include: DockerHub: docker.io or https://index.docker.io/v1 Azure Container Registry: <name>.azurecr.io AWS Elastic Container Registry: <account>.dkr.ecr.us-east-2.amazonaws.com Google Container Registry: <name>.gcr.io

property username

username: pulumi.Input<string>;

Username for login to the target Docker registry.

interface NetworkArgs

interface NetworkArgs

The set of arguments for constructing a Network resource.

property attachable

attachable?: pulumi.Input<boolean>;

Enable manual container attachment to the network. Defaults to false.

property checkDuplicate

checkDuplicate?: pulumi.Input<boolean>;

Requests daemon to check for networks with same name.

property driver

driver?: pulumi.Input<string>;

Name of the network driver to use. Defaults to bridge driver.

property ingress

ingress?: pulumi.Input<boolean>;

Create swarm routing-mesh network. Defaults to false.

property internal

internal?: pulumi.Input<boolean>;

Restrict external access to the network. Defaults to false.

property ipamConfigs

ipamConfigs?: pulumi.Input<pulumi.Input<NetworkIpamConfig>[]>;

See IPAM config below for details.

property ipamDriver

ipamDriver?: pulumi.Input<string>;

Driver used by the custom IP scheme of the network.

property ipv6

ipv6?: pulumi.Input<boolean>;

Enable IPv6 networking. Defaults to false.

property labels

labels?: pulumi.Input<pulumi.Input<NetworkLabel>[]>;

See Labels below for details.

property name

name?: pulumi.Input<string>;

The name of the Docker network.

property options

options?: pulumi.Input<{[key: string]: any}>;

Network specific options to be used by the drivers.

interface NetworkState

interface NetworkState

Input properties used for looking up and filtering Network resources.

property attachable

attachable?: pulumi.Input<boolean>;

Enable manual container attachment to the network. Defaults to false.

property checkDuplicate

checkDuplicate?: pulumi.Input<boolean>;

Requests daemon to check for networks with same name.

property driver

driver?: pulumi.Input<string>;

Name of the network driver to use. Defaults to bridge driver.

property ingress

ingress?: pulumi.Input<boolean>;

Create swarm routing-mesh network. Defaults to false.

property internal

internal?: pulumi.Input<boolean>;

Restrict external access to the network. Defaults to false.

property ipamConfigs

ipamConfigs?: pulumi.Input<pulumi.Input<NetworkIpamConfig>[]>;

See IPAM config below for details.

property ipamDriver

ipamDriver?: pulumi.Input<string>;

Driver used by the custom IP scheme of the network.

property ipv6

ipv6?: pulumi.Input<boolean>;

Enable IPv6 networking. Defaults to false.

property labels

labels?: pulumi.Input<pulumi.Input<NetworkLabel>[]>;

See Labels below for details.

property name

name?: pulumi.Input<string>;

The name of the Docker network.

property options

options?: pulumi.Input<{[key: string]: any}>;

Network specific options to be used by the drivers.

property scope

scope?: pulumi.Input<string>;

interface ProviderArgs

interface ProviderArgs

The set of arguments for constructing a Provider resource.

property caMaterial

caMaterial?: pulumi.Input<string>;

PEM-encoded content of Docker host CA certificate

property certMaterial

certMaterial?: pulumi.Input<string>;

PEM-encoded content of Docker client certificate

property certPath

certPath?: pulumi.Input<string>;

Path to directory with Docker TLS config

property host

host?: pulumi.Input<string>;

The Docker daemon address

property keyMaterial

keyMaterial?: pulumi.Input<string>;

PEM-encoded content of Docker client private key

property registryAuth

registryAuth?: pulumi.Input<pulumi.Input<ProviderRegistryAuth>[]>;

interface Registry

interface Registry

property password

password: pulumi.Input<string>;

property registry

registry: pulumi.Input<string>;

property username

username: pulumi.Input<string>;

interface RemoteImageArgs

interface RemoteImageArgs

The set of arguments for constructing a RemoteImage resource.

property keepLocally

keepLocally?: pulumi.Input<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.

property name

name: pulumi.Input<string>;

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

property pullTrigger

DEPRECATED Use field pull_triggers instead

pullTrigger?: pulumi.Input<string>;

Deprecated, use pullTriggers instead.

property pullTriggers

pullTriggers?: pulumi.Input<pulumi.Input<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 docker..getRegistryImage data source to trigger an image update.

interface RemoteImageState

interface RemoteImageState

Input properties used for looking up and filtering RemoteImage resources.

property keepLocally

keepLocally?: pulumi.Input<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.

property latest

latest?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

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

property pullTrigger

DEPRECATED Use field pull_triggers instead

pullTrigger?: pulumi.Input<string>;

Deprecated, use pullTriggers instead.

property pullTriggers

pullTriggers?: pulumi.Input<pulumi.Input<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 docker..getRegistryImage data source to trigger an image update.

interface SecretArgs

interface SecretArgs

The set of arguments for constructing a Secret resource.

property data

data: pulumi.Input<string>;

The base64 encoded data of the secret.

property labels

labels?: pulumi.Input<pulumi.Input<SecretLabel>[]>;

See Labels below for details.

property name

name?: pulumi.Input<string>;

The name of the Docker secret.

interface SecretState

interface SecretState

Input properties used for looking up and filtering Secret resources.

property data

data?: pulumi.Input<string>;

The base64 encoded data of the secret.

property labels

labels?: pulumi.Input<pulumi.Input<SecretLabel>[]>;

See Labels below for details.

property name

name?: pulumi.Input<string>;

The name of the Docker secret.

interface ServiceArgs

interface ServiceArgs

The set of arguments for constructing a Service resource.

property auth

auth?: pulumi.Input<ServiceAuth>;

See Auth below for details.

property convergeConfig

convergeConfig?: pulumi.Input<ServiceConvergeConfig>;

See Converge Config below for details.

property endpointSpec

endpointSpec?: pulumi.Input<ServiceEndpointSpec>;

See EndpointSpec below for details.

property labels

labels?: pulumi.Input<pulumi.Input<ServiceLabel>[]>;

See Labels below for details.

property mode

mode?: pulumi.Input<ServiceMode>;

See Mode below for details.

property name

name?: pulumi.Input<string>;

The name of the Docker service.

property rollbackConfig

rollbackConfig?: pulumi.Input<ServiceRollbackConfig>;

See RollbackConfig below for details.

property taskSpec

taskSpec: pulumi.Input<ServiceTaskSpec>;

See TaskSpec below for details.

property updateConfig

updateConfig?: pulumi.Input<ServiceUpdateConfig>;

See UpdateConfig below for details.

interface ServiceConfigArgs

interface ServiceConfigArgs

The set of arguments for constructing a ServiceConfig resource.

property data

data: pulumi.Input<string>;

The base64 encoded data of the config.

property name

name?: pulumi.Input<string>;

The name of the Docker config.

interface ServiceConfigState

interface ServiceConfigState

Input properties used for looking up and filtering ServiceConfig resources.

property data

data?: pulumi.Input<string>;

The base64 encoded data of the config.

property name

name?: pulumi.Input<string>;

The name of the Docker config.

interface ServiceState

interface ServiceState

Input properties used for looking up and filtering Service resources.

property auth

auth?: pulumi.Input<ServiceAuth>;

See Auth below for details.

property convergeConfig

convergeConfig?: pulumi.Input<ServiceConvergeConfig>;

See Converge Config below for details.

property endpointSpec

endpointSpec?: pulumi.Input<ServiceEndpointSpec>;

See EndpointSpec below for details.

property labels

labels?: pulumi.Input<pulumi.Input<ServiceLabel>[]>;

See Labels below for details.

property mode

mode?: pulumi.Input<ServiceMode>;

See Mode below for details.

property name

name?: pulumi.Input<string>;

The name of the Docker service.

property rollbackConfig

rollbackConfig?: pulumi.Input<ServiceRollbackConfig>;

See RollbackConfig below for details.

property taskSpec

taskSpec?: pulumi.Input<ServiceTaskSpec>;

See TaskSpec below for details.

property updateConfig

updateConfig?: pulumi.Input<ServiceUpdateConfig>;

See UpdateConfig below for details.

interface VolumeArgs

interface VolumeArgs

The set of arguments for constructing a Volume resource.

property driver

driver?: pulumi.Input<string>;

Driver type for the volume (defaults to local).

property driverOpts

driverOpts?: pulumi.Input<{[key: string]: any}>;

Options specific to the driver.

property labels

labels?: pulumi.Input<pulumi.Input<VolumeLabel>[]>;

User-defined key/value metadata.

property name

name?: pulumi.Input<string>;

The name of the Docker volume (generated if not provided).

interface VolumeState

interface VolumeState

Input properties used for looking up and filtering Volume resources.

property driver

driver?: pulumi.Input<string>;

Driver type for the volume (defaults to local).

property driverOpts

driverOpts?: pulumi.Input<{[key: string]: any}>;

Options specific to the driver.

property labels

labels?: pulumi.Input<pulumi.Input<VolumeLabel>[]>;

User-defined key/value metadata.

property mountpoint

mountpoint?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The name of the Docker volume (generated if not provided).

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Package @pulumi/docker

Modules

Resources

Functions

Others

Resources

Example Usage

Example Usage

Example Usage

Dynamic image