Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix eamples & re-generate code/docs #196

Merged
merged 5 commits into from
Sep 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Optional:
Required:

- `composite_type_ref` (Attributes) CompositeTypeRef specifies the type of composite resource that thiscomposition is compatible with. (see [below for nested schema](#nestedatt--spec--composite_type_ref))
- `revision` (Number) Revision number. Newer revisions have larger numbers.This number can change. When a Composition transitions from state A-> B -> A there will be only two CompositionRevisions. Crossplane willedit the original CompositionRevision to change its revision number from0 to 2.
- `revision` (Number) Revision number. Newer revisions have larger numbers.

Optional:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Optional:
Required:

- `composite_type_ref` (Attributes) CompositeTypeRef specifies the type of composite resource that thiscomposition is compatible with. (see [below for nested schema](#nestedatt--spec--composite_type_ref))
- `revision` (Number) Revision number. Newer revisions have larger numbers.This number can change. When a Composition transitions from state A-> B -> A there will be only two CompositionRevisions. Crossplane willedit the original CompositionRevision to change its revision number from0 to 2.
- `revision` (Number) Revision number. Newer revisions have larger numbers.

Optional:

Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ Optional:

- `label_selector` (Attributes) LabelSelector is used to find matching pods.Pods that match this label selector are counted to determine the number of podsin their corresponding topology domain. (see [below for nested schema](#nestedatt--spec--dividing_scheduling--dynamic_dividing--topology_spread_constraints--label_selector))
- `match_label_keys` (List of String) MatchLabelKeys is a set of pod label keys to select the pods over whichspreading will be calculated. The keys are used to lookup values from theincoming pod labels, those key-value labels are ANDed with labelSelectorto select the group of existing pods over which spreading will be calculatedfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.MatchLabelKeys cannot be set when LabelSelector isn't set.Keys that don't exist in the incoming pod labels willbe ignored. A null or empty list means only match against labelSelector.This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).
- `min_domains` (Number) MinDomains indicates a minimum number of eligible domains.When the number of eligible domains with matching topology keys is less than minDomains,Pod Topology Spread treats 'global minimum' as 0, and then the calculation of Skew is performed.And when the number of eligible domains with matching topology keys equals or greater than minDomains,this value has no effect on scheduling.As a result, when the number of eligible domains is less than minDomains,scheduler won't schedule more than maxSkew Pods to those domains.If value is nil, the constraint behaves as if MinDomains is equal to 1.Valid values are integers greater than 0.When value is not nil, WhenUnsatisfiable must be DoNotSchedule.For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the samelabelSelector spread as 2/2/2:| zone1 | zone2 | zone3 || P P | P P | P P |The number of domains is less than 5(MinDomains), so 'global minimum' is treated as 0.In this situation, new pod with the same labelSelector cannot be scheduled,because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,it will violate MaxSkew.
- `min_domains` (Number) MinDomains indicates a minimum number of eligible domains.When the number of eligible domains with matching topology keys is less than minDomains,Pod Topology Spread treats 'global minimum' as 0, and then the calculation of Skew is performed.And when the number of eligible domains with matching topology keys equals or greater than minDomains,this value has no effect on scheduling.As a result, when the number of eligible domains is less than minDomains,scheduler won't schedule more than maxSkew Pods to those domains.If value is nil, the constraint behaves as if MinDomains is equal to 1.Valid values are integers greater than 0.When value is not nil, WhenUnsatisfiable must be DoNotSchedule.For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the samelabelSelector spread as 2/2/2:| zone1 | zone2 | zone3 || P P | P P | P P |The number of domains is less than 5(MinDomains), so 'global minimum' is treated as 0.In this situation, new pod with the same labelSelector cannot be scheduled,because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,it will violate MaxSkew.This is a beta field and requires the MinDomainsInPodTopologySpread feature gate to be enabled (enabled by default).
- `node_affinity_policy` (String) NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelectorwhen calculating pod topology spread skew. Options are:- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.If this value is nil, the behavior is equivalent to the Honor policy.This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
- `node_taints_policy` (String) NodeTaintsPolicy indicates how we will treat node taints when calculatingpod topology spread skew. Options are:- Honor: nodes without taints, along with tainted nodes for which the incoming podhas a toleration, are included.- Ignore: node taints are ignored. All nodes are included.If this value is nil, the behavior is equivalent to the Ignore policy.This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Optional:

Required:

- `comp_def` (String) Specifies the exact name, name prefix, or regular expression pattern for matching the name of the ComponentDefinitioncustom resource (CR) that defines the Component's characteristics and behavior.The system selects the ComponentDefinition CR with the latest version that matches the pattern.This approach allows:1. Precise selection by providing the exact name of a ComponentDefinition CR.2. Flexible and automatic selection of the most up-to-date ComponentDefinition CR by specifying a name prefix or regular expression pattern.Once set, this field cannot be updated.
- `comp_def` (String) Specifies the name or prefix of the ComponentDefinition custom resource(CR) thatdefines the Component's characteristics and behavior.When a prefix is used, the system selects the ComponentDefinition CR with the latest version that matches the prefix.This approach allows:1. Precise selection by providing the exact name of a ComponentDefinition CR.2. Flexible and automatic selection of the most up-to-date ComponentDefinition CR by specifying a prefix.Once set, this field cannot be updated.
- `name` (String) Defines the unique identifier of the component within the cluster topology.It follows IANA Service naming rules and is used as part of the Service's DNS name.The name must start with a lowercase letter, can contain lowercase letters, numbers,and hyphens, and must end with a lowercase letter or number.Cannot be updated once set.


Expand Down
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. Warning: Halt policy is deprecated in 0.9.1 and will have same meaning as DoNotTerminate.- '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.- '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.

Optional:

Expand Down Expand Up @@ -116,7 +116,7 @@ Optional:

- `affinity` (Attributes) Specifies a group of affinity scheduling rules for the Component.It allows users to control how the Component's Pods are scheduled onto nodes in the K8s cluster.Deprecated since v0.10, replaced by the 'schedulingPolicy' field. (see [below for nested schema](#nestedatt--spec--component_specs--affinity))
- `annotations` (Map of String) Specifies Annotations to override or add for underlying Pods.
- `component_def` (String) Specifies the exact name, name prefix, or regular expression pattern for matching the name of the ComponentDefinitioncustom resource (CR) that defines the Component's characteristics and behavior.If both 'componentDefRef' and 'componentDef' are provided,the 'componentDef' will take precedence over 'componentDefRef'.
- `component_def` (String) References the name of a ComponentDefinition object.The ComponentDefinition specifies the behavior and characteristics of the Component.If both 'componentDefRef' and 'componentDef' are provided,the 'componentDef' will take precedence over 'componentDefRef'.
- `component_def_ref` (String) References a ClusterComponentDefinition defined in the 'clusterDefinition.spec.componentDef' field.Must comply with the IANA service naming rule.Deprecated since v0.9,because defining Components in 'clusterDefinition.spec.componentDef' field has been deprecated.This field is replaced by the 'componentDef' field, use 'componentDef' instead.This field is maintained for backward compatibility and its use is discouraged.Existing usage should be updated to the current preferred approach to avoid compatibility issues in future releases.TODO +kubebuilder:validation:XValidation:rule='self == oldSelf',message='componentDefRef is immutable'
- `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.
Expand Down Expand Up @@ -3688,7 +3688,7 @@ Optional:

- `affinity` (Attributes) Specifies a group of affinity scheduling rules for the Component.It allows users to control how the Component's Pods are scheduled onto nodes in the K8s cluster.Deprecated since v0.10, replaced by the 'schedulingPolicy' field. (see [below for nested schema](#nestedatt--spec--sharding_specs--template--affinity))
- `annotations` (Map of String) Specifies Annotations to override or add for underlying Pods.
- `component_def` (String) Specifies the exact name, name prefix, or regular expression pattern for matching the name of the ComponentDefinitioncustom resource (CR) that defines the Component's characteristics and behavior.If both 'componentDefRef' and 'componentDef' are provided,the 'componentDef' will take precedence over 'componentDefRef'.
- `component_def` (String) References the name of a ComponentDefinition object.The ComponentDefinition specifies the behavior and characteristics of the Component.If both 'componentDefRef' and 'componentDef' are provided,the 'componentDef' will take precedence over 'componentDefRef'.
- `component_def_ref` (String) References a ClusterComponentDefinition defined in the 'clusterDefinition.spec.componentDef' field.Must comply with the IANA service naming rule.Deprecated since v0.9,because defining Components in 'clusterDefinition.spec.componentDef' field has been deprecated.This field is replaced by the 'componentDef' field, use 'componentDef' instead.This field is maintained for backward compatibility and its use is discouraged.Existing usage should be updated to the current preferred approach to avoid compatibility issues in future releases.TODO +kubebuilder:validation:XValidation:rule='self == oldSelf',message='componentDefRef is immutable'
- `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.
Expand Down
Loading
Loading