From 61e45dbaa1ca4de2196e62cc36e70be3cf6e9a72 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 24 Apr 2024 12:37:41 +0000 Subject: [PATCH 1/3] chore(deps): Bump github.com/hashicorp/terraform-plugin-docs Bumps [github.com/hashicorp/terraform-plugin-docs](https://github.com/hashicorp/terraform-plugin-docs) from 0.19.0 to 0.19.1. - [Release notes](https://github.com/hashicorp/terraform-plugin-docs/releases) - [Changelog](https://github.com/hashicorp/terraform-plugin-docs/blob/main/CHANGELOG.md) - [Commits](https://github.com/hashicorp/terraform-plugin-docs/compare/v0.19.0...v0.19.1) --- updated-dependencies: - dependency-name: github.com/hashicorp/terraform-plugin-docs dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- go.mod | 2 +- go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index dab774457..af5301b99 100644 --- a/go.mod +++ b/go.mod @@ -10,7 +10,7 @@ toolchain go1.22.2 require ( github.com/getkin/kin-openapi v0.124.0 github.com/gruntwork-io/terratest v0.46.14 - github.com/hashicorp/terraform-plugin-docs v0.19.0 + github.com/hashicorp/terraform-plugin-docs v0.19.1 github.com/hashicorp/terraform-plugin-framework v1.8.0 github.com/hashicorp/terraform-plugin-framework-validators v0.12.0 github.com/hashicorp/terraform-plugin-log v0.9.0 diff --git a/go.sum b/go.sum index 2a447173a..e96c156a3 100644 --- a/go.sum +++ b/go.sum @@ -485,8 +485,8 @@ github.com/hashicorp/terraform-exec v0.20.0 h1:DIZnPsqzPGuUnq6cH8jWcPunBfY+C+M8J github.com/hashicorp/terraform-exec v0.20.0/go.mod h1:ckKGkJWbsNqFKV1itgMnE0hY9IYf1HoiekpuN0eWoDw= github.com/hashicorp/terraform-json v0.21.0 h1:9NQxbLNqPbEMze+S6+YluEdXgJmhQykRyRNd+zTI05U= github.com/hashicorp/terraform-json v0.21.0/go.mod h1:qdeBs11ovMzo5puhrRibdD6d2Dq6TyE/28JiU4tIQxk= -github.com/hashicorp/terraform-plugin-docs v0.19.0 h1:ufXLte5Kx20LazYmGN2UZG2bN4aF0PmlDyuS1iKWSXo= -github.com/hashicorp/terraform-plugin-docs v0.19.0/go.mod h1:NPfKCSfzTtq+YCFHr2qTAMknWUxR8C4KgTbGkHULSV8= +github.com/hashicorp/terraform-plugin-docs v0.19.1 h1:XYIlGCfnUDVTyKPIHFKRDfB4INU+pyPKk6VZ/1apPIc= +github.com/hashicorp/terraform-plugin-docs v0.19.1/go.mod h1:NPfKCSfzTtq+YCFHr2qTAMknWUxR8C4KgTbGkHULSV8= github.com/hashicorp/terraform-plugin-framework v1.8.0 h1:P07qy8RKLcoBkCrY2RHJer5AEvJnDuXomBgou6fD8kI= github.com/hashicorp/terraform-plugin-framework v1.8.0/go.mod h1:/CpTukO88PcL/62noU7cuyaSJ4Rsim+A/pa+3rUVufY= github.com/hashicorp/terraform-plugin-framework-validators v0.12.0 h1:HOjBuMbOEzl7snOdOoUfE2Jgeto6JOjLVQ39Ls2nksc= From d9b0e64f803e03e7bb870c6aad61811e937dc035 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebastian=20Ho=C3=9F?= Date: Thu, 25 Apr 2024 06:30:50 +0200 Subject: [PATCH 2/3] re-generate docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Sebastian Hoß --- ...group_org_kogito_infra_v1beta1_manifest.md | 2 +- ...p_terraform_io_module_v1alpha2_manifest.md | 2 +- .../apps_stateful_set_v1_manifest.md | 100 ++++++++++++++++++ ...hbase_migration_replication_v2_manifest.md | 2 +- ...etworking_k8s_io_grpc_route_v1_manifest.md | 2 +- ...ing_k8s_io_grpc_route_v1alpha2_manifest.md | 2 +- .../getambassador_io_module_v1_manifest.md | 2 +- .../getambassador_io_module_v2_manifest.md | 2 +- ...tambassador_io_module_v3alpha1_manifest.md | 2 +- ..._io_hnc_configuration_v1alpha2_manifest.md | 2 +- ...o_subnamespace_anchor_v1alpha2_manifest.md | 2 +- .../kyverno_io_policy_v1_manifest.md | 2 +- .../kyverno_io_policy_v2beta1_manifest.md | 2 +- .../persistent_volume_v1_manifest.md | 2 +- ...k8s_io_seccomp_profile_v1beta1_manifest.md | 2 +- ...nner_l7mp_io_static_service_v1_manifest.md | 2 +- ...nkerbell_org_template_v1alpha2_manifest.md | 2 +- ...fik_io_middleware_tcp_v1alpha1_manifest.md | 2 +- ...traefik_io_middleware_v1alpha1_manifest.md | 2 +- ...servers_transport_tcp_v1alpha1_manifest.md | 2 +- ..._io_servers_transport_v1alpha1_manifest.md | 2 +- ...traefik_io_tls_option_v1alpha1_manifest.md | 2 +- .../traefik_io_tls_store_v1alpha1_manifest.md | 2 +- ...ik_io_traefik_service_v1alpha1_manifest.md | 2 +- 24 files changed, 123 insertions(+), 23 deletions(-) diff --git a/docs/data-sources/app_kiegroup_org_kogito_infra_v1beta1_manifest.md b/docs/data-sources/app_kiegroup_org_kogito_infra_v1beta1_manifest.md index 4ff429469..2b78224c5 100644 --- a/docs/data-sources/app_kiegroup_org_kogito_infra_v1beta1_manifest.md +++ b/docs/data-sources/app_kiegroup_org_kogito_infra_v1beta1_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_app_kiegroup_org_kogito_infra_v1beta1_manifest Data Source - terraform-provider-k8s" subcategory: "app.kiegroup.org" description: |- - KogitoInfra is the resource to bind a Custom Resource (CR) not managed by Kogito Operator to a given deployed Kogito service. It holds the reference of a CR managed by another operator such as Strimzi. For example: one can create a Kafka CR via Strimzi and link this resource using KogitoInfra to a given Kogito service (custom or supporting, such as Data Index). Please refer to the Kogito Operator documentation () for more information. + KogitoInfra is the resource to bind a Custom Resource (CR) not managed by Kogito Operator to a given deployed Kogito service. It holds the reference of a CR managed by another operator such as Strimzi. For example: one can create a Kafka CR via Strimzi and link this resource using KogitoInfra to a given Kogito service (custom or supporting, such as Data Index). Please refer to the Kogito Operator documentation (https://docs.jboss.org/kogito/release/latest/html_single/) for more information. --- # k8s_app_kiegroup_org_kogito_infra_v1beta1_manifest (Data Source) diff --git a/docs/data-sources/app_terraform_io_module_v1alpha2_manifest.md b/docs/data-sources/app_terraform_io_module_v1alpha2_manifest.md index b21acd9c2..28aacac62 100644 --- a/docs/data-sources/app_terraform_io_module_v1alpha2_manifest.md +++ b/docs/data-sources/app_terraform_io_module_v1alpha2_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_app_terraform_io_module_v1alpha2_manifest Data Source - terraform-provider-k8s" subcategory: "app.terraform.io" description: |- - Module is the Schema for the modules APIModule implements the API-driven Run WorkflowMore information: - + Module is the Schema for the modules APIModule implements the API-driven Run WorkflowMore information: - https://developer.hashicorp.com/terraform/cloud-docs/run/api --- # k8s_app_terraform_io_module_v1alpha2_manifest (Data Source) diff --git a/docs/data-sources/apps_stateful_set_v1_manifest.md b/docs/data-sources/apps_stateful_set_v1_manifest.md index 6e7fac34a..ba4c396b2 100644 --- a/docs/data-sources/apps_stateful_set_v1_manifest.md +++ b/docs/data-sources/apps_stateful_set_v1_manifest.md @@ -3576,7 +3576,63 @@ Optional: Optional: +- `api_version` (String) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources +- `kind` (String) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +- `metadata` (Attributes) ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. (see [below for nested schema](#nestedatt--spec--volume_claim_templates--metadata)) - `spec` (Attributes) PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes (see [below for nested schema](#nestedatt--spec--volume_claim_templates--spec)) +- `status` (Attributes) PersistentVolumeClaimStatus is the current status of a persistent volume claim. (see [below for nested schema](#nestedatt--spec--volume_claim_templates--status)) + + +### Nested Schema for `spec.volume_claim_templates.metadata` + +Optional: + +- `annotations` (Map of String) Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations +- `creation_timestamp` (String) Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. +- `deletion_grace_period_seconds` (Number) Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. +- `deletion_timestamp` (String) Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. +- `finalizers` (List of String) Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. +- `generate_name` (String) GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.If this field is specified and the generated name exists, the server will return a 409.Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency +- `generation` (Number) A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. +- `labels` (Map of String) Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels +- `managed_fields` (Attributes List) ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like 'ci-cd'. The set of fields is always in the version that the workflow used when modifying the object. (see [below for nested schema](#nestedatt--spec--volume_claim_templates--metadata--managed_fields)) +- `name` (String) Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names +- `namespace` (String) Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the 'default' namespace, but 'default' is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces +- `owner_references` (Attributes List) List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. (see [below for nested schema](#nestedatt--spec--volume_claim_templates--metadata--owner_references)) +- `resource_version` (String) An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency +- `self_link` (String) Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. +- `uid` (String) UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids + + +### Nested Schema for `spec.volume_claim_templates.metadata.managed_fields` + +Optional: + +- `api_version` (String) APIVersion defines the version of this resource that this field set applies to. The format is 'group/version' just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. +- `fields_type` (String) FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: 'FieldsV1' +- `fields_v1` (Map of String) FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.The exact format is defined in sigs.k8s.io/structured-merge-diff +- `manager` (String) Manager is an identifier of the workflow managing these fields. +- `operation` (String) Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. +- `subresource` (String) Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. +- `time` (String) Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. + + + +### Nested Schema for `spec.volume_claim_templates.metadata.owner_references` + +Required: + +- `api_version` (String) API version of the referent. +- `kind` (String) Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds +- `name` (String) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names +- `uid` (String) UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids + +Optional: + +- `block_owner_deletion` (Boolean) If true, AND if the owner has the 'foregroundDeletion' finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs 'delete' permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. +- `controller` (Boolean) If true, this reference points to the managing controller. + + ### Nested Schema for `spec.volume_claim_templates.spec` @@ -3648,3 +3704,47 @@ Required: Optional: - `values` (List of String) values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. + + + + + +### Nested Schema for `spec.volume_claim_templates.status` + +Optional: + +- `access_modes` (List of String) accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 +- `allocated_resource_statuses` (Map of String) allocatedResourceStatuses stores status of resource being resized for the given PVC. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as 'example.com/my-custom-resource'Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used.ClaimResourceStatus can be in any of following states: - ControllerResizeInProgress: State set when resize controller starts resizing the volume in control-plane. - ControllerResizeFailed: State set when resize has failed in resize controller with a terminal error. - NodeResizePending: State set when resize controller has finished resizing the volume but further resizing of volume is needed on the node. - NodeResizeInProgress: State set when kubelet starts resizing the volume. - NodeResizeFailed: State set when resizing has failed in kubelet with a terminal error. Transient errors don't set NodeResizeFailed.For example: if expanding a PVC for more capacity - this field can be one of the following states: - pvc.status.allocatedResourceStatus['storage'] = 'ControllerResizeInProgress' - pvc.status.allocatedResourceStatus['storage'] = 'ControllerResizeFailed' - pvc.status.allocatedResourceStatus['storage'] = 'NodeResizePending' - pvc.status.allocatedResourceStatus['storage'] = 'NodeResizeInProgress' - pvc.status.allocatedResourceStatus['storage'] = 'NodeResizeFailed'When this field is not set, it means that no resize operation is in progress for the given PVC.A controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC.This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature. +- `allocated_resources` (Map of String) allocatedResources tracks the resources allocated to a PVC including its capacity. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as 'example.com/my-custom-resource'Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used.Capacity reported here may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity.A controller that receives PVC update with previously unknown resourceName should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC.This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature. +- `capacity` (Map of String) capacity represents the actual resources of the underlying volume. +- `conditions` (Attributes List) conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'. (see [below for nested schema](#nestedatt--spec--volume_claim_templates--status--conditions)) +- `current_volume_attributes_class_name` (String) currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim This is an alpha field and requires enabling VolumeAttributesClass feature. +- `modify_volume_status` (Attributes) ModifyVolumeStatus represents the status object of ControllerModifyVolume operation (see [below for nested schema](#nestedatt--spec--volume_claim_templates--status--modify_volume_status)) +- `phase` (String) phase represents the current phase of PersistentVolumeClaim. + + +### Nested Schema for `spec.volume_claim_templates.status.conditions` + +Required: + +- `status` (String) +- `type` (String) + +Optional: + +- `last_probe_time` (String) Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. +- `last_transition_time` (String) Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. +- `message` (String) message is the human-readable message indicating details about last transition. +- `reason` (String) reason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports 'Resizing' that means the underlying persistent volume is being resized. + + + +### Nested Schema for `spec.volume_claim_templates.status.modify_volume_status` + +Required: + +- `status` (String) status is the status of the ControllerModifyVolume operation. It can be in any of following states: - Pending Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as the specified VolumeAttributesClass not existing. - InProgress InProgress indicates that the volume is being modified. - Infeasible Infeasible indicates that the request has been rejected as invalid by the CSI driver. To resolve the error, a valid VolumeAttributesClass needs to be specified.Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately. + +Optional: + +- `target_volume_attributes_class_name` (String) targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled diff --git a/docs/data-sources/couchbase_com_couchbase_migration_replication_v2_manifest.md b/docs/data-sources/couchbase_com_couchbase_migration_replication_v2_manifest.md index 5f95b76ad..492a006ae 100644 --- a/docs/data-sources/couchbase_com_couchbase_migration_replication_v2_manifest.md +++ b/docs/data-sources/couchbase_com_couchbase_migration_replication_v2_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_couchbase_com_couchbase_migration_replication_v2_manifest Data Source - terraform-provider-k8s" subcategory: "couchbase.com" description: |- - The CouchbaseScopeMigration resource represents the use of the special migration mapping within XDCR to take a filtered list from the default scope and collection of the source bucket, replicate it to named scopes and collections within the target bucket. The bucket-to-bucket replication cannot duplicate any used by the CouchbaseReplication resource, as these two types of replication are mutually exclusive between buckets. + The CouchbaseScopeMigration resource represents the use of the special migration mapping within XDCR to take a filtered list from the default scope and collection of the source bucket, replicate it to named scopes and collections within the target bucket. The bucket-to-bucket replication cannot duplicate any used by the CouchbaseReplication resource, as these two types of replication are mutually exclusive between buckets. https://docs.couchbase.com/server/current/learn/clusters-and-availability/xdcr-with-scopes-and-collections.html#migration --- # k8s_couchbase_com_couchbase_migration_replication_v2_manifest (Data Source) diff --git a/docs/data-sources/gateway_networking_k8s_io_grpc_route_v1_manifest.md b/docs/data-sources/gateway_networking_k8s_io_grpc_route_v1_manifest.md index 0abfa0543..21b8069ef 100644 --- a/docs/data-sources/gateway_networking_k8s_io_grpc_route_v1_manifest.md +++ b/docs/data-sources/gateway_networking_k8s_io_grpc_route_v1_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_gateway_networking_k8s_io_grpc_route_v1_manifest Data Source - terraform-provider-k8s" subcategory: "gateway.networking.k8s.io" description: |- - GRPCRoute provides a way to route gRPC requests. This includes the capabilityto match requests by hostname, gRPC service, gRPC method, or HTTP/2 header.Filters can be used to specify additional processing steps. Backends specifywhere matching requests will be routed.GRPCRoute falls under extended support within the Gateway API. Within thefollowing specification, the word 'MUST' indicates that an implementationsupporting GRPCRoute must conform to the indicated requirement, but animplementation not supporting this route type need not follow the requirementunless explicitly indicated.Implementations supporting 'GRPCRoute' with the 'HTTPS' 'ProtocolType' MUSTaccept HTTP/2 connections without an initial upgrade from HTTP/1.1, i.e. viaALPN. If the implementation does not support this, then it MUST set the'Accepted' condition to 'False' for the affected listener with a reason of'UnsupportedProtocol'. Implementations MAY also accept HTTP/2 connectionswith an upgrade from HTTP/1.Implementations supporting 'GRPCRoute' with the 'HTTP' 'ProtocolType' MUSTsupport HTTP/2 over cleartext TCP (h2c,https://www.rfc-editor.org/rfc/rfc7540#section-3.1) without an initialupgrade from HTTP/1.1, i.e. with prior knowledge(. If the implementationdoes not support this, then it MUST set the 'Accepted' condition to 'False'for the affected listener with a reason of 'UnsupportedProtocol'.Implementations MAY also accept HTTP/2 connections with an upgrade fromHTTP/1, i.e. without prior knowledge. + GRPCRoute provides a way to route gRPC requests. This includes the capabilityto match requests by hostname, gRPC service, gRPC method, or HTTP/2 header.Filters can be used to specify additional processing steps. Backends specifywhere matching requests will be routed.GRPCRoute falls under extended support within the Gateway API. Within thefollowing specification, the word 'MUST' indicates that an implementationsupporting GRPCRoute must conform to the indicated requirement, but animplementation not supporting this route type need not follow the requirementunless explicitly indicated.Implementations supporting 'GRPCRoute' with the 'HTTPS' 'ProtocolType' MUSTaccept HTTP/2 connections without an initial upgrade from HTTP/1.1, i.e. viaALPN. If the implementation does not support this, then it MUST set the'Accepted' condition to 'False' for the affected listener with a reason of'UnsupportedProtocol'. Implementations MAY also accept HTTP/2 connectionswith an upgrade from HTTP/1.Implementations supporting 'GRPCRoute' with the 'HTTP' 'ProtocolType' MUSTsupport HTTP/2 over cleartext TCP (h2c,https://www.rfc-editor.org/rfc/rfc7540#section-3.1) without an initialupgrade from HTTP/1.1, i.e. with prior knowledge(https://www.rfc-editor.org/rfc/rfc7540#section-3.4). If the implementationdoes not support this, then it MUST set the 'Accepted' condition to 'False'for the affected listener with a reason of 'UnsupportedProtocol'.Implementations MAY also accept HTTP/2 connections with an upgrade fromHTTP/1, i.e. without prior knowledge. --- # k8s_gateway_networking_k8s_io_grpc_route_v1_manifest (Data Source) diff --git a/docs/data-sources/gateway_networking_k8s_io_grpc_route_v1alpha2_manifest.md b/docs/data-sources/gateway_networking_k8s_io_grpc_route_v1alpha2_manifest.md index d39141e98..9947b90d2 100644 --- a/docs/data-sources/gateway_networking_k8s_io_grpc_route_v1alpha2_manifest.md +++ b/docs/data-sources/gateway_networking_k8s_io_grpc_route_v1alpha2_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_gateway_networking_k8s_io_grpc_route_v1alpha2_manifest Data Source - terraform-provider-k8s" subcategory: "gateway.networking.k8s.io" description: |- - GRPCRoute provides a way to route gRPC requests. This includes the capabilityto match requests by hostname, gRPC service, gRPC method, or HTTP/2 header.Filters can be used to specify additional processing steps. Backends specifywhere matching requests will be routed.GRPCRoute falls under extended support within the Gateway API. Within thefollowing specification, the word 'MUST' indicates that an implementationsupporting GRPCRoute must conform to the indicated requirement, but animplementation not supporting this route type need not follow the requirementunless explicitly indicated.Implementations supporting 'GRPCRoute' with the 'HTTPS' 'ProtocolType' MUSTaccept HTTP/2 connections without an initial upgrade from HTTP/1.1, i.e. viaALPN. If the implementation does not support this, then it MUST set the'Accepted' condition to 'False' for the affected listener with a reason of'UnsupportedProtocol'. Implementations MAY also accept HTTP/2 connectionswith an upgrade from HTTP/1.Implementations supporting 'GRPCRoute' with the 'HTTP' 'ProtocolType' MUSTsupport HTTP/2 over cleartext TCP (h2c,https://www.rfc-editor.org/rfc/rfc7540#section-3.1) without an initialupgrade from HTTP/1.1, i.e. with prior knowledge(. If the implementationdoes not support this, then it MUST set the 'Accepted' condition to 'False'for the affected listener with a reason of 'UnsupportedProtocol'.Implementations MAY also accept HTTP/2 connections with an upgrade fromHTTP/1, i.e. without prior knowledge. + GRPCRoute provides a way to route gRPC requests. This includes the capabilityto match requests by hostname, gRPC service, gRPC method, or HTTP/2 header.Filters can be used to specify additional processing steps. Backends specifywhere matching requests will be routed.GRPCRoute falls under extended support within the Gateway API. Within thefollowing specification, the word 'MUST' indicates that an implementationsupporting GRPCRoute must conform to the indicated requirement, but animplementation not supporting this route type need not follow the requirementunless explicitly indicated.Implementations supporting 'GRPCRoute' with the 'HTTPS' 'ProtocolType' MUSTaccept HTTP/2 connections without an initial upgrade from HTTP/1.1, i.e. viaALPN. If the implementation does not support this, then it MUST set the'Accepted' condition to 'False' for the affected listener with a reason of'UnsupportedProtocol'. Implementations MAY also accept HTTP/2 connectionswith an upgrade from HTTP/1.Implementations supporting 'GRPCRoute' with the 'HTTP' 'ProtocolType' MUSTsupport HTTP/2 over cleartext TCP (h2c,https://www.rfc-editor.org/rfc/rfc7540#section-3.1) without an initialupgrade from HTTP/1.1, i.e. with prior knowledge(https://www.rfc-editor.org/rfc/rfc7540#section-3.4). If the implementationdoes not support this, then it MUST set the 'Accepted' condition to 'False'for the affected listener with a reason of 'UnsupportedProtocol'.Implementations MAY also accept HTTP/2 connections with an upgrade fromHTTP/1, i.e. without prior knowledge. --- # k8s_gateway_networking_k8s_io_grpc_route_v1alpha2_manifest (Data Source) diff --git a/docs/data-sources/getambassador_io_module_v1_manifest.md b/docs/data-sources/getambassador_io_module_v1_manifest.md index 9413a8c0f..c393df6a8 100644 --- a/docs/data-sources/getambassador_io_module_v1_manifest.md +++ b/docs/data-sources/getambassador_io_module_v1_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_getambassador_io_module_v1_manifest Data Source - terraform-provider-k8s" subcategory: "getambassador.io" description: |- - A Module defines system-wide configuration. The type of module is controlled by the .metadata.name; valid names are 'ambassador' or 'tls'. + A Module defines system-wide configuration. The type of module is controlled by the .metadata.name; valid names are 'ambassador' or 'tls'. https://www.getambassador.io/docs/edge-stack/latest/topics/running/ambassador/#the-ambassador-module https://www.getambassador.io/docs/edge-stack/latest/topics/running/tls/#tls-module-deprecated --- # k8s_getambassador_io_module_v1_manifest (Data Source) diff --git a/docs/data-sources/getambassador_io_module_v2_manifest.md b/docs/data-sources/getambassador_io_module_v2_manifest.md index a8641f8ec..f18774e23 100644 --- a/docs/data-sources/getambassador_io_module_v2_manifest.md +++ b/docs/data-sources/getambassador_io_module_v2_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_getambassador_io_module_v2_manifest Data Source - terraform-provider-k8s" subcategory: "getambassador.io" description: |- - A Module defines system-wide configuration. The type of module is controlled by the .metadata.name; valid names are 'ambassador' or 'tls'. + A Module defines system-wide configuration. The type of module is controlled by the .metadata.name; valid names are 'ambassador' or 'tls'. https://www.getambassador.io/docs/edge-stack/latest/topics/running/ambassador/#the-ambassador-module https://www.getambassador.io/docs/edge-stack/latest/topics/running/tls/#tls-module-deprecated --- # k8s_getambassador_io_module_v2_manifest (Data Source) diff --git a/docs/data-sources/getambassador_io_module_v3alpha1_manifest.md b/docs/data-sources/getambassador_io_module_v3alpha1_manifest.md index a707b13f8..f540dc83e 100644 --- a/docs/data-sources/getambassador_io_module_v3alpha1_manifest.md +++ b/docs/data-sources/getambassador_io_module_v3alpha1_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_getambassador_io_module_v3alpha1_manifest Data Source - terraform-provider-k8s" subcategory: "getambassador.io" description: |- - A Module defines system-wide configuration. The type of module is controlled by the .metadata.name; valid names are 'ambassador' or 'tls'. + A Module defines system-wide configuration. The type of module is controlled by the .metadata.name; valid names are 'ambassador' or 'tls'. https://www.getambassador.io/docs/edge-stack/latest/topics/running/ambassador/#the-ambassador-module https://www.getambassador.io/docs/edge-stack/latest/topics/running/tls/#tls-module-deprecated --- # k8s_getambassador_io_module_v3alpha1_manifest (Data Source) diff --git a/docs/data-sources/hnc_x_k8s_io_hnc_configuration_v1alpha2_manifest.md b/docs/data-sources/hnc_x_k8s_io_hnc_configuration_v1alpha2_manifest.md index 92b8181ef..7b5e13e3c 100644 --- a/docs/data-sources/hnc_x_k8s_io_hnc_configuration_v1alpha2_manifest.md +++ b/docs/data-sources/hnc_x_k8s_io_hnc_configuration_v1alpha2_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_hnc_x_k8s_io_hnc_configuration_v1alpha2_manifest Data Source - terraform-provider-k8s" subcategory: "hnc.x-k8s.io" description: |- - HNCConfiguration is a cluster-wide configuration for HNC as a whole. See details in + HNCConfiguration is a cluster-wide configuration for HNC as a whole. See details in http://bit.ly/hnc-type-configuration --- # k8s_hnc_x_k8s_io_hnc_configuration_v1alpha2_manifest (Data Source) diff --git a/docs/data-sources/hnc_x_k8s_io_subnamespace_anchor_v1alpha2_manifest.md b/docs/data-sources/hnc_x_k8s_io_subnamespace_anchor_v1alpha2_manifest.md index 4fcf7eeb7..360a01194 100644 --- a/docs/data-sources/hnc_x_k8s_io_subnamespace_anchor_v1alpha2_manifest.md +++ b/docs/data-sources/hnc_x_k8s_io_subnamespace_anchor_v1alpha2_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_hnc_x_k8s_io_subnamespace_anchor_v1alpha2_manifest Data Source - terraform-provider-k8s" subcategory: "hnc.x-k8s.io" description: |- - SubnamespaceAnchor is the Schema for the subnamespace API. See details at . + SubnamespaceAnchor is the Schema for the subnamespace API. See details at http://bit.ly/hnc-self-serve-ux. --- # k8s_hnc_x_k8s_io_subnamespace_anchor_v1alpha2_manifest (Data Source) diff --git a/docs/data-sources/kyverno_io_policy_v1_manifest.md b/docs/data-sources/kyverno_io_policy_v1_manifest.md index 72c8fa84d..9b6f89097 100644 --- a/docs/data-sources/kyverno_io_policy_v1_manifest.md +++ b/docs/data-sources/kyverno_io_policy_v1_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_kyverno_io_policy_v1_manifest Data Source - terraform-provider-k8s" subcategory: "kyverno.io" description: |- - Policy declares validation, mutation, and generation behaviors for matching resources.See: for more information. + Policy declares validation, mutation, and generation behaviors for matching resources.See: https://kyverno.io/docs/writing-policies/ for more information. --- # k8s_kyverno_io_policy_v1_manifest (Data Source) diff --git a/docs/data-sources/kyverno_io_policy_v2beta1_manifest.md b/docs/data-sources/kyverno_io_policy_v2beta1_manifest.md index 0f9c50338..c8904b65c 100644 --- a/docs/data-sources/kyverno_io_policy_v2beta1_manifest.md +++ b/docs/data-sources/kyverno_io_policy_v2beta1_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_kyverno_io_policy_v2beta1_manifest Data Source - terraform-provider-k8s" subcategory: "kyverno.io" description: |- - Policy declares validation, mutation, and generation behaviors for matching resources.See: for more information. + Policy declares validation, mutation, and generation behaviors for matching resources.See: https://kyverno.io/docs/writing-policies/ for more information. --- # k8s_kyverno_io_policy_v2beta1_manifest (Data Source) diff --git a/docs/data-sources/persistent_volume_v1_manifest.md b/docs/data-sources/persistent_volume_v1_manifest.md index 20fe3c668..acc3c9bb7 100644 --- a/docs/data-sources/persistent_volume_v1_manifest.md +++ b/docs/data-sources/persistent_volume_v1_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_persistent_volume_v1_manifest Data Source - terraform-provider-k8s" subcategory: "core" description: |- - PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: + PersistentVolume (PV) is a storage resource provisioned by an administrator. It is analogous to a node. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes --- # k8s_persistent_volume_v1_manifest (Data Source) diff --git a/docs/data-sources/security_profiles_operator_x_k8s_io_seccomp_profile_v1beta1_manifest.md b/docs/data-sources/security_profiles_operator_x_k8s_io_seccomp_profile_v1beta1_manifest.md index 7fa36896e..0d14331af 100644 --- a/docs/data-sources/security_profiles_operator_x_k8s_io_seccomp_profile_v1beta1_manifest.md +++ b/docs/data-sources/security_profiles_operator_x_k8s_io_seccomp_profile_v1beta1_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_security_profiles_operator_x_k8s_io_seccomp_profile_v1beta1_manifest Data Source - terraform-provider-k8s" subcategory: "security-profiles-operator.x-k8s.io" description: |- - SeccompProfile is a cluster level specification for a seccomp profile.See + SeccompProfile is a cluster level specification for a seccomp profile.See https://github.com/opencontainers/runtime-spec/blob/master/config-linux.md#seccomp --- # k8s_security_profiles_operator_x_k8s_io_seccomp_profile_v1beta1_manifest (Data Source) diff --git a/docs/data-sources/stunner_l7mp_io_static_service_v1_manifest.md b/docs/data-sources/stunner_l7mp_io_static_service_v1_manifest.md index bf348e4f6..3580a1b8d 100644 --- a/docs/data-sources/stunner_l7mp_io_static_service_v1_manifest.md +++ b/docs/data-sources/stunner_l7mp_io_static_service_v1_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_stunner_l7mp_io_static_service_v1_manifest Data Source - terraform-provider-k8s" subcategory: "stunner.l7mp.io" description: |- - StaticService is a set of static IP address prefixes STUNner allows access to via a UDPRoute (or TCPRoute in the future). In contrast to Kubernetes Services, StaticServices expose all ports on the given IPs. See also . + StaticService is a set of static IP address prefixes STUNner allows access to via a UDPRoute (or TCPRoute in the future). In contrast to Kubernetes Services, StaticServices expose all ports on the given IPs. See also https://github.com/kubernetes/enhancements/pull/2611. --- # k8s_stunner_l7mp_io_static_service_v1_manifest (Data Source) diff --git a/docs/data-sources/tinkerbell_org_template_v1alpha2_manifest.md b/docs/data-sources/tinkerbell_org_template_v1alpha2_manifest.md index a423ac00e..38ebd57a5 100644 --- a/docs/data-sources/tinkerbell_org_template_v1alpha2_manifest.md +++ b/docs/data-sources/tinkerbell_org_template_v1alpha2_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_tinkerbell_org_template_v1alpha2_manifest Data Source - terraform-provider-k8s" subcategory: "tinkerbell.org" description: |- - Template defines a set of actions to be run on a target machine. The template is renderedprior to execution where it is exposed to Hardware and user defined data. Most fields within theTemplateSpec may contain templates values excluding .TemplateSpec.Actions[].Name.See for more details. + Template defines a set of actions to be run on a target machine. The template is renderedprior to execution where it is exposed to Hardware and user defined data. Most fields within theTemplateSpec may contain templates values excluding .TemplateSpec.Actions[].Name.See https://pkg.go.dev/text/template for more details. --- # k8s_tinkerbell_org_template_v1alpha2_manifest (Data Source) diff --git a/docs/data-sources/traefik_io_middleware_tcp_v1alpha1_manifest.md b/docs/data-sources/traefik_io_middleware_tcp_v1alpha1_manifest.md index 2df0186be..1f49c7c68 100644 --- a/docs/data-sources/traefik_io_middleware_tcp_v1alpha1_manifest.md +++ b/docs/data-sources/traefik_io_middleware_tcp_v1alpha1_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_traefik_io_middleware_tcp_v1alpha1_manifest Data Source - terraform-provider-k8s" subcategory: "traefik.io" description: |- - MiddlewareTCP is the CRD implementation of a Traefik TCP middleware.More info: + MiddlewareTCP is the CRD implementation of a Traefik TCP middleware.More info: https://doc.traefik.io/traefik/v3.0/middlewares/overview/ --- # k8s_traefik_io_middleware_tcp_v1alpha1_manifest (Data Source) diff --git a/docs/data-sources/traefik_io_middleware_v1alpha1_manifest.md b/docs/data-sources/traefik_io_middleware_v1alpha1_manifest.md index 5087af9b5..222189c69 100644 --- a/docs/data-sources/traefik_io_middleware_v1alpha1_manifest.md +++ b/docs/data-sources/traefik_io_middleware_v1alpha1_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_traefik_io_middleware_v1alpha1_manifest Data Source - terraform-provider-k8s" subcategory: "traefik.io" description: |- - Middleware is the CRD implementation of a Traefik Middleware.More info: + Middleware is the CRD implementation of a Traefik Middleware.More info: https://doc.traefik.io/traefik/v3.0/middlewares/http/overview/ --- # k8s_traefik_io_middleware_v1alpha1_manifest (Data Source) diff --git a/docs/data-sources/traefik_io_servers_transport_tcp_v1alpha1_manifest.md b/docs/data-sources/traefik_io_servers_transport_tcp_v1alpha1_manifest.md index cb6873772..ccf0a4b8e 100644 --- a/docs/data-sources/traefik_io_servers_transport_tcp_v1alpha1_manifest.md +++ b/docs/data-sources/traefik_io_servers_transport_tcp_v1alpha1_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_traefik_io_servers_transport_tcp_v1alpha1_manifest Data Source - terraform-provider-k8s" subcategory: "traefik.io" description: |- - ServersTransportTCP is the CRD implementation of a TCPServersTransport.If no tcpServersTransport is specified, a default one named default@internal will be used.The default@internal tcpServersTransport can be configured in the static configuration.More info: + ServersTransportTCP is the CRD implementation of a TCPServersTransport.If no tcpServersTransport is specified, a default one named default@internal will be used.The default@internal tcpServersTransport can be configured in the static configuration.More info: https://doc.traefik.io/traefik/v3.0/routing/services/#serverstransport_3 --- # k8s_traefik_io_servers_transport_tcp_v1alpha1_manifest (Data Source) diff --git a/docs/data-sources/traefik_io_servers_transport_v1alpha1_manifest.md b/docs/data-sources/traefik_io_servers_transport_v1alpha1_manifest.md index bcfb08b65..5fb513cea 100644 --- a/docs/data-sources/traefik_io_servers_transport_v1alpha1_manifest.md +++ b/docs/data-sources/traefik_io_servers_transport_v1alpha1_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_traefik_io_servers_transport_v1alpha1_manifest Data Source - terraform-provider-k8s" subcategory: "traefik.io" description: |- - ServersTransport is the CRD implementation of a ServersTransport.If no serversTransport is specified, the default@internal will be used.The default@internal serversTransport is created from the static configuration.More info: + ServersTransport is the CRD implementation of a ServersTransport.If no serversTransport is specified, the default@internal will be used.The default@internal serversTransport is created from the static configuration.More info: https://doc.traefik.io/traefik/v3.0/routing/services/#serverstransport_1 --- # k8s_traefik_io_servers_transport_v1alpha1_manifest (Data Source) diff --git a/docs/data-sources/traefik_io_tls_option_v1alpha1_manifest.md b/docs/data-sources/traefik_io_tls_option_v1alpha1_manifest.md index 8d13c5ed7..82ea7f64e 100644 --- a/docs/data-sources/traefik_io_tls_option_v1alpha1_manifest.md +++ b/docs/data-sources/traefik_io_tls_option_v1alpha1_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_traefik_io_tls_option_v1alpha1_manifest Data Source - terraform-provider-k8s" subcategory: "traefik.io" description: |- - TLSOption is the CRD implementation of a Traefik TLS Option, allowing to configure some parameters of the TLS connection.More info: + TLSOption is the CRD implementation of a Traefik TLS Option, allowing to configure some parameters of the TLS connection.More info: https://doc.traefik.io/traefik/v3.0/https/tls/#tls-options --- # k8s_traefik_io_tls_option_v1alpha1_manifest (Data Source) diff --git a/docs/data-sources/traefik_io_tls_store_v1alpha1_manifest.md b/docs/data-sources/traefik_io_tls_store_v1alpha1_manifest.md index f1934f988..5ac97c6c5 100644 --- a/docs/data-sources/traefik_io_tls_store_v1alpha1_manifest.md +++ b/docs/data-sources/traefik_io_tls_store_v1alpha1_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_traefik_io_tls_store_v1alpha1_manifest Data Source - terraform-provider-k8s" subcategory: "traefik.io" description: |- - TLSStore is the CRD implementation of a Traefik TLS Store.For the time being, only the TLSStore named default is supported.This means that you cannot have two stores that are named default in different Kubernetes namespaces.More info: + TLSStore is the CRD implementation of a Traefik TLS Store.For the time being, only the TLSStore named default is supported.This means that you cannot have two stores that are named default in different Kubernetes namespaces.More info: https://doc.traefik.io/traefik/v3.0/https/tls/#certificates-stores --- # k8s_traefik_io_tls_store_v1alpha1_manifest (Data Source) diff --git a/docs/data-sources/traefik_io_traefik_service_v1alpha1_manifest.md b/docs/data-sources/traefik_io_traefik_service_v1alpha1_manifest.md index 6e82600ba..d6b047acb 100644 --- a/docs/data-sources/traefik_io_traefik_service_v1alpha1_manifest.md +++ b/docs/data-sources/traefik_io_traefik_service_v1alpha1_manifest.md @@ -3,7 +3,7 @@ page_title: "k8s_traefik_io_traefik_service_v1alpha1_manifest Data Source - terraform-provider-k8s" subcategory: "traefik.io" description: |- - TraefikService is the CRD implementation of a Traefik Service.TraefikService object allows to:- Apply weight to Services on load-balancing- Mirror traffic on servicesMore info: + TraefikService is the CRD implementation of a Traefik Service.TraefikService object allows to:- Apply weight to Services on load-balancing- Mirror traffic on servicesMore info: https://doc.traefik.io/traefik/v3.0/routing/providers/kubernetes-crd/#kind-traefikservice --- # k8s_traefik_io_traefik_service_v1alpha1_manifest (Data Source) From a975fe2705193f924debc590d1e78b25882d3f57 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebastian=20Ho=C3=9F?= Date: Thu, 25 Apr 2024 06:42:25 +0200 Subject: [PATCH 3/3] re-generate docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Sebastian Hoß --- .../apps_stateful_set_v1_manifest.md | 100 ------------------ 1 file changed, 100 deletions(-) diff --git a/docs/data-sources/apps_stateful_set_v1_manifest.md b/docs/data-sources/apps_stateful_set_v1_manifest.md index ba4c396b2..6e7fac34a 100644 --- a/docs/data-sources/apps_stateful_set_v1_manifest.md +++ b/docs/data-sources/apps_stateful_set_v1_manifest.md @@ -3576,63 +3576,7 @@ Optional: Optional: -- `api_version` (String) APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources -- `kind` (String) Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -- `metadata` (Attributes) ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. (see [below for nested schema](#nestedatt--spec--volume_claim_templates--metadata)) - `spec` (Attributes) PersistentVolumeClaimSpec describes the common attributes of storage devices and allows a Source for provider-specific attributes (see [below for nested schema](#nestedatt--spec--volume_claim_templates--spec)) -- `status` (Attributes) PersistentVolumeClaimStatus is the current status of a persistent volume claim. (see [below for nested schema](#nestedatt--spec--volume_claim_templates--status)) - - -### Nested Schema for `spec.volume_claim_templates.metadata` - -Optional: - -- `annotations` (Map of String) Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations -- `creation_timestamp` (String) Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. -- `deletion_grace_period_seconds` (Number) Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only. -- `deletion_timestamp` (String) Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. -- `finalizers` (List of String) Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list. -- `generate_name` (String) GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.If this field is specified and the generated name exists, the server will return a 409.Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency -- `generation` (Number) A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. -- `labels` (Map of String) Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels -- `managed_fields` (Attributes List) ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like 'ci-cd'. The set of fields is always in the version that the workflow used when modifying the object. (see [below for nested schema](#nestedatt--spec--volume_claim_templates--metadata--managed_fields)) -- `name` (String) Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names -- `namespace` (String) Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the 'default' namespace, but 'default' is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces -- `owner_references` (Attributes List) List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller. (see [below for nested schema](#nestedatt--spec--volume_claim_templates--metadata--owner_references)) -- `resource_version` (String) An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency -- `self_link` (String) Deprecated: selfLink is a legacy read-only field that is no longer populated by the system. -- `uid` (String) UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids - - -### Nested Schema for `spec.volume_claim_templates.metadata.managed_fields` - -Optional: - -- `api_version` (String) APIVersion defines the version of this resource that this field set applies to. The format is 'group/version' just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted. -- `fields_type` (String) FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: 'FieldsV1' -- `fields_v1` (Map of String) FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats: 'f:', where is the name of a field in a struct, or key in a map 'v:', where is the exact json formatted value of a list item 'i:', where is position of a item in a list 'k:', where is a map of a list item's key fields to their unique values If a key maps to an empty Fields value, the field that key represents is part of the set.The exact format is defined in sigs.k8s.io/structured-merge-diff -- `manager` (String) Manager is an identifier of the workflow managing these fields. -- `operation` (String) Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'. -- `subresource` (String) Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource. -- `time` (String) Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. - - - -### Nested Schema for `spec.volume_claim_templates.metadata.owner_references` - -Required: - -- `api_version` (String) API version of the referent. -- `kind` (String) Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds -- `name` (String) Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names -- `uid` (String) UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids - -Optional: - -- `block_owner_deletion` (Boolean) If true, AND if the owner has the 'foregroundDeletion' finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs 'delete' permission of the owner, otherwise 422 (Unprocessable Entity) will be returned. -- `controller` (Boolean) If true, this reference points to the managing controller. - - ### Nested Schema for `spec.volume_claim_templates.spec` @@ -3704,47 +3648,3 @@ Required: Optional: - `values` (List of String) values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. - - - - - -### Nested Schema for `spec.volume_claim_templates.status` - -Optional: - -- `access_modes` (List of String) accessModes contains the actual access modes the volume backing the PVC has. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 -- `allocated_resource_statuses` (Map of String) allocatedResourceStatuses stores status of resource being resized for the given PVC. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as 'example.com/my-custom-resource'Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used.ClaimResourceStatus can be in any of following states: - ControllerResizeInProgress: State set when resize controller starts resizing the volume in control-plane. - ControllerResizeFailed: State set when resize has failed in resize controller with a terminal error. - NodeResizePending: State set when resize controller has finished resizing the volume but further resizing of volume is needed on the node. - NodeResizeInProgress: State set when kubelet starts resizing the volume. - NodeResizeFailed: State set when resizing has failed in kubelet with a terminal error. Transient errors don't set NodeResizeFailed.For example: if expanding a PVC for more capacity - this field can be one of the following states: - pvc.status.allocatedResourceStatus['storage'] = 'ControllerResizeInProgress' - pvc.status.allocatedResourceStatus['storage'] = 'ControllerResizeFailed' - pvc.status.allocatedResourceStatus['storage'] = 'NodeResizePending' - pvc.status.allocatedResourceStatus['storage'] = 'NodeResizeInProgress' - pvc.status.allocatedResourceStatus['storage'] = 'NodeResizeFailed'When this field is not set, it means that no resize operation is in progress for the given PVC.A controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC.This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature. -- `allocated_resources` (Map of String) allocatedResources tracks the resources allocated to a PVC including its capacity. Key names follow standard Kubernetes label syntax. Valid values are either: * Un-prefixed keys: - storage - the capacity of the volume. * Custom resources must use implementation-defined prefixed names such as 'example.com/my-custom-resource'Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered reserved and hence may not be used.Capacity reported here may be larger than the actual capacity when a volume expansion operation is requested. For storage quota, the larger value from allocatedResources and PVC.spec.resources is used. If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation. If a volume expansion capacity request is lowered, allocatedResources is only lowered if there are no expansion operations in progress and if the actual volume capacity is equal or lower than the requested capacity.A controller that receives PVC update with previously unknown resourceName should ignore the update for the purpose it was designed. For example - a controller that only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid resources associated with PVC.This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature. -- `capacity` (Map of String) capacity represents the actual resources of the underlying volume. -- `conditions` (Attributes List) conditions is the current Condition of persistent volume claim. If underlying persistent volume is being resized then the Condition will be set to 'Resizing'. (see [below for nested schema](#nestedatt--spec--volume_claim_templates--status--conditions)) -- `current_volume_attributes_class_name` (String) currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim This is an alpha field and requires enabling VolumeAttributesClass feature. -- `modify_volume_status` (Attributes) ModifyVolumeStatus represents the status object of ControllerModifyVolume operation (see [below for nested schema](#nestedatt--spec--volume_claim_templates--status--modify_volume_status)) -- `phase` (String) phase represents the current phase of PersistentVolumeClaim. - - -### Nested Schema for `spec.volume_claim_templates.status.conditions` - -Required: - -- `status` (String) -- `type` (String) - -Optional: - -- `last_probe_time` (String) Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. -- `last_transition_time` (String) Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. -- `message` (String) message is the human-readable message indicating details about last transition. -- `reason` (String) reason is a unique, this should be a short, machine understandable string that gives the reason for condition's last transition. If it reports 'Resizing' that means the underlying persistent volume is being resized. - - - -### Nested Schema for `spec.volume_claim_templates.status.modify_volume_status` - -Required: - -- `status` (String) status is the status of the ControllerModifyVolume operation. It can be in any of following states: - Pending Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as the specified VolumeAttributesClass not existing. - InProgress InProgress indicates that the volume is being modified. - Infeasible Infeasible indicates that the request has been rejected as invalid by the CSI driver. To resolve the error, a valid VolumeAttributesClass needs to be specified.Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately. - -Optional: - -- `target_volume_attributes_class_name` (String) targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled