mirror of
https://github.com/kreuzwerker/terraform-provider-docker.git
synced 2026-01-28 01:19:20 -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
63 lines
No EOL
2 KiB
Cheetah
63 lines
No EOL
2 KiB
Cheetah
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "{{.Type}} {{.Name}} - {{.ProviderName}}"
|
|
subcategory: ""
|
|
description: |-
|
|
{{ .Description | plainmarkdown | trimspace | prefixlines " " }}
|
|
---
|
|
<!-- Bug: Type and Name are switched -->
|
|
# {{.Type}} ({{.Name}})
|
|
|
|
{{ .Description | trimspace }}
|
|
|
|
## Example Usage
|
|
|
|
### Basic
|
|
|
|
{{tffile "examples/resources/docker_config/resource-basic.tf"}}
|
|
|
|
### Advanced
|
|
#### Dynamically set config with a template
|
|
In this example you can use the `${var.foo_port}` variable to dynamically
|
|
set the `${port}` variable in the `foo.configs.json.tpl` template and create
|
|
the data of the `foo_config` with the help of the `base64encode` interpolation
|
|
function.
|
|
|
|
The file `foo.config.json.tpl` has the following content:
|
|
|
|
{{codefile "gojson" "examples/resources/docker_config/foo.config.json.tpl" }}
|
|
|
|
and the resource uses it as follows:
|
|
|
|
{{tffile "examples/resources/docker_config/resource-advanced.tf"}}
|
|
|
|
#### Update config with no downtime
|
|
To update a `config`, Terraform will destroy the existing resource and create a replacement.
|
|
To effectively use a `docker_config` resource with a `docker_service` resource, it's recommended
|
|
to specify `create_before_destroy` in a `lifecycle` block. Provide a unique `name` attribute,
|
|
for example with one of the interpolation functions `uuid` or `timestamp` as shown
|
|
in the example below. The reason is this [issue](https://github.com/moby/moby/issues/35803).
|
|
|
|
{{tffile "examples/resources/docker_config/resource-no-downtime.tf"}}
|
|
|
|
{{ .SchemaMarkdown | trimspace }}
|
|
|
|
## Import
|
|
|
|
Import is supported using the following syntax by providing the `id`:
|
|
|
|
{{codefile "shell" "examples/resources/docker_config/import.sh" }}
|
|
|
|
### Example
|
|
|
|
Assuming you created a `config` as follows
|
|
|
|
{{codefile "shell" "examples/resources/docker_config/import-create.sh" }}
|
|
|
|
you provide the definition for the resource as follows
|
|
|
|
{{tffile "examples/resources/docker_config/import-resource.tf" }}
|
|
|
|
then the import command is as follows
|
|
|
|
{{codefile "shell" "examples/resources/docker_config/import-resource.sh" }} |