-
Notifications
You must be signed in to change notification settings - Fork 191
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* 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 dce9b7a. * 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
- Loading branch information
Showing
122 changed files
with
4,639 additions
and
2,645 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "docker_network Data Source - terraform-provider-docker" | ||
| subcategory: "" | ||
| description: |- | ||
| docker_network provides details about a specific Docker Network. | ||
| --- | ||
|
|
||
| # docker_network (Data Source) | ||
|
|
||
| `docker_network` provides details about a specific Docker Network. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| data "docker_network" "main" { | ||
| name = "main" | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - **name** (String) The name of the Docker network. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - **driver** (String) The driver of the Docker network. Possible values are `bridge`, `host`, `overlay`, `macvlan`. See [network docs](https://docs.docker.com/network/#network-drivers) for more details. | ||
| - **id** (String) The ID of this resource. | ||
| - **internal** (Boolean) If `true`, the network is internal. | ||
| - **ipam_config** (Set of Object) The IPAM configuration options (see [below for nested schema](#nestedatt--ipam_config)) | ||
| - **options** (Map of String) Only available with bridge networks. See [bridge options docs](https://docs.docker.com/engine/reference/commandline/network_create/#bridge-driver-options) for more details. | ||
| - **scope** (String) Scope of the network. One of `swarm`, `global`, or `local`. | ||
|
|
||
| <a id="nestedatt--ipam_config"></a> | ||
| ### Nested Schema for `ipam_config` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - **aux_address** (Map of String) | ||
| - **gateway** (String) | ||
| - **ip_range** (String) | ||
| - **subnet** (String) | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "docker_plugin Data Source - terraform-provider-docker" | ||
| subcategory: "" | ||
| description: |- | ||
| Reads the local Docker plugin. The plugin must be installed locally. | ||
| --- | ||
|
|
||
| # docker_plugin (Data Source) | ||
|
|
||
| Reads the local Docker plugin. The plugin must be installed locally. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| ### With alias | ||
| data "docker_plugin" "by_alias" { | ||
| alias = "sample-volume-plugin:latest" | ||
| } | ||
| ### With ID | ||
| data "docker_plugin" "by_id" { | ||
| id = "e9a9db917b3bfd6706b5d3a66d4bceb9f" | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Optional | ||
|
|
||
| - **alias** (String) The alias of the Docker plugin. If the tag is omitted, `:latest` is complemented to the attribute value. | ||
| - **id** (String) The ID of the plugin, which has precedence over the `alias` of both are given | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - **enabled** (Boolean) If `true` the plugin is enabled | ||
| - **env** (Set of String) The environment variables in the form of `KEY=VALUE`, e.g. `DEBUG=0` | ||
| - **grant_all_permissions** (Boolean) If true, grant all permissions necessary to run the plugin | ||
| - **name** (String) The plugin name. If the tag is omitted, `:latest` is complemented to the attribute value. | ||
| - **plugin_reference** (String) The Docker Plugin Reference | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "docker_registry_image Data Source - terraform-provider-docker" | ||
| subcategory: "" | ||
| description: |- | ||
| Reads the image metadata from a Docker Registry. Used in conjunction with the docker_image ../resources/image.md resource to keep an image up to date on the latest available version of the tag. | ||
| --- | ||
|
|
||
| # docker_registry_image (Data Source) | ||
|
|
||
| Reads the image metadata from a Docker Registry. Used in conjunction with the [docker_image](../resources/image.md) resource to keep an image up to date on the latest available version of the tag. | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ```terraform | ||
| data "docker_registry_image" "ubuntu" { | ||
| name = "ubuntu:precise" | ||
| } | ||
| resource "docker_image" "ubuntu" { | ||
| name = data.docker_registry_image.ubuntu.name | ||
| pull_triggers = [data.docker_registry_image.ubuntu.sha256_digest] | ||
| } | ||
| ``` | ||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - **name** (String) The name of the Docker image, including any tags. e.g. `alpine:latest` | ||
|
|
||
| ### Optional | ||
|
|
||
| - **id** (String) The ID of this resource. | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - **sha256_digest** (String) The content digest of the image, as stored in the registry. | ||
|
|
||
|
|
Oops, something went wrong.