chore: Improve code style

Author: siegfriedweber

extra/crds.yaml

@@ -1871,6 +1871,11 @@ spec:
                           nullable: true
                           type: string
                         default: {}
+                        description: |-
+                          Flat key-value overrides for `*.properties`, Hadoop XML, etc.
+
+                          This is backwards-compatible with the existing flat key-value YAML format
+                          used by `HashMap<String, String>`.
                         type: object
                     type: object
                   envOverrides:
@@ -2562,6 +2567,11 @@ spec:
                                 nullable: true
                                 type: string
                               default: {}
+                              description: |-
+                                Flat key-value overrides for `*.properties`, Hadoop XML, etc.
+
+                                This is backwards-compatible with the existing flat key-value YAML format
+                                used by `HashMap<String, String>`.
                               type: object
                           type: object
                         envOverrides:

rust/operator-binary/src/controller.rs

@@ -147,8 +147,8 @@ impl ReconcilerError for Error {
 }
 
 type OpenSearchRoleGroupConfig = RoleGroupConfig<
-    GenericCommonConfig,
     ValidatedOpenSearchConfig,
+    GenericCommonConfig,
     v1alpha1::OpenSearchConfigOverrides,
 >;
 

rust/operator-binary/src/controller/build/role_group_builder.rs

@@ -1073,6 +1073,8 @@ impl<'a> RoleGroupBuilder<'a> {
     ) -> Vec<Volume> {
         let mut volume_source_builder = SecretOperatorVolumeSourceBuilder::new(
             tls_internal_secret_class,
+            // OpenSearch requires both the public certificate and the private key to serve the
+            // transport layer via TLS.
             SecretClassVolumeProvisionParts::PublicPrivate,
         );
 
@@ -1110,6 +1112,8 @@ impl<'a> RoleGroupBuilder<'a> {
     ) -> Vec<Volume> {
         let mut volume_source_builder = SecretOperatorVolumeSourceBuilder::new(
             tls_server_secret_class,
+            // OpenSearch requires both the public certificate and the private key to serve the
+            // REST layer via TLS.
             SecretClassVolumeProvisionParts::PublicPrivate,
         );
 

rust/operator-binary/src/crd/mod.rs

@@ -488,8 +488,8 @@ pub mod versioned {
     }
 
     #[derive(Clone, Debug, Default, Deserialize, JsonSchema, Merge, PartialEq, Serialize)]
-    #[serde(rename_all = "camelCase")]
     pub struct OpenSearchConfigOverrides {
+        // File name defined in [`crate::controller::build::node_config::CONFIGURATION_FILE_OPENSEARCH_YML`]
         #[serde(default, rename = "opensearch.yml")]
         pub opensearch_yml: KeyValueConfigOverrides,
     }

rust/operator-binary/src/framework/config_overrides.rs

@@ -5,6 +5,10 @@ use serde::{Deserialize, Serialize};
 use stackable_operator::{config::merge::Merge, schemars};
 
 // Mergeable variant of [`stackable_operator::config_overrides::KeyValueConfigOverrides`]
+/// Flat key-value overrides for `*.properties`, Hadoop XML, etc.
+///
+/// This is backwards-compatible with the existing flat key-value YAML format
+/// used by `HashMap<String, String>`.
 #[derive(Clone, Debug, Default, Deserialize, Eq, JsonSchema, Merge, PartialEq, Serialize)]
 pub struct KeyValueConfigOverrides {
     #[serde(flatten)]

rust/operator-binary/src/framework/role_utils.rs

@@ -37,7 +37,7 @@ impl Merge for GenericCommonConfig {
 /// * `config` is flattened.
 /// * The [`HashMap`] in `env_overrides` is replaced with an [`EnvVarSet`].
 #[derive(Clone, Debug, PartialEq)]
-pub struct RoleGroupConfig<ProductSpecificCommonConfig, Config, ConfigOverrides> {
+pub struct RoleGroupConfig<Config, CommonConfig, ConfigOverrides> {
     pub replicas: u16,
     pub config: Config,
     pub config_overrides: ConfigOverrides,
@@ -46,12 +46,10 @@ pub struct RoleGroupConfig<ProductSpecificCommonConfig, Config, ConfigOverrides>
     pub pod_overrides: PodTemplateSpec,
     // allow(dead_code) is not necessary anymore when moved to operator-rs
     #[allow(dead_code)]
-    pub product_specific_common_config: ProductSpecificCommonConfig,
+    pub product_specific_common_config: CommonConfig,
 }
 
-impl<ProductSpecificCommonConfig, Config, ConfigOverrides>
-    RoleGroupConfig<ProductSpecificCommonConfig, Config, ConfigOverrides>
-{
+impl<Config, CommonConfig, ConfigOverrides> RoleGroupConfig<Config, CommonConfig, ConfigOverrides> {
     pub fn cli_overrides_to_vec(&self) -> Vec<String> {
         self.cli_overrides
             .clone()
@@ -62,13 +60,13 @@ impl<ProductSpecificCommonConfig, Config, ConfigOverrides>
 }
 
 /// Merges and validates the [`RoleGroup`] with the given `role` and `default_config`
-pub fn with_validated_config<C, CommonConfig, Config, RoleConfig, ConfigOverrides>(
+pub fn with_validated_config<ValidatedConfig, CommonConfig, Config, RoleConfig, ConfigOverrides>(
     role_group: &RoleGroup<Config, CommonConfig, ConfigOverrides>,
     role: &Role<Config, ConfigOverrides, RoleConfig, CommonConfig>,
     default_config: &Config,
-) -> Result<RoleGroup<C, CommonConfig, ConfigOverrides>, fragment::ValidationError>
+) -> Result<RoleGroup<ValidatedConfig, CommonConfig, ConfigOverrides>, fragment::ValidationError>
 where
-    C: FromFragment<Fragment = Config>,
+    ValidatedConfig: FromFragment<Fragment = Config>,
     CommonConfig: Clone + Default + JsonSchema + Merge + Serialize,
     Config: Clone + Merge,
     RoleConfig: Default + JsonSchema + Serialize,