Skip to content

Commit f53715d

Browse files
committed
chore: generate docs for data sources
Signed-off-by: Sebastian Hoß <seb@xn--ho-hia.de>
1 parent 3c72fea commit f53715d

2,070 files changed

Lines changed: 75145 additions & 603169 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "k8s_about_k8s_io_cluster_property_v1alpha1 Data Source - terraform-provider-k8s"
4+
subcategory: "about.k8s.io"
5+
description: |-
6+
ClusterProperty is a resource provides a way to store identification related, cluster scoped information for multi-cluster tools while creating flexibility for implementations.
7+
---
8+
9+
# k8s_about_k8s_io_cluster_property_v1alpha1 (Data Source)
10+
11+
ClusterProperty is a resource provides a way to store identification related, cluster scoped information for multi-cluster tools while creating flexibility for implementations.
12+
13+
## Example Usage
14+
15+
```terraform
16+
data "k8s_about_k8s_io_cluster_property_v1alpha1" "example" {
17+
metadata = {
18+
name = "some-name"
19+
20+
}
21+
}
22+
```
23+
24+
<!-- schema generated by tfplugindocs -->
25+
## Schema
26+
27+
### Required
28+
29+
- `metadata` (Attributes) Data that helps uniquely identify this object. See https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata for more details. (see [below for nested schema](#nestedatt--metadata))
30+
31+
### Read-Only
32+
33+
- `api_version` (String) The API group of the requested resource.
34+
- `id` (String) Contains the value `metadata.name`.
35+
- `kind` (String) The type of the requested resource.
36+
- `spec` (Attributes) Spec represents the desired behavior. (see [below for nested schema](#nestedatt--spec))
37+
38+
<a id="nestedatt--metadata"></a>
39+
### Nested Schema for `metadata`
40+
41+
Required:
42+
43+
- `name` (String) Unique identifier for this object. See https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names for more details.
44+
45+
Read-Only:
46+
47+
- `annotations` (Map of String) Keys and values that can be used by external tooling to store and retrieve arbitrary metadata about this object. See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ for more details.
48+
- `labels` (Map of String) Keys and values that can be used to organize and categorize objects. See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more details.
49+
50+
51+
<a id="nestedatt--spec"></a>
52+
### Nested Schema for `spec`
53+
54+
Read-Only:
55+
56+
- `value` (String) Value is the property-dependent string.
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "k8s_about_k8s_io_cluster_property_v1alpha1_manifest Data Source - terraform-provider-k8s"
4+
subcategory: "about.k8s.io"
5+
description: |-
6+
ClusterProperty is a resource provides a way to store identification related, cluster scoped information for multi-cluster tools while creating flexibility for implementations.
7+
---
8+
9+
# k8s_about_k8s_io_cluster_property_v1alpha1_manifest (Data Source)
10+
11+
ClusterProperty is a resource provides a way to store identification related, cluster scoped information for multi-cluster tools while creating flexibility for implementations.
12+
13+
## Example Usage
14+
15+
```terraform
16+
data "k8s_about_k8s_io_cluster_property_v1alpha1_manifest" "example" {
17+
metadata = {
18+
name = "some-name"
19+
20+
}
21+
}
22+
```
23+
24+
<!-- schema generated by tfplugindocs -->
25+
## Schema
26+
27+
### Required
28+
29+
- `metadata` (Attributes) Data that helps uniquely identify this object. See https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#metadata for more details. (see [below for nested schema](#nestedatt--metadata))
30+
- `spec` (Attributes) Spec represents the desired behavior. (see [below for nested schema](#nestedatt--spec))
31+
32+
### Read-Only
33+
34+
- `id` (String) Contains the value `metadata.name`.
35+
- `yaml` (String) The generated manifest in YAML format.
36+
37+
<a id="nestedatt--metadata"></a>
38+
### Nested Schema for `metadata`
39+
40+
Required:
41+
42+
- `name` (String) Unique identifier for this object. See https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names for more details.
43+
44+
Optional:
45+
46+
- `annotations` (Map of String) Keys and values that can be used by external tooling to store and retrieve arbitrary metadata about this object. See https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ for more details.
47+
- `labels` (Map of String) Keys and values that can be used to organize and categorize objects. See https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ for more details.
48+
49+
50+
<a id="nestedatt--spec"></a>
51+
### Nested Schema for `spec`
52+
53+
Required:
54+
55+
- `value` (String) Value is the property-dependent string.

docs/data-sources/acid_zalan_do_operator_configuration_v1.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,10 @@ data "k8s_acid_zalan_do_operator_configuration_v1" "example" {
3030

3131
### Read-Only
3232

33+
- `api_version` (String) The API group of the requested resource.
3334
- `configuration` (Attributes) (see [below for nested schema](#nestedatt--configuration))
3435
- `id` (String) Contains the value `metadata.namespace/metadata.name`.
36+
- `kind` (String) The type of the requested resource.
3537

3638
<a id="nestedatt--metadata"></a>
3739
### Nested Schema for `metadata`
@@ -160,6 +162,7 @@ Read-Only:
160162
- `node_readiness_label_merge` (String)
161163
- `oauth_token_secret_name` (String)
162164
- `pdb_name_format` (String)
165+
- `persistent_volume_claim_retention_policy` (Attributes) (see [below for nested schema](#nestedatt--configuration--kubernetes--persistent_volume_claim_retention_policy))
163166
- `pod_antiaffinity_preferred_during_scheduling` (Boolean)
164167
- `pod_antiaffinity_topology_key` (String)
165168
- `pod_environment_configmap` (String)
@@ -197,6 +200,15 @@ Read-Only:
197200
- `userkey` (String)
198201

199202

203+
<a id="nestedatt--configuration--kubernetes--persistent_volume_claim_retention_policy"></a>
204+
### Nested Schema for `configuration.kubernetes.persistent_volume_claim_retention_policy`
205+
206+
Read-Only:
207+
208+
- `when_deleted` (String)
209+
- `when_scaled` (String)
210+
211+
200212

201213
<a id="nestedatt--configuration--load_balancer"></a>
202214
### Nested Schema for `configuration.load_balancer`

docs/data-sources/acid_zalan_do_operator_configuration_v1_manifest.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,7 @@ Optional:
163163
- `node_readiness_label_merge` (String)
164164
- `oauth_token_secret_name` (String)
165165
- `pdb_name_format` (String)
166+
- `persistent_volume_claim_retention_policy` (Attributes) (see [below for nested schema](#nestedatt--configuration--kubernetes--persistent_volume_claim_retention_policy))
166167
- `pod_antiaffinity_preferred_during_scheduling` (Boolean)
167168
- `pod_antiaffinity_topology_key` (String)
168169
- `pod_environment_configmap` (String)
@@ -203,6 +204,15 @@ Optional:
203204
- `template` (Boolean)
204205

205206

207+
<a id="nestedatt--configuration--kubernetes--persistent_volume_claim_retention_policy"></a>
208+
### Nested Schema for `configuration.kubernetes.persistent_volume_claim_retention_policy`
209+
210+
Optional:
211+
212+
- `when_deleted` (String)
213+
- `when_scaled` (String)
214+
215+
206216

207217
<a id="nestedatt--configuration--load_balancer"></a>
208218
### Nested Schema for `configuration.load_balancer`

docs/data-sources/acid_zalan_do_postgres_team_v1.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ data "k8s_acid_zalan_do_postgres_team_v1" "example" {
3030

3131
### Read-Only
3232

33+
- `api_version` (String) The API group of the requested resource.
3334
- `id` (String) Contains the value `metadata.namespace/metadata.name`.
35+
- `kind` (String) The type of the requested resource.
3436
- `spec` (Attributes) (see [below for nested schema](#nestedatt--spec))
3537

3638
<a id="nestedatt--metadata"></a>

docs/data-sources/acid_zalan_do_postgresql_v1.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@ data "k8s_acid_zalan_do_postgresql_v1" "example" {
3030

3131
### Read-Only
3232

33+
- `api_version` (String) The API group of the requested resource.
3334
- `id` (String) Contains the value `metadata.namespace/metadata.name`.
35+
- `kind` (String) The type of the requested resource.
3436
- `spec` (Attributes) (see [below for nested schema](#nestedatt--spec))
3537

3638
<a id="nestedatt--metadata"></a>

docs/data-sources/acme_cert_manager_io_challenge_v1.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@ data "k8s_acme_cert_manager_io_challenge_v1" "example" {
3131

3232
### Read-Only
3333

34+
- `api_version` (String) The API group of the requested resource.
3435
- `id` (String) Contains the value `metadata.namespace/metadata.name`.
36+
- `kind` (String) The type of the requested resource.
3537
- `spec` (Attributes) (see [below for nested schema](#nestedatt--spec))
3638

3739
<a id="nestedatt--metadata"></a>
@@ -336,11 +338,11 @@ Read-Only:
336338
Read-Only:
337339

338340
- `group` (String) Group is the group of the referent. When unspecified, 'gateway.networking.k8s.io' is inferred. To set the core API group (such as for a 'Service' kind referent), Group must be explicitly set to '' (empty string). Support: Core
339-
- `kind` (String) Kind is kind of the referent. Support: Core (Gateway) Support: Implementation-specific (Other Resources)
341+
- `kind` (String) Kind is kind of the referent. There are two kinds of parent resources with 'Core' support: * Gateway (Gateway conformance profile) * Service (Mesh conformance profile, experimental, ClusterIP Services only) Support for other resources is Implementation-Specific.
340342
- `name` (String) Name is the name of the referent. Support: Core
341-
- `namespace` (String) Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. Support: Core
342-
- `port` (Number) Port is the network port this Route targets. It can be interpreted differently based on the type of parent resource. When the parent resource is a Gateway, this targets all listeners listening on the specified port that also support this kind of Route(and select this Route). It's not recommended to set 'Port' unless the networking behaviors specified in a Route must apply to a specific port as opposed to a listener(s) whose port(s) may be changed. When both Port and SectionName are specified, the name and port of the selected listener must match both specified values. Implementations MAY choose to support other parent resources. Implementations supporting other types of parent resources MUST clearly document how/if Port is interpreted. For the purpose of status, an attachment is considered successful as long as the parent resource accepts it partially. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. Support: Extended <gateway:experimental>
343-
- `section_name` (String) SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following: * Gateway: Listener Name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted. When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. Support: Core
343+
- `namespace` (String) Namespace is the namespace of the referent. When unspecified, this refers to the local namespace of the Route. Note that there are specific rules for ParentRefs which cross namespace boundaries. Cross-namespace references are only valid if they are explicitly allowed by something in the namespace they are referring to. For example: Gateway has the AllowedRoutes field, and ReferenceGrant provides a generic way to enable any other kind of cross-namespace reference. ParentRefs from a Route to a Service in the same namespace are 'producer' routes, which apply default routing rules to inbound connections from any namespace to the Service. ParentRefs from a Route to a Service in a different namespace are 'consumer' routes, and these routing rules are only applied to outbound connections originating from the same namespace as the Route, for which the intended destination of the connections are a Service targeted as a ParentRef of the Route. Support: Core
344+
- `port` (Number) Port is the network port this Route targets. It can be interpreted differently based on the type of parent resource. When the parent resource is a Gateway, this targets all listeners listening on the specified port that also support this kind of Route(and select this Route). It's not recommended to set 'Port' unless the networking behaviors specified in a Route must apply to a specific port as opposed to a listener(s) whose port(s) may be changed. When both Port and SectionName are specified, the name and port of the selected listener must match both specified values. When the parent resource is a Service, this targets a specific port in the Service spec. When both Port (experimental) and SectionName are specified, the name and port of the selected port must match both specified values. Implementations MAY choose to support other parent resources. Implementations supporting other types of parent resources MUST clearly document how/if Port is interpreted. For the purpose of status, an attachment is considered successful as long as the parent resource accepts it partially. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. Support: Extended <gateway:experimental>
345+
- `section_name` (String) SectionName is the name of a section within the target resource. In the following resources, SectionName is interpreted as the following: * Gateway: Listener Name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. * Service: Port Name. When both Port (experimental) and SectionName are specified, the name and port of the selected listener must match both specified values. Note that attaching Routes to Services as Parents is part of experimental Mesh support and is not supported for any other purpose. Implementations MAY choose to support attaching Routes to other resources. If that is the case, they MUST clearly document how SectionName is interpreted. When unspecified (empty string), this will reference the entire resource. For the purpose of status, an attachment is considered successful if at least one section in the parent resource accepts it. For example, Gateway listeners can restrict which Routes can attach to them by Route kind, namespace, or hostname. If 1 of 2 Gateway listeners accept attachment from the referencing Route, the Route MUST be considered successfully attached. If no Gateway listeners accept attachment from this Route, the Route MUST be considered detached from the Gateway. Support: Core
344346

345347

346348

0 commit comments

Comments
 (0)