mirror of
https://github.com/kreuzwerker/terraform-provider-docker.git
synced 2025-12-23 08:09:37 -05:00
7e569e1813
* chore(ci): Update website-generation workflow * chore(docs): Apply new formatting. * chore: Add update go.mod and go.sum files.
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: "Resource docker_plugin - terraform-provider-docker"
|
|
subcategory: ""
|
|
description: |-
|
|
Manages the lifecycle of a Docker plugin.
|
|
---
|
|
<!-- Bug: Type and Name are switched -->
|
|
# Resource (docker_plugin)
|
|
|
|
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))
|
|
|
|
### Read-Only
|
|
|
|
- `id` (String) The ID of this resource.
|
|
- `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)"
|
|
``` |