terraform-provider-docker/docs/resources/registry_image.md
2021-05-16 15:44:59 +02:00

117 lines
2.4 KiB
Markdown

---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "docker_registry_image Resource - terraform-provider-docker"
subcategory: ""
description: |-
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
```terraform
resource "docker_registry_image" "helloworld" {
name = "helloworld:1.0"
build {
context = "pathToContextFolder"
}
}
```
<!-- schema generated by tfplugindocs -->
## Schema
### Required
- **name** (String)
### Optional
- **build** (Block List, Max: 1) (see [below for nested schema](#nestedblock--build))
- **id** (String) The ID of this resource.
- **keep_remotely** (Boolean)
### Read-Only
- **sha256_digest** (String)
<a id="nestedblock--build"></a>
### Nested Schema for `build`
Required:
- **context** (String)
Optional:
- **auth_config** (Block List) (see [below for nested schema](#nestedblock--build--auth_config))
- **build_args** (Map of String)
- **build_id** (String)
- **cache_from** (List of String)
- **cgroup_parent** (String)
- **cpu_period** (Number)
- **cpu_quota** (Number)
- **cpu_set_cpus** (String)
- **cpu_set_mems** (String)
- **cpu_shares** (Number)
- **dockerfile** (String)
- **extra_hosts** (List of String)
- **force_remove** (Boolean)
- **isolation** (String)
- **labels** (Map of String)
- **memory** (Number)
- **memory_swap** (Number)
- **network_mode** (String)
- **no_cache** (Boolean)
- **platform** (String)
- **pull_parent** (Boolean)
- **remote_context** (String)
- **remove** (Boolean)
- **security_opt** (List of String)
- **session_id** (String)
- **shm_size** (Number)
- **squash** (Boolean)
- **suppress_output** (Boolean)
- **target** (String)
- **ulimit** (Block List) (see [below for nested schema](#nestedblock--build--ulimit))
- **version** (String)
<a id="nestedblock--build--auth_config"></a>
### Nested Schema for `build.auth_config`
Required:
- **host_name** (String)
Optional:
- **auth** (String)
- **email** (String)
- **identity_token** (String)
- **password** (String)
- **registry_token** (String)
- **server_address** (String)
- **user_name** (String)
<a id="nestedblock--build--ulimit"></a>
### Nested Schema for `build.ulimit`
Required:
- **hard** (Number)
- **name** (String)
- **soft** (Number)
## Import
Import is supported using the following syntax:
```shell
#!/bin/bash
# TODO
```