Feat: Trino Listener Integration (#753)

* add listener to roles

* wip - adapt role and rolegroup access

* remove unused error

* fmt

* fix tests

* fmt

* regenerated charts

* add docs

* wip - working

* make headless service name a function

* added tests

* adapted changelog

* move scripts to commons folder, fix tests

* new lines

* fix tls test

* fix authentication test

* fix opa test

* attempt to fix

* adapt getting started to listener

* use role level listener

* add lost comment

* fix listener examples / comments

* Apply suggestions from code review

Co-authored-by: Nick <[email protected]>

* clippy

* fix smoke test

* fix tls test

* fix authorization test

* regenerate charts

* fix metrics test for lsitener changes

* fix test

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

Co-authored-by: Nick <[email protected]>

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

Co-authored-by: Nick <[email protected]>

* fmt

* fix app version

* remove merge artifact

* adapt readme for smoke aws test

* move rolegroup_metrics_service_name out of cluster impl

* typo

---------

Co-authored-by: Nick <[email protected]>

Author: maltesander

CHANGELOG.md

@@ -10,6 +10,7 @@ All notable changes to this project will be documented in this file.
   - Use `--file-log-max-files` (or `FILE_LOG_MAX_FILES`) to limit the number of log files kept.
   - Use `--file-log-rotation-period` (or `FILE_LOG_ROTATION_PERIOD`) to configure the frequency of rotation.
   - Use `--console-log-format` (or `CONSOLE_LOG_FORMAT`) to set the format to `plain` (default) or `json`.
+- Add Listener integration for Trino ([#753]).
 - Add support for Trino 476 ([#755]).
 
 ### Changed
@@ -52,6 +53,7 @@ All notable changes to this project will be documented in this file.
 [#745]: https://github.com/stackabletech/trino-operator/pull/745
 [#748]: https://github.com/stackabletech/trino-operator/pull/748
 [#752]: https://github.com/stackabletech/trino-operator/pull/752
+[#753]: https://github.com/stackabletech/trino-operator/pull/753
 [#755]: https://github.com/stackabletech/trino-operator/pull/755
 [#760]: https://github.com/stackabletech/trino-operator/pull/760
 

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

@@ -105,23 +105,6 @@ spec:
                           description: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
                           type: object
                       type: object
-                    listenerClass:
-                      default: cluster-internal
-                      description: |-
-                        This field controls which type of Service the Operator creates for this TrinoCluster:
-
-                        * cluster-internal: Use a ClusterIP service
-
-                        * external-unstable: Use a NodePort service
-
-                        * external-stable: Use a LoadBalancer 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
-                        - external-stable
-                      type: string
                     tls:
                       default:
                         internalSecretClass: tls
@@ -436,11 +419,16 @@ spec:
                       x-kubernetes-preserve-unknown-fields: true
                     roleConfig:
                       default:
+                        listenerClass: cluster-internal
                         podDisruptionBudget:
                           enabled: true
                           maxUnavailable: null
                       description: This is a product-agnostic RoleConfig, which is sufficient for most of the products.
                       properties:
+                        listenerClass:
+                          default: cluster-internal
+                          description: This field controls which [ListenerClass](https://docs.stackable.tech/home/nightly/listener-operator/listenerclass.html) is used to expose the coordinator.
+                          type: string
                         podDisruptionBudget:
                           default:
                             enabled: true

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

@@ -97,11 +97,16 @@ rules:
     verbs:
       - get
   - apiGroups:
-      - apiextensions.k8s.io
+      - listeners.stackable.tech
     resources:
-      - customresourcedefinitions
+      - listeners
     verbs:
       - get
+      - list
+      - watch
+      - patch
+      - create
+      - delete
   - apiGroups:
       - events.k8s.io
     resources:

docs/modules/trino/examples/getting_started/code/trino.yaml

@@ -10,8 +10,9 @@ spec:
     catalogLabelSelector:
       matchLabels:
         trino: simple-trino
-    listenerClass: external-unstable
   coordinators:
+    roleConfig:
+      listenerClass: external-unstable
     roleGroups:
       default:
         replicas: 1

docs/modules/trino/examples/getting_started/code/trino.yaml.j2

@@ -10,8 +10,9 @@ spec:
     catalogLabelSelector:
       matchLabels:
         trino: simple-trino
-    listenerClass: external-unstable
   coordinators:
+    roleConfig:
+      listenerClass: external-unstable
     roleGroups:
       default:
         replicas: 1

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

@@ -1,17 +1,18 @@
 = Service exposition with ListenerClasses
+:description: Configure Trino service exposure with ListenerClasses: cluster-internal, external-unstable, or external-stable.
 
-Trino offers a web UI and an API, both are exposed by the `connector` xref:concepts:roles-and-role-groups.adoc[role].
-The Operator deploys a service called `<name>-connector` (where `<name>` is the name of the TrinoCluster) through which Trino can be reached.
-
-This service can have three different types: `cluster-internal`, `external-unstable` and `external-stable`.
-Read more about the types in the xref:concepts:service-exposition.adoc[service exposition] documentation at platform level.
-
-This is how the ListenerClass is configured:
+The operator deploys a xref:listener-operator:listener.adoc[Listener] for the coodinator pod.
+The listener defaults to only being accessible from within the Kubernetes cluster, but this can be changed by setting `.spec.coordinators.roleConfig.listenerClass`:
 
 [source,yaml]
 ----
 spec:
-  clusterConfig:
-    listenerClass: cluster-internal  # <1>
+  coordinators:
+    roleConfig:
+      listenerClass: external-unstable  # <1>
+    ...
+  workers:
+    ...
 ----
-<1> The default `cluster-internal` setting.
+<1> Specify a ListenerClass, such as `external-stable`, `external-unstable`, or `cluster-internal` (the default setting is `cluster-internal`).
+This can be set only for the coordinator role.

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

@@ -276,7 +276,7 @@ mod tests {
         let role = TrinoRole::Coordinator;
         let rolegroup_ref = role.rolegroup_ref(&trino, "default");
         let merged_config = trino.merged_config(&role, &rolegroup_ref, &[]).unwrap();
-        let coordinators = trino.spec.coordinators.unwrap();
+        let coordinators = trino.role(&role).unwrap();
 
         let product_version = trino.spec.image.product_version();