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
89 lines
2.4 KiB
Go
89 lines
2.4 KiB
Go
package provider
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
|
|
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
|
|
)
|
|
|
|
func dataSourceDockerPlugin() *schema.Resource {
|
|
return &schema.Resource{
|
|
Description: "Reads the local Docker plugin. The plugin must be installed locally.",
|
|
|
|
Read: dataSourceDockerPluginRead,
|
|
|
|
Schema: map[string]*schema.Schema{
|
|
"id": {
|
|
Type: schema.TypeString,
|
|
Description: "The ID of the plugin, which has precedence over the `alias` of both are given",
|
|
Optional: true,
|
|
},
|
|
"alias": {
|
|
Type: schema.TypeString,
|
|
Description: "The alias of the Docker plugin. If the tag is omitted, `:latest` is complemented to the attribute value.",
|
|
Optional: true,
|
|
},
|
|
"name": {
|
|
Type: schema.TypeString,
|
|
Description: "The plugin name. If the tag is omitted, `:latest` is complemented to the attribute value.",
|
|
Computed: true,
|
|
},
|
|
"plugin_reference": {
|
|
Type: schema.TypeString,
|
|
Description: "The Docker Plugin Reference",
|
|
Computed: true,
|
|
},
|
|
"enabled": {
|
|
Type: schema.TypeBool,
|
|
Description: "If `true` the plugin is enabled",
|
|
Computed: true,
|
|
},
|
|
"grant_all_permissions": {
|
|
Type: schema.TypeBool,
|
|
Description: "If true, grant all permissions necessary to run the plugin",
|
|
Computed: true,
|
|
},
|
|
"env": {
|
|
Type: schema.TypeSet,
|
|
Description: "The environment variables in the form of `KEY=VALUE`, e.g. `DEBUG=0`",
|
|
Computed: true,
|
|
Elem: &schema.Schema{Type: schema.TypeString},
|
|
},
|
|
},
|
|
}
|
|
}
|
|
|
|
var errDataSourceKeyIsMissing = errors.New("one of id or alias must be assigned")
|
|
|
|
func getDataSourcePluginKey(d *schema.ResourceData) (string, error) {
|
|
id, idOK := d.GetOk("id")
|
|
alias, aliasOK := d.GetOk("alias")
|
|
if idOK {
|
|
if aliasOK {
|
|
return "", errDataSourceKeyIsMissing
|
|
}
|
|
return id.(string), nil
|
|
}
|
|
if aliasOK {
|
|
return alias.(string), nil
|
|
}
|
|
return "", errDataSourceKeyIsMissing
|
|
}
|
|
|
|
func dataSourceDockerPluginRead(d *schema.ResourceData, meta interface{}) error {
|
|
key, err := getDataSourcePluginKey(d)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
client := meta.(*ProviderConfig).DockerClient
|
|
ctx := context.Background()
|
|
plugin, _, err := client.PluginInspectWithRaw(ctx, key)
|
|
if err != nil {
|
|
return fmt.Errorf("inspect a Docker plugin "+key+": %w", err)
|
|
}
|
|
|
|
setDockerPlugin(d, plugin)
|
|
return nil
|
|
}
|