mirror of
https://github.com/kreuzwerker/terraform-provider-docker.git
synced 2025-12-21 07:09:48 -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
72 lines
No EOL
2.1 KiB
Markdown
72 lines
No EOL
2.1 KiB
Markdown
---
|
|
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
|
page_title: "docker_plugin Resource - terraform-provider-docker"
|
|
subcategory: ""
|
|
description: |-
|
|
Manages the lifecycle of a Docker plugin.
|
|
---
|
|
<!-- Bug: Type and Name are switched -->
|
|
# docker_plugin (Resource)
|
|
|
|
Manages the lifecycle of a Docker plugin.
|
|
|
|
## Example Usage
|
|
|
|
```terraform
|
|
resource "docker_plugin" "sample-volume-plugin" {
|
|
name = "docker.io/tiborvass/sample-volume-plugin:latest"
|
|
}
|
|
|
|
resource "docker_plugin" "sample-volume-plugin" {
|
|
name = "tiborvass/sample-volume-plugin"
|
|
alias = "sample-volume-plugin"
|
|
enabled = false
|
|
grant_all_permissions = true
|
|
force_destroy = true
|
|
enable_timeout = 60
|
|
force_disable = true
|
|
env = [
|
|
"DEBUG=1"
|
|
]
|
|
}
|
|
```
|
|
|
|
<!-- schema generated by tfplugindocs -->
|
|
## Schema
|
|
|
|
### Required
|
|
|
|
- **name** (String) Docker Plugin name
|
|
|
|
### Optional
|
|
|
|
- **alias** (String) Docker Plugin alias
|
|
- **enable_timeout** (Number) HTTP client timeout to enable the plugin
|
|
- **enabled** (Boolean) If `true` the plugin is enabled. Defaults to `true`
|
|
- **env** (Set of String) The environment variables in the form of `KEY=VALUE`, e.g. `DEBUG=0`
|
|
- **force_destroy** (Boolean) If true, then the plugin is destroyed forcibly
|
|
- **force_disable** (Boolean) If true, then the plugin is disabled forcibly
|
|
- **grant_all_permissions** (Boolean) If true, grant all permissions necessary to run the plugin
|
|
- **grant_permissions** (Block Set) Grant specific permissions only (see [below for nested schema](#nestedblock--grant_permissions))
|
|
- **id** (String) The ID of this resource.
|
|
|
|
### Read-Only
|
|
|
|
- **plugin_reference** (String) Docker Plugin Reference
|
|
|
|
<a id="nestedblock--grant_permissions"></a>
|
|
### Nested Schema for `grant_permissions`
|
|
|
|
Required:
|
|
|
|
- **name** (String) The name of the permission
|
|
- **value** (Set of String) The value of the permission
|
|
|
|
## Import
|
|
|
|
Import is supported using the following syntax:
|
|
|
|
```shell
|
|
#!/bin/bash
|
|
terraform import docker_plugin.sample-volume-plugin "$(docker plugin inspect -f {{.ID}} tiborvass/sample-volume-plugin:latest)"
|
|
``` |