mirror of
https://github.com/kreuzwerker/terraform-provider-docker.git
synced 2025-12-22 15:49:34 -05:00
6c796e15a5
* chore: add tfplugindocs tool
* feat: add tfplugin doc dependency and make target
* chore: apply documentation generation
* docs(contributing): update for documentation generation
* fix: adapt website-lint target to new do folder
* docs(network): update ds descriptions
* docs: add template for index.md
* docs: add network resource generation
* chore(ci): updates paths for website checks
* docs: add plugin data source generation
* docs: add import cmd for network resource
* docs: add plugin resource generation
* feat: outlines remaining resources with example and import cmd
* feat: add descriptions to docs
* chore: add DevSkim ignores and fix capitalized errors
* docs: complete ds registry image
* docs: add container resource generation
* docs: add lables description to missing resources
* docs: remove computed:true from network data
so the list is rendered in the description
* Revert "docs: remove computed:true from network data"
This reverts commit dce9b7a5a2.
* docs: add docker image descriptions to generate the docs
* docs: add docker registry image descriptions to generate the docs
* docs: add docker service descriptions to generate the docs
* docs: add docker volume descriptions to generate the docs
* docs(index): clarifies description
so more docker resources are mentioned
* docs(network): fixes required and read-only attributes
so the ds can only be read by-name
* docs(plugin): clarifies the ds docs attributes
* docs: fix typo registry image ds
* docs(config): clarifies attributes and enhances examples
Provide a long example and import command
* fix(config): make data non-sensitive
Because only secrets data is
* docs(containter): clarifies attributes
and enhances examples with import
* docs(config): fix typo
* docs(image): clarifies attributes and remove import
* docs(network): clarifies attributes and adapts import
* docs(plugin): clarifies attributes and import
* docs(registry_image): clarifies attributes and removes import
* chore(secret): remove typo
* docs(service): clarifies attributes and import
* docs(volume): clarifies attributes and import
* fix: correct md linter rules after doc gen
* docs(volume): regenerated
* docs: add config custom template
* docs: add templates for all resources
* docs(config): templates all sections and examples
for better redability and structure
* docs(config): fix md linter
* docs(container): templates all sections and examples
* docs(image): templates all sections and examples
* docs(image): fix import resource by renaming
* docs(network): templates all sections and examples
* docs(service): templates all sections and examples
* docs(volume): templates all sections and examples
* fix(lint): replace website with doc directory
* fix(ci): link check file extension check
* fix: markdown links
* chore: remove old website folder
* chore: fix website-lint terrafmr dir and pattern
* fix: lint fix target website folder
* fix: website links
* docs(provider): update examples
with templates on auth and certs
* docs(provider): add tf-plugin-docs line
* docs(contributing): split doc generation section
* docs: final brush up for readability and structure
* chore(ci): add website-generation job
to see if files changed and it should run locally again
* chore(ci): remove explicit docker setup
from website lint because it's installed by default
108 lines
No EOL
4.4 KiB
Markdown
108 lines
No EOL
4.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.
|
||
---
|
||
<!-- Bug: Type and Name are switched -->
|
||
# 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) The name of the Docker image.
|
||
|
||
### Optional
|
||
|
||
- **build** (Block List, Max: 1) Definition for building the image (see [below for nested schema](#nestedblock--build))
|
||
- **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.
|
||
|
||
<a id="nestedblock--build"></a>
|
||
### 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](#nestedblock--build--auth_config))
|
||
- **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](#nestedblock--build--ulimit))
|
||
- **version** (String) Version of the unerlying builder to use
|
||
|
||
<a id="nestedblock--build--auth_config"></a>
|
||
### 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
|
||
|
||
|
||
<a id="nestedblock--build--ulimit"></a>
|
||
### Nested Schema for `build.ulimit`
|
||
|
||
Required:
|
||
|
||
- **hard** (Number) soft limit
|
||
- **name** (String) type of ulimit, e.g. `nofile`
|
||
- **soft** (Number) hard limit |