chore: tidy up metrics ports and use consts

Author: NickLarsenNZ

rust/operator-binary/src/config/jvm.rs

@@ -5,8 +5,8 @@ use stackable_operator::{
 };
 
 use crate::crd::{
-    JVM_SECURITY_PROPERTIES_FILE, LOG4J_CONFIG_FILE, LOGBACK_CONFIG_FILE, LoggingFramework,
-    METRICS_PORT, STACKABLE_CONFIG_DIR, STACKABLE_LOG_CONFIG_DIR,
+    JMX_METRICS_PORT, JVM_SECURITY_PROPERTIES_FILE, LOG4J_CONFIG_FILE, LOGBACK_CONFIG_FILE,
+    LoggingFramework, STACKABLE_CONFIG_DIR, STACKABLE_LOG_CONFIG_DIR,
     v1alpha1::{
         ZookeeperCluster, ZookeeperConfig, ZookeeperConfigFragment, ZookeeperServerRoleConfig,
     },
@@ -39,7 +39,7 @@ fn construct_jvm_args(
     let jvm_args = vec![
         format!("-Djava.security.properties={STACKABLE_CONFIG_DIR}/{JVM_SECURITY_PROPERTIES_FILE}"),
         format!(
-            "-javaagent:/stackable/jmx/jmx_prometheus_javaagent.jar={METRICS_PORT}:/stackable/jmx/server.yaml"
+            "-javaagent:/stackable/jmx/jmx_prometheus_javaagent.jar={JMX_METRICS_PORT}:/stackable/jmx/server.yaml"
         ),
         match logging_framework {
             LoggingFramework::LOG4J => {

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

@@ -51,12 +51,16 @@ pub const OPERATOR_NAME: &str = "zookeeper.stackable.tech";
 pub const ZOOKEEPER_PROPERTIES_FILE: &str = "zoo.cfg";
 pub const JVM_SECURITY_PROPERTIES_FILE: &str = "security.properties";
 
+pub const ZOOKEEPER_SERVER_PORT_NAME: &str = "zk";
+pub const ZOOKEEPER_LEADER_PORT_NAME: &str = "zk-leader";
 pub const ZOOKEEPER_LEADER_PORT: u16 = 2888;
+pub const ZOOKEEPER_ELECTION_PORT_NAME: &str = "zk-election";
 pub const ZOOKEEPER_ELECTION_PORT: u16 = 3888;
 
-pub const METRICS_PORT_NAME: &str = "metrics";
-pub const METRICS_PORT: u16 = 9505;
+pub const JMX_METRICS_PORT_NAME: &str = "metrics";
+pub const JMX_METRICS_PORT: u16 = 9505;
 pub const METRICS_PROVIDER_HTTP_PORT_KEY: &str = "metricsProvider.httpPort";
+pub const METRICS_PROVIDER_HTTP_PORT_NAME: &str = "native-metrics";
 pub const METRICS_PROVIDER_HTTP_PORT: u16 = 7000;
 
 pub const STACKABLE_DATA_DIR: &str = "/stackable/data";

rust/operator-binary/src/discovery.rs

@@ -10,7 +10,7 @@ use stackable_operator::{
 };
 
 use crate::{
-    crd::{ZookeeperRole, security::ZookeeperSecurity, v1alpha1},
+    crd::{ZOOKEEPER_SERVER_PORT_NAME, ZookeeperRole, security::ZookeeperSecurity, v1alpha1},
     utils::build_recommended_labels,
 };
 
@@ -75,7 +75,7 @@ pub fn build_discovery_configmap(
     let name = owner.name_unchecked();
     let namespace = owner.namespace().context(NoNamespaceSnafu)?;
 
-    let listener_addresses = listener_addresses(&listener, "zk")?;
+    let listener_addresses = listener_addresses(&listener, ZOOKEEPER_SERVER_PORT_NAME)?;
 
     // Write a connection string of the format that Java ZooKeeper client expects:
     // "{host1}:{port1},{host2:port2},.../{chroot}"

rust/operator-binary/src/listener.rs

@@ -7,7 +7,7 @@ use stackable_operator::{
 };
 
 use crate::{
-    crd::{ZookeeperRole, security::ZookeeperSecurity, v1alpha1},
+    crd::{ZOOKEEPER_SERVER_PORT_NAME, ZookeeperRole, security::ZookeeperSecurity, v1alpha1},
     utils::build_recommended_labels,
     zk_controller::ZK_CONTROLLER_NAME,
 };
@@ -85,11 +85,10 @@ pub fn role_listener_name(zk: &v1alpha1::ZookeeperCluster, zk_role: &ZookeeperRo
     format!("{zk}-{zk_role}", zk = zk.name_any())
 }
 
-// We only use the http port here and intentionally omit
-// the metrics one.
+// We only use the server port here and intentionally omit the metrics one.
 fn listener_ports(zookeeper_security: &ZookeeperSecurity) -> Vec<listener::v1alpha1::ListenerPort> {
     vec![listener::v1alpha1::ListenerPort {
-        name: "zk".to_string(),
+        name: ZOOKEEPER_SERVER_PORT_NAME.to_string(),
         port: zookeeper_security.client_port().into(),
         protocol: Some("TCP".to_string()),
     }]

rust/operator-binary/src/zk_controller.rs

@@ -76,11 +76,14 @@ use crate::{
     command::create_init_container_command_args,
     config::jvm::{construct_non_heap_jvm_args, construct_zk_server_heap_env},
     crd::{
-        DOCKER_IMAGE_BASE_NAME, JVM_SECURITY_PROPERTIES_FILE, MAX_PREPARE_LOG_FILE_SIZE,
-        MAX_ZK_LOG_FILES_SIZE, METRICS_PORT, METRICS_PORT_NAME, METRICS_PROVIDER_HTTP_PORT,
-        METRICS_PROVIDER_HTTP_PORT_KEY, STACKABLE_CONFIG_DIR, STACKABLE_DATA_DIR,
+        DOCKER_IMAGE_BASE_NAME, JMX_METRICS_PORT, JMX_METRICS_PORT_NAME,
+        JVM_SECURITY_PROPERTIES_FILE, MAX_PREPARE_LOG_FILE_SIZE, MAX_ZK_LOG_FILES_SIZE,
+        METRICS_PROVIDER_HTTP_PORT, METRICS_PROVIDER_HTTP_PORT_KEY,
+        METRICS_PROVIDER_HTTP_PORT_NAME, STACKABLE_CONFIG_DIR, STACKABLE_DATA_DIR,
         STACKABLE_LOG_CONFIG_DIR, STACKABLE_LOG_DIR, STACKABLE_RW_CONFIG_DIR,
-        ZOOKEEPER_ELECTION_PORT, ZOOKEEPER_LEADER_PORT, ZOOKEEPER_PROPERTIES_FILE, ZookeeperRole,
+        ZOOKEEPER_ELECTION_PORT, ZOOKEEPER_ELECTION_PORT_NAME, ZOOKEEPER_LEADER_PORT,
+        ZOOKEEPER_LEADER_PORT_NAME, ZOOKEEPER_PROPERTIES_FILE, ZOOKEEPER_SERVER_PORT_NAME,
+        ZookeeperRole,
         security::{self, ZookeeperSecurity},
         v1alpha1::{self, ZookeeperServerRoleConfig},
     },
@@ -693,15 +696,13 @@ fn build_server_rolegroup_headless_service(
         cluster_ip: Some("None".to_string()),
         ports: Some(vec![
             ServicePort {
-                // TODO (@NickLarsenNZ): Use a const
-                name: Some("zk-leader".to_string()),
+                name: Some(ZOOKEEPER_LEADER_PORT_NAME.to_string()),
                 port: ZOOKEEPER_LEADER_PORT as i32,
                 protocol: Some("TCP".to_string()),
                 ..ServicePort::default()
             },
             ServicePort {
-                // TODO (@NickLarsenNZ): Use a const
-                name: Some("zk-election".to_string()),
+                name: Some(ZOOKEEPER_ELECTION_PORT_NAME.to_string()),
                 port: ZOOKEEPER_ELECTION_PORT as i32,
                 protocol: Some("TCP".to_string()),
                 ..ServicePort::default()
@@ -757,15 +758,14 @@ fn build_server_rolegroup_metrics_service(
         cluster_ip: Some("None".to_string()),
         ports: Some(vec![
             ServicePort {
-                name: Some(METRICS_PORT_NAME.to_string()),
-                port: METRICS_PORT.into(),
+                name: Some(JMX_METRICS_PORT_NAME.to_string()),
+                port: JMX_METRICS_PORT as i32,
                 protocol: Some("TCP".to_string()),
                 ..ServicePort::default()
             },
             ServicePort {
-                // TODO (@NickLarsenNZ): Use a const: METRICS_PROVIDER_HTTP_PORT_NAME
-                name: Some("native-metrics".to_string()),
-                port: metrics_port_from_rolegroup_config(rolegroup_config).into(),
+                name: Some(METRICS_PROVIDER_HTTP_PORT_NAME.to_string()),
+                port: metrics_port_from_rolegroup_config(rolegroup_config) as i32,
                 protocol: Some("TCP".to_string()),
                 ..ServicePort::default()
             },
@@ -983,13 +983,15 @@ fn build_server_rolegroup_statefulset(
             period_seconds: Some(1),
             ..Probe::default()
         })
-        // TODO (@NickLarsenNZ): Use consts for the port names (since they are used in multiple places)
-        .add_container_port("zk", zookeeper_security.client_port().into())
-        .add_container_port("zk-leader", ZOOKEEPER_LEADER_PORT as i32)
-        .add_container_port("zk-election", ZOOKEEPER_ELECTION_PORT as i32)
-        .add_container_port("metrics", 9505)
         .add_container_port(
-            "native-metrics",
+            ZOOKEEPER_SERVER_PORT_NAME,
+            zookeeper_security.client_port() as i32,
+        )
+        .add_container_port(ZOOKEEPER_LEADER_PORT_NAME, ZOOKEEPER_LEADER_PORT as i32)
+        .add_container_port(ZOOKEEPER_ELECTION_PORT_NAME, ZOOKEEPER_ELECTION_PORT as i32)
+        .add_container_port(JMX_METRICS_PORT_NAME, 9505)
+        .add_container_port(
+            METRICS_PROVIDER_HTTP_PORT_NAME,
             metrics_port_from_rolegroup_config(server_config).into(),
         )
         .add_volume_mount("data", STACKABLE_DATA_DIR)