feat: support Docker plugin

[suzuki-shunsuke]

Close #24

[suzuki-shunsuke]

I have implemented the basic feature.

Example

resource "docker_plugin" "sample-volume-plugin" {
  plugin_reference      = "docker.io/tiborvass/sample-volume-plugin:latest"
  alias                 = "sample-volume-plugin:latest"
  disabled              = true
  grant_all_permissions = true
  disable_when_set      = true
  force_destroy         = true
  enable_timeout        = 60
  force_disable         = true
  env = [
    "DEBUG=1"
  ]
}

Note

plugin_reference and alias must be full path. Otherwise, after terraform apply is run, there would be diffs of them.

For example,

resource "docker_plugin" "sample-volume-plugin" {
  plugin_reference      = "tiborvass/sample-volume-plugin" # must be "docker.io/tiborvass/sample-volume-plugin:latest"
  alias                 = "sample" # must be "sample:latest"
}

$ terraform apply
docker_plugin.sshfs: Refreshing state... [id=7973bfc2ba539a01b7598c55facf1d9c61f016fd49735072f1bd0848aee53b75]
docker_plugin.sample-volume-plugin: Refreshing state... [id=98169cdf6c522ac34f5f67217534b56017722087ab8671135f76f62c8bb12ba8]

An execution plan has been generated and is shown below.
Resource actions are indicated with the following symbols:
  + create

Terraform will perform the following actions:

  # docker_plugin.sample-volume-plugin will be created
  + resource "docker_plugin" "sample-volume-plugin" {
      + alias            = "sample"
      + env              = (known after apply)
      + id               = (known after apply)
      + plugin_reference = "tiborvass/sample-volume-plugin"
    }

Plan: 1 to add, 0 to change, 0 to destroy.

Do you want to perform these actions?
  Terraform will perform the actions described above.
  Only 'yes' will be accepted to approve.

  Enter a value: yes

docker_plugin.sample-volume-plugin: Creating...
docker_plugin.sample-volume-plugin: Still creating... [10s elapsed]
docker_plugin.sample-volume-plugin: Creation complete after 11s [id=27784976e1471c1e473a901a0a02055ddc8bc1c9dec9c44d81a49d516c0c28f9]

Apply complete! Resources: 1 added, 0 changed, 0 destroyed.

$ terraform plan
Refreshing Terraform state in-memory prior to plan...
The refreshed state will be used to calculate this plan, but will not be
persisted to local or remote state storage.

docker_plugin.sample-volume-plugin: Refreshing state... [id=27784976e1471c1e473a901a0a02055ddc8bc1c9dec9c44d81a49d516c0c28f9]
docker_plugin.sshfs: Refreshing state... [id=7973bfc2ba539a01b7598c55facf1d9c61f016fd49735072f1bd0848aee53b75]

------------------------------------------------------------------------

An execution plan has been generated and is shown below.
Resource actions are indicated with the following symbols:
-/+ destroy and then create replacement

Terraform will perform the following actions:

  # docker_plugin.sample-volume-plugin must be replaced
-/+ resource "docker_plugin" "sample-volume-plugin" {
      ~ alias            = "sample:latest" -> "sample" # forces replacement
      - disabled         = false -> null
      ~ env              = [
          - "DEBUG=0",
        ] -> (known after apply)
      ~ id               = "27784976e1471c1e473a901a0a02055ddc8bc1c9dec9c44d81a49d516c0c28f9" -> (known after apply)
      ~ plugin_reference = "docker.io/tiborvass/sample-volume-plugin:latest" -> "tiborvass/sample-volume-plugin" # forces replacement
    }

Plan: 1 to add, 0 to change, 1 to destroy.

Check List

• Import
• update
• install option https://docs.docker.com/engine/reference/commandline/plugin_install/
  • alias
  • disable
  • disable-content-trust
    • There is no field in types.PluginInstallOptions
  • grant-all-permissions
  • key=value
    • env variables
    • source of mounts
    • path of devices
    • args
• enable option https://docs.docker.com/engine/reference/commandline/plugin_enable/
  • timeout
• disable option
  • force
• rm option https://docs.docker.com/engine/reference/commandline/plugin_rm/
  • force
• upgrade plugin

[suzuki-shunsuke]

I have created some issues for future work.

• Support for plugin.device settings #106
• Support to configure source of mounts of Docker plugin #107
• Support to configure source of the arguments of Docker plugin #108
• Support for a data source docker_plugins #109
• Add computed attributes for Docker plugin config and settings #110

[mavogel]

I propose that we will first merge this PR here and then rebase #102 for the TF SDK update on it. We are ready4review right @suzuki-shunsuke ?

[suzuki-shunsuke]

@mavogel Yes. Please review.

[innovate-invent]

For some reason a critical comment is being hidden by github: #35 (comment)

[suzuki-shunsuke]

I'm writing tests of getDockerPluginGrantPermissions and found that it doesn't work as expected.
I'm investigating the issue.

[suzuki-shunsuke]

#35 (comment)

I'm writing tests of getDockerPluginGrantPermissions and found that it doesn't work as expected.
I'm investigating the issue.

Oh, sorry. There is a typo in tests.
It has been solved.

[mavogel]

See conversations for details. Awesome work till here. Let's get this ready

[suzuki-shunsuke]

Updated. Please review.
#35 (comment)

[mavogel]

LGTM. Thanks, @suzuki-shunsuke and @innovate-invent for the fruitful discussion 🚀