Add ConversionWebhookOptions struct

Author: sbernauer

Cargo.lock

@@ -19,6 +19,7 @@ hyper.workspace = true
 k8s-openapi.workspace = true
 kube.workspace = true
 opentelemetry.workspace = true
+opentelemetry-semantic-conventions.workspace = true
 rand.workspace = true
 serde_json.workspace = true
 snafu.workspace = true

crates/stackable-webhook/Cargo.toml

@@ -8,12 +8,12 @@
 //! routes and their handler functions.
 //!
 //! ```
-//! use stackable_webhook::{WebhookServer, Options};
+//! use stackable_webhook::{WebhookServer, WebhookOptions};
 //! use axum::Router;
 //!
 //! # async fn test() {
 //! let router = Router::new();
-//! let (server, cert_rx) = WebhookServer::new(router, Options::default())
+//! let (server, cert_rx) = WebhookServer::new(router, WebhookOptions::default())
 //!     .await
 //!     .expect("failed to create WebhookServer");
 //! # }
@@ -46,7 +46,7 @@ pub mod servers;
 pub mod tls;
 
 // Selected re-exports
-pub use crate::options::Options;
+pub use crate::options::WebhookOptions;
 
 /// A generic webhook handler receiving a request and sending back a response.
 ///
@@ -88,23 +88,23 @@ pub struct WebhookServer {
 impl WebhookServer {
     /// Creates a new ready-to-use webhook server.
     ///
-    /// The server listens on `socket_addr` which is provided via the [`Options`]
-    /// and handles routing based on the provided Axum `router`. Most of the time
-    /// it is sufficient to use [`Options::default()`]. See the documentation
-    /// for [`Options`] for more details on the default values.
+    /// The server listens on `socket_addr` which is provided via the [`WebhookOptions`] and handles
+    /// routing based on the provided Axum `router`. Most of the time it is sufficient to use
+    /// [`WebhookOptions::default()`]. See the documentation for [`WebhookOptions`] for more details
+    /// on the default values.
     ///
     /// To start the server, use the [`WebhookServer::run()`] function. This will
     /// run the server using the Tokio runtime until it is terminated.
     ///
     /// ### Basic Example
     ///
     /// ```
-    /// use stackable_webhook::{WebhookServer, Options};
+    /// use stackable_webhook::{WebhookServer, WebhookOptions};
     /// use axum::Router;
     ///
     /// # async fn test() {
     /// let router = Router::new();
-    /// let (server, cert_rx) = WebhookServer::new(router, Options::default())
+    /// let (server, cert_rx) = WebhookServer::new(router, WebhookOptions::default())
     ///     .await
     ///     .expect("failed to create WebhookServer");
     /// # }
@@ -113,11 +113,11 @@ impl WebhookServer {
     /// ### Example with Custom Options
     ///
     /// ```
-    /// use stackable_webhook::{WebhookServer, Options};
+    /// use stackable_webhook::{WebhookServer, WebhookOptions};
     /// use axum::Router;
     ///
     /// # async fn test() {
-    /// let options = Options::builder()
+    /// let options = WebhookOptions::builder()
     ///     .bind_address([127, 0, 0, 1], 8080)
     ///     .add_subject_alterative_dns_name("my-san-entry")
     ///     .build();
@@ -130,7 +130,7 @@ impl WebhookServer {
     /// ```
     pub async fn new(
         router: Router,
-        options: Options,
+        options: WebhookOptions,
     ) -> Result<(Self, mpsc::Receiver<Certificate>)> {
         tracing::trace!("create new webhook server");
 
@@ -154,13 +154,9 @@ impl WebhookServer {
             .route("/health", get(|| async { "ok" }));
 
         tracing::debug!("create TLS server");
-        let (tls_server, cert_rx) = TlsServer::new(
-            options.socket_addr,
-            router,
-            options.subject_alterative_dns_names,
-        )
-        .await
-        .context(CreateTlsServerSnafu)?;
+        let (tls_server, cert_rx) = TlsServer::new(router, options)
+            .await
+            .context(CreateTlsServerSnafu)?;
 
         Ok((Self { tls_server }, cert_rx))
     }

crates/stackable-webhook/src/lib.rs

@@ -10,34 +10,33 @@ use crate::constants::DEFAULT_SOCKET_ADDRESS;
 
 /// Specifies available webhook server options.
 ///
-/// The [`Default`] implemention for this struct contains the following
-/// values:
+/// The [`Default`] implementation for this struct contains the following values:
 ///
 /// - The socket binds to 127.0.0.1 on port 8443 (HTTPS)
-/// - The TLS cert used gets auto-generated
+/// - An empty list of SANs is provided to the certificate the TLS server uses.
 ///
 /// ### Example with Custom HTTPS IP Address and Port
 ///
 /// ```
-/// use stackable_webhook::Options;
+/// use stackable_webhook::WebhookOptions;
 ///
 /// // Set IP address and port at the same time
-/// let options = Options::builder()
+/// let options = WebhookOptions::builder()
 ///     .bind_address([0, 0, 0, 0], 12345)
 ///     .build();
 ///
 /// // Set IP address only
-/// let options = Options::builder()
+/// let options = WebhookOptions::builder()
 ///     .bind_ip([0, 0, 0, 0])
 ///     .build();
 ///
 /// // Set port only
-/// let options = Options::builder()
+/// let options = WebhookOptions::builder()
 ///     .bind_port(12345)
 ///     .build();
 /// ```
 #[derive(Debug)]
-pub struct Options {
+pub struct WebhookOptions {
     /// The default HTTPS socket address the [`TcpListener`][tokio::net::TcpListener]
     /// binds to.
     pub socket_addr: SocketAddr,
@@ -47,15 +46,15 @@ pub struct Options {
     pub subject_alterative_dns_names: Vec<String>,
 }
 
-impl Default for Options {
+impl Default for WebhookOptions {
     fn default() -> Self {
         Self::builder().build()
     }
 }
 
-impl Options {
+impl WebhookOptions {
     /// Returns the default [`OptionsBuilder`] which allows to selectively
-    /// customize the options. See the documention for [`Options`] for more
+    /// customize the options. See the documentation for [`Options`] for more
     /// information on available functions.
     pub fn builder() -> OptionsBuilder {
         OptionsBuilder::default()
@@ -106,7 +105,7 @@ impl OptionsBuilder {
         self
     }
 
-    /// Adds the (subject alterative DNS name to the list of names.
+    /// Adds the subject alterative DNS name to the list of names.
     pub fn add_subject_alterative_dns_name(
         mut self,
         subject_alterative_dns_name: impl Into<String>,
@@ -118,8 +117,8 @@ impl OptionsBuilder {
 
     /// Builds the final [`Options`] by using default values for any not
     /// explicitly set option.
-    pub fn build(self) -> Options {
-        Options {
+    pub fn build(self) -> WebhookOptions {
+        WebhookOptions {
             socket_addr: self.socket_addr.unwrap_or(DEFAULT_SOCKET_ADDRESS),
             subject_alterative_dns_names: self.subject_alterative_dns_names,
         }