terraform-provider-docker/docs/resources/plugin.md
2021-05-14 09:16:00 +02:00

2 KiB

page_title subcategory description
docker_plugin Resource - terraform-provider-docker Manages the lifecycle of a Docker plugin.

docker_plugin (Resource)

Manages the lifecycle of a Docker plugin.

Example Usage

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

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
  • 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
  • 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)
  • id (String) The ID of this resource.

Read-Only

  • plugin_reference (String) Docker Plugin Reference

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:

#!/bin/bash
terraform import docker_plugin.sample-volume-plugin "$(docker plugin inspect -f "{{.ID}}" tiborvass/sample-volume-plugin:latest)"