fix docs

Author: maltesander

rust/operator-binary/src/crd/mod.rs

@@ -341,7 +341,7 @@ pub struct KafkaPodDescriptor {
 
 impl KafkaPodDescriptor {
     /// Return the fully qualified domain name
-    /// Format: <pod-name>.<service>.<namespace>.svc.<cluster-domain>
+    /// Format: `<pod-name>.<service>.<namespace>.svc.<cluster-domain>`
     pub fn fqdn(&self) -> String {
         format!(
             "{pod_name}.{service_name}.{namespace}.svc.{cluster_domain}",
@@ -357,11 +357,11 @@ impl KafkaPodDescriptor {
     }
 
     /// Build the Kraft voter String
-    /// See: https://kafka.apache.org/documentation/#kraft_storage_voters
+    /// See: <https://kafka.apache.org/documentation/#kraft_storage_voters>
     /// Example: 0@controller-0:1234:0000000000-00000000000
     ///   * 0 is the replica id
     ///   * 0000000000-00000000000 is the replica directory id (even though the used Uuid states to be type 4 it does not work)
-    ///     See: https://github.com/apache/kafka/blob/c5169ca805bd03d870a5bcd49744dcc34891cf15/clients/src/main/java/org/apache/kafka/common/Uuid.java#L29
+    ///     See: <https://github.com/apache/kafka/blob/c5169ca805bd03d870a5bcd49744dcc34891cf15/clients/src/main/java/org/apache/kafka/common/Uuid.java#L29>
     ///   * controller-0 is the replica's host,
     ///   * 1234 is the replica's port.
     // TODO(@maltesander): Even though the used Uuid states to be type 4 it does not work... 0000000000-00000000000 works...

rust/operator-binary/src/kafka_controller.rs

@@ -49,7 +49,7 @@ use crate::{
     resource::{
         configmap::build_rolegroup_config_map,
         listener::build_broker_rolegroup_bootstrap_listener,
-        service::build_broker_rolegroup_service,
+        service::build_rolegroup_service,
         statefulset::{build_broker_rolegroup_statefulset, build_controller_rolegroup_statefulset},
     },
 };
@@ -348,7 +348,7 @@ pub async fn reconcile_kafka(
                 .context(FailedToResolveConfigSnafu)?;
 
             let rg_service =
-                build_broker_rolegroup_service(kafka, &resolved_product_image, &rolegroup_ref)
+                build_rolegroup_service(kafka, &resolved_product_image, &rolegroup_ref)
                     .context(BuildServiceSnafu)?;
 
             let rg_configmap = build_rolegroup_config_map(

rust/operator-binary/src/resource/service.rs

@@ -34,7 +34,7 @@ pub enum Error {
 /// The rolegroup [`Service`] is a headless service that allows direct access to the instances of a certain rolegroup
 ///
 /// This is mostly useful for internal communication between peers, or for clients that perform client-side load balancing.
-pub fn build_broker_rolegroup_service(
+pub fn build_rolegroup_service(
     kafka: &v1alpha1::KafkaCluster,
     resolved_product_image: &ResolvedProductImage,
     rolegroup: &RoleGroupRef<v1alpha1::KafkaCluster>,

rust/operator-binary/src/resource/statefulset.rs

@@ -155,7 +155,8 @@ pub enum Error {
 
 /// The broker rolegroup [`StatefulSet`] runs the rolegroup, as configured by the administrator.
 ///
-/// The [`Pod`](`stackable_operator::k8s_openapi::api::core::v1::Pod`)s are accessible through the corresponding [`Service`] (from [`build_broker_rolegroup_service`]).
+/// The [`Pod`](`stackable_operator::k8s_openapi::api::core::v1::Pod`)s are accessible through the corresponding
+/// [`Service`](`stackable_operator::k8s_openapi::api::core::v1::Service`) from [`build_rolegroup_service`](`crate::resource::service::build_rolegroup_service`).
 #[allow(clippy::too_many_arguments)]
 pub fn build_broker_rolegroup_statefulset(
     kafka: &v1alpha1::KafkaCluster,