Fork me on GitHub

Package @pulumi/docker

Node.js:

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

ES6 modules:

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

Index

docker.ts

function buildAndPushImage

buildAndPushImage(imageName: string, pathOrBuild: string | DockerBuild, repositoryUrl: pulumi.Input<string>, logResource: pulumi.Resource, connectToRegistry: { ... }): pulumi.Output<string>

function buildAndPushImageAsync

buildAndPushImageAsync(baseImageName: string, pathOrBuild: string | DockerBuild, repositoryUrl: string, logResource: pulumi.Resource, connectToRegistry?: undefined | { ... }): Promise<string>

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?: 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 DockerBuild

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

property args

args?: undefined | { ... };

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?: 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?: undefined | 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?: undefined | 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.

interface Registry

property password

password: string;

property registry

registry: string;

property username

username: string;