Helm chart redesign for Quarkus-based runtimes #626

adutra · 2025-01-08T13:58:54Z

This is a major redesign of the Helm chart to make it compliant with Quarkus, but also improving a lot of aspects of the existing chart, such as the persistence secret management and the bootstrap jobs, to name a few.

Summary of changes

Persistence

Thanks to the improvement brought by #613, it's not necessary anymore to have an init container create a conf.jar. From now on, the user provides a secret with their persistence.xml, and that file is mounted on each Polaris pod directly.

Enhanced services

The services for Polaris now are separated in 3 categories:

Main service: the service that serves API requests; it is usually behind an Ingress or LoadBalancer
Management service: the service for metrics and health; this is usually ClusterIP and headless
Extra services: if any of the services needs to be exposed with different settings to different consumers, this section can be used.

Each service section has the same structure and allows to configure one or more ports.

Observability

New sections were added for logging, tracing, metrics, with also the ability to create a ServiceMonitor.

Bootstrap Job

The bootstrap section now configures the bootstrap job. Thanks to the Polaris Admin Tool introduced in #605, the jobs now use the tool to bootstrap realms.

I am not convinced personally that this bootstrap job has a huge value, compared to just running the admin tool directly. But I didn't want to remove it.

Advanced Config

A new advancedConfig section can be used to customize Polaris deployments in any possible way, even when the Helm chart does not expose the desired setting.

adutra · 2025-01-24T16:36:49Z

helm/polaris/README.md

 ```

 ### Uninstalling the chart

 ```bash
-$ helm uninstall --namespace polaris polaris
+helm uninstall --namespace polaris polaris
 ```

 ## Values


Note: this is automatically generated by helm-docs.

MonkeyCanCode · 2025-02-02T23:35:36Z

.github/workflows/helm.yml

@@ -79,7 +79,7 @@ jobs:
        if: steps.list-changed.outputs.changed == 'true'
        run: |
          helm plugin install https://github.com/helm-unittest/helm-unittest.git || true
-          helm unittest helm/polaris
+          helm unittest helm/polaris 2> >(grep -v 'found symbolic link' >&2)


With https://github.com/apache/polaris/pull/912/files, we will need only the original command without filter out the warning messages due to symbolic link.

Yes! I'm just waiting for #912 to be merged.

#912 is merged! I removed the workaround.

MonkeyCanCode · 2025-02-02T23:42:21Z

helm/polaris/README.md


 ```bash
-$ helm install polaris helm/polaris --namespace polaris --create-namespace
+helm unittest helm/polaris 2> >(grep -v 'found symbolic link' >&2)


Same as above if we should merge https://github.com/apache/polaris/pull/912/files first then remove the filter part.

MonkeyCanCode · 2025-02-02T23:51:15Z

helm/polaris/ci/fixtures/persistence.yaml

-          <property name="jakarta.persistence.jdbc.url" value="jdbc:h2:mem:polaris-{realm}"/>
-          <property name="jakarta.persistence.jdbc.user" value="sa"/>
-          <property name="jakarta.persistence.jdbc.password" value=""/>
+          <property name="jakarta.persistence.jdbc.url"


EclipseLink uses a default of 32 connections for connection pooling. For local testing, this is more than enough. If people want to use it for some load testing, this will suffer when there are many concurrent client connection. Do you think we may want to add an example or add the default value here? So for people who may not be familiar with EclipseLink, they can just change the max value etc.

Good point. I added the following:

<property name="eclipselink.connection-pool.default.initial" value="1" /> <property name="eclipselink.connection-pool.default.min" value="1" /> <property name="eclipselink.connection-pool.default.max" value="1" />

MonkeyCanCode · 2025-02-02T23:56:49Z

helm/polaris/templates/configmap.yaml

+    {{- $global := . -}}
+    {{- range $k, $v := $map }}
+    {{ include "polaris.appendConfigOption" (list  $k $v $global) }}


nits: extra space between "list $k"

MonkeyCanCode · 2025-02-03T00:00:01Z

helm/polaris/values.yaml

-  tag: "latest"
+  # -- The path to the directory where the application.properties file, and other configuration
+  # files, if any, should be mounted.
+  configDir: /deployments/config


Should we add a similar comment here for the file listing issue (#907)

Good point, done

flyrain · 2025-02-04T17:35:52Z

cc @gh-yzou

gh-yzou · 2025-02-06T02:39:49Z

helm/polaris/ci/fixtures/persistence.yaml

          <property name="jakarta.persistence.schema-generation.database.action" value="create"/>
          <property name="eclipselink.logging.level.sql" value="FINE"/>
          <property name="eclipselink.logging.parameters" value="true"/>
          <property name="eclipselink.persistence-context.flush-mode" value="auto"/>
+          <property name="eclipselink.connection-pool.default.initial" value="1" />


does that mean by default we will have a connection pool with size 1? maybe we should mention this in the read me, and along with some instruction about how to adjust the size

This is only for CI tests.

gh-yzou · 2025-02-06T02:40:14Z

helm/polaris/ci/fixtures/storage.yaml

+type: Opaque
+stringData:
+  access-key: "my-key"
+  secret-key: "my-secret"


gh-yzou · 2025-02-06T02:44:37Z

helm/polaris/ci/fixtures/token-broker.yaml

+stringData:
+  private.pem: |-
+    -----BEGIN PRIVATE KEY-----
+    MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDiae5jQnQ+Dt8Optpa4fLNuUfI


where does the private key and public key coming from ? will we be able to generate it on fly?

This is just for tests. They were randomly generated and do not contain any sensitive information. I will add a comment.

gh-yzou · 2025-02-06T02:49:57Z

helm/polaris/ci/extra-service-values.yaml

+  internalTrafficPolicy: Cluster
+  externalTrafficPolicy: Cluster
+  ports:
+    - name: polaris-http


is that two ports one for icebergRestCatalog service, and another one for OAuth service?

This file is just for tests and contains "bogus" data that does not necessarily reflect how extraServices will be used in real life, because in these tests we cannot create load balancers, ingresses, etc.

The typical use case for extraServices is:

User wants port 8181 to be exposed to internal clients (in the same namespace) using a ClusterIP service.

User also wants to expose port 8181 using a LoadBalancer service, for consumption by external clients (potentially with TLS termination, etc.)

This can be achieved by simply leaving service and managementService untouched, and adding the following config:

extraServices: - nameSuffix: "ext" type: LoadBalancer ports: - name: polaris-http port: 8181

Assuming the release name is my-release, the above will generate the following services:

my-release of type ClusterIP for port 8181;

my-release-ext of type LoadBalancer for port 8181;

my-release-mgmt service of type ClusterIP (headless) for port 8182.

adutra · 2025-02-06T12:06:05Z

@MonkeyCanCode @gh-yzou while answering a question from @gh-yzou I realized that I forgot to set ClusterIP: None (headless) by default for the management service. I just fixed it in the last commit. It's common practice to use headless services for healthchecks and metrics scraping. Let me know if you are OK.

adutra · 2025-02-07T14:03:51Z

@MonkeyCanCode @gh-yzou should we move forward with this? I would suggest to merge unless you see any blockers, then we can always keep improving the chart after the merge. It's not like we are going to do a release of the chart any time soon 😄

gh-yzou · 2025-02-07T18:04:27Z

@adutra i don't have other further questions, but i am not familiar with this part, so I will let @MonkeyCanCode and @collado-mike to do the final approval on this. You don't have to wait for me to approve this.

MonkeyCanCode · 2025-02-08T03:11:48Z

@adutra i don't have other further questions, but i am not familiar with this part, so I will let @MonkeyCanCode and @collado-mike to do the final approval on this. You don't have to wait for me to approve this.

Thought I clicked on approved earlier. Approved. Very well done.

adutra · 2025-02-11T12:47:59Z

Heads up: I am going to merge this now to unblock people looking for node port support, see #982.

adutra force-pushed the quarkus-helm branch 4 times, most recently from 09657d1 to f66d623 Compare January 8, 2025 17:21

adutra mentioned this pull request Jan 8, 2025

Helm: add securityContext to initContainers #602

Merged

adutra force-pushed the quarkus-helm branch 13 times, most recently from 0ac047b to 434a847 Compare January 13, 2025 21:36

This was referenced Jan 14, 2025

Refactor RealmContext to RealmId #741

Merged

Build viable Docker images for Polaris using Quarkus #610

Merged

adutra force-pushed the quarkus-helm branch 3 times, most recently from 68cbdfc to acee0c9 Compare January 15, 2025 09:50

adutra force-pushed the quarkus-helm branch from acee0c9 to 74f5669 Compare January 24, 2025 16:33

adutra changed the title ~~[WIP] Helm chart redesign for Quarkus-based runtimes~~ Helm chart redesign for Quarkus-based runtimes Jan 24, 2025

adutra commented Jan 24, 2025

View reviewed changes

adutra force-pushed the quarkus-helm branch from 74f5669 to d5014bb Compare January 24, 2025 16:43

adutra marked this pull request as ready for review January 24, 2025 16:51

adutra requested review from ashvina and dennishuo as code owners January 24, 2025 16:51

adutra force-pushed the quarkus-helm branch 2 times, most recently from 8719049 to 957553e Compare February 1, 2025 15:57

MonkeyCanCode reviewed Feb 3, 2025

View reviewed changes

adutra force-pushed the quarkus-helm branch 2 times, most recently from 4d36036 to ac643dc Compare February 4, 2025 12:41

adutra force-pushed the quarkus-helm branch from ac643dc to 0504299 Compare February 5, 2025 08:15

gh-yzou reviewed Feb 6, 2025

View reviewed changes

adutra added 7 commits February 6, 2025 12:33

Helm chart redesign for Quarkus-based runtimes

ad0d480

remove bootstrap job

bac622d

set connection pool size to 1

8d5737b

review

ba5882d

add comment about EclipseLink

8c45ee0

remove workaround for noisy warning during helm unittest

cd330f8

review

80cc4d4

adutra force-pushed the quarkus-helm branch from 0504299 to 01f3611 Compare February 6, 2025 11:51

switch management service to headless (oversight)

c64771b

adutra force-pushed the quarkus-helm branch from 01f3611 to c64771b Compare February 6, 2025 12:03

MonkeyCanCode approved these changes Feb 8, 2025

View reviewed changes

adutra mentioned this pull request Feb 11, 2025

Add Nodeport support in Helm #981

Closed

adutra merged commit 08b67b7 into apache:main Feb 11, 2025
5 checks passed

adutra deleted the quarkus-helm branch February 11, 2025 12:48

This was referenced Feb 11, 2025

(fix): Check NodePort Service Type before setting it #982

Closed

(fix): add conditional for nodePort check #984

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Helm chart redesign for Quarkus-based runtimes #626

Helm chart redesign for Quarkus-based runtimes #626

adutra commented Jan 8, 2025 •

edited

Loading

adutra Jan 24, 2025

MonkeyCanCode Feb 2, 2025

adutra Feb 3, 2025

adutra Feb 4, 2025

MonkeyCanCode Feb 2, 2025

adutra Feb 4, 2025

MonkeyCanCode Feb 2, 2025

adutra Feb 3, 2025

MonkeyCanCode Feb 2, 2025

MonkeyCanCode Feb 3, 2025

adutra Feb 3, 2025

flyrain commented Feb 4, 2025

gh-yzou Feb 6, 2025

adutra Feb 6, 2025

gh-yzou Feb 6, 2025

gh-yzou Feb 6, 2025

adutra Feb 6, 2025

gh-yzou Feb 6, 2025

adutra Feb 6, 2025 •

edited

Loading

adutra commented Feb 6, 2025

adutra commented Feb 7, 2025

gh-yzou commented Feb 7, 2025 •

edited

Loading

MonkeyCanCode commented Feb 8, 2025

adutra commented Feb 11, 2025

Helm chart redesign for Quarkus-based runtimes #626

Helm chart redesign for Quarkus-based runtimes #626

Conversation

adutra commented Jan 8, 2025 • edited Loading

Summary of changes

Persistence

Enhanced services

Observability

Bootstrap Job

Advanced Config

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

flyrain commented Feb 4, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adutra Feb 6, 2025 • edited Loading

Choose a reason for hiding this comment

adutra commented Feb 6, 2025

adutra commented Feb 7, 2025

gh-yzou commented Feb 7, 2025 • edited Loading

MonkeyCanCode commented Feb 8, 2025

adutra commented Feb 11, 2025

adutra commented Jan 8, 2025 •

edited

Loading

adutra Feb 6, 2025 •

edited

Loading

gh-yzou commented Feb 7, 2025 •

edited

Loading