feat: HBase Listener integration #639

adwk67 · 2025-03-26T15:39:02Z

Description

fixes: #618

Warning

Merge this at the same time as stackabletech/docker-images#1159, otherwise tests will break!

How to test

build the image locally with bake -p hbase from the branch for this PR
upload image(s) to local kind cluster with e.g. kind load docker-image oci.stackable.tech/sdp/hbase:2.6.1-stackable0.0.0-dev --name stackable-data-platform
deploy the operator with stackable op in hbase=0.0.0-pr639
run tests with e.g. ./scripts/run-tests --skip-operator hbase --test ...

Implementation notes

Persistent volumes are used for all endpoints as they are all user-facing
the listener endpoints are written to hbase-site.xml
no group listeners are used across a group of replicas, but each listener is specific to a particular pod

Output from the HBase demo:

17:59 $ stackablectl stacklet list

┌───────────┬───────────┬───────────┬──────────────────────────────────────────────────────────────┬─────────────────────────────────┐
│ PRODUCT   ┆ NAME      ┆ NAMESPACE ┆ ENDPOINTS                                                    ┆ CONDITIONS                      │
╞═══════════╪═══════════╪═══════════╪══════════════════════════════════════════════════════════════╪═════════════════════════════════╡
│ hbase     ┆ hbase     ┆ default   ┆ master-default-0-master              172.19.0.3:32673        ┆ Available, Reconciling, Running │
│           ┆           ┆           ┆ master-default-0-ui-http             172.19.0.3:30430        ┆                                 │
│           ┆           ┆           ┆ regionserver-default-0-regionserver  172.19.0.4:31204        ┆                                 │
│           ┆           ┆           ┆ regionserver-default-0-ui-http       172.19.0.4:31767        ┆                                 │
│           ┆           ┆           ┆ regionserver-default-1-regionserver  172.19.0.3:30602        ┆                                 │
│           ┆           ┆           ┆ regionserver-default-1-ui-http       172.19.0.3:31627        ┆                                 │
│           ┆           ┆           ┆ restserver-default-0-rest-http       172.19.0.3:30155        ┆                                 │
│           ┆           ┆           ┆ restserver-default-0-ui-http         172.19.0.3:30586        ┆                                 │
├╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤

The Localities indicate that the serving region is the same node as the HDFS data:

CRD change

Note

There does not need to be a decision on this (discussed briefly in planning 09.04.2024) as the implementation is in line with existing implementations for HDFs and Kafka.

old:

clusterConfig:
   listenerClass: {external-unstable|external-stable|cluster-internal}

new:
(this is inline with the implementations for HDFS and Kafka)

spec:
  masters:
    config:
      listenerClass: {external-unstable|external-stable|cluster-internal}
  regionServers:
    config:
      listenerClass: {external-unstable|external-stable|cluster-internal}
  restServers:
    config:
      listenerClass: {external-unstable|external-stable|cluster-internal}

Tests (OpenShift)

--- PASS: kuttl (1736.72s)
    --- PASS: kuttl/harness (0.00s)
        --- PASS: kuttl/harness/cluster-operation_hbase-latest-2.6.1_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_openshift-true (251.16s)
        --- PASS: kuttl/harness/omid_hbase-2.6.1_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_openshift-true_omid-1.1.2 (287.90s)
        --- PASS: kuttl/harness/orphaned_resources_hbase-latest-2.6.1_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_openshift-true (186.60s)
        --- PASS: kuttl/harness/smoke_hbase-2.6.1_hdfs-3.4.1_zookeeper-3.9.3_listener-class-external-unstable_openshift-true (320.82s)
        --- PASS: kuttl/harness/overrides_hbase-latest-2.6.1_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_openshift-true (182.74s)
        --- PASS: kuttl/harness/kerberos_hbase-2.6.1_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_krb5-1.21.1_listener-class-external-unstable_kerberos-realm-PROD.MYCORP_kerberos-backend-mit_openshift-true (510.35s)
        --- PASS: kuttl/harness/snapshot-export_hbase-2.6.1_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_openshift-true (259.22s)
        --- PASS: kuttl/harness/profiling_hbase-2.6.1_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_openshift-true (196.50s)
        --- PASS: kuttl/harness/opa_hbase-opa-2.6.1_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_krb5-1.21.1_opa-1.0.1_openshift-true (280.21s)
        --- PASS: kuttl/harness/logging_hbase-2.6.1_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_openshift-true (209.32s)
        --- PASS: kuttl/harness/shutdown_hbase-2.6.1_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_openshift-true (331.83s)
        --- PASS: kuttl/harness/external-access_hbase-2.6.1_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_listener-class-external-unstable_openshift-true (180.55s)
        --- PASS: kuttl/harness/resources_hbase-latest-2.6.1_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_openshift-true (213.95s)
PASS

Definition of Done Checklist

Not all of these items are applicable to all PRs, the author should update this template to only leave the boxes in that are relevant
Please make sure all these things are done and tick the boxes

Author

Changes are OpenShift compatible
CRD changes approved
CRD documentation for all fields, following the style guide.
Helm chart can be installed and deployed operator works
Integration tests passed (for non trivial changes)
Changes need to be "offline" compatible

Reviewer

Code contains useful comments
Code contains useful logging statements
(Integration-)Test cases added
Documentation added or updated. Follows the style guide.
Changelog updated
Cargo.toml only contains references to git tags (not specific commits or branches)

Acceptance

Feature Tracker has been updated
Proper release label has been added
Roadmap has been updated

sbernauer · 2025-04-09T07:05:52Z

Can you please run cargo update -p tokio to fix the cargo deny? :)

…g through as as argument

maltesander

Tests / Demos look good so far!

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

CHANGELOG.md

rust/operator-binary/src/hbase_controller.rs

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

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

Co-authored-by: Malte Sander <[email protected]>

adwk67 · 2025-06-27T08:12:29Z

🟢 Re-run local tests

Tests

--- PASS: kuttl (2312.09s)
    --- PASS: kuttl/harness (0.00s)
        --- PASS: kuttl/harness/logging_hbase-2.6.2_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_openshift-false (309.14s)
        --- PASS: kuttl/harness/shutdown_hbase-2.6.2_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_openshift-false (346.83s)
        --- PASS: kuttl/harness/overrides_hbase-latest-2.6.2_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_openshift-false (172.70s)
        --- PASS: kuttl/harness/omid_hbase-2.6.2_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_openshift-false_omid-1.1.3 (322.48s)
        --- PASS: kuttl/harness/resources_hbase-latest-2.6.2_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_openshift-false (162.23s)
        --- PASS: kuttl/harness/opa_hbase-opa-2.6.2_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_krb5-1.21.1_opa-1.4.2_openshift-false (390.30s)
        --- PASS: kuttl/harness/smoke_hbase-2.6.2_hdfs-3.4.1_zookeeper-3.9.3_listener-class-external-unstable_openshift-false (256.92s)
        --- PASS: kuttl/harness/smoke_hbase-2.6.2_hdfs-3.4.1_zookeeper-3.9.3_listener-class-cluster-internal_openshift-false (260.77s)
        --- PASS: kuttl/harness/orphaned_resources_hbase-latest-2.6.2_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_openshift-false (218.15s)
        --- PASS: kuttl/harness/snapshot-export_hbase-2.6.2_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_openshift-false (297.74s)
        --- PASS: kuttl/harness/profiling_hbase-2.6.2_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_openshift-false (159.04s)
        --- PASS: kuttl/harness/external-access_hbase-2.6.2_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_openshift-false (164.32s)
        --- PASS: kuttl/harness/kerberos_hbase-2.6.2_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_krb5-1.21.1_listener-class-external-unstable_kerberos-realm-PROD.MYCORP_kerberos-backend-mit_openshift-false (751.62s)
        --- PASS: kuttl/harness/kerberos_hbase-2.6.2_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_krb5-1.21.1_listener-class-cluster-internal_kerberos-realm-PROD.MYCORP_kerberos-backend-mit_openshift-false (448.56s)
        --- PASS: kuttl/harness/cluster-operation_hbase-latest-2.6.2_hdfs-latest-3.4.1_zookeeper-latest-3.9.3_openshift-false (209.02s)
PASS

maltesander

LGTM! Will wait with approval for on stackabletech/docker-images#1159

adwk67 added 2 commits March 26, 2025 14:09

output listener refs

05e5c16

add listener refs to config map

776e273

adwk67 self-assigned this Mar 26, 2025

adwk67 added 18 commits March 26, 2025 17:13

Merge branch 'main' into feat/integrate-listener-operator

d824b50

changelog

967239d

changed logging statement

4eb4e35

integration test

96593c7

changed listener class designation

ae1654a

update listener class docs

53ea8bc

working tests

f8cc1c7

wip: experimental command

7a2756b

cleanup start command

2affa65

added hostname/port to hbase-env.sh

652999e

wip: will move startup logic to hbase-entrypoint.sh

c8a2644

cleaned up/reverted previous wip

dd793c0

cleaned up/reverted previous wip II

bd1db17

correct callout

80adf71

use pvcs for externally-reachable endpoints

aee4fc2

added comment

bf969a0

docs

90efe2b

merge main

0030bfb

adwk67 marked this pull request as ready for review April 3, 2025 16:37

adwk67 requested a review from a team April 3, 2025 16:38

adwk67 moved this to Development: Waiting for Review in Stackable Engineering Apr 3, 2025

adwk67 added this to Stackable Engineering Apr 3, 2025

adwk67 added 3 commits April 8, 2025 17:33

resolve listener-class across role-groups/role

8313995

merge conflicts

465d0f1

regenerate nix

fb8efde

sbernauer self-requested a review April 9, 2025 07:06

adwk67 added 11 commits June 5, 2025 18:04

merge main and fix conflicts

550ea47

replaced listener-class enum with string

71015a5

Merge branch 'main' into feat/integrate-listener-operator

c555448

tweak test cases

8b3e650

add generic properties for listener endpoints

39740fa

write endpoints to hbase-site instead of dedicated config map

00ef5c9

remove unused error defs

74bfc29

remove unused error def/function

6c616a1

fix some tests inline with 2.6.1, add UI port type

4309b9d

use listener service resolved in entrypoint script rather than passin…

51b2837

…g through as as argument

Merge branch 'main' into feat/integrate-listener-operator

a51003c

adwk67 mentioned this pull request Jun 16, 2025

chore: HBase demo - add listener class fields stackabletech/demos#230

Open

adwk67 moved this from Development: In Progress to Development: Waiting for Review in Stackable Engineering Jun 16, 2025

adwk67 mentioned this pull request Jun 17, 2025

feat: HBase resolvable endpoints stackabletech/docker-images#1159

Open

6 tasks

adwk67 added 2 commits June 25, 2025 14:17

updated env-vars based on patch changes

4ceb588

merge main and fix conflicts

4122baf

maltesander self-requested a review June 26, 2025 07:49

maltesander moved this from Development: Waiting for Review to Development: In Review in Stackable Engineering Jun 26, 2025

adwk67 added 3 commits June 26, 2025 10:36

fix smoke test

fda8ca3

fixed orphaned-resources test

2c41938

fixed opa test

16e7c45

maltesander requested changes Jun 26, 2025

View reviewed changes

adwk67 and others added 3 commits June 26, 2025 17:45

Update CHANGELOG.md

88d7458

Co-authored-by: Malte Sander <[email protected]>

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

42148aa

Co-authored-by: Malte Sander <[email protected]>

review feedback

67d6e54

adwk67 added 2 commits June 27, 2025 10:15

added constant

474bdfe

replace expects with snafu error

e8469ab

maltesander reviewed Jun 27, 2025

View reviewed changes

correct property usage to match latest image changes

1aa786a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: HBase Listener integration #639

feat: HBase Listener integration #639

Uh oh!

adwk67 commented Mar 26, 2025 •

edited

Loading

Uh oh!

sbernauer commented Apr 9, 2025

Uh oh!

maltesander left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adwk67 commented Jun 27, 2025 •

edited

Loading

Uh oh!

maltesander left a comment

Uh oh!

Uh oh!

Uh oh!

feat: HBase Listener integration #639

Are you sure you want to change the base?

feat: HBase Listener integration #639

Uh oh!

Conversation

adwk67 commented Mar 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

How to test

Implementation notes

CRD change

Tests (OpenShift)

Definition of Done Checklist

Author

Reviewer

Acceptance

Uh oh!

sbernauer commented Apr 9, 2025

Uh oh!

maltesander left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

adwk67 commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

maltesander left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

adwk67 commented Mar 26, 2025 •

edited

Loading

adwk67 commented Jun 27, 2025 •

edited

Loading