diff --git a/deploy/helm/hbase-operator/crds/crds.yaml b/deploy/helm/hbase-operator/crds/crds.yaml index c2030665..fca35132 100644 --- a/deploy/helm/hbase-operator/crds/crds.yaml +++ b/deploy/helm/hbase-operator/crds/crds.yaml @@ -114,6 +114,12 @@ spec: type: string type: object masters: + description: |- + This struct represents a role - e.g. HDFS datanodes or Trino workers. It has a [`HashMap`] containing all the roleGroups that are part of this role. Additionally, there is a `config`, which is configurable at the role *and* roleGroup level. Everything at roleGroup level is merged on top of what is configured on role level using the [`Merge`] trait. There is also a second form of config, which can only be configured at role level, the `roleConfig`. + + `T` here is the `config` shared between role and roleGroup. + + `U` here is the `roleConfig` only available on the role. It defaults to [`GenericRoleConfig`], as this is sufficient for most products. There are some exceptions, where e.g. [`EmptyRoleConfig`] is used. However, product-operators can define their own - custom - struct and use that here. nullable: true properties: cliOverrides: @@ -3529,6 +3535,10 @@ spec: podDisruptionBudget: enabled: true maxUnavailable: null + description: |- + This is a product-agnostic RoleConfig, which fulfills the needs for most of the product. Currently it contains: + + 1. `podDisruptionBudget` to configure the created PDBs. properties: podDisruptionBudget: default: @@ -7000,6 +7010,12 @@ spec: - roleGroups type: object regionServers: + description: |- + This struct represents a role - e.g. HDFS datanodes or Trino workers. It has a [`HashMap`] containing all the roleGroups that are part of this role. Additionally, there is a `config`, which is configurable at the role *and* roleGroup level. Everything at roleGroup level is merged on top of what is configured on role level using the [`Merge`] trait. There is also a second form of config, which can only be configured at role level, the `roleConfig`. + + `T` here is the `config` shared between role and roleGroup. + + `U` here is the `roleConfig` only available on the role. It defaults to [`GenericRoleConfig`], as this is sufficient for most products. There are some exceptions, where e.g. [`EmptyRoleConfig`] is used. However, product-operators can define their own - custom - struct and use that here. nullable: true properties: cliOverrides: @@ -10415,6 +10431,10 @@ spec: podDisruptionBudget: enabled: true maxUnavailable: null + description: |- + This is a product-agnostic RoleConfig, which fulfills the needs for most of the product. Currently it contains: + + 1. `podDisruptionBudget` to configure the created PDBs. properties: podDisruptionBudget: default: @@ -13886,6 +13906,12 @@ spec: - roleGroups type: object restServers: + description: |- + This struct represents a role - e.g. HDFS datanodes or Trino workers. It has a [`HashMap`] containing all the roleGroups that are part of this role. Additionally, there is a `config`, which is configurable at the role *and* roleGroup level. Everything at roleGroup level is merged on top of what is configured on role level using the [`Merge`] trait. There is also a second form of config, which can only be configured at role level, the `roleConfig`. + + `T` here is the `config` shared between role and roleGroup. + + `U` here is the `roleConfig` only available on the role. It defaults to [`GenericRoleConfig`], as this is sufficient for most products. There are some exceptions, where e.g. [`EmptyRoleConfig`] is used. However, product-operators can define their own - custom - struct and use that here. nullable: true properties: cliOverrides: @@ -17301,6 +17327,10 @@ spec: podDisruptionBudget: enabled: true maxUnavailable: null + description: |- + This is a product-agnostic RoleConfig, which fulfills the needs for most of the product. Currently it contains: + + 1. `podDisruptionBudget` to configure the created PDBs. properties: podDisruptionBudget: default: