feat: Add conversion webhook

Author: Techassi

Cargo.lock

@@ -10,7 +10,7 @@ edition = "2024"
 repository = "https://github.com/stackabletech/opensearch-operator"
 
 [workspace.dependencies]
-stackable-operator = { git = "https://github.com/stackabletech/operator-rs.git", tag = "stackable-operator-0.105.0", features = ["telemetry", "versioned"] }
+stackable-operator = { git = "https://github.com/stackabletech/operator-rs.git", tag = "stackable-operator-0.105.0", features = ["telemetry", "versioned", "webhook"] }
 
 built = { version = "0.8.0", features = ["chrono", "git2"] }
 clap = "4.5"

Cargo.nix

@@ -17,11 +17,6 @@ custom_build(
     outputs_image_ref_to='result/ref',
 )
 
-# Load the latest CRDs from Nix
-watch_file('result')
-if os.path.exists('result'):
-   k8s_yaml('result/crds.yaml')
-
 # We need to set the correct image annotation on the operator Deployment to use e.g.
 # oci.stackable.tech/sandbox/opa-operator:7y19m3d8clwxlv34v5q2x4p7v536s00g instead of
 # oci.stackable.tech/sandbox/opa-operator:0.0.0-dev (which does not exist)
@@ -35,18 +30,12 @@ helm_values = settings.get('helm_values', None)
 
 helm_override_image_repository = 'image.repository=' + registry + '/' + operator_name
 
-# Exclude stale CRDs from Helm chart, and apply the rest
-helm_crds, helm_non_crds = filter_yaml(
-   helm(
-      'deploy/helm/' + operator_name,
-      name=operator_name,
-      namespace="stackable-operators",
-      set=[
-         helm_override_image_repository,
-      ],
-      values=helm_values,
-   ),
-   api_version = "^apiextensions\\.k8s\\.io/.*$",
-   kind = "^CustomResourceDefinition$",
-)
-k8s_yaml(helm_non_crds)
+k8s_yaml(helm(
+   'deploy/helm/' + operator_name,
+   name=operator_name,
+   namespace="stackable-operators",
+   set=[
+      helm_override_image_repository,
+   ],
+   values=helm_values,
+))

Cargo.toml

@@ -57,6 +57,7 @@ pub const HTTP_PORT_NAME: &str = "http";
 pub const HTTP_PORT: Port = Port(9200);
 pub const TRANSPORT_PORT_NAME: &str = "transport";
 pub const TRANSPORT_PORT: Port = Port(9300);
+pub const FIELD_MANAGER: &str = "opensearch-operator";
 
 /// Names in the controller context which are passed to the submodules of the controller
 ///

Tiltfile

@@ -34,6 +34,7 @@ use strum::{EnumDiscriminants, IntoStaticStr};
 mod controller;
 mod crd;
 mod framework;
+mod webhooks;
 
 mod built_info {
     include!(concat!(env!("OUT_DIR"), "/built.rs"));
@@ -74,6 +75,18 @@ pub enum Error {
     CreateSignalWatcher {
         source: stackable_operator::utils::signal::SignalError,
     },
+
+    #[snafu(display("failed to create webhook server"))]
+    CreateWebhook { source: webhooks::conversion::Error },
+
+    // No context selector is being generated here so that we can run the webhook
+    // as is, without the need to map the error to this variant. The ? operator
+    // used after the futures::try_join function automatically converts the
+    // underlying error to this variant.
+    #[snafu(display("failed to run webhook server"), context(false))]
+    RunWebhook {
+        source: stackable_operator::webhook::WebhookServerError,
+    },
 }
 
 #[derive(clap::Parser)]
@@ -95,7 +108,7 @@ async fn main() -> Result<()> {
                 .context(SerializeCrdSnafu)?;
         }
         Command::Run(RunArguments {
-            operator_environment: _,
+            operator_environment,
             product_config: _,
             watch_namespace,
             maintenance,
@@ -135,6 +148,16 @@ async fn main() -> Result<()> {
             .await
             .context(CreateClientSnafu)?;
 
+            let webhook_server = webhooks::conversion::create_webhook_server(
+                &operator_environment,
+                maintenance.disable_crd_maintenance,
+                client.as_kube_client(),
+            )
+            .await
+            .context(CreateWebhookSnafu)?;
+
+            let webhook_server = webhook_server.run(sigterm_watcher.handle());
+
             let controller_context = controller::Context::new(client.clone(), operator_name);
             let full_controller_name = controller_context.full_controller_name();
 
@@ -203,7 +226,7 @@ async fn main() -> Result<()> {
             )
             .map(Ok);
 
-            futures::try_join!(controller, eos_checker)?;
+            futures::try_join!(controller, eos_checker, webhook_server)?;
         }
     }
 

crate-hashes.json

@@ -0,0 +1,55 @@
+use snafu::{ResultExt, Snafu};
+use stackable_operator::{
+    cli::OperatorEnvironmentOptions,
+    kube::{Client, core::crd::MergeError},
+    webhook::{
+        WebhookServer, WebhookServerError, WebhookServerOptions,
+        webhooks::{ConversionWebhook, ConversionWebhookOptions},
+    },
+};
+
+use crate::{
+    controller::FIELD_MANAGER,
+    crd::{OpenSearchCluster, OpenSearchClusterVersion},
+};
+
+/// Contains errors which can be encountered when creating the conversion webhook server and the
+/// CRD maintainer.
+#[derive(Debug, Snafu)]
+pub enum Error {
+    #[snafu(display("failed to merge CRD"))]
+    MergeCrd { source: MergeError },
+
+    #[snafu(display("failed to create conversion webhook server"))]
+    CreateWebhook { source: WebhookServerError },
+}
+
+/// Creates and returns a [`WebhookServer`].
+pub async fn create_webhook_server(
+    operator_environment: &OperatorEnvironmentOptions,
+    disable_crd_maintenance: bool,
+    client: Client,
+) -> Result<WebhookServer, Error> {
+    let crds_and_handlers = vec![(
+        OpenSearchCluster::merged_crd(OpenSearchClusterVersion::V1Alpha1).context(MergeCrdSnafu)?,
+        OpenSearchCluster::try_convert,
+    )];
+
+    let conversion_webhook_options = ConversionWebhookOptions {
+        disable_crd_maintenance,
+        field_manager: FIELD_MANAGER.to_owned(),
+    };
+
+    let (conversion_webhook, _initial_reconcile_rx) =
+        ConversionWebhook::new(crds_and_handlers, client, conversion_webhook_options);
+
+    let webhook_server_options = WebhookServerOptions {
+        socket_addr: WebhookServer::DEFAULT_SOCKET_ADDRESS,
+        webhook_namespace: operator_environment.operator_namespace.to_owned(),
+        webhook_service_name: operator_environment.operator_service_name.to_owned(),
+    };
+
+    WebhookServer::new(vec![Box::new(conversion_webhook)], webhook_server_options)
+        .await
+        .context(CreateWebhookSnafu)
+}

rust/operator-binary/src/controller.rs

@@ -0,0 +1 @@
+pub mod conversion;