terraform-provider-docker/docs/resources/plugin.md

73 lines
2 KiB
Markdown
Raw Normal View History

2021-05-13 02:06:55 -04:00
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "docker_plugin Resource - terraform-provider-docker"
subcategory: ""
description: |-
2021-05-14 03:16:00 -04:00
Manages the lifecycle of a Docker plugin.
2021-05-13 02:06:55 -04:00
---
# docker_plugin (Resource)
2021-05-14 03:16:00 -04:00
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"
]
}
```
2021-05-13 02:06:55 -04:00
<!-- 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
2021-05-14 03:16:00 -04:00
- **enabled** (Boolean) If `true` the plugin is enabled
- **env** (Set of String) The environment variables in the from 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
2021-05-13 02:06:55 -04:00
- **grant_all_permissions** (Boolean) If true, grant all permissions necessary to run the plugin
2021-05-14 03:16:00 -04:00
- **grant_permissions** (Block Set) Grant specific permissions only (see [below for nested schema](#nestedblock--grant_permissions))
2021-05-13 02:06:55 -04:00
- **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:
2021-05-14 03:16:00 -04:00
- **name** (String) The name of the permission
- **value** (Set of String) The value of the permission
## Import
2021-05-13 02:06:55 -04:00
2021-05-14 03:16:00 -04:00
Import is supported using the following syntax:
2021-05-13 02:06:55 -04:00
2021-05-14 03:16:00 -04:00
```shell
#!/bin/bash
terraform import docker_plugin.sample-volume-plugin "$(docker plugin inspect -f "{{.ID}}" tiborvass/sample-volume-plugin:latest)"
```