Rework CLI structs and names

Author: sbernauer

crates/stackable-operator/CHANGELOG.md

@@ -37,6 +37,9 @@ All notable changes to this project will be documented in this file.
 - BREAKING: Return type for `ListenerOperatorVolumeSourceBuilder::new()` is no longer a `Result` ([#1058]).
 - BREAKING: Require two new CLI arguments: `--operator-namespace` and `-operator-service-name`.
   These are required, so that the operator knows what Service it needs to enter as CRD conversion webhook ([#1066]).
+- BREAKING: The `ProductOperatorRun` used for CLI arguments has some field renamed for consistency ([#1066]):
+  - `telemetry_arguments` -> `telemetry`
+  - `cluster_info_opts` -> `cluster_info`
 
 ### Fixed
 

crates/stackable-operator/src/cli.rs

@@ -116,7 +116,7 @@ use product_config::ProductConfigManager;
 use snafu::{ResultExt, Snafu};
 use stackable_telemetry::tracing::TelemetryOptions;
 
-use crate::{namespace::WatchNamespace, utils::cluster_info::KubernetesClusterInfoOpts};
+use crate::{namespace::WatchNamespace, utils::cluster_info::KubernetesClusterInfoOptions};
 
 pub const AUTHOR: &str = "Stackable GmbH - info@stackable.tech";
 
@@ -163,10 +163,10 @@ pub enum Command<Run: Args = ProductOperatorRun> {
 /// Can be embedded into an extended argument set:
 ///
 /// ```rust
-/// # use stackable_operator::cli::{Command, OperatorEnvironmentOpts, ProductOperatorRun, ProductConfigPath};
+/// # use stackable_operator::cli::{Command, OperatorEnvironmentOptions, ProductOperatorRun, ProductConfigPath};
+/// # use stackable_operator::{namespace::WatchNamespace, utils::cluster_info::KubernetesClusterInfoOptions};
+/// # use stackable_telemetry::tracing::TelemetryOptions;
 /// use clap::Parser;
-/// use stackable_operator::{namespace::WatchNamespace, utils::cluster_info::KubernetesClusterInfoOpts};
-/// use stackable_telemetry::tracing::TelemetryOptions;
 ///
 /// #[derive(clap::Parser, Debug, PartialEq, Eq)]
 /// struct Run {
@@ -197,12 +197,12 @@ pub enum Command<Run: Args = ProductOperatorRun> {
 ///     common: ProductOperatorRun {
 ///         product_config: ProductConfigPath::from("bar".as_ref()),
 ///         watch_namespace: WatchNamespace::One("foobar".to_string()),
-///         telemetry_arguments: TelemetryOptions::default(),
-///         cluster_info_opts: KubernetesClusterInfoOpts {
+///         telemetry: TelemetryOptions::default(),
+///         cluster_info: KubernetesClusterInfoOptions {
 ///             kubernetes_cluster_domain: None,
 ///             kubernetes_node_name: "baz".to_string(),
 ///         },
-///         operator_environment: OperatorEnvironmentOpts {
+///         operator_environment: OperatorEnvironmentOptions {
 ///             operator_namespace: "stackable-operators".to_string(),
 ///             operator_service_name: "foo-operator".to_string(),
 ///         },
@@ -239,13 +239,13 @@ pub struct ProductOperatorRun {
     pub watch_namespace: WatchNamespace,
 
     #[command(flatten)]
-    pub operator_environment: OperatorEnvironmentOpts,
+    pub operator_environment: OperatorEnvironmentOptions,
 
     #[command(flatten)]
-    pub telemetry_arguments: TelemetryOptions,
+    pub telemetry: TelemetryOptions,
 
     #[command(flatten)]
-    pub cluster_info_opts: KubernetesClusterInfoOpts,
+    pub cluster_info: KubernetesClusterInfoOptions,
 }
 
 /// A path to a [`ProductConfigManager`] spec file
@@ -304,7 +304,7 @@ impl ProductConfigPath {
 }
 
 #[derive(clap::Parser, Debug, PartialEq, Eq)]
-pub struct OperatorEnvironmentOpts {
+pub struct OperatorEnvironmentOptions {
     /// The namespace the operator is running in, usually `stackable-operators`.
     #[arg(long, env)]
     pub operator_namespace: String,
@@ -440,12 +440,12 @@ mod tests {
             ProductOperatorRun {
                 product_config: ProductConfigPath::from("bar".as_ref()),
                 watch_namespace: WatchNamespace::One("foo".to_string()),
-                cluster_info_opts: KubernetesClusterInfoOpts {
+                cluster_info: KubernetesClusterInfoOptions {
                     kubernetes_cluster_domain: None,
                     kubernetes_node_name: "baz".to_string()
                 },
-                telemetry_arguments: Default::default(),
-                operator_environment: OperatorEnvironmentOpts {
+                telemetry: Default::default(),
+                operator_environment: OperatorEnvironmentOptions {
                     operator_namespace: "stackable-operators".to_string(),
                     operator_service_name: "foo-operator".to_string(),
                 }
@@ -469,12 +469,12 @@ mod tests {
             ProductOperatorRun {
                 product_config: ProductConfigPath::from("bar".as_ref()),
                 watch_namespace: WatchNamespace::All,
-                cluster_info_opts: KubernetesClusterInfoOpts {
+                cluster_info: KubernetesClusterInfoOptions {
                     kubernetes_cluster_domain: None,
                     kubernetes_node_name: "baz".to_string()
                 },
-                telemetry_arguments: Default::default(),
-                operator_environment: OperatorEnvironmentOpts {
+                telemetry: Default::default(),
+                operator_environment: OperatorEnvironmentOptions {
                     operator_namespace: "stackable-operators".to_string(),
                     operator_service_name: "foo-operator".to_string(),
                 }
@@ -493,12 +493,12 @@ mod tests {
             ProductOperatorRun {
                 product_config: ProductConfigPath::from("bar".as_ref()),
                 watch_namespace: WatchNamespace::One("foo".to_string()),
-                cluster_info_opts: KubernetesClusterInfoOpts {
+                cluster_info: KubernetesClusterInfoOptions {
                     kubernetes_cluster_domain: None,
                     kubernetes_node_name: "baz".to_string()
                 },
-                telemetry_arguments: Default::default(),
-                operator_environment: OperatorEnvironmentOpts {
+                telemetry: Default::default(),
+                operator_environment: OperatorEnvironmentOptions {
                     operator_namespace: "stackable-operators".to_string(),
                     operator_service_name: "foo-operator".to_string(),
                 }

crates/stackable-operator/src/client.rs

@@ -21,7 +21,7 @@ use tracing::trace;
 
 use crate::{
     kvp::LabelSelectorExt,
-    utils::cluster_info::{KubernetesClusterInfo, KubernetesClusterInfoOpts},
+    utils::cluster_info::{KubernetesClusterInfo, KubernetesClusterInfoOptions},
 };
 
 pub type Result<T, E = Error> = std::result::Result<T, E>;
@@ -529,13 +529,13 @@ impl Client {
     /// use k8s_openapi::api::core::v1::Pod;
     /// use stackable_operator::{
     ///     client::{Client, initialize_operator},
-    ///     utils::cluster_info::KubernetesClusterInfoOpts,
+    ///     utils::cluster_info::KubernetesClusterInfoOptions,
     /// };
     ///
     /// #[tokio::main]
     /// async fn main() {
-    /// let cluster_info_opts = KubernetesClusterInfoOpts::parse();
-    /// let client = initialize_operator(None, &cluster_info_opts)
+    /// let cluster_info_options = KubernetesClusterInfoOptions::parse();
+    /// let client = initialize_operator(None, &cluster_info_options)
     ///     .await
     ///     .expect("Unable to construct client.");
     /// let watcher_config: watcher::Config =
@@ -652,7 +652,7 @@ where
 
 pub async fn initialize_operator(
     field_manager: Option<String>,
-    cluster_info_opts: &KubernetesClusterInfoOpts,
+    cluster_info_opts: &KubernetesClusterInfoOptions,
 ) -> Result<Client> {
     let kubeconfig: Config = kube::Config::infer()
         .await
@@ -687,10 +687,10 @@ mod tests {
     };
     use tokio::time::error::Elapsed;
 
-    use crate::utils::cluster_info::KubernetesClusterInfoOpts;
+    use crate::utils::cluster_info::KubernetesClusterInfoOptions;
 
-    async fn test_cluster_info_opts() -> KubernetesClusterInfoOpts {
-        KubernetesClusterInfoOpts {
+    async fn test_cluster_info_opts() -> KubernetesClusterInfoOptions {
+        KubernetesClusterInfoOptions {
             // We have to hard-code a made-up cluster domain,
             // since kubernetes_node_name (probably) won't be a valid Node that we can query.
             kubernetes_cluster_domain: Some(

crates/stackable-operator/src/utils/cluster_info.rs

@@ -16,7 +16,7 @@ pub struct KubernetesClusterInfo {
 }
 
 #[derive(clap::Parser, Debug, PartialEq, Eq)]
-pub struct KubernetesClusterInfoOpts {
+pub struct KubernetesClusterInfoOptions {
     /// Kubernetes cluster domain, usually this is `cluster.local`.
     // We are not using a default value here, as we query the cluster if it is not specified.
     #[arg(long, env)]
@@ -30,18 +30,18 @@ pub struct KubernetesClusterInfoOpts {
 impl KubernetesClusterInfo {
     pub async fn new(
         client: &Client,
-        cluster_info_opts: &KubernetesClusterInfoOpts,
+        cluster_info_opts: &KubernetesClusterInfoOptions,
     ) -> Result<Self, Error> {
         let cluster_domain = match cluster_info_opts {
-            KubernetesClusterInfoOpts {
+            KubernetesClusterInfoOptions {
                 kubernetes_cluster_domain: Some(cluster_domain),
                 ..
             } => {
                 tracing::info!(%cluster_domain, "Using configured Kubernetes cluster domain");
 
                 cluster_domain.clone()
             }
-            KubernetesClusterInfoOpts {
+            KubernetesClusterInfoOptions {
                 kubernetes_node_name: node_name,
                 ..
             } => {

crates/stackable-webhook/src/servers/conversion.rs

@@ -18,7 +18,7 @@ use kube::{
     api::{Patch, PatchParams},
 };
 use snafu::{OptionExt, ResultExt, Snafu};
-use stackable_operator::cli::OperatorEnvironmentOpts;
+use stackable_operator::cli::OperatorEnvironmentOptions;
 use tokio::{sync::mpsc, try_join};
 use tracing::instrument;
 use x509_cert::{
@@ -75,7 +75,7 @@ pub struct ConversionWebhookServer {
     client: Client,
     field_manager: String,
     crds: Vec<CustomResourceDefinition>,
-    operator_environment: OperatorEnvironmentOpts,
+    operator_environment: OperatorEnvironmentOptions,
 }
 
 impl ConversionWebhookServer {
@@ -144,7 +144,7 @@ impl ConversionWebhookServer {
         options: Options,
         client: Client,
         field_manager: impl Into<String> + Debug,
-        operator_environment: OperatorEnvironmentOpts,
+        operator_environment: OperatorEnvironmentOptions,
     ) -> Result<Self, ConversionWebhookError>
     where
         H: WebhookHandler<ConversionReview, ConversionReview> + Clone + Send + Sync + 'static,
@@ -241,7 +241,7 @@ impl ConversionWebhookServer {
         client: &Client,
         field_manager: &str,
         crds: &[CustomResourceDefinition],
-        operator_environment: &OperatorEnvironmentOpts,
+        operator_environment: &OperatorEnvironmentOptions,
     ) -> Result<(), ConversionWebhookError> {
         while let Some(current_cert) = cert_rx.recv().await {
             Self::reconcile_crds(
@@ -262,7 +262,7 @@ impl ConversionWebhookServer {
         client: &Client,
         field_manager: &str,
         crds: &[CustomResourceDefinition],
-        operator_environment: &OperatorEnvironmentOpts,
+        operator_environment: &OperatorEnvironmentOptions,
         current_cert: &Certificate,
     ) -> Result<(), ConversionWebhookError> {
         tracing::info!(