feat: HBase Listener integration

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## [Unreleased]
 
+### Added
+
+- Added listener support for HBase ([#639]).
+
+[#639]: https://github.com/stackabletech/hbase-operator/pull/639
+
 ## [25.3.0] - 2025-03-21
 
 ### Added

deploy/helm/hbase-operator/crds/crds.yaml

@@ -73,20 +73,6 @@ spec:
                     hdfsConfigMapName:
                       description: Name of the [discovery ConfigMap](https://docs.stackable.tech/home/nightly/concepts/service_discovery) for an HDFS cluster.
                       type: string
-                    listenerClass:
-                      default: cluster-internal
-                      description: |-
-                        This field controls which type of Service the Operator creates for this HbaseCluster:
-
-                        * cluster-internal: Use a ClusterIP service
-
-                        * external-unstable: Use a NodePort service
-
-                        This is a temporary solution with the goal to keep yaml manifests forward compatible. In the future, this setting will control which [ListenerClass](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass.html) will be used to expose the service, and ListenerClass names will stay the same, allowing for a non-breaking change.
-                      enum:
-                        - cluster-internal
-                        - external-unstable
-                      type: string
                     vectorAggregatorConfigMapName:
                       description: Name of the Vector aggregator [discovery ConfigMap](https://docs.stackable.tech/home/nightly/concepts/service_discovery). It must contain the key `ADDRESS` with the address of the Vector aggregator. Follow the [logging tutorial](https://docs.stackable.tech/home/nightly/tutorials/logging-vector-aggregator) to learn how to configure log aggregation with Vector.
                       nullable: true
@@ -210,6 +196,14 @@ spec:
                         hbaseRootdir:
                           nullable: true
                           type: string
+                        listenerClass:
+                          description: This field controls which [ListenerClass](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass.html) is used to expose this rolegroup.
+                          enum:
+                            - cluster-internal
+                            - external-unstable
+                            - external-stable
+                          nullable: true
+                          type: string
                         logging:
                           default:
                             containers: {}
@@ -460,6 +454,14 @@ spec:
                               hbaseRootdir:
                                 nullable: true
                                 type: string
+                              listenerClass:
+                                description: This field controls which [ListenerClass](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass.html) is used to expose this rolegroup.
+                                enum:
+                                  - cluster-internal
+                                  - external-unstable
+                                  - external-stable
+                                nullable: true
+                                type: string
                               logging:
                                 default:
                                   containers: {}
@@ -691,6 +693,14 @@ spec:
                         hbaseRootdir:
                           nullable: true
                           type: string
+                        listenerClass:
+                          description: This field controls which [ListenerClass](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass.html) is used to expose this rolegroup.
+                          enum:
+                            - cluster-internal
+                            - external-unstable
+                            - external-stable
+                          nullable: true
+                          type: string
                         logging:
                           default:
                             containers: {}
@@ -969,6 +979,14 @@ spec:
                               hbaseRootdir:
                                 nullable: true
                                 type: string
+                              listenerClass:
+                                description: This field controls which [ListenerClass](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass.html) is used to expose this rolegroup.
+                                enum:
+                                  - cluster-internal
+                                  - external-unstable
+                                  - external-stable
+                                nullable: true
+                                type: string
                               logging:
                                 default:
                                   containers: {}
@@ -1228,6 +1246,14 @@ spec:
                         hbaseRootdir:
                           nullable: true
                           type: string
+                        listenerClass:
+                          description: This field controls which [ListenerClass](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass.html) is used to expose this rolegroup.
+                          enum:
+                            - cluster-internal
+                            - external-unstable
+                            - external-stable
+                          nullable: true
+                          type: string
                         logging:
                           default:
                             containers: {}
@@ -1478,6 +1504,14 @@ spec:
                               hbaseRootdir:
                                 nullable: true
                                 type: string
+                              listenerClass:
+                                description: This field controls which [ListenerClass](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass.html) is used to expose this rolegroup.
+                                enum:
+                                  - cluster-internal
+                                  - external-unstable
+                                  - external-stable
+                                nullable: true
+                                type: string
                               logging:
                                 default:
                                   containers: {}

deploy/helm/hbase-operator/templates/roles.yaml

@@ -77,6 +77,12 @@ rules:
     verbs:
       - create
       - patch
+  - apiGroups:
+      - listeners.stackable.tech
+    resources:
+      - listeners
+    verbs:
+      - get
   - apiGroups:
       - {{ include "operator.name" . }}.stackable.tech
     resources:

docs/modules/hbase/pages/usage-guide/listenerclass.adoc

@@ -1,18 +1,37 @@
 = Service exposition with ListenerClasses
+:description: Configure HBase service exposure using ListenerClasses to control internal and external access for all roles.
 
-Apache HBase offers an API.
-The operator deploys a service called `<name>` (where `<name>` is the name of the HbaseCluster) through which HBase can be reached.
+The operator deploys a xref:listener-operator:listener.adoc[Listener] for each Master, Regionserver and Restserver pod.
+They all default to only being accessible from within the Kubernetes cluster, but this can be changed by setting `.spec.{masters,regionServers,restServers}.config.listenerClass`:
 
-This service can have either the `cluster-internal` or `external-unstable` type.
-`external-stable` is not supported for HBase at the moment.
-Read more about the types in the xref:concepts:service-exposition.adoc[service exposition] documentation at platform level.
+[source,yaml]
+----
+spec:
+  masters:
+    config:
+      listenerClass: external-unstable  # <1>
+  regionServers:
+    config:
+      listenerClass: external-unstable
+  restServers:
+    config:
+      listenerClass: external-unstable
+----
+<1> Specify one of `external-stable`, `external-unstable`, `cluster-internal` (the default setting is `cluster-internal`).
+This can be set separately for all three roles.
 
-This is how the listener class is configured:
+Externally-reachable endpoints (i.e. where listener-class = `external-unstable` or `external-unstable`) are written to a ConfigMap called `<cluster-name>-ui-endpoints`, listing each rolegroup by replica:
 
 [source,yaml]
 ----
-spec:
-  clusterConfig:
-    listenerClass: cluster-internal  # <1>
+apiVersion: v1
+data:
+  hbase.master-0.ui: 172.19.0.3:32353
+  hbase.master-1.ui: 172.19.0.5:31817
+  hbase.regionserver-0.ui: 172.19.0.3:31719
+  hbase.regionserver-1.ui: 172.19.0.5:30626
+  hbase.restserver-0.ui: 172.19.0.3:31790
+  hbase.restserver-1.ui: 172.19.0.5:32292
+kind: ConfigMap
+...
 ----
-<1> The default `cluster-internal` setting.