From bb3163eb8a5351c46e44500821fe1641ea85d536 Mon Sep 17 00:00:00 2001 From: Sarah French <15078782+SarahFrench@users.noreply.github.com> Date: Mon, 4 Dec 2023 10:22:19 +0000 Subject: [PATCH 1/4] Fix typo in manifest documentation --- website/docs/r/manifest.html.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/r/manifest.html.markdown b/website/docs/r/manifest.html.markdown index c2fa610833..b54508fccc 100644 --- a/website/docs/r/manifest.html.markdown +++ b/website/docs/r/manifest.html.markdown @@ -238,7 +238,7 @@ The following arguments are supported: A field path is a string that describes the fully qualified address of a field within the resource, including its parent fields all the way up to "object". The syntax of a path string follows the rules below: * Fields of objects are addressed with `.` * Keys of a map field are addressed with `[""]` - * Elements of a list or tuple field are addresed with `[]` + * Elements of a list or tuple field are addressed with `[]` The following example waits for Kubernetes to create a ServiceAccount token in a Secret, where the `data` field of the Secret is a map. ```hcl From 8e45dca653b1b124b55bb6c73d9b8972ac6a3e18 Mon Sep 17 00:00:00 2001 From: Sarah French Date: Mon, 4 Dec 2023 10:27:55 +0000 Subject: [PATCH 2/4] Address linter issues --- website/docs/r/manifest.html.markdown | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/website/docs/r/manifest.html.markdown b/website/docs/r/manifest.html.markdown index b54508fccc..aa3933fdf6 100644 --- a/website/docs/r/manifest.html.markdown +++ b/website/docs/r/manifest.html.markdown @@ -236,11 +236,12 @@ The following arguments are supported: - `fields` (Optional) A map of field paths and a corresponding regular expression with a pattern to wait for. The provider will wait until the field's value matches the regular expression. Use `*` for any value. A field path is a string that describes the fully qualified address of a field within the resource, including its parent fields all the way up to "object". The syntax of a path string follows the rules below: - * Fields of objects are addressed with `.` - * Keys of a map field are addressed with `[""]` - * Elements of a list or tuple field are addressed with `[]` +* Fields of objects are addressed with `.` +* Keys of a map field are addressed with `[""]` +* Elements of a list or tuple field are addressed with `[]` The following example waits for Kubernetes to create a ServiceAccount token in a Secret, where the `data` field of the Secret is a map. + ```hcl wait { fields = { @@ -248,7 +249,9 @@ A field path is a string that describes the fully qualified address of a field w } } ``` + You can use the [`type()`]() Terraform function to determine the type of a field. With the resource created and present in state, run `terraform console` and then the following command: + ```hcl > type(kubernetes_manifest.my-secret.object.data) map(string) From 08097d7818dccf9e012a76f6286b3e947cb8d95a Mon Sep 17 00:00:00 2001 From: Sarah French Date: Mon, 4 Dec 2023 10:31:02 +0000 Subject: [PATCH 3/4] Address lint error & empty link --- website/docs/r/manifest.html.markdown | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/website/docs/r/manifest.html.markdown b/website/docs/r/manifest.html.markdown index aa3933fdf6..70f057a21f 100644 --- a/website/docs/r/manifest.html.markdown +++ b/website/docs/r/manifest.html.markdown @@ -236,6 +236,7 @@ The following arguments are supported: - `fields` (Optional) A map of field paths and a corresponding regular expression with a pattern to wait for. The provider will wait until the field's value matches the regular expression. Use `*` for any value. A field path is a string that describes the fully qualified address of a field within the resource, including its parent fields all the way up to "object". The syntax of a path string follows the rules below: + * Fields of objects are addressed with `.` * Keys of a map field are addressed with `[""]` * Elements of a list or tuple field are addressed with `[]` @@ -250,7 +251,7 @@ A field path is a string that describes the fully qualified address of a field w } ``` - You can use the [`type()`]() Terraform function to determine the type of a field. With the resource created and present in state, run `terraform console` and then the following command: + You can use the [`type()`](https://developer.hashicorp.com/terraform/language/functions/type) Terraform function to determine the type of a field. With the resource created and present in state, run `terraform console` and then the following command: ```hcl > type(kubernetes_manifest.my-secret.object.data) From 59b4726d41bf520a151c83450a18ae1643056348 Mon Sep 17 00:00:00 2001 From: Sarah French <15078782+SarahFrench@users.noreply.github.com> Date: Mon, 4 Dec 2023 12:22:16 +0000 Subject: [PATCH 4/4] Update bullet points to use `-` instead of `*` --- website/docs/r/manifest.html.markdown | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/website/docs/r/manifest.html.markdown b/website/docs/r/manifest.html.markdown index 70f057a21f..dad9833fb5 100644 --- a/website/docs/r/manifest.html.markdown +++ b/website/docs/r/manifest.html.markdown @@ -16,9 +16,9 @@ Once applied, the `object` attribute contains the state of the resource as retur ### Before you use this resource -* This resource requires API access during planning time. This means the cluster has to be accessible at plan time and thus cannot be created in the same apply operation. We recommend only using this resource for custom resources or resources not yet fully supported by the provider. +- This resource requires API access during planning time. This means the cluster has to be accessible at plan time and thus cannot be created in the same apply operation. We recommend only using this resource for custom resources or resources not yet fully supported by the provider. -* This resource uses [Server-side Apply](https://kubernetes.io/docs/reference/using-api/server-side-apply/) to carry out apply operations. A minimum Kubernetes version of 1.16.x is required, but versions 1.17+ are strongly recommended as the SSA implementation in Kubernetes 1.16.x is incomplete and unstable. +- This resource uses [Server-side Apply](https://kubernetes.io/docs/reference/using-api/server-side-apply/) to carry out apply operations. A minimum Kubernetes version of 1.16.x is required, but versions 1.17+ are strongly recommended as the SSA implementation in Kubernetes 1.16.x is incomplete and unstable. ### Example: Create a Kubernetes ConfigMap @@ -237,9 +237,9 @@ The following arguments are supported: A field path is a string that describes the fully qualified address of a field within the resource, including its parent fields all the way up to "object". The syntax of a path string follows the rules below: -* Fields of objects are addressed with `.` -* Keys of a map field are addressed with `[""]` -* Elements of a list or tuple field are addressed with `[]` +- Fields of objects are addressed with `.` +- Keys of a map field are addressed with `[""]` +- Elements of a list or tuple field are addressed with `[]` The following example waits for Kubernetes to create a ServiceAccount token in a Secret, where the `data` field of the Secret is a map.