Skip to content

Commit

Permalink
re-generate
Browse files Browse the repository at this point in the history
Signed-off-by: Sebastian Hoß <[email protected]>
  • Loading branch information
sebhoss committed Sep 27, 2024
1 parent 86f8c85 commit 6c3b36c
Show file tree
Hide file tree
Showing 113 changed files with 9,105 additions and 19,692 deletions.
11 changes: 4 additions & 7 deletions docs/data-sources/acme_cert_manager_io_challenge_v1_manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -338,16 +338,13 @@ Optional:
<a id="nestedatt--spec--solver--dns01--route53"></a>
### Nested Schema for `spec.solver.dns01.route53`

Required:

- `region` (String) Always set the region when using AccessKeyID and SecretAccessKey

Optional:

- `access_key_id` (String) The AccessKeyID is used for authentication. Cannot be set when SecretAccessKeyID is set. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials
- `access_key_id_secret_ref` (Attributes) The SecretAccessKey is used for authentication. If set, pull the AWS access key ID from a key within a Kubernetes Secret. Cannot be set when AccessKeyID is set. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials (see [below for nested schema](#nestedatt--spec--solver--dns01--route53--access_key_id_secret_ref))
- `auth` (Attributes) Auth configures how cert-manager authenticates. (see [below for nested schema](#nestedatt--spec--solver--dns01--route53--auth))
- `hosted_zone_id` (String) If set, the provider will manage only this zone in Route53 and will not do an lookup using the route53:ListHostedZonesByName api call.
- `hosted_zone_id` (String) If set, the provider will manage only this zone in Route53 and will not do a lookup using the route53:ListHostedZonesByName api call.
- `region` (String) Override the AWS region. Route53 is a global service and does not have regional endpoints but the region specified here (or via environment variables) is used as a hint to help compute the correct AWS credential scope and partition when it connects to Route53. See: - [Amazon Route 53 endpoints and quotas](https://docs.aws.amazon.com/general/latest/gr/r53.html) - [Global services](https://docs.aws.amazon.com/whitepapers/latest/aws-fault-isolation-boundaries/global-services.html) If you omit this region field, cert-manager will use the region from AWS_REGION and AWS_DEFAULT_REGION environment variables, if they are set in the cert-manager controller Pod. The 'region' field is not needed if you use [IAM Roles for Service Accounts (IRSA)](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html). Instead an AWS_REGION environment variable is added to the cert-manager controller Pod by: [Amazon EKS Pod Identity Webhook](https://github.com/aws/amazon-eks-pod-identity-webhook). In this case this 'region' field value is ignored. The 'region' field is not needed if you use [EKS Pod Identities](https://docs.aws.amazon.com/eks/latest/userguide/pod-identities.html). Instead an AWS_REGION environment variable is added to the cert-manager controller Pod by: [Amazon EKS Pod Identity Agent](https://github.com/aws/eks-pod-identity-agent), In this case this 'region' field value is ignored.
- `role` (String) Role is a Role ARN which the Route53 provider will assume using either the explicit credentials AccessKeyID/SecretAccessKey or the inferred credentials from environment variables, shared credentials file or AWS Instance metadata
- `secret_access_key_secret_ref` (Attributes) The SecretAccessKey is used for authentication. If neither the Access Key nor Key ID are set, we fall-back to using env vars, shared credentials file or AWS Instance metadata, see: https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html#specifying-credentials (see [below for nested schema](#nestedatt--spec--solver--dns01--route53--secret_access_key_secret_ref))

Expand Down Expand Up @@ -465,7 +462,7 @@ Optional:

Optional:

- `annotations` (Map of String) Annotations that should be added to the create ACME HTTP01 solver pods.
- `annotations` (Map of String) Annotations that should be added to the created ACME HTTP01 solver pods.
- `labels` (Map of String) Labels that should be added to the created ACME HTTP01 solver pods.


Expand Down Expand Up @@ -977,7 +974,7 @@ Optional:

Optional:

- `annotations` (Map of String) Annotations that should be added to the create ACME HTTP01 solver pods.
- `annotations` (Map of String) Annotations that should be added to the created ACME HTTP01 solver pods.
- `labels` (Map of String) Labels that should be added to the created ACME HTTP01 solver pods.


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -208,12 +208,13 @@ Required:
- `acmesolver` (Attributes) (see [below for nested schema](#nestedatt--spec--versions_bundles--cert_manager--acmesolver))
- `cainjector` (Attributes) (see [below for nested schema](#nestedatt--spec--versions_bundles--cert_manager--cainjector))
- `controller` (Attributes) (see [below for nested schema](#nestedatt--spec--versions_bundles--cert_manager--controller))
- `ctl` (Attributes) (see [below for nested schema](#nestedatt--spec--versions_bundles--cert_manager--ctl))
- `manifest` (Attributes) (see [below for nested schema](#nestedatt--spec--versions_bundles--cert_manager--manifest))
- `startupapicheck` (Attributes) (see [below for nested schema](#nestedatt--spec--versions_bundles--cert_manager--startupapicheck))
- `webhook` (Attributes) (see [below for nested schema](#nestedatt--spec--versions_bundles--cert_manager--webhook))

Optional:

- `ctl` (Attributes) This field has been deprecated (see [below for nested schema](#nestedatt--spec--versions_bundles--cert_manager--ctl))
- `version` (String)

<a id="nestedatt--spec--versions_bundles--cert_manager--acmesolver"></a>
Expand Down Expand Up @@ -258,8 +259,16 @@ Optional:
- `uri` (String) The image repository, name, and tag


<a id="nestedatt--spec--versions_bundles--cert_manager--ctl"></a>
### Nested Schema for `spec.versions_bundles.cert_manager.ctl`
<a id="nestedatt--spec--versions_bundles--cert_manager--manifest"></a>
### Nested Schema for `spec.versions_bundles.cert_manager.manifest`

Optional:

- `uri` (String) URI points to the manifest yaml file


<a id="nestedatt--spec--versions_bundles--cert_manager--startupapicheck"></a>
### Nested Schema for `spec.versions_bundles.cert_manager.startupapicheck`

Optional:

Expand All @@ -272,16 +281,22 @@ Optional:
- `uri` (String) The image repository, name, and tag


<a id="nestedatt--spec--versions_bundles--cert_manager--manifest"></a>
### Nested Schema for `spec.versions_bundles.cert_manager.manifest`
<a id="nestedatt--spec--versions_bundles--cert_manager--webhook"></a>
### Nested Schema for `spec.versions_bundles.cert_manager.webhook`

Optional:

- `uri` (String) URI points to the manifest yaml file
- `arch` (List of String) Architectures of the asset
- `description` (String)
- `image_digest` (String) The SHA256 digest of the image manifest
- `name` (String) The asset name
- `os` (String) Operating system of the asset
- `os_name` (String) Name of the OS like ubuntu, bottlerocket
- `uri` (String) The image repository, name, and tag


<a id="nestedatt--spec--versions_bundles--cert_manager--webhook"></a>
### Nested Schema for `spec.versions_bundles.cert_manager.webhook`
<a id="nestedatt--spec--versions_bundles--cert_manager--ctl"></a>
### Nested Schema for `spec.versions_bundles.cert_manager.ctl`

Optional:

Expand Down
10 changes: 5 additions & 5 deletions docs/data-sources/apps_kubeblocks_io_cluster_v1_manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Optional:

Required:

- `termination_policy` (String) Specifies the behavior when a Cluster is deleted. It defines how resources, data, and backups associated with a Cluster are managed during termination. Choose a policy based on the desired level of resource cleanup and data preservation: - 'DoNotTerminate': Prevents deletion of the Cluster. This policy ensures that all resources remain intact. - 'Halt': Deletes Cluster resources like Pods and Services but retains Persistent Volume Claims (PVCs), allowing for data preservation while stopping other operations. - 'Delete': Extends the 'Halt' policy by also removing PVCs, leading to a thorough cleanup while removing all persistent data. - 'WipeOut': An aggressive policy that deletes all Cluster resources, including volume snapshots and backups in external storage. This results in complete data removal and should be used cautiously, primarily in non-production environments to avoid irreversible data loss. Warning: Choosing an inappropriate termination policy can result in data loss. The 'WipeOut' policy is particularly risky in production environments due to its irreversible nature.
- `termination_policy` (String) Specifies the behavior when a Cluster is deleted. It defines how resources, data, and backups associated with a Cluster are managed during termination. Choose a policy based on the desired level of resource cleanup and data preservation: - 'DoNotTerminate': Prevents deletion of the Cluster. This policy ensures that all resources remain intact. - 'Delete': Deletes all runtime resources belong to the Cluster. - 'WipeOut': An aggressive policy that deletes all Cluster resources, including volume snapshots and backups in external storage. This results in complete data removal and should be used cautiously, primarily in non-production environments to avoid irreversible data loss. Warning: Choosing an inappropriate termination policy can result in data loss. The 'WipeOut' policy is particularly risky in production environments due to its irreversible nature.

Optional:

Expand Down Expand Up @@ -94,14 +94,14 @@ Required:

Optional:

- `annotations` (Map of String) Specifies Annotations to override or add for underlying Pods.
- `annotations` (Map of String) Specifies Annotations to override or add for underlying Pods, PVCs, Account & TLS Secrets, Services Owned by Component.
- `component_def` (String) Specifies the ComponentDefinition custom resource (CR) that defines the Component's characteristics and behavior. Supports three different ways to specify the ComponentDefinition: - the regular expression - recommended - the full name - recommended - the name prefix
- `configs` (Attributes List) Specifies the configuration content of a config template. (see [below for nested schema](#nestedatt--spec--component_specs--configs))
- `disable_exporter` (Boolean) Determines whether metrics exporter information is annotated on the Component's headless Service. If set to true, the following annotations will not be patched into the Service: - 'monitor.kubeblocks.io/path' - 'monitor.kubeblocks.io/port' - 'monitor.kubeblocks.io/scheme' These annotations allow the Prometheus installed by KubeBlocks to discover and scrape metrics from the exporter.
- `env` (Attributes List) List of environment variables to add. These environment variables will be placed after the environment variables declared in the Pod. (see [below for nested schema](#nestedatt--spec--component_specs--env))
- `instances` (Attributes List) Allows for the customization of configuration values for each instance within a Component. An instance represent a single replica (Pod and associated K8s resources like PVCs, Services, and ConfigMaps). While instances typically share a common configuration as defined in the ClusterComponentSpec, they can require unique settings in various scenarios: For example: - A database Component might require different resource allocations for primary and secondary instances, with primaries needing more resources. - During a rolling upgrade, a Component may first update the image for one or a few instances, and then update the remaining instances after verifying that the updated instances are functioning correctly. InstanceTemplate allows for specifying these unique configurations per instance. Each instance's name is constructed using the pattern: $(component.name)-$(template.name)-$(ordinal), starting with an ordinal of 0. It is crucial to maintain unique names for each InstanceTemplate to avoid conflicts. The sum of replicas across all InstanceTemplates should not exceed the total number of replicas specified for the Component. Any remaining replicas will be generated using the default template and will follow the default naming rules. (see [below for nested schema](#nestedatt--spec--component_specs--instances))
- `issuer` (Attributes) Specifies the configuration for the TLS certificates issuer. It allows defining the issuer name and the reference to the secret containing the TLS certificates and key. The secret should contain the CA certificate, TLS certificate, and private key in the specified keys. Required when TLS is enabled. (see [below for nested schema](#nestedatt--spec--component_specs--issuer))
- `labels` (Map of String) Specifies Labels to override or add for underlying Pods.
- `labels` (Map of String) Specifies Labels to override or add for underlying Pods, PVCs, Account & TLS Secrets, Services Owned by Component.
- `name` (String) Specifies the Component's name. It's part of the Service DNS name and must comply with the IANA service naming rule. The name is optional when ClusterComponentSpec is used as a template (e.g., in 'shardingSpec'), but required otherwise.
- `offline_instances` (List of String) Specifies the names of instances to be transitioned to offline status. Marking an instance as offline results in the following: 1. The associated Pod is stopped, and its PersistentVolumeClaim (PVC) is retained for potential future reuse or data recovery, but it is no longer actively used. 2. The ordinal number assigned to this instance is preserved, ensuring it remains unique and avoiding conflicts with new instances. Setting instances to offline allows for a controlled scale-in process, preserving their data and maintaining ordinal consistency within the Cluster. Note that offline instances and their associated resources, such as PVCs, are not automatically deleted. The administrator must manually manage the cleanup and removal of these resources when they are no longer needed.
- `parallel_pod_management_concurrency` (String) Controls the concurrency of pods during initial scale up, when replacing pods on nodes, or when scaling down. It only used when 'PodManagementPolicy' is set to 'Parallel'. The default Concurrency is 100%.
Expand Down Expand Up @@ -3547,14 +3547,14 @@ Required:

Optional:

- `annotations` (Map of String) Specifies Annotations to override or add for underlying Pods.
- `annotations` (Map of String) Specifies Annotations to override or add for underlying Pods, PVCs, Account & TLS Secrets, Services Owned by Component.
- `component_def` (String) Specifies the ComponentDefinition custom resource (CR) that defines the Component's characteristics and behavior. Supports three different ways to specify the ComponentDefinition: - the regular expression - recommended - the full name - recommended - the name prefix
- `configs` (Attributes List) Specifies the configuration content of a config template. (see [below for nested schema](#nestedatt--spec--sharding_specs--template--configs))
- `disable_exporter` (Boolean) Determines whether metrics exporter information is annotated on the Component's headless Service. If set to true, the following annotations will not be patched into the Service: - 'monitor.kubeblocks.io/path' - 'monitor.kubeblocks.io/port' - 'monitor.kubeblocks.io/scheme' These annotations allow the Prometheus installed by KubeBlocks to discover and scrape metrics from the exporter.
- `env` (Attributes List) List of environment variables to add. These environment variables will be placed after the environment variables declared in the Pod. (see [below for nested schema](#nestedatt--spec--sharding_specs--template--env))
- `instances` (Attributes List) Allows for the customization of configuration values for each instance within a Component. An instance represent a single replica (Pod and associated K8s resources like PVCs, Services, and ConfigMaps). While instances typically share a common configuration as defined in the ClusterComponentSpec, they can require unique settings in various scenarios: For example: - A database Component might require different resource allocations for primary and secondary instances, with primaries needing more resources. - During a rolling upgrade, a Component may first update the image for one or a few instances, and then update the remaining instances after verifying that the updated instances are functioning correctly. InstanceTemplate allows for specifying these unique configurations per instance. Each instance's name is constructed using the pattern: $(component.name)-$(template.name)-$(ordinal), starting with an ordinal of 0. It is crucial to maintain unique names for each InstanceTemplate to avoid conflicts. The sum of replicas across all InstanceTemplates should not exceed the total number of replicas specified for the Component. Any remaining replicas will be generated using the default template and will follow the default naming rules. (see [below for nested schema](#nestedatt--spec--sharding_specs--template--instances))
- `issuer` (Attributes) Specifies the configuration for the TLS certificates issuer. It allows defining the issuer name and the reference to the secret containing the TLS certificates and key. The secret should contain the CA certificate, TLS certificate, and private key in the specified keys. Required when TLS is enabled. (see [below for nested schema](#nestedatt--spec--sharding_specs--template--issuer))
- `labels` (Map of String) Specifies Labels to override or add for underlying Pods.
- `labels` (Map of String) Specifies Labels to override or add for underlying Pods, PVCs, Account & TLS Secrets, Services Owned by Component.
- `name` (String) Specifies the Component's name. It's part of the Service DNS name and must comply with the IANA service naming rule. The name is optional when ClusterComponentSpec is used as a template (e.g., in 'shardingSpec'), but required otherwise.
- `offline_instances` (List of String) Specifies the names of instances to be transitioned to offline status. Marking an instance as offline results in the following: 1. The associated Pod is stopped, and its PersistentVolumeClaim (PVC) is retained for potential future reuse or data recovery, but it is no longer actively used. 2. The ordinal number assigned to this instance is preserved, ensuring it remains unique and avoiding conflicts with new instances. Setting instances to offline allows for a controlled scale-in process, preserving their data and maintaining ordinal consistency within the Cluster. Note that offline instances and their associated resources, such as PVCs, are not automatically deleted. The administrator must manually manage the cleanup and removal of these resources when they are no longer needed.
- `parallel_pod_management_concurrency` (String) Controls the concurrency of pods during initial scale up, when replacing pods on nodes, or when scaling down. It only used when 'PodManagementPolicy' is set to 'Parallel'. The default Concurrency is 100%.
Expand Down
Loading

0 comments on commit 6c3b36c

Please sign in to comment.