Fix documentation

hashicorp · Sep 23, 2022 · b497b8d · b497b8d
1 parent e4160e4
commit b497b8d
Show file tree

Hide file tree

Showing 86 changed files with 170 additions and 28 deletions.
diff --git a/...ata-sources/acl_auth_method.html.markdown → docs/data-sources/acl_auth_method.html.md b/...ata-sources/acl_auth_method.html.markdown → docs/data-sources/acl_auth_method.html.md
diff --git a/docs/data-sources/acl_policy.html.markdown → docs/data-sources/acl_policy.html.md b/docs/data-sources/acl_policy.html.markdown → docs/data-sources/acl_policy.html.md
diff --git a/docs/data-sources/acl_role.html.markdown → docs/data-sources/acl_role.html.md b/docs/data-sources/acl_role.html.markdown → docs/data-sources/acl_role.html.md
diff --git a/docs/data-sources/acl_token.html.markdown → docs/data-sources/acl_token.html.md b/docs/data-sources/acl_token.html.markdown → docs/data-sources/acl_token.html.md
diff --git a/...sources/acl_token_secret_id.html.markdown → .../data-sources/acl_token_secret_id.html.md b/...sources/acl_token_secret_id.html.markdown → .../data-sources/acl_token_secret_id.html.md
diff --git a/docs/data-sources/agent_config.html.markdown → docs/data-sources/agent_config.html.md b/docs/data-sources/agent_config.html.markdown → docs/data-sources/agent_config.html.md
diff --git a/docs/data-sources/agent_self.html.markdown → docs/data-sources/agent_self.html.md b/docs/data-sources/agent_self.html.markdown → docs/data-sources/agent_self.html.md
diff --git a/...ta-sources/autopilot_health.html.markdown → docs/data-sources/autopilot_health.html.md b/...ta-sources/autopilot_health.html.markdown → docs/data-sources/autopilot_health.html.md
diff --git a/docs/data-sources/datacenters.html.markdown → docs/data-sources/datacenters.html.md b/docs/data-sources/datacenters.html.markdown → docs/data-sources/datacenters.html.md
diff --git a/docs/data-sources/key_prefix.html.markdown → docs/data-sources/key_prefix.html.md b/docs/data-sources/key_prefix.html.markdown → docs/data-sources/key_prefix.html.md
diff --git a/docs/data-sources/keys.html.markdown → docs/data-sources/keys.html.md b/docs/data-sources/keys.html.markdown → docs/data-sources/keys.html.md
diff --git a/...ources/network_area_members.html.markdown → ...data-sources/network_area_members.html.md b/...ources/network_area_members.html.markdown → ...data-sources/network_area_members.html.md
diff --git a/...ta-sources/network_segments.html.markdown → docs/data-sources/network_segments.html.md b/...ta-sources/network_segments.html.markdown → docs/data-sources/network_segments.html.md
diff --git a/docs/data-sources/nodes.html.markdown → docs/data-sources/nodes.html.md b/docs/data-sources/nodes.html.markdown → docs/data-sources/nodes.html.md
diff --git a/docs/data-sources/service.html.markdown → docs/data-sources/service.html.md b/docs/data-sources/service.html.markdown → docs/data-sources/service.html.md
diff --git a/...data-sources/service_health.html.markdown → docs/data-sources/service_health.html.md b/...data-sources/service_health.html.markdown → docs/data-sources/service_health.html.md
diff --git a/docs/data-sources/services.html.markdown → docs/data-sources/services.html.md b/docs/data-sources/services.html.markdown → docs/data-sources/services.html.md
diff --git a/docs/guides/upgrading.html.markdown → docs/guides/upgrading.html.md b/docs/guides/upgrading.html.markdown → docs/guides/upgrading.html.md
diff --git a/docs/index.md b/docs/index.md
@@ -1,42 +1,92 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "consul Provider"
-subcategory: ""
+layout: "consul"
+page_title: "Provider: Consul"
+sidebar_current: "docs-consul-index"
 description: |-
-  
+  Consul is a tool for service discovery, configuration and orchestration. The Consul provider exposes resources used to interact with a Consul cluster. Configuration of the provider is optional, as it provides defaults for all arguments.
 ---
 
-# consul Provider
+# Consul Provider
 
+[Consul](https://www.consul.io) is a service networking platform which provides
+service discovery, service mesh, and application configuration capabilities.
+The Consul provider exposes resources used to interact with a
+Consul cluster. Configuration of the provider is optional, as it provides
+reasonable defaults for all arguments.
 
+Use the navigation to the left to read about the available resources.
 
+~> **NOTE:** The Consul provider should not be confused with the [Consul remote
+state backend][consul-remote-state-backend], which is one of many backends that
+can be used to store Terraform state. The Consul provider is instead used to
+manage resources within Consul itself, such as adding external services or
+working with the key/value store.
 
+[consul-remote-state-backend]: /docs/backends/types/consul.html
 
-<!-- schema generated by tfplugindocs -->
-## Schema
+## Example Usage
 
-### Optional
+```hcl
+# Configure the Consul provider
+provider "consul" {
+  address    = "demo.consul.io:80"
+  datacenter = "nyc1"
+}
 
-- `address` (String)
-- `ca_file` (String)
-- `ca_path` (String)
-- `ca_pem` (String)
-- `cert_file` (String)
-- `cert_pem` (String)
-- `datacenter` (String)
-- `header` (Block List) Additional headers to send with each Consul request. (see [below for nested schema](#nestedblock--header))
-- `http_auth` (String)
-- `insecure_https` (Boolean)
-- `key_file` (String)
-- `key_pem` (String)
-- `namespace` (String)
-- `scheme` (String)
-- `token` (String, Sensitive)
+# Access a key in Consul
+data "consul_keys" "app" {
+  key {
+    name    = "ami"
+    path    = "service/app/launch_ami"
+    default = "ami-1234"
+  }
+}
 
-<a id="nestedblock--header"></a>
-### Nested Schema for `header`
+# Use our variable from Consul
+resource "aws_instance" "app" {
+  ami = data.consul_keys.app.var.ami
+}
+```
 
-Required:
+## Compatibility
 
-- `name` (String) The header name
-- `value` (String) The header value
+The Consul Terraform provider uses features of the latest version of Consul.
+Some resources may not be supported by older versions of Consul.
+
+The known compatibility between this provider and Consul is:
+
+| Terraform provider version | Consul version |
+| -------------------------- | -------------- |
+| 2.15.0                     | >= 1.11.0      |
+| 2.14.0                     | >= 1.10.0      |
+| 2.13.0                     | >= 1.10.0      |
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `address` - (Optional) The HTTP(S) API address of the agent to use. Defaults to "127.0.0.1:8500".
+* `scheme` - (Optional) The URL scheme of the agent to use ("http" or "https"). Defaults to "http".
+* `http_auth` - (Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either `user` or `user:pass`. This may also be specified using the `CONSUL_HTTP_AUTH` environment variable.
+* `datacenter` - (Optional) The datacenter to use. Defaults to that of the agent.
+* `token` - (Optional) The ACL token to use by default when making requests to the agent. Can also be specified with `CONSUL_HTTP_TOKEN` or `CONSUL_TOKEN` as an environment variable.
+* `ca_file` - (Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.
+* `ca_pem` - (Optional) PEM-encoded certificate authority used to verify the remote agent's certificate.
+* `cert_file` - (Optional) A path to a PEM-encoded certificate provided to the remote agent; requires use of `key_file` or `key_pem`.
+* `cert_pem` - (Optional) PEM-encoded certificate provided to the remote agent; requires use of `key_file` or `key_pem`.
+* `key_file`- (Optional) A path to a PEM-encoded private key, required if `cert_file` or `cert_pem` is specified.
+* `key_pem`- (Optional) PEM-encoded private key, required if `cert_file` or `cert_pem` is specified.
+* `ca_path` - (Optional) A path to a directory of PEM-encoded certificate authority files to use to check the authenticity of client and server connections. Can also be specified with the `CONSUL_CAPATH` environment variable.
+* `insecure_https`- (Optional) Boolean value to disable SSL certificate verification; setting this value to true is not recommended for production use. Only use this with scheme set to "https".
+* `header` - (Optional) A configuration block, described below, that provides additional headers to be sent along with all requests to the Consul server. This block can be specified multiple times.
+
+The `header` configuration block accepts the following arguments:
+
+ * `name` - (Required) The name of the header.
+
+ * `value` - (Required) The value of the header.
+
+## Environment Variables
+
+All environment variables listed in the [Consul environment variables](https://www.consul.io/docs/commands/index.html#environment-variables)
+documentation are supported by the Terraform provider.
diff --git a/docs/resources/acl_auth_method.markdown → docs/resources/acl_auth_method.md b/docs/resources/acl_auth_method.markdown → docs/resources/acl_auth_method.md
diff --git a/docs/resources/acl_binding_rule.markdown → docs/resources/acl_binding_rule.md b/docs/resources/acl_binding_rule.markdown → docs/resources/acl_binding_rule.md
diff --git a/docs/resources/acl_policy.html.markdown → docs/resources/acl_policy.html.md b/docs/resources/acl_policy.html.markdown → docs/resources/acl_policy.html.md
diff --git a/docs/resources/acl_role.markdown → docs/resources/acl_role.md b/docs/resources/acl_role.markdown → docs/resources/acl_role.md
diff --git a/docs/resources/acl_token.html.markdown → docs/resources/acl_token.html.md b/docs/resources/acl_token.html.markdown → docs/resources/acl_token.html.md
diff --git a/...acl_token_policy_attachment.html.markdown → ...urces/acl_token_policy_attachment.html.md b/...acl_token_policy_attachment.html.markdown → ...urces/acl_token_policy_attachment.html.md
diff --git a/...s/acl_token_role_attachment.html.markdown → ...sources/acl_token_role_attachment.html.md b/...s/acl_token_role_attachment.html.markdown → ...sources/acl_token_role_attachment.html.md
diff --git a/docs/resources/admin_partition.markdown → docs/resources/admin_partition.md b/docs/resources/admin_partition.markdown → docs/resources/admin_partition.md
diff --git a/docs/resources/agent_service.html.markdown → docs/resources/agent_service.html.md b/docs/resources/agent_service.html.markdown → docs/resources/agent_service.html.md
diff --git a/.../resources/autopilot_config.html.markdown → docs/resources/autopilot_config.html.md b/.../resources/autopilot_config.html.markdown → docs/resources/autopilot_config.html.md
diff --git a/docs/resources/catalog_entry.html.markdown → docs/resources/catalog_entry.html.md b/docs/resources/catalog_entry.html.markdown → docs/resources/catalog_entry.html.md
diff --git a/...urces/certificate_authority.html.markdown → docs/resources/certificate_authority.html.md b/...urces/certificate_authority.html.markdown → docs/resources/certificate_authority.html.md
diff --git a/docs/resources/config_entry.markdown → docs/resources/config_entry.md b/docs/resources/config_entry.markdown → docs/resources/config_entry.md
diff --git a/docs/resources/intention.html.markdown → docs/resources/intention.html.md b/docs/resources/intention.html.markdown → docs/resources/intention.html.md
diff --git a/docs/resources/key_prefix.html.markdown → docs/resources/key_prefix.html.md b/docs/resources/key_prefix.html.markdown → docs/resources/key_prefix.html.md
diff --git a/docs/resources/keys.html.markdown → docs/resources/keys.html.md b/docs/resources/keys.html.markdown → docs/resources/keys.html.md
diff --git a/docs/resources/license.markdown → docs/resources/license.md b/docs/resources/license.markdown → docs/resources/license.md
diff --git a/docs/resources/namespace.markdown → docs/resources/namespace.md b/docs/resources/namespace.markdown → docs/resources/namespace.md
diff --git a/...namespace_policy_attachment.html.markdown → ...urces/namespace_policy_attachment.html.md b/...namespace_policy_attachment.html.markdown → ...urces/namespace_policy_attachment.html.md
diff --git a/...s/namespace_role_attachment.html.markdown → ...sources/namespace_role_attachment.html.md b/...s/namespace_role_attachment.html.markdown → ...sources/namespace_role_attachment.html.md
diff --git a/docs/resources/network_area.html.markdown → docs/resources/network_area.html.md b/docs/resources/network_area.html.markdown → docs/resources/network_area.html.md
diff --git a/docs/resources/node.html.markdown → docs/resources/node.html.md b/docs/resources/node.html.markdown → docs/resources/node.html.md
diff --git a/docs/resources/prepared_query.markdown → docs/resources/prepared_query.md b/docs/resources/prepared_query.markdown → docs/resources/prepared_query.md
diff --git a/docs/resources/service.html.markdown → docs/resources/service.html.md b/docs/resources/service.html.markdown → docs/resources/service.html.md
diff --git a/...ata-sources/acl_auth_method.html.markdown → ...ates/data-sources/acl_auth_method.html.md b/...ata-sources/acl_auth_method.html.markdown → ...ates/data-sources/acl_auth_method.html.md
diff --git a/...tes/data-sources/acl_policy.html.markdown → templates/data-sources/acl_policy.html.md b/...tes/data-sources/acl_policy.html.markdown → templates/data-sources/acl_policy.html.md
diff --git a/...lates/data-sources/acl_role.html.markdown → templates/data-sources/acl_role.html.md b/...lates/data-sources/acl_role.html.markdown → templates/data-sources/acl_role.html.md
diff --git a/...ates/data-sources/acl_token.html.markdown → templates/data-sources/acl_token.html.md b/...ates/data-sources/acl_token.html.markdown → templates/data-sources/acl_token.html.md
diff --git a/...sources/acl_token_secret_id.html.markdown → .../data-sources/acl_token_secret_id.html.md b/...sources/acl_token_secret_id.html.markdown → .../data-sources/acl_token_secret_id.html.md
diff --git a/...s/data-sources/agent_config.html.markdown → templates/data-sources/agent_config.html.md b/...s/data-sources/agent_config.html.markdown → templates/data-sources/agent_config.html.md
diff --git a/...tes/data-sources/agent_self.html.markdown → templates/data-sources/agent_self.html.md b/...tes/data-sources/agent_self.html.markdown → templates/data-sources/agent_self.html.md
diff --git a/...ta-sources/autopilot_health.html.markdown → ...tes/data-sources/autopilot_health.html.md b/...ta-sources/autopilot_health.html.markdown → ...tes/data-sources/autopilot_health.html.md
diff --git a/...es/data-sources/datacenters.html.markdown → templates/data-sources/datacenters.html.md b/...es/data-sources/datacenters.html.markdown → templates/data-sources/datacenters.html.md
diff --git a/...tes/data-sources/key_prefix.html.markdown → templates/data-sources/key_prefix.html.md b/...tes/data-sources/key_prefix.html.markdown → templates/data-sources/key_prefix.html.md
diff --git a/templates/data-sources/keys.html.markdown → templates/data-sources/keys.html.md b/templates/data-sources/keys.html.markdown → templates/data-sources/keys.html.md
diff --git a/...ources/network_area_members.html.markdown → ...data-sources/network_area_members.html.md b/...ources/network_area_members.html.markdown → ...data-sources/network_area_members.html.md
diff --git a/...ta-sources/network_segments.html.markdown → ...tes/data-sources/network_segments.html.md b/...ta-sources/network_segments.html.markdown → ...tes/data-sources/network_segments.html.md
diff --git a/templates/data-sources/nodes.html.markdown → templates/data-sources/nodes.html.md b/templates/data-sources/nodes.html.markdown → templates/data-sources/nodes.html.md
diff --git a/templates/data-sources/service.html.markdown → templates/data-sources/service.html.md b/templates/data-sources/service.html.markdown → templates/data-sources/service.html.md
diff --git a/...data-sources/service_health.html.markdown → ...lates/data-sources/service_health.html.md b/...data-sources/service_health.html.markdown → ...lates/data-sources/service_health.html.md
diff --git a/...lates/data-sources/services.html.markdown → templates/data-sources/services.html.md b/...lates/data-sources/services.html.markdown → templates/data-sources/services.html.md
diff --git a/templates/guides/upgrading.html.markdown → templates/guides/upgrading.html.md b/templates/guides/upgrading.html.markdown → templates/guides/upgrading.html.md
diff --git a/templates/index.md b/templates/index.md
@@ -0,0 +1,92 @@
+---
+layout: "consul"
+page_title: "Provider: Consul"
+sidebar_current: "docs-consul-index"
+description: |-
+  Consul is a tool for service discovery, configuration and orchestration. The Consul provider exposes resources used to interact with a Consul cluster. Configuration of the provider is optional, as it provides defaults for all arguments.
+---
+
+# Consul Provider
+
+[Consul](https://www.consul.io) is a service networking platform which provides
+service discovery, service mesh, and application configuration capabilities.
+The Consul provider exposes resources used to interact with a
+Consul cluster. Configuration of the provider is optional, as it provides
+reasonable defaults for all arguments.
+
+Use the navigation to the left to read about the available resources.
+
+~> **NOTE:** The Consul provider should not be confused with the [Consul remote
+state backend][consul-remote-state-backend], which is one of many backends that
+can be used to store Terraform state. The Consul provider is instead used to
+manage resources within Consul itself, such as adding external services or
+working with the key/value store.
+
+[consul-remote-state-backend]: /docs/backends/types/consul.html
+
+## Example Usage
+
+```hcl
+# Configure the Consul provider
+provider "consul" {
+  address    = "demo.consul.io:80"
+  datacenter = "nyc1"
+}
+
+# Access a key in Consul
+data "consul_keys" "app" {
+  key {
+    name    = "ami"
+    path    = "service/app/launch_ami"
+    default = "ami-1234"
+  }
+}
+
+# Use our variable from Consul
+resource "aws_instance" "app" {
+  ami = data.consul_keys.app.var.ami
+}
+```
+
+## Compatibility
+
+The Consul Terraform provider uses features of the latest version of Consul.
+Some resources may not be supported by older versions of Consul.
+
+The known compatibility between this provider and Consul is:
+
+| Terraform provider version | Consul version |
+| -------------------------- | -------------- |
+| 2.15.0                     | >= 1.11.0      |
+| 2.14.0                     | >= 1.10.0      |
+| 2.13.0                     | >= 1.10.0      |
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `address` - (Optional) The HTTP(S) API address of the agent to use. Defaults to "127.0.0.1:8500".
+* `scheme` - (Optional) The URL scheme of the agent to use ("http" or "https"). Defaults to "http".
+* `http_auth` - (Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either `user` or `user:pass`. This may also be specified using the `CONSUL_HTTP_AUTH` environment variable.
+* `datacenter` - (Optional) The datacenter to use. Defaults to that of the agent.
+* `token` - (Optional) The ACL token to use by default when making requests to the agent. Can also be specified with `CONSUL_HTTP_TOKEN` or `CONSUL_TOKEN` as an environment variable.
+* `ca_file` - (Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.
+* `ca_pem` - (Optional) PEM-encoded certificate authority used to verify the remote agent's certificate.
+* `cert_file` - (Optional) A path to a PEM-encoded certificate provided to the remote agent; requires use of `key_file` or `key_pem`.
+* `cert_pem` - (Optional) PEM-encoded certificate provided to the remote agent; requires use of `key_file` or `key_pem`.
+* `key_file`- (Optional) A path to a PEM-encoded private key, required if `cert_file` or `cert_pem` is specified.
+* `key_pem`- (Optional) PEM-encoded private key, required if `cert_file` or `cert_pem` is specified.
+* `ca_path` - (Optional) A path to a directory of PEM-encoded certificate authority files to use to check the authenticity of client and server connections. Can also be specified with the `CONSUL_CAPATH` environment variable.
+* `insecure_https`- (Optional) Boolean value to disable SSL certificate verification; setting this value to true is not recommended for production use. Only use this with scheme set to "https".
+* `header` - (Optional) A configuration block, described below, that provides additional headers to be sent along with all requests to the Consul server. This block can be specified multiple times.
+
+The `header` configuration block accepts the following arguments:
+
+ * `name` - (Required) The name of the header.
+
+ * `value` - (Required) The value of the header.
+
+## Environment Variables
+
+All environment variables listed in the [Consul environment variables](https://www.consul.io/docs/commands/index.html#environment-variables)
+documentation are supported by the Terraform provider.
diff --git a/templates/resources/acl_auth_method.markdown → templates/resources/acl_auth_method.md b/templates/resources/acl_auth_method.markdown → templates/resources/acl_auth_method.md
diff --git a/...lates/resources/acl_binding_rule.markdown → templates/resources/acl_binding_rule.md b/...lates/resources/acl_binding_rule.markdown → templates/resources/acl_binding_rule.md
diff --git a/templates/resources/acl_policy.html.markdown → templates/resources/acl_policy.html.md b/templates/resources/acl_policy.html.markdown → templates/resources/acl_policy.html.md
diff --git a/templates/resources/acl_role.markdown → templates/resources/acl_role.md b/templates/resources/acl_role.markdown → templates/resources/acl_role.md
diff --git a/templates/resources/acl_token.html.markdown → templates/resources/acl_token.html.md b/templates/resources/acl_token.html.markdown → templates/resources/acl_token.html.md
diff --git a/...acl_token_policy_attachment.html.markdown → ...urces/acl_token_policy_attachment.html.md b/...acl_token_policy_attachment.html.markdown → ...urces/acl_token_policy_attachment.html.md
diff --git a/...s/acl_token_role_attachment.html.markdown → ...sources/acl_token_role_attachment.html.md b/...s/acl_token_role_attachment.html.markdown → ...sources/acl_token_role_attachment.html.md
diff --git a/templates/resources/admin_partition.markdown → templates/resources/admin_partition.md b/templates/resources/admin_partition.markdown → templates/resources/admin_partition.md
diff --git a/...tes/resources/agent_service.html.markdown → templates/resources/agent_service.html.md b/...tes/resources/agent_service.html.markdown → templates/resources/agent_service.html.md
diff --git a/.../resources/autopilot_config.html.markdown → templates/resources/autopilot_config.html.md b/.../resources/autopilot_config.html.markdown → templates/resources/autopilot_config.html.md
diff --git a/...tes/resources/catalog_entry.html.markdown → templates/resources/catalog_entry.html.md b/...tes/resources/catalog_entry.html.markdown → templates/resources/catalog_entry.html.md
diff --git a/...urces/certificate_authority.html.markdown → ...s/resources/certificate_authority.html.md b/...urces/certificate_authority.html.markdown → ...s/resources/certificate_authority.html.md
diff --git a/templates/resources/config_entry.markdown → templates/resources/config_entry.md b/templates/resources/config_entry.markdown → templates/resources/config_entry.md
diff --git a/templates/resources/intention.html.markdown → templates/resources/intention.html.md b/templates/resources/intention.html.markdown → templates/resources/intention.html.md
diff --git a/templates/resources/key_prefix.html.markdown → templates/resources/key_prefix.html.md b/templates/resources/key_prefix.html.markdown → templates/resources/key_prefix.html.md
diff --git a/templates/resources/keys.html.markdown → templates/resources/keys.html.md b/templates/resources/keys.html.markdown → templates/resources/keys.html.md
diff --git a/templates/resources/license.markdown → templates/resources/license.md b/templates/resources/license.markdown → templates/resources/license.md
diff --git a/templates/resources/namespace.markdown → templates/resources/namespace.md b/templates/resources/namespace.markdown → templates/resources/namespace.md
diff --git a/...namespace_policy_attachment.html.markdown → ...urces/namespace_policy_attachment.html.md b/...namespace_policy_attachment.html.markdown → ...urces/namespace_policy_attachment.html.md
diff --git a/...s/namespace_role_attachment.html.markdown → ...sources/namespace_role_attachment.html.md b/...s/namespace_role_attachment.html.markdown → ...sources/namespace_role_attachment.html.md
diff --git a/...ates/resources/network_area.html.markdown → templates/resources/network_area.html.md b/...ates/resources/network_area.html.markdown → templates/resources/network_area.html.md
diff --git a/templates/resources/node.html.markdown → templates/resources/node.html.md b/templates/resources/node.html.markdown → templates/resources/node.html.md
diff --git a/templates/resources/prepared_query.markdown → templates/resources/prepared_query.md b/templates/resources/prepared_query.markdown → templates/resources/prepared_query.md
diff --git a/templates/resources/service.html.markdown → templates/resources/service.html.md b/templates/resources/service.html.markdown → templates/resources/service.html.md