main merge, fix conflicts

Author: razvan

.github/workflows/build.yml

@@ -17,7 +17,7 @@ env:
   CARGO_TERM_COLOR: always
   CARGO_INCREMENTAL: '0'
   CARGO_PROFILE_DEV_DEBUG: '0'
-  RUST_TOOLCHAIN_VERSION: "1.71.0"
+  RUST_TOOLCHAIN_VERSION: "1.75.0"
   RUSTFLAGS: "-D warnings"
   RUSTDOCFLAGS: "-D warnings"
   RUST_LOG: "info"

CHANGELOG.md

@@ -4,6 +4,71 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+## Added
+
+- Add `stackable_webhook` crate which provides utilities to create webhooks with TLS termination ([#730]).
+
+[#730]: https://github.com/stackabletech/operator-rs/pull/730
+
+## Changed
+
+- Remove `resources` key from `DynamicValues` struct ([#734]).
+
+## Fixed
+
+- Fixed incorrect time calculation ([#735]).
+
+[#734]: https://github.com/stackabletech/operator-rs/pull/734
+[#735]: https://github.com/stackabletech/operator-rs/pull/735
+
+## [0.64.0] - 2024-01-31
+
+### Added
+
+- Derive `Hash` and `Ord` instances for `AuthenticationClassProvider`,
+  so that duplicates can be detected ([#731]).
+
+[#731]: https://github.com/stackabletech/operator-rs/pull/731
+
+## [0.63.0] - 2024-01-26
+
+### Added
+
+- Add Serde `Deserialize` and `Serialize` support for `CpuQuantity` and `MemoryQuantity` ([#724]).
+- Add `DynamicValues` struct to work with operator `values.yaml` files during runtime ([#723]).
+
+[#723]: https://github.com/stackabletech/operator-rs/pull/723
+[#724]: https://github.com/stackabletech/operator-rs/pull/724
+
+### Changed
+
+- Change Deref target of `KeyPrefix` and `KeyName` from `String` to `str` ([#725]).
+- Add Stackable vendor label `stackable.tech/vendor: Stackable` to recommended labels ([#728]).
+
+[#725]: https://github.com/stackabletech/operator-rs/pull/725
+[#728]: https://github.com/stackabletech/operator-rs/pull/728
+
+## [0.62.0] - 2024-01-19
+
+### Added
+
+- Added `Option::as_ref_or_else` to `utils` ([#717]).
+- Add `iter()` methods to `KeyValuePairs<T>`, and delegate iter() for `Labels`, and `Annotations` ([#720]).
+- Implement `IntoIterator` for `KeyValuePairs<T>`, `Labels` and `Annotations` ([#720]).
+- Added `ListenerOperatorVolumeSourceBuilder::build_pvc` ([#719]).
+- Added `Logging::for_container` ([#721]).
+
+### Changed
+
+- Split `utils` into submodules ([#717]).
+- Bump rust to 1.75.0 ([#720]).
+- Renamed `ListenerOperatorVolumeSourceBuilder::build` to `::build_ephemeral` ([#719]).
+
+[#717]: https://github.com/stackabletech/operator-rs/pull/717
+[#720]: https://github.com/stackabletech/operator-rs/pull/720
+[#719]: https://github.com/stackabletech/operator-rs/pull/719
+[#721]: https://github.com/stackabletech/operator-rs/pull/721
+
 ## [0.61.0] - 2024-01-15
 
 ### Added

Cargo.toml

@@ -1,5 +1,5 @@
 [workspace.package]
-version = "0.61.0"
+version = "0.64.0"
 authors = ["Stackable GmbH <info@stackable.de>"]
 license = "Apache-2.0"
 edition = "2021"
@@ -27,12 +27,12 @@ dockerfile-parser = "0.8.0"
 either = "1.9.0"
 futures = "0.3.28"
 json-patch = "1.0.0"
-k8s-openapi = { version = "0.20.0", default-features = false, features = [
+k8s-openapi = { version = "0.21.0", default-features = false, features = [
     "schemars",
     "v1_28",
 ] }
 # We use rustls instead of openssl for easier portablitly, e.g. so that we can build stackablectl without the need to vendor (build from source) openssl
-kube = { version = "0.87.1", default-features = false, features = [
+kube = { version = "0.88.1", default-features = false, features = [
     "client",
     "jsonpatch",
     "runtime",
@@ -51,9 +51,9 @@ semver = "1.0"
 serde = { version = "1.0.184", features = ["derive"] }
 serde_json = "1.0.104"
 serde_yaml = "0.9.25"
-snafu = "0.7.5"
+snafu = "0.8.0"
 stackable-operator-derive = { path = "stackable-operator-derive" }
-strum = { version = "0.25.0", features = ["derive"] }
+strum = { version = "0.26.1", features = ["derive"] }
 thiserror = "1.0.44"
 time = { version = "0.3.29", optional = true }
 tokio = { version = "1.29.1", features = ["macros", "rt-multi-thread"] }
@@ -67,4 +67,4 @@ rstest = "0.18.1"
 tempfile = "3.7.1"
 
 [workspace]
-members = ["stackable-operator-derive"]
+members = ["stackable-operator-derive", "stackable-webhook"]

fixtures/helm/input-additional.yaml

@@ -0,0 +1,20 @@
+# Partly taken from https://github.com/stackabletech/zookeeper-operator/blob/main/deploy/helm/zookeeper-operator/values.yaml
+---
+image:
+  repository: docker.stackable.tech/stackable/zookeeper-operator
+  pullPolicy: IfNotPresent
+  pullSecrets: []
+nameOverride: ''
+fullnameOverride: ''
+serviceAccount:
+  create: true
+  annotations: {}
+  name: ''
+labels:
+  stackable.tech/vendor: Stackable
+  stackable.tech/managed-by: stackablectl
+podAnnotations: {}
+podSecurityContext: {}
+nodeSelector: {}
+tolerations: []
+affinity: {}

fixtures/helm/input-required.yaml

@@ -0,0 +1,15 @@
+# Partly taken from https://github.com/stackabletech/zookeeper-operator/blob/main/deploy/helm/zookeeper-operator/values.yaml
+---
+image:
+  repository: docker.stackable.tech/stackable/zookeeper-operator
+  pullPolicy: IfNotPresent
+  pullSecrets: []
+nameOverride: ''
+fullnameOverride: ''
+serviceAccount:
+  create: true
+  annotations: {}
+  name: ''
+labels:
+  stackable.tech/vendor: Stackable
+  stackable.tech/managed-by: stackablectl

fixtures/helm/output.yaml

@@ -0,0 +1,15 @@
+---
+image:
+  repository: docker.stackable.tech/stackable/zookeeper-operator
+  pullPolicy: IfNotPresent
+  pullSecrets: []
+nameOverride: ''
+fullnameOverride: ''
+serviceAccount:
+  create: true
+  annotations: {}
+  name: ''
+labels:
+  stackable.tech/demo: logging
+  stackable.tech/managed-by: stackablectl
+  stackable.tech/vendor: Stackable

rust-toolchain.toml

@@ -1,2 +1,2 @@
 [toolchain]
-channel = "1.71.0"
+channel = "1.75.0"

src/builder/meta.rs

@@ -343,7 +343,7 @@ mod tests {
         assert_eq!(meta.name, Some("foo".to_string()));
         assert_eq!(meta.owner_references.as_ref().unwrap().len(), 1);
         assert!(
-            matches!(meta.owner_references.unwrap().get(0), Some(OwnerReference { uid, ..}) if uid == "uid")
+            matches!(meta.owner_references.unwrap().first(), Some(OwnerReference { uid, ..}) if uid == "uid")
         );
         assert_eq!(meta.annotations.as_ref().unwrap().len(), 1);
         assert_eq!(

src/builder/pod/container.rs

@@ -392,7 +392,7 @@ mod tests {
 
         assert_eq!(container.name, "testcontainer");
         assert!(
-            matches!(container.env.as_ref().unwrap().get(0), Some(EnvVar {name, value: Some(value), ..}) if name == "foo" && value == "bar")
+            matches!(container.env.as_ref().unwrap().first(), Some(EnvVar {name, value: Some(value), ..}) if name == "foo" && value == "bar")
         );
         assert!(
             matches!(container.env.as_ref().unwrap().get(1), Some(EnvVar {name, value_from: Some(EnvVarSource {config_map_key_ref: Some(ConfigMapKeySelector {name: Some(config_map_name), key: config_map_key, ..}), ..}), ..}) if name == "envFromConfigMap" && config_map_name == "my-configmap" && config_map_key == "my-key")
@@ -402,7 +402,7 @@ mod tests {
         );
         assert_eq!(container.volume_mounts.as_ref().unwrap().len(), 1);
         assert!(
-            matches!(container.volume_mounts.as_ref().unwrap().get(0), Some(VolumeMount {mount_path, name, ..}) if mount_path == "/mount" && name == "configmap")
+            matches!(container.volume_mounts.as_ref().unwrap().first(), Some(VolumeMount {mount_path, name, ..}) if mount_path == "/mount" && name == "configmap")
         );
         assert_eq!(container.ports.as_ref().unwrap().len(), 2);
         assert_eq!(

src/builder/pod/mod.rs

@@ -351,7 +351,7 @@ impl PodBuilder {
     ) -> Result<&mut Self> {
         let listener_reference = ListenerReference::ListenerClass(listener_class.to_string());
         let volume = ListenerOperatorVolumeSourceBuilder::new(&listener_reference)
-            .build()
+            .build_ephemeral()
             .context(ListenerVolumeSnafu { name: volume_name })?;
 
         self.add_volume(Volume {
@@ -440,7 +440,7 @@ impl PodBuilder {
     ) -> Result<&mut Self> {
         let listener_reference = ListenerReference::ListenerName(listener_name.to_string());
         let volume = ListenerOperatorVolumeSourceBuilder::new(&listener_reference)
-            .build()
+            .build_ephemeral()
             .context(ListenerVolumeSnafu { name: volume_name })?;
 
         self.add_volume(Volume {
@@ -691,13 +691,13 @@ mod tests {
             pod_spec
                 .init_containers
                 .as_ref()
-                .and_then(|containers| containers.get(0).as_ref().map(|c| c.name.clone())),
+                .and_then(|containers| containers.first().as_ref().map(|c| c.name.clone())),
             Some("init-containername".to_string())
         );
 
         assert_eq!(
             pod_spec.volumes.as_ref().and_then(|volumes| volumes
-                .get(0)
+                .first()
                 .as_ref()
                 .and_then(|volume| volume.config_map.as_ref()?.name.clone())),
             Some("configmap".to_string())

src/builder/pod/volume.rs

@@ -1,9 +1,10 @@
 use k8s_openapi::{
     api::core::v1::{
         CSIVolumeSource, ConfigMapVolumeSource, DownwardAPIVolumeSource, EmptyDirVolumeSource,
-        EphemeralVolumeSource, HostPathVolumeSource, PersistentVolumeClaimSpec,
-        PersistentVolumeClaimTemplate, PersistentVolumeClaimVolumeSource, ProjectedVolumeSource,
-        ResourceRequirements, SecretVolumeSource, Volume, VolumeMount,
+        EphemeralVolumeSource, HostPathVolumeSource, PersistentVolumeClaim,
+        PersistentVolumeClaimSpec, PersistentVolumeClaimTemplate,
+        PersistentVolumeClaimVolumeSource, ProjectedVolumeSource, ResourceRequirements,
+        SecretVolumeSource, Volume, VolumeMount,
     },
     apimachinery::pkg::api::resource::Quantity,
 };
@@ -461,8 +462,27 @@ impl ListenerOperatorVolumeSourceBuilder {
         }
     }
 
-    /// Build an [`EphemeralVolumeSource`] from the builder
+    fn build_spec(&self) -> PersistentVolumeClaimSpec {
+        PersistentVolumeClaimSpec {
+            storage_class_name: Some("listeners.stackable.tech".to_string()),
+            resources: Some(ResourceRequirements {
+                requests: Some([("storage".to_string(), Quantity("1".to_string()))].into()),
+                ..ResourceRequirements::default()
+            }),
+            access_modes: Some(vec!["ReadWriteMany".to_string()]),
+            ..PersistentVolumeClaimSpec::default()
+        }
+    }
+
+    #[deprecated(note = "renamed to `build_ephemeral`", since = "0.61.1")]
     pub fn build(&self) -> Result<EphemeralVolumeSource, ListenerOperatorVolumeSourceBuilderError> {
+        self.build_ephemeral()
+    }
+
+    /// Build an [`EphemeralVolumeSource`] from the builder.
+    pub fn build_ephemeral(
+        &self,
+    ) -> Result<EphemeralVolumeSource, ListenerOperatorVolumeSourceBuilderError> {
         let listener_reference_annotation = self
             .listener_reference
             .to_annotation()
@@ -475,18 +495,30 @@ impl ListenerOperatorVolumeSourceBuilder {
                         .with_annotation(listener_reference_annotation)
                         .build(),
                 ),
-                spec: PersistentVolumeClaimSpec {
-                    storage_class_name: Some("listeners.stackable.tech".to_string()),
-                    resources: Some(ResourceRequirements {
-                        requests: Some([("storage".to_string(), Quantity("1".to_string()))].into()),
-                        ..ResourceRequirements::default()
-                    }),
-                    access_modes: Some(vec!["ReadWriteMany".to_string()]),
-                    ..PersistentVolumeClaimSpec::default()
-                },
+                spec: self.build_spec(),
             }),
         })
     }
+
+    /// Build a [`PersistentVolumeClaim`] from the builder.
+    pub fn build_pvc(
+        &self,
+        name: impl Into<String>,
+    ) -> Result<PersistentVolumeClaim, ListenerOperatorVolumeSourceBuilderError> {
+        let listener_reference_annotation = self
+            .listener_reference
+            .to_annotation()
+            .context(ListenerReferenceAnnotationSnafu)?;
+
+        Ok(PersistentVolumeClaim {
+            metadata: ObjectMetaBuilder::new()
+                .name(name)
+                .with_annotation(listener_reference_annotation)
+                .build(),
+            spec: Some(self.build_spec()),
+            ..Default::default()
+        })
+    }
 }
 
 #[cfg(test)]
@@ -556,7 +588,7 @@ mod tests {
             "public".into(),
         ));
 
-        let volume_source = builder.build().unwrap();
+        let volume_source = builder.build_ephemeral().unwrap();
 
         let volume_claim_template = volume_source.volume_claim_template;
         let annotations = volume_claim_template

src/commons/authentication/ldap.rs

@@ -31,7 +31,9 @@ pub enum Error {
     AddLdapTlsClientDetailsVolumes { source: TlsClientDetailsError },
 }
 
-#[derive(Clone, Debug, Deserialize, Eq, JsonSchema, PartialEq, Serialize)]
+#[derive(
+    Clone, Debug, Deserialize, Eq, Hash, JsonSchema, Ord, PartialEq, PartialOrd, Serialize,
+)]
 #[serde(rename_all = "camelCase")]
 pub struct AuthenticationProvider {
     /// Hostname of the LDAP server, for example: `my.ldap.server`.
@@ -155,7 +157,9 @@ impl AuthenticationProvider {
     }
 }
 
-#[derive(Clone, Debug, Deserialize, Eq, JsonSchema, PartialEq, Serialize)]
+#[derive(
+    Clone, Debug, Deserialize, Eq, Hash, JsonSchema, Ord, PartialEq, PartialOrd, Serialize,
+)]
 #[serde(rename_all = "camelCase")]
 pub struct FieldNames {
     /// The name of the username field

src/commons/authentication/mod.rs

@@ -20,7 +20,19 @@ pub(crate) const SECRET_BASE_PATH: &str = "/stackable/secrets";
 /// Multiple different authentication providers are supported.
 /// Learn more in the [authentication concept documentation](DOCS_BASE_URL_PLACEHOLDER/concepts/authentication) and the
 /// [Authentication with OpenLDAP tutorial](DOCS_BASE_URL_PLACEHOLDER/tutorials/authentication_with_openldap).
-#[derive(Clone, CustomResource, Debug, Deserialize, Eq, JsonSchema, PartialEq, Serialize)]
+#[derive(
+    Clone,
+    CustomResource,
+    Debug,
+    Deserialize,
+    Eq,
+    Hash,
+    JsonSchema,
+    Ord,
+    PartialEq,
+    PartialOrd,
+    Serialize,
+)]
 #[kube(
     group = "authentication.stackable.tech",
     version = "v1alpha1",
@@ -38,7 +50,9 @@ pub struct AuthenticationClassSpec {
     pub provider: AuthenticationClassProvider,
 }
 
-#[derive(Clone, Debug, Deserialize, Display, Eq, JsonSchema, PartialEq, Serialize)]
+#[derive(
+    Clone, Debug, Deserialize, Display, Eq, Hash, JsonSchema, Ord, PartialEq, PartialOrd, Serialize,
+)]
 #[serde(rename_all = "camelCase")]
 #[allow(clippy::large_enum_variant)]
 pub enum AuthenticationClassProvider {