chore: Update templated files (f1f1a9e) (#929)

stackable-bot · NickLarsenNZ · web-flow · commit 4185691722ae · 2025-04-03T12:14:14.000Z
* chore: Generated commit to update templated files since the last template run up to stackabletech/operator-templating@f1f1a9e Reference-to: stackabletech/operator-templating@f1f1a9e (Bump Rust to 1.85.0) * fix: rustfmt lint * ci: use nightly toolchain for cargo udeps * ci: use nightly toolchain for cargo udeps * Revert "ci: use nightly toolchain for cargo udeps" This reverts commit f00d434. * Revert "ci: use nightly toolchain for cargo udeps" This reverts commit 410e93c. --------- Co-authored-by: Nick Larsen <nick.larsen@stackable.tech>
diff --git a/.github/PULL_REQUEST_TEMPLATE/pre-release-rust-deps.md b/.github/PULL_REQUEST_TEMPLATE/pre-release-rust-deps.md
@@ -1,4 +1,4 @@
-# Bump Rust Dependencies for Stackable Release XX.(X)X
+# Bump Rust Dependencies for Stackable Release YY.M.X
 
 <!--
     Make sure to update the link in 'issues/.github/ISSUE_TEMPLATE/pre-release-operator-rust-deps.md'
@@ -32,7 +32,7 @@ Part of <https://github.com/stackabletech/issues/issues/TRACKING_ISSUE>
 
 ```[tasklist]
 ### Bump Rust Dependencies
-- [ ] Bump `stackable-operator` and friends.
-- [ ] Bump `product-version`.
-- [ ] Bump all other dependencies.
+- [ ] Bump `stackable-operator` and friends
+- [ ] Bump `product-config`
+- [ ] Bump all other dependencies
 ```
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -26,7 +26,8 @@ env:
   CARGO_TERM_COLOR: always
   CARGO_INCREMENTAL: '0'
   CARGO_PROFILE_DEV_DEBUG: '0'
-  RUST_TOOLCHAIN_VERSION: "1.84.1"
+  RUST_TOOLCHAIN_VERSION: "1.85.0"
+  RUST_NIGHTLY_TOOLCHAIN_VERSION: "nightly-2025-01-15"
   PYTHON_VERSION: "3.12"
   RUSTFLAGS: "-D warnings"
   RUSTDOCFLAGS: "-D warnings"
@@ -136,9 +137,11 @@ jobs:
           submodules: recursive
       - uses: dtolnay/rust-toolchain@c5a29ddb4d9d194e7c84ec8c3fba61b1c31fee8c
         with:
-          toolchain: ${{ env.RUST_TOOLCHAIN_VERSION }}
+          toolchain: ${{ env.RUST_NIGHTLY_TOOLCHAIN_VERSION }}
           components: rustfmt
-      - run: cargo fmt --all -- --check
+      - env:
+          RUST_TOOLCHAIN_VERSION: ${{ env.RUST_NIGHTLY_TOOLCHAIN_VERSION }}
+        run: cargo "+$RUST_TOOLCHAIN_VERSION" fmt --all -- --check
 
   run_clippy:
     name: Run Clippy
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,7 @@
+{
+    "rust-analyzer.rustfmt.overrideCommand": [
+        "rustfmt",
+        "+nightly-2025-01-15",
+        "--"
+    ],
+}
diff --git a/rust-toolchain.toml b/rust-toolchain.toml
@@ -1,3 +1,3 @@
 # DO NOT EDIT, this file is generated by operator-templating
 [toolchain]
-channel = "1.84.1"
+channel = "1.85.0"
diff --git a/rust/operator-binary/src/config/jvm.rs b/rust/operator-binary/src/config/jvm.rs
@@ -5,9 +5,9 @@ use stackable_operator::{
 };
 
 use crate::crd::{
-    v1alpha1::{ZookeeperCluster, ZookeeperConfig, ZookeeperConfigFragment},
-    LoggingFramework, JVM_SECURITY_PROPERTIES_FILE, LOG4J_CONFIG_FILE, LOGBACK_CONFIG_FILE,
+    JVM_SECURITY_PROPERTIES_FILE, LOG4J_CONFIG_FILE, LOGBACK_CONFIG_FILE, LoggingFramework,
     METRICS_PORT, STACKABLE_CONFIG_DIR, STACKABLE_LOG_CONFIG_DIR,
+    v1alpha1::{ZookeeperCluster, ZookeeperConfig, ZookeeperConfigFragment},
 };
 
 const JAVA_HEAP_FACTOR: f32 = 0.8;
@@ -35,11 +35,17 @@ fn construct_jvm_args(
     let logging_framework = zk.logging_framework();
 
     let jvm_args = vec![
-      format!("-Djava.security.properties={STACKABLE_CONFIG_DIR}/{JVM_SECURITY_PROPERTIES_FILE}"),
-      format!("-javaagent:/stackable/jmx/jmx_prometheus_javaagent.jar={METRICS_PORT}:/stackable/jmx/server.yaml"),
-      match logging_framework {
-            LoggingFramework::LOG4J => format!("-Dlog4j.configuration=file:{STACKABLE_LOG_CONFIG_DIR}/{LOG4J_CONFIG_FILE}"),
-            LoggingFramework::LOGBACK => format!("-Dlogback.configurationFile={STACKABLE_LOG_CONFIG_DIR}/{LOGBACK_CONFIG_FILE}"),
+        format!("-Djava.security.properties={STACKABLE_CONFIG_DIR}/{JVM_SECURITY_PROPERTIES_FILE}"),
+        format!(
+            "-javaagent:/stackable/jmx/jmx_prometheus_javaagent.jar={METRICS_PORT}:/stackable/jmx/server.yaml"
+        ),
+        match logging_framework {
+            LoggingFramework::LOG4J => {
+                format!("-Dlog4j.configuration=file:{STACKABLE_LOG_CONFIG_DIR}/{LOG4J_CONFIG_FILE}")
+            }
+            LoggingFramework::LOGBACK => format!(
+                "-Dlogback.configurationFile={STACKABLE_LOG_CONFIG_DIR}/{LOGBACK_CONFIG_FILE}"
+            ),
         },
     ];
 
@@ -93,7 +99,7 @@ fn is_heap_jvm_argument(jvm_argument: &str) -> bool {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::crd::{v1alpha1::ZookeeperConfig, ZookeeperRole};
+    use crate::crd::{ZookeeperRole, v1alpha1::ZookeeperConfig};
 
     #[test]
     fn test_construct_jvm_arguments_defaults() {
diff --git a/rust/operator-binary/src/crd/affinity.rs b/rust/operator-binary/src/crd/affinity.rs
@@ -1,9 +1,9 @@
 use stackable_operator::{
-    commons::affinity::{affinity_between_role_pods, StackableAffinityFragment},
+    commons::affinity::{StackableAffinityFragment, affinity_between_role_pods},
     k8s_openapi::api::core::v1::PodAntiAffinity,
 };
 
-use crate::crd::{ZookeeperRole, APP_NAME};
+use crate::crd::{APP_NAME, ZookeeperRole};
 
 pub fn get_affinity(cluster_name: &str, role: &ZookeeperRole) -> StackableAffinityFragment {
     let affinity_between_role_pods =
diff --git a/rust/operator-binary/src/crd/authentication.rs b/rust/operator-binary/src/crd/authentication.rs
@@ -19,7 +19,9 @@ pub enum Error {
         authentication_class: ObjectRef<AuthenticationClass>,
     },
     // TODO: Adapt message if multiple authentication classes are supported
-    #[snafu(display("only one authentication class is currently supported. Possible Authentication classes are {SUPPORTED_AUTHENTICATION_CLASS:?}"))]
+    #[snafu(display(
+        "only one authentication class is currently supported. Possible Authentication classes are {SUPPORTED_AUTHENTICATION_CLASS:?}"
+    ))]
     MultipleAuthenticationClassesProvided,
     #[snafu(display(
         "failed to use authentication method [{method}] for authentication class [{authentication_class}] - supported mechanisms: {SUPPORTED_AUTHENTICATION_CLASS:?}",
@@ -81,7 +83,7 @@ impl ResolvedAuthenticationClasses {
                     return Err(Error::AuthenticationMethodNotSupported {
                         authentication_class: ObjectRef::from_obj(auth_class),
                         method: auth_class.spec.provider.to_string(),
-                    })
+                    });
                 }
             }
         }
diff --git a/rust/operator-binary/src/crd/mod.rs b/rust/operator-binary/src/crd/mod.rs
@@ -21,7 +21,7 @@ use stackable_operator::{
         api::core::v1::{PersistentVolumeClaim, ResourceRequirements},
         apimachinery::pkg::api::resource::Quantity,
     },
-    kube::{runtime::reflector::ObjectRef, CustomResource, ResourceExt},
+    kube::{CustomResource, ResourceExt, runtime::reflector::ObjectRef},
     memory::{BinaryMultiple, MemoryQuantity},
     product_config_utils::{self, Configuration},
     product_logging::{self, spec::Logging},
@@ -368,14 +368,12 @@ impl v1alpha1::CurrentlySupportedListenerClasses {
 }
 
 impl v1alpha1::ZookeeperConfig {
+    pub const DATA_DIR: &'static str = "dataDir";
+    const DEFAULT_SECRET_LIFETIME: Duration = Duration::from_days_unchecked(1);
     pub const INIT_LIMIT: &'static str = "initLimit";
+    pub const MYID_OFFSET: &'static str = "MYID_OFFSET";
     pub const SYNC_LIMIT: &'static str = "syncLimit";
     pub const TICK_TIME: &'static str = "tickTime";
-    pub const DATA_DIR: &'static str = "dataDir";
-
-    pub const MYID_OFFSET: &'static str = "MYID_OFFSET";
-
-    const DEFAULT_SECRET_LIFETIME: Duration = Duration::from_days_unchecked(1);
 
     fn default_server_config(
         cluster_name: &str,
diff --git a/rust/operator-binary/src/crd/security.rs b/rust/operator-binary/src/crd/security.rs
@@ -11,12 +11,12 @@ use stackable_operator::{
     builder::{
         self,
         pod::{
+            PodBuilder,
             container::ContainerBuilder,
             volume::{
                 SecretFormat, SecretOperatorVolumeSourceBuilder,
                 SecretOperatorVolumeSourceBuilderError, VolumeBuilder,
             },
-            PodBuilder,
         },
     },
     client::Client,
@@ -60,14 +60,21 @@ impl ZookeeperSecurity {
     // ports
     pub const CLIENT_PORT: u16 = 2181;
     pub const CLIENT_PORT_NAME: &'static str = "clientPort";
-    pub const SECURE_CLIENT_PORT: u16 = 2282;
-    pub const SECURE_CLIENT_PORT_NAME: &'static str = "secureClientPort";
     // directories
     pub const QUORUM_TLS_DIR: &'static str = "/stackable/quorum_tls";
     pub const QUORUM_TLS_MOUNT_DIR: &'static str = "/stackable/quorum_tls_mount";
+    pub const SECURE_CLIENT_PORT: u16 = 2282;
+    pub const SECURE_CLIENT_PORT_NAME: &'static str = "secureClientPort";
+    pub const SERVER_CNXN_FACTORY: &'static str = "serverCnxnFactory";
     pub const SERVER_TLS_DIR: &'static str = "/stackable/server_tls";
     pub const SERVER_TLS_MOUNT_DIR: &'static str = "/stackable/server_tls_mount";
-    pub const SYSTEM_TRUST_STORE_DIR: &'static str = "/etc/pki/java/cacerts";
+    // Common TLS
+    pub const SSL_AUTH_PROVIDER_X509: &'static str = "authProvider.x509";
+    // Client TLS
+    pub const SSL_CLIENT_AUTH: &'static str = "ssl.clientAuth";
+    pub const SSL_HOST_NAME_VERIFICATION: &'static str = "ssl.hostnameVerification";
+    pub const SSL_KEY_STORE_LOCATION: &'static str = "ssl.keyStore.location";
+    pub const SSL_KEY_STORE_PASSWORD: &'static str = "ssl.keyStore.password";
     // Quorum TLS
     pub const SSL_QUORUM: &'static str = "sslQuorum";
     pub const SSL_QUORUM_CLIENT_AUTH: &'static str = "ssl.quorum.clientAuth";
@@ -76,18 +83,11 @@ impl ZookeeperSecurity {
     pub const SSL_QUORUM_KEY_STORE_PASSWORD: &'static str = "ssl.quorum.keyStore.password";
     pub const SSL_QUORUM_TRUST_STORE_LOCATION: &'static str = "ssl.quorum.trustStore.location";
     pub const SSL_QUORUM_TRUST_STORE_PASSWORD: &'static str = "ssl.quorum.trustStore.password";
-    // Client TLS
-    pub const SSL_CLIENT_AUTH: &'static str = "ssl.clientAuth";
-    pub const SSL_HOST_NAME_VERIFICATION: &'static str = "ssl.hostnameVerification";
-    pub const SSL_KEY_STORE_LOCATION: &'static str = "ssl.keyStore.location";
-    pub const SSL_KEY_STORE_PASSWORD: &'static str = "ssl.keyStore.password";
     pub const SSL_TRUST_STORE_LOCATION: &'static str = "ssl.trustStore.location";
     pub const SSL_TRUST_STORE_PASSWORD: &'static str = "ssl.trustStore.password";
-    // Common TLS
-    pub const SSL_AUTH_PROVIDER_X509: &'static str = "authProvider.x509";
-    pub const SERVER_CNXN_FACTORY: &'static str = "serverCnxnFactory";
     // Mis
     pub const STORE_PASSWORD_ENV: &'static str = "STORE_PASSWORD";
+    pub const SYSTEM_TRUST_STORE_DIR: &'static str = "/etc/pki/java/cacerts";
 
     /// Create a `ZookeeperSecurity` struct from the Zookeeper custom resource and resolve
     /// all provided `AuthenticationClass` references.
diff --git a/rust/operator-binary/src/discovery.rs b/rust/operator-binary/src/discovery.rs
@@ -5,12 +5,12 @@ use stackable_operator::{
     builder::{configmap::ConfigMapBuilder, meta::ObjectMetaBuilder},
     commons::product_image_selection::ResolvedProductImage,
     k8s_openapi::api::core::v1::{ConfigMap, Endpoints, Service},
-    kube::{runtime::reflector::ObjectRef, Resource, ResourceExt},
+    kube::{Resource, ResourceExt, runtime::reflector::ObjectRef},
     utils::cluster_info::KubernetesClusterInfo,
 };
 
 use crate::{
-    crd::{security::ZookeeperSecurity, v1alpha1, ZookeeperRole},
+    crd::{ZookeeperRole, security::ZookeeperSecurity, v1alpha1},
     utils::build_recommended_labels,
 };
 
diff --git a/rust/operator-binary/src/main.rs b/rust/operator-binary/src/main.rs
@@ -1,26 +1,27 @@
 use std::sync::Arc;
 
-use clap::{crate_description, crate_version, Parser};
-use crd::{v1alpha1, ZookeeperCluster, ZookeeperZnode, APP_NAME, OPERATOR_NAME};
-use futures::{pin_mut, StreamExt};
+use clap::{Parser, crate_description, crate_version};
+use crd::{APP_NAME, OPERATOR_NAME, ZookeeperCluster, ZookeeperZnode, v1alpha1};
+use futures::{StreamExt, pin_mut};
 use stackable_operator::{
+    YamlSchema,
     cli::{Command, ProductOperatorRun},
     k8s_openapi::api::{
         apps::v1::StatefulSet,
         core::v1::{ConfigMap, Endpoints, Service},
     },
     kube::{
+        Resource,
         core::DeserializeGuard,
         runtime::{
+            Controller,
             events::{Recorder, Reporter},
             reflector::ObjectRef,
-            watcher, Controller,
+            watcher,
         },
-        Resource,
     },
     logging::controller::report_controller_reconciled,
     shared::yaml::SerializeOptions,
-    YamlSchema,
 };
 
 use crate::{zk_controller::ZK_FULL_CONTROLLER_NAME, znode_controller::ZNODE_FULL_CONTROLLER_NAME};
@@ -92,13 +93,10 @@ async fn main() -> anyhow::Result<()> {
                 watcher::Config::default(),
             );
 
-            let zk_event_recorder = Arc::new(Recorder::new(
-                client.as_kube_client(),
-                Reporter {
-                    controller: ZK_FULL_CONTROLLER_NAME.to_string(),
-                    instance: None,
-                },
-            ));
+            let zk_event_recorder = Arc::new(Recorder::new(client.as_kube_client(), Reporter {
+                controller: ZK_FULL_CONTROLLER_NAME.to_string(),
+                instance: None,
+            }));
             let zk_store = zk_controller.store();
             let zk_controller = zk_controller
                 .owns(
@@ -162,13 +160,10 @@ async fn main() -> anyhow::Result<()> {
                 watch_namespace.get_api::<DeserializeGuard<v1alpha1::ZookeeperZnode>>(&client),
                 watcher::Config::default(),
             );
-            let znode_event_recorder = Arc::new(Recorder::new(
-                client.as_kube_client(),
-                Reporter {
-                    controller: ZNODE_FULL_CONTROLLER_NAME.to_string(),
-                    instance: None,
-                },
-            ));
+            let znode_event_recorder = Arc::new(Recorder::new(client.as_kube_client(), Reporter {
+                controller: ZNODE_FULL_CONTROLLER_NAME.to_string(),
+                instance: None,
+            }));
 
             let znode_store = znode_controller.store();
             let znode_controller = znode_controller
diff --git a/rust/operator-binary/src/operations/pdb.rs b/rust/operator-binary/src/operations/pdb.rs
@@ -5,7 +5,7 @@ use stackable_operator::{
 };
 
 use crate::{
-    crd::{v1alpha1, ZookeeperRole, APP_NAME, OPERATOR_NAME},
+    crd::{APP_NAME, OPERATOR_NAME, ZookeeperRole, v1alpha1},
     zk_controller::ZK_CONTROLLER_NAME,
 };
 
diff --git a/rust/operator-binary/src/product_logging.rs b/rust/operator-binary/src/product_logging.rs
@@ -13,8 +13,8 @@ use stackable_operator::{
 };
 
 use crate::crd::{
-    v1alpha1, LoggingFramework, ZookeeperRole, LOG4J_CONFIG_FILE, LOGBACK_CONFIG_FILE,
-    MAX_ZK_LOG_FILES_SIZE, STACKABLE_LOG_DIR, ZOOKEEPER_LOG_FILE,
+    LOG4J_CONFIG_FILE, LOGBACK_CONFIG_FILE, LoggingFramework, MAX_ZK_LOG_FILES_SIZE,
+    STACKABLE_LOG_DIR, ZOOKEEPER_LOG_FILE, ZookeeperRole, v1alpha1,
 };
 
 #[derive(Snafu, Debug)]
diff --git a/rust/operator-binary/src/zk_controller.rs b/rust/operator-binary/src/zk_controller.rs
diff --git a/rust/operator-binary/src/znode_controller.rs b/rust/operator-binary/src/znode_controller.rs
diff --git a/rustfmt.toml b/rustfmt.toml
diff --git a/scripts/docs_templating.sh b/scripts/docs_templating.sh

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,9 @@ pub enum Error {`
`19`	`19`	`authentication_class: ObjectRef<AuthenticationClass>,`
`20`	`20`	`},`
`21`	`21`	`// TODO: Adapt message if multiple authentication classes are supported`
`22`		`- #[snafu(display("only one authentication class is currently supported. Possible Authentication classes are {SUPPORTED_AUTHENTICATION_CLASS:?}"))]`
	`22`	`+ #[snafu(display(`
	`23`	`+ "only one authentication class is currently supported. Possible Authentication classes are {SUPPORTED_AUTHENTICATION_CLASS:?}"`
	`24`	`+ ))]`
`23`	`25`	`MultipleAuthenticationClassesProvided,`
`24`	`26`	`#[snafu(display(`
`25`	`27`	`"failed to use authentication method [{method}] for authentication class [{authentication_class}] - supported mechanisms: {SUPPORTED_AUTHENTICATION_CLASS:?}",`
`@@ -81,7 +83,7 @@ impl ResolvedAuthenticationClasses {`
`81`	`83`	`return Err(Error::AuthenticationMethodNotSupported {`
`82`	`84`	`authentication_class: ObjectRef::from_obj(auth_class),`
`83`	`85`	`method: auth_class.spec.provider.to_string(),`
`84`		`- })`
	`86`	`+ });`
`85`	`87`	`}`
`86`	`88`	`}`
`87`	`89`	`}`