[TF Plugin Docs] - Edit data source template files (#2529)

Author: sheneska

.markdownlint.yml

@@ -16,9 +16,11 @@ MD010: false
 MD012: false
 MD013: false
 MD014: false
+MD018: false
 MD022: false
 MD024: false
 MD029: false
+MD032: false
 MD033: false
 MD034: false
 MD037: false

docs/data-sources/all_namespaces.md

@@ -7,9 +7,17 @@ description: |-
 
 # kubernetes_all_namespaces
 
-This data source provides a mechanism for listing the names of all available namespaces in a Kubernetes cluster. It can be used to check for existence of a specific namespaces or to apply another resource to all or a subset of existing namespaces in a cluster.
+This data source provides a mechanism for listing the names of all available namespaces in a Kubernetes cluster. It can be used to check for existence of a specific namespaces or to apply another resource to all or a subset of existing namespaces in a cluster.In Kubernetes, namespaces provide a scope for names and are intended as a way to divide cluster resources between multiple users. 
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Read-Only
+
+- `id` (String) The ID of this resource.
+- `namespaces` (List of String) List of all namespaces in a cluster.
+
 
-In Kubernetes, namespaces provide a scope for names and are intended as a way to divide cluster resources between multiple users.
 
 ## Example Usage
 

docs/data-sources/config_map.md

@@ -5,10 +5,46 @@ description: |-
   This data source reads configuration data from a config map.
 ---
 
-# kubernetes_config map
+# kubernetes_config_map
 
 Config Maps are key-value pairs containing configuration data. The Config Map data source provides a mechanism for extracting these key-value pairs.
 
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `metadata` (Block List, Min: 1, Max: 1) Standard config_map's metadata. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata (see [below for nested schema](#nestedblock--metadata))
+
+### Optional
+
+- `immutable` (Boolean) Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.
+
+### Read-Only
+
+- `binary_data` (Map of String) A map of the config map binary data.
+- `data` (Map of String) A map of the config map data.
+- `id` (String) The ID of this resource.
+
+<a id="nestedblock--metadata"></a>
+### Nested Schema for `metadata`
+
+Optional:
+
+- `annotations` (Map of String) An unstructured key value map stored with the config_map that may be used to store arbitrary metadata. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
+- `labels` (Map of String) Map of string keys and values that can be used to organize and categorize (scope and select) the config_map. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
+- `name` (String) Name of the config_map, must be unique. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+- `namespace` (String) Namespace defines the space within which name of the config_map must be unique.
+
+Read-Only:
+
+- `generation` (Number) A sequence number representing a specific generation of the desired state.
+- `resource_version` (String) An opaque value that represents the internal version of this config_map that can be used by clients to determine when config_map has changed. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+- `uid` (String) The unique in time and space value for this config_map. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
+
+
+
+
 ~> **Note:** All arguments including the config map data will be stored in the raw state as plain-text. [Read more about sensitive data in state](/docs/state/sensitive-data.html).
 
 ## Example Usage

docs/data-sources/config_map_v1.md

@@ -5,44 +5,54 @@ description: |-
   This data source reads configuration data from a config map.
 ---
 
-# kubernetes_config map
+# kubernetes_config_map_v1
 
 Config Maps are key-value pairs containing configuration data. The Config Map data source provides a mechanism for extracting these key-value pairs.
 
-~> **Note:** All arguments including the config map data will be stored in the raw state as plain-text. [Read more about sensitive data in state](/docs/state/sensitive-data.html).
+<!-- schema generated by tfplugindocs -->
+## Schema
 
-## Example Usage
+### Required
 
-```terraform
-data "kubernetes_config_map_v1" "example" {
-  metadata {
-    name = "my-config"
-  }
-}
-```
+- `metadata` (Block List, Min: 1, Max: 1) Standard config_map's metadata. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata (see [below for nested schema](#nestedblock--metadata))
+
+### Optional
+
+- `immutable` (Boolean) Immutable, if set to true, ensures that data stored in the ConfigMap cannot be updated (only object metadata can be modified). If not set to true, the field can be modified at any time. Defaulted to nil.
 
-## Argument Reference
+### Read-Only
 
-The following arguments are supported:
+- `binary_data` (Map of String) A map of the config map binary data.
+- `data` (Map of String) A map of the config map data.
+- `id` (String) The ID of this resource.
 
-* `metadata` - (Required) Standard config map's metadata. For more info see [Kubernetes reference](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata)
+<a id="nestedblock--metadata"></a>
+### Nested Schema for `metadata`
 
-## Nested Blocks
+Optional:
 
-### `metadata`
+- `annotations` (Map of String) An unstructured key value map stored with the config_map that may be used to store arbitrary metadata. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
+- `labels` (Map of String) Map of string keys and values that can be used to organize and categorize (scope and select) the config_map. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
+- `name` (String) Name of the config_map, must be unique. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+- `namespace` (String) Namespace defines the space within which name of the config_map must be unique.
 
-#### Arguments
+Read-Only:
 
-* `name` - (Required) Name of the config map, must be unique. For more info see [Kubernetes reference](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names)
-* `namespace` - (Optional) Namespace defines the space within which name of the config map must be unique.
+- `generation` (Number) A sequence number representing a specific generation of the desired state.
+- `resource_version` (String) An opaque value that represents the internal version of this config_map that can be used by clients to determine when config_map has changed. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+- `uid` (String) The unique in time and space value for this config_map. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
 
-#### Attributes
 
-* `generation` - A sequence number representing a specific generation of the desired state.
-* `resource_version` - An opaque value that represents the internal version of this config map that can be used by clients to determine when config map has changed. For more info see [Kubernetes reference](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency)
-* `uid` - The unique in time and space value for this config map. For more info see [Kubernetes reference](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids)
 
-## Attribute Reference
 
-* `data` - A map of the config map data.
-* `binary_data` - A map of preserved non-UTF8 data. For more info see [Kubernetes API reference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.26/#configmap-v1-core).
+~> **Note:** All arguments including the config map data will be stored in the raw state as plain-text. [Read more about sensitive data in state](/docs/state/sensitive-data.html).
+
+## Example Usage
+
+```terraform
+data "kubernetes_config_map_v1" "example" {
+  metadata {
+    name = "my-config"
+  }
+}
+```

docs/data-sources/endpoints_v1.md

@@ -9,68 +9,98 @@ description: |-
 
 An Endpoints resource is an abstraction, linked to a Service, which defines the list of endpoints that actually implement the service.
 
-## Example Usage
+<!-- schema generated by tfplugindocs -->
+## Schema
 
-```terraform
-data "kubernetes_endpoints_v1" "api_endpoints" {
-  metadata {
-    name      = "kubernetes"
-    namespace = "default"
-  }
-}
-```
+### Required
+
+- `metadata` (Block List, Min: 1, Max: 1) Standard endpoints's metadata. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata (see [below for nested schema](#nestedblock--metadata))
+
+### Optional
+
+- `subset` (Block Set) Set of addresses and ports that comprise a service. More info: https://kubernetes.io/docs/concepts/services-networking/service/#services-without-selectors (see [below for nested schema](#nestedblock--subset))
+
+### Read-Only
+
+- `id` (String) The ID of this resource.
+
+<a id="nestedblock--metadata"></a>
+### Nested Schema for `metadata`
+
+Optional:
+
+- `annotations` (Map of String) An unstructured key value map stored with the endpoints that may be used to store arbitrary metadata. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
+- `generate_name` (String) Prefix, used by the server, to generate a unique name ONLY IF the `name` field has not been provided. This value will also be combined with a unique suffix. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#idempotency
+- `labels` (Map of String) Map of string keys and values that can be used to organize and categorize (scope and select) the endpoints. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
+- `name` (String) Name of the endpoints, must be unique. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+- `namespace` (String) Namespace defines the space within which name of the endpoints must be unique.
 
-## Argument Reference
+Read-Only:
 
-The following arguments are supported:
+- `generation` (Number) A sequence number representing a specific generation of the desired state.
+- `resource_version` (String) An opaque value that represents the internal version of this endpoints that can be used by clients to determine when endpoints has changed. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+- `uid` (String) The unique in time and space value for this endpoints. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
 
-* `metadata` - (Required) Standard endpoints' metadata. For more info see [Kubernetes reference](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata)
 
-## Nested Blocks
+<a id="nestedblock--subset"></a>
+### Nested Schema for `subset`
 
-### `metadata`
+Optional:
 
-#### Arguments
+- `address` (Block Set) IP address which offers the related ports that are marked as ready. These endpoints should be considered safe for load balancers and clients to utilize. (see [below for nested schema](#nestedblock--subset--address))
+- `not_ready_address` (Block Set) IP address which offers the related ports but is not currently marked as ready because it have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check. (see [below for nested schema](#nestedblock--subset--not_ready_address))
+- `port` (Block Set) Port number available on the related IP addresses. (see [below for nested schema](#nestedblock--subset--port))
 
-* `name` - (Required) Name of the endpoints resource.
-* `namespace` - (Optional) Namespace defines the space within which name of the endpoints resource must be unique.
+<a id="nestedblock--subset--address"></a>
+### Nested Schema for `subset.address`
 
-#### Attributes
+Required:
 
-* `generation` - A sequence number representing a specific generation of the desired state.
-* `resource_version` - An opaque value that represents the internal version of this endpoints resource that can be used by clients to determine when endpoints resource has changed. For more info see [Kubernetes reference](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency)
-* `uid` - The unique in time and space value for this endpoints resource. For more info see [Kubernetes reference](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids)
+- `ip` (String) The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24).
 
-## Attribute Reference
+Optional:
 
-### `subset`
+- `hostname` (String) The Hostname of this endpoint.
+- `node_name` (String) Node hosting this endpoint. This can be used to determine endpoints local to a node.
 
-#### Attributes
 
-* `address` - (Optional) An IP address block which offers the related ports and is ready to accept traffic. These endpoints should be considered safe for load balancers and clients to utilize. Can be repeated multiple times.
-* `not_ready_address` - (Optional) A IP address block which offers the related ports but is not currently marked as ready because it have not yet finished starting, have recently failed a readiness check, or have recently failed a liveness check. Can be repeated multiple times.
-* `port` - (Optional) A port number block available on the related IP addresses. Can be repeated multiple times.
+<a id="nestedblock--subset--not_ready_address"></a>
+### Nested Schema for `subset.not_ready_address`
 
-### `address`
+Required:
 
-#### Attributes
+- `ip` (String) The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24).
 
-* `ip` - The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24).
-* `hostname` - (Optional) The Hostname of this endpoint.
-* `node_name` - (Optional) Node hosting this endpoint. This can be used to determine endpoints local to a node.
+Optional:
 
-### `not_ready_address`
+- `hostname` (String) The Hostname of this endpoint.
+- `node_name` (String) Node hosting this endpoint. This can be used to determine endpoints local to a node.
 
-#### Attributes
 
-* `ip` - The IP of this endpoint. May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), or link-local multicast ((224.0.0.0/24).
-* `hostname` - (Optional) The Hostname of this endpoint.
-* `node_name` - (Optional) Node hosting this endpoint. This can be used to determine endpoints local to a node.
+<a id="nestedblock--subset--port"></a>
+### Nested Schema for `subset.port`
 
-### `port`
+Required:
 
-#### Attributes
+- `port` (Number) The port that will be exposed by this endpoint.
+
+Optional:
+
+- `name` (String) The name of this port within the endpoint. Must be a DNS_LABEL. Optional if only one Port is defined on this endpoint.
+- `protocol` (String) The IP protocol for this port. Supports `TCP` and `UDP`. Default is `TCP`.
+
+
+
+ 
+
+## Example Usage
+
+```terraform
+data "kubernetes_endpoints_v1" "api_endpoints" {
+  metadata {
+    name      = "kubernetes"
+    namespace = "default"
+  }
+}
+```
 
-* `name` - (Optional) The name of this port within the endpoint. All ports within the endpoint must have unique names. Optional if only one port is defined on this endpoint.
-* `port` - (Required) The port that will be utilized by this endpoint.
-* `protocol` - (Optional) The IP protocol for this port. Supports `TCP` and `UDP`. Default is `TCP`.