feat: Warn when a non-default region is configured (#700)

* feat: Warn when a non-default region is configured

* changelog

* change warning

* typo

* typo part 2

* make regenerate-nix

* clippy

Author: sbernauer

CHANGELOG.md

@@ -14,7 +14,8 @@ All notable changes to this project will be documented in this file.
 - BREAKING: Adjust default memory limits of coordinator from `512Mi` to `768Mi` and middlemanager from `1Gi` to `1500Mi` ([#685]).
 - Support configuring JVM arguments ([#693]).
 - Add `region.name` field in S3Connection.
-  This field is **ignored** by this operator, see [ingestion] and [deep storage] documentation ([#695]).
+  This field is **ignored** by this operator, see [ingestion] and [deep storage] documentation.
+  A warning is emitted when a non-default endpoint is used ([#695], [#700]).
 
 ### Changed
 
@@ -28,6 +29,7 @@ All notable changes to this project will be documented in this file.
 [#693]: https://github.com/stackabletech/druid-operator/pull/693
 [#685]: https://github.com/stackabletech/druid-operator/pull/685
 [#695]: https://github.com/stackabletech/druid-operator/pull/695
+[#700]: https://github.com/stackabletech/druid-operator/pull/700
 
 [ingestion]: https://docs.stackable.tech/home/nightly/druid/usage-guide/ingestion/
 [deep storage]: https://docs.stackable.tech/home/nightly/druid/usage-guide/deep-storage/

Cargo.lock

@@ -11,7 +11,7 @@ repository = "https://github.com/stackabletech/druid-operator"
 
 [workspace.dependencies]
 stackable-versioned = { git = "https://github.com/stackabletech/operator-rs.git", features = ["k8s"], tag = "stackable-versioned-0.6.0" }
-stackable-operator = { git = "https://github.com/stackabletech/operator-rs.git", tag = "stackable-operator-0.87.2" }
+stackable-operator = { git = "https://github.com/stackabletech/operator-rs.git", tag = "stackable-operator-0.87.3" }
 product-config = { git = "https://github.com/stackabletech/product-config.git", tag = "0.7.0" }
 
 anyhow = "1.0"

Cargo.nix

@@ -3,7 +3,7 @@
 You can specify just a connection/bucket for either ingestion or deep storage or for both, but Druid only supports a single S3 connection under the hood.
 If two connections are specified, they must be the same. This is easiest if a dedicated S3 Connection Resource is used - not defined inline but as a dedicated object.
 
-The connection/bucket `region.name` field is ignored because Druid uses the AWS SDK v1, which ignores the region if the endpoint is set.
+The `S3Connection` `region` field is ignored because Druid uses the AWS SDK v1, which ignores the region if the endpoint is set.
 The host is a required field, therefore the endpoint will always be set.
 
 TLS for S3 is not yet supported.

Cargo.toml

@@ -389,6 +389,7 @@ impl v1alpha1::DruidCluster {
         Ok(result)
     }
 
+    #[allow(clippy::type_complexity)]
     pub fn build_role_properties(
         &self,
     ) -> HashMap<

crate-hashes.json

@@ -734,6 +734,17 @@ fn build_rolegroup_config_map(
                 };
 
                 if let Some(s3) = s3_conn {
+                    if !s3.region.is_default_config() {
+                        // Raising this as warning instead of returning an error, better safe than sorry.
+                        // It might still work out for the user.
+                        tracing::warn!(
+                            region = ?s3.region,
+                            "You configured a non-default region on the S3Connection.
+                            The S3Connection region field is ignored because Druid uses the AWS SDK v1, which ignores the region if the endpoint is set. \
+                            The host is a required field, therefore the endpoint will always be set."
+                        )
+                    }
+
                     conf.insert(
                         S3_ENDPOINT_URL.to_string(),
                         Some(s3.endpoint().context(ConfigureS3Snafu)?.to_string()),