Edit Template Files - TFPluginDocs (hashicorp#2477)

opentofu · May 22, 2024 · 72041db · 72041db
1 parent d7cefb3
commit 72041db
Show file tree

Hide file tree

Showing 396 changed files with 37,695 additions and 19,880 deletions.
diff --git a/.copywrite.hcl b/.copywrite.hcl
@@ -11,5 +11,6 @@ project {
     ".markdownlint.yml",
     ".release/**",
     "vendor/**",
+    "examples/**"
   ]
 }
diff --git a/.markdownlint.yml b/.markdownlint.yml
@@ -18,7 +18,11 @@ MD013: false
 MD014: false
 MD022: false
 MD024: false
+MD029: false
+MD033: false
 MD034: false
+MD037: false
 MD038: false
 MD040: false
+MD046: false
 MD047: false
diff --git a/docs/resources/annotations.md b/docs/resources/annotations.md
@@ -9,6 +9,40 @@ description: |-
 
 This resource allows Terraform to manage the annotations for a resource that already exists. This resource uses [field management](https://kubernetes.io/docs/reference/using-api/server-side-apply/#field-management) and [server-side apply](https://kubernetes.io/docs/reference/using-api/server-side-apply/) to manage only the annotations that are defined in the Terraform configuration. Existing annotations not specified in the configuration will be ignored. If an annotation specified in the config and is already managed by another client it will cause a conflict which can be overridden by setting `force` to true.
 
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `api_version` (String) The apiVersion of the resource to annotate.
+- `kind` (String) The kind of the resource to annotate.
+- `metadata` (Block List, Min: 1, Max: 1) (see [below for nested schema](#nestedblock--metadata))
+
+### Optional
+
+- `annotations` (Map of String) A map of annotations to apply to the resource.
+- `field_manager` (String) Set the name of the field manager for the specified labels.
+- `force` (Boolean) Force overwriting annotations that were created or edited outside of Terraform.
+- `template_annotations` (Map of String) A map of annotations to apply to the resource template.
+
+### Read-Only
+
+- `id` (String) The ID of this resource.
+
+<a id="nestedblock--metadata"></a>
+### Nested Schema for `metadata`
+
+Required:
+
+- `name` (String) The name of the resource.
+
+Optional:
+
+- `namespace` (String) The namespace of the resource.
+
+
+
+
 ## Example Usage
 
 ```terraform
@@ -44,29 +78,6 @@ resource "kubernetes_annotations" "example" {
 }
 ```
 
-## Argument Reference
-
-The following arguments are supported:
-
-~> NOTE: At least one of `annotations` or `template_annotations` is required.
-
-* `api_version` - (Required) The apiVersion of the resource to be annotated.
-* `kind` - (Required) The kind of the resource to be annotated.
-* `metadata` - (Required) Standard metadata of the resource to be annotated.
-* `annotations` - (Optional) A map of annotations to apply to the resource.
-* `template_annotations` - (Optional) A map of annotations to apply to the pod template within the resource.
-* `force` - (Optional) Force management of annotations if there is a conflict. Defaults to `false`.
-* `field_manager` - (Optional) The name of the [field manager](https://kubernetes.io/docs/reference/using-api/server-side-apply/#field-management). Defaults to `Terraform`.
-
-## Nested Blocks
-
-### `metadata`
-
-#### Arguments
-
-* `name` - (Required) Name of the resource to be annotated.
-* `namespace` - (Optional) Namespace of the resource to be annotated.
-
 ## Import
 
 This resource does not support the `import` command. As this resource operates on Kubernetes resources that already exist, creating the resource is equivalent to importing it.
diff --git a/docs/resources/api_service.md b/docs/resources/api_service.md
@@ -9,77 +9,88 @@ description: |-
 
 An API Service is an abstraction which defines for locating and communicating with servers.
 
-## Example Usage
+<!-- schema generated by tfplugindocs -->
+## Schema
 
-```terraform
-resource "kubernetes_api_service" "example" {
-  metadata {
-    name = "terraform-example"
-  }
-  spec {
-    selector {
-      app = "${kubernetes_pod.example.metadata.0.labels.app}"
-    }
-    session_affinity = "ClientIP"
-    port {
-      port        = 8080
-      target_port = 80
-    }
+### Required
 
-    type = "LoadBalancer"
-  }
-}
-```
+- `metadata` (Block List, Min: 1, Max: 1) Standard api_service'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))
+- `spec` (Block List, Min: 1, Max: 1) Spec contains information for locating and communicating with a server. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status (see [below for nested schema](#nestedblock--spec))
+
+### Read-Only
+
+- `id` (String) The ID of this resource.
+
+<a id="nestedblock--metadata"></a>
+### Nested Schema for `metadata`
 
-## Argument Reference
+Optional:
 
-The following arguments are supported:
+- `annotations` (Map of String) An unstructured key value map stored with the api_service 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 api_service. 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 api_service, must be unique. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
 
-* `metadata` - (Required) Standard API service's metadata. For more info see [Kubernetes reference](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata)
-* `spec` - (Required) Spec contains information for locating and communicating with a server. [Kubernetes reference](https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status)
+Read-Only:
 
-## Nested Blocks
+- `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 api_service that can be used by clients to determine when api_service 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 api_service. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids
 
-### `metadata`
 
-#### Arguments
+<a id="nestedblock--spec"></a>
+### Nested Schema for `spec`
 
-* `annotations` - (Optional) An unstructured key value map stored with the API service that may be used to store arbitrary metadata.
+Required:
 
-~> By default, the provider ignores any annotations whose key names end with *kubernetes.io*. This is necessary because such annotations can be mutated by server-side components and consequently cause a perpetual diff in the Terraform plan output. If you explicitly specify any such annotations in the configuration template then Terraform will consider these as normal resource attributes and manage them as expected (while still avoiding the perpetual diff problem). For more info see [Kubernetes reference](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/)
+- `group` (String) Group is the API group name this server hosts.
+- `group_priority_minimum` (Number) GroupPriorityMinimum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s.
+- `version` (String) Version is the API version this server hosts. For example, `v1`.
+- `version_priority` (Number) VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is `kube-like`, it will sort above non `kube-like` version strings, which are ordered lexicographically. `Kube-like` versions start with a `v`, then are followed by a number (the major version), then optionally the string `alpha` or `beta` and another number (the minor version). These are sorted first by GA > `beta` > `alpha` (where GA is a version with no suffix such as `beta` or `alpha`), and then by comparing major version, then minor version. An example sorted list of versions: `v10`, `v2`, `v1`, `v11beta2`, `v10beta3`, `v3beta1`, `v12alpha1`, `v11alpha2`, `foo1`, `foo10`.
 
-* `generate_name` - (Optional) 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. For more info see [Kubernetes reference](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#idempotency)
-* `labels` - (Optional) Map of string keys and values that can be used to organize and categorize (scope and select) the API service.
+Optional:
 
-~> By default, the provider ignores any labels whose key names end with *kubernetes.io*. This is necessary because such labels can be mutated by server-side components and consequently cause a perpetual diff in the Terraform plan output. If you explicitly specify any such labels in the configuration template then Terraform will consider these as normal resource attributes and manage them as expected (while still avoiding the perpetual diff problem). For more info see [Kubernetes reference](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/)
+- `ca_bundle` (String) CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. If unspecified, system trust roots on the apiserver are used.
+- `insecure_skip_tls_verify` (Boolean) InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead.
+- `service` (Block List, Max: 1) Service is a reference to the service for this API server. It must communicate on port 443. If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled. (see [below for nested schema](#nestedblock--spec--service))
 
-* `name` - (Optional) Name of the API service, must be unique. Cannot be updated. For more info see [Kubernetes reference](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names)
+<a id="nestedblock--spec--service"></a>
+### Nested Schema for `spec.service`
 
-#### 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 API service that can be used by clients to determine when API service 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 API service. For more info see [Kubernetes reference](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids)
+- `name` (String) Name is the name of the service.
+- `namespace` (String) Namespace is the namespace of the service.
 
-### `spec`
+Optional:
 
-#### Arguments
+- `port` (Number) If specified, the port on the service that is hosting the service. Defaults to 443 for backward compatibility. Should be a valid port number (1-65535, inclusive).
 
-* `ca_bundle` - (Optional) CABundle is a PEM encoded CA bundle which will be used to validate an API server's serving certificate. If unspecified, system trust roots on the apiserver are used.
-* `group` - (Required) Group is the API group name this server hosts.
-* `group_priority_minimum` - (Required) GroupPriorityMininum is the priority this group should have at least. Higher priority means that the group is preferred by clients over lower priority ones. Note that other versions of this group might specify even higher GroupPriorityMininum values such that the whole group gets a higher priority. The primary sort is based on GroupPriorityMinimum, ordered highest number to lowest (20 before 10). The secondary sort is based on the alphabetical comparison of the name of the object. (v1.bar before v1.foo) We'd recommend something like: *.k8s.io (except extensions) at 18000 and PaaSes (OpenShift, Deis) are recommended to be in the 2000s.
-* `insecure_skip_tls_verify` - (Required) InsecureSkipTLSVerify disables TLS certificate verification when communicating with this server. This is strongly discouraged. You should use the CABundle instead.
-* `service` - (Optional) Service is a reference to the service for this API server. It must communicate on port 443. If the Service is nil, that means the handling for the API groupversion is handled locally on this server. The call will simply delegate to the normal handler chain to be fulfilled. See `service` block attributes below.
-* `version` - (Required) Version is the API version this server hosts. For example, `v1`.
-* `version_priority` - (Required) VersionPriority controls the ordering of this API version inside of its group. Must be greater than zero. The primary sort is based on VersionPriority, ordered highest to lowest (20 before 10). Since it's inside of a group, the number can be small, probably in the 10s. In case of equal version priorities, the version string will be used to compute the order inside a group. If the version string is `kube-like`, it will sort above non `kube-like` version strings, which are ordered lexicographically. `Kube-like` versions start with a `v`, then are followed by a number (the major version), then optionally the string `alpha` or `beta` and another number (the minor version). These are sorted first by GA > `beta` > `alpha` (where GA is a version with no suffix such as `beta` or `alpha`), and then by comparing major version, then minor version. An example sorted list of versions: `v10`, `v2`, `v1`, `v11beta2`, `v10beta3`, `v3beta1`, `v12alpha1`, `v11alpha2`, `foo1`, `foo10`..
 
-### `service`
 
-#### Arguments
 
-* `name` - (Required) Name is the name of the service.
-* `namespace` - (Required) Namespace is the namespace of the service.
-* `port` - (Optional) If specified, the port on the service that is hosting the service. Defaults to 443 for backward compatibility. Should be a valid port number (1-65535, inclusive).
+
+## Example Usage
+
+```terraform
+resource "kubernetes_api_service" "example" {
+  metadata {
+    name = "terraform-example"
+  }
+  spec {
+    selector {
+      app = "${kubernetes_pod.example.metadata.0.labels.app}"
+    }
+    session_affinity = "ClientIP"
+    port {
+      port        = 8080
+      target_port = 80
+    }
+
+    type = "LoadBalancer"
+  }
+}
+```
 
 ## Import