terraform-provider-docker/docs/resources/registry_image.md

page_title	subcategory	description
docker_registry_image Resource - terraform-provider-docker		Manages the lifecycle of docker image/tag in a registry.

docker_registry_image (Resource)

Manages the lifecycle of docker image/tag in a registry.

Example Usage

resource "docker_registry_image" "helloworld" {
  name = "helloworld:1.0"

  build {
    context = "pathToContextFolder"
  }
}

Schema

Required

• name (String) The name of the Docker image.

Optional

• build (Block List, Max: 1) Definition for building the image (see below for nested schema)
• id (String) The ID of this resource.
• keep_remotely (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 registry on destroy operation. Defaults to false

Read-Only

• sha256_digest (String) The sha256 digest of the image.

Nested Schema for build

Required:

• context (String) The path to the context folder

Optional:

• auth_config (Block List) The configuration for the autentication (see below for nested schema)
• build_args (Map of String) Pairs for build-time variables in the form TODO
• build_id (String) BuildID is an optional identifier that can be passed together with the build request. The
• cache_from (List of String) Images to consider as cache sources
• cgroup_parent (String) Optional parent cgroup for the container
• cpu_period (Number) The length of a CPU period in microseconds
• cpu_quota (Number) Microseconds of CPU time that the container can get in a CPU period
• cpu_set_cpus (String) CPUs in which to allow execution (e.g., 0-3, 0, 1)
• cpu_set_mems (String) MEMs in which to allow execution (0-3, 0, 1)
• cpu_shares (Number) CPU shares (relative weight)
• dockerfile (String) Dockerfile file. Defaults to Dockerfile
• extra_hosts (List of String) A list of hostnames/IP mappings to add to the container’s /etc/hosts file. Specified in the form ["hostname:IP"]
• force_remove (Boolean) Always remove intermediate containers
• isolation (String) Isolation represents the isolation technology of a container. The supported values are
• labels (Map of String) User-defined key/value metadata
• memory (Number) Set memory limit for build
• memory_swap (Number) Total memory (memory + swap), -1 to enable unlimited swap
• network_mode (String) Set the networking mode for the RUN instructions during build
• no_cache (Boolean) Do not use the cache when building the image
• platform (String) Set platform if server is multi-platform capable
• pull_parent (Boolean) Attempt to pull the image even if an older image exists locally
• remote_context (String) A Git repository URI or HTTP/HTTPS context URI
• remove (Boolean) Remove intermediate containers after a successful build (default behavior)
• security_opt (List of String) The security options
• session_id (String) Set an ID for the build session
• shm_size (Number) Size of /dev/shm in bytes. The size must be greater than 0
• squash (Boolean) If true the new layers are squashed into a new image with a single new layer
• suppress_output (Boolean) Suppress the build output and print image ID on success
• target (String) Set the target build stage to build
• ulimit (Block List) Configuration for ulimits (see below for nested schema)
• version (String) Version of the unerlying builder to use

Nested Schema for build.auth_config

Required:

• host_name (String) hostname of the registry

Optional:

• auth (String) the auth token
• email (String) the user emal
• identity_token (String) the identity token
• password (String) the registry password
• registry_token (String) the registry token
• server_address (String) the server address
• user_name (String) the registry user name

Nested Schema for build.ulimit

Required:

• hard (Number) soft limit
• name (String) type of ulimit, e.g. nofile
• soft (Number) hard limit