Helm chart redesign for Quarkus-based runtimes

.github/workflows/helm.yml

@@ -99,9 +99,9 @@ jobs:
         if: steps.list-changed.outputs.changed == 'true'
         run: |
           eval $(minikube -p minikube docker-env)
-          ./gradlew :polaris-quarkus-server:assemble \
+          ./gradlew :polaris-quarkus-server:assemble :polaris-quarkus-admin:assemble \
             -Dquarkus.container-image.build=true \
-            -PeclipseLinkDeps=com.h2database:h2:2.3.232
+            -PeclipseLinkDeps=org.postgresql:postgresql:42.7.4
           minikube image ls
 
       - name: Install fixtures

helm/polaris/README.md.gotmpl

@@ -6,9 +6,9 @@
   to you under the Apache License, Version 2.0 (the
   "License"); you may not use this file except in compliance
   with the License.  You may obtain a copy of the License at
- 
+
    http://www.apache.org/licenses/LICENSE-2.0
- 
+
   Unless required by applicable law or agreed to in writing,
   software distributed under the License is distributed on an
   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -49,23 +49,85 @@
 
 ### Optional
 
-When using a custom `persistence.xml`, a Kubernetes Secret must be created for `.persistenceConfigSecret`. Below is a sample command:
+When using a custom `persistence.xml`, a Kubernetes Secret must be created for it. Below is a sample command:
 ```bash
 kubectl create secret generic polaris-secret -n polaris --from-file=persistence.xml
 ```
 
-### From local directory (for development purposes)
+### Running the unit tests
+
+Helm unit tests do not require a Kubernetes cluster. To run the unit tests from the Polaris repo
+root:
+
+```bash
+helm unittest helm/polaris
+```
+
+Note: the `grep` command is used to filter out the annoying warning messages about symbolic links;
+see https://github.com/helm/helm/issues/7019.
+
+### Running locally with a Kind cluster
+
+The below instructions assume Kind and Helm are installed.
+
+Simply run the `run.sh` script from the Polaris repo root, making sure to specify the
+`--eclipse-link-deps` option:
+
+```bash
+./run.sh --eclipse-link-deps=org.postgresql:postgresql:42.7.4
+```
+
+This script will create a Kind cluster, deploy a local Docker registry, build the Polaris Docker
+images with support for Postgres and load them into the Kind cluster. (It will also create an
+example Deployment and Service with in-memory storage.)
+
+### Running locally with a Minikube cluster
+
+The below instructions assume a Minikube cluster is already running and Helm is installed.
+
+If necessary, build and load the Docker images with support for Postgres into Minikube:
+
+```bash
+eval $(minikube -p minikube docker-env)
+
+./gradlew :polaris-quarkus-server:assemble :polaris-quarkus-admin:assemble \
+    -Dquarkus.container-image.build=true \
+    -PeclipseLinkDeps=org.postgresql:postgresql:42.7.4
+```
+
+### Installing the chart locally
+
+The below instructions assume a local Kubernetes cluster is running and Helm is installed.
+
+Create and populate the target namespace:
+
+```bash
+kubectl create namespace polaris
+kubectl apply --namespace polaris -f helm/polaris/ci/fixtures/
+```
+
+Finally, install the chart. From Polaris repo root:
+
+```bash
+helm upgrade --install --namespace polaris \
+  --debug --values helm/polaris/ci/simple-values.yaml \
+   polaris helm/polaris
+```
+
+The `helm/polaris/ci` contains a number of values files that can be used to install the chart with
+different configurations.
 
-From Polaris repo root:
+You can also run `ct` (chart-testing):
 
 ```bash
-$ helm install polaris helm/polaris --namespace polaris --create-namespace
+ct lint --charts helm/polaris
+ct install --namespace polaris --debug --charts ./helm/polaris
 ```
 
 ### Uninstalling the chart
 
 ```bash
-$ helm uninstall --namespace polaris polaris
+helm uninstall --namespace polaris polaris
 ```
 
 {{ template "chart.valuesSection" . }}

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

@@ -0,0 +1,47 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+image:
+  pullPolicy: Never
+
+service:
+  type: ClusterIP
+  sessionAffinity: ClientIP
+  internalTrafficPolicy: Cluster
+  externalTrafficPolicy: Cluster
+  ports:
+    - name: polaris-http
+      port: 18181
+      targetPort: 8181
+      protocol: TCP
+    - name: polaris-http2
+      port: 28181
+      targetPort: 8181
+      protocol: TCP
+
+extraServices:
+  - nameSuffix: "ext"
+    type: ClusterIP
+    sessionAffinity: None
+    internalTrafficPolicy: Local
+    externalTrafficPolicy: Local
+    ports:
+    - name: polaris-http2
+      port: 38181
+      targetPort: 8181

helm/polaris/ci/fixtures/persistence.yaml

@@ -38,13 +38,17 @@ stringData:
         <class>org.apache.polaris.jpa.models.ModelSequenceId</class>
         <shared-cache-mode>NONE</shared-cache-mode>
         <properties>
-          <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"
+            value="jdbc:postgresql://postgres:5432/{realm}"/>
+          <property name="jakarta.persistence.jdbc.user" value="postgres"/>
+          <property name="jakarta.persistence.jdbc.password" value="postgres"/>
           <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" />
+          <property name="eclipselink.connection-pool.default.min" value="1" />
+          <property name="eclipselink.connection-pool.default.max" value="1" />
         </properties>
       </persistence-unit>
     </persistence>

helm/polaris/ci/fixtures/postgres.yaml

@@ -0,0 +1,72 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: postgres
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app: postgres
+  template:
+    metadata:
+      labels:
+        app: postgres
+    spec:
+      containers:
+        - name: postgres
+          image: postgres:17.2
+          ports:
+            - containerPort: 5432
+          resources:
+            limits:
+              memory: "128Mi"
+          env:
+            - name: POSTGRES_USER
+              value: "postgres"
+            - name: POSTGRES_PASSWORD
+              value: "postgres"
+            - name: POSTGRES_DB
+              value: "POLARIS"
+            - name: POSTGRES_INITDB_ARGS
+              value: "--encoding UTF8 --data-checksums"
+          readinessProbe:
+            exec:
+              command:
+                - pg_isready
+                - -U
+                - postgres
+            initialDelaySeconds: 5
+            periodSeconds: 5
+            timeoutSeconds: 2
+            failureThreshold: 15
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: postgres
+spec:
+  selector:
+      app: postgres
+  ports:
+      - protocol: TCP
+        port: 5432
+        targetPort: 5432

helm/polaris/ci/fixtures/storage.yaml

@@ -0,0 +1,27 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+apiVersion: v1
+kind: Secret
+metadata:
+  name: polaris-storage
+type: Opaque
+stringData:
+  access-key: "my-key"
+  secret-key: "my-secret"

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

@@ -0,0 +1,63 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+apiVersion: v1
+kind: Secret
+metadata:
+  name: polaris-token-broker
+type: Opaque
+# The following values were generated using the following commands:
+# openssl genrsa -out private.pem 2048
+# openssl rsa -in private.pem -pubout -out public.pem
+# They do not contain any sensitive information and are used for testing purposes only.
+stringData:
+  private.pem: |-
+    -----BEGIN PRIVATE KEY-----
+    MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDiae5jQnQ+Dt8Optpa4fLNuUfI
+    37Sy29JPfn22CkGNo54SJi8NtR38Q958Bx9B+30IZPm3KtZGPC38Tm78/C508h7/Bd0jO7S3/UuQ
+    rYlg9H8gC59j14fE5cKEiKCvHrNK35Act9LrfhwEoGBs7G+90KD3SBIWzoc4vS8AB/ey09kRN3+M
+    dQ/DuRrafRgEx8ecq0x4KPggrmvworVVm1ya+H2JNKUQ+uQugmwxeRDE1GuJrgNnn4+ajueEnGdc
+    ohgz067AgZExzoyRlujJXBuL6JRtOSbEYVpNV1laVdA8UJ2b5I1PiNnVvx1m4gFi/Cela479EO6t
+    +AC+a1ez+MxTAgMBAAECggEAA1QiXJQ4CEeIsPrz/90NiEe+je34Bp8jtuZ5q6j38MCkjMjB7VYp
+    1DEdPr6OD5bGbk6puy8mik7NMEXo7NA6UJ7UpNQtvZxdmkzfhQeAGwxNKCfzlnCvPs5P70ng7uIp
+    KaMix8FOGQc4GztOX5uUQvqjuy70kSBFLajeXYZAdoEOu+E3QDaCUqiJlK3cRAJhg39Br+XfOHDp
+    cBdhlbxqQKZHWqDR010XUNoQpMHXWTu/e779Xze9uAvmYw98YGtCW8JB5AqjnqAmCZFaktKYw5Z3
+    IHZCA9hTVngk0WTanuIeTlB2bbl0df+87xHfim2yDuXEkTfAOCug/Qpf+pEhfQKBgQD9M14a1MQ2
+    Omf9f7X401Ig32e2YfX6sW73THB8Lupz9MCBZxNFCZlzVl55bL2o2vOROEeaneGdboqASW+1ph6e
+    QbdipiYAfHsG/mvkysqH/plo8QT69GUlzs2yt5zdmFjvkwaZmRmbB6Gjg2sSHKBt3YjTPbdmpuKV
+    oLvpmaslvQKBgQDk6r+4CGTZwfKYcrTNqJYPdOwfaVjSCulm0wHRw3PvJEi5Eb5qNaJbNICLl5FD
+    wkOAg33CZ+9h9FJnPd2IbBUBUGcNL5sGNZZNMH16LuFlRYKGgYxjlOjktOC5OXXa7iqkwMqf1dFf
+    GYU/wHGXYamUKOlinA9rFmbQCUNJL6mzTwKBgQC5Ky/O/3rfDaevRA6YgjK1x6vZPZreU5SLVmOM
+    7eKYGo4OFIuLGZIXPzqoIlYxfq5RrY7wDDZLI+Q2HX6MoYgSxIyQoGF6SY7PdpEBKS0kd5VJobm6
+    rbCrDapw4MbfZ+LiketpuQV40wPqyNkszbKlpjXCBohxkepy8rF6DN+VIQKBgFYHFnedx/DB316F
+    NQdYxNQYN6hyWavN5/r5b2SaVFZZx26tiWa2s0YdS/WpxzC0r9N7FubZUm/4doNQD5H2NEqjIacl
+    7dd+ifaGM5GYTqJVZgEQbGb8Di3s/8r8Ghtlh+cUgNFidGWN3LKhqs6eKDGC0np5dZ3j9E1YPc4i
+    OF8nAoGAYeFjfXBXKQhQXItTlL5NMd+yNvMGJDOvNYOn90acZrDld8GvqHI9A1kQf2IuYfA8Yfxg
+    O2lpCWjiPAsAC3W5BMhfkzjxpikW6YLpXXx7wpDzNAUBAuhEHlmFSMOoa4CIBnN2+6Zw8PSsKnrI
+    49N28pje/ZyABaY7SYP3fcJY17o=
+    -----END PRIVATE KEY-----
+  public.pem: |-
+    -----BEGIN PUBLIC KEY-----
+    MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA4mnuY0J0Pg7fDqbaWuHyzblHyN+0stvS
+    T359tgpBjaOeEiYvDbUd/EPefAcfQft9CGT5tyrWRjwt/E5u/PwudPIe/wXdIzu0t/1LkK2JYPR/
+    IAufY9eHxOXChIigrx6zSt+QHLfS634cBKBgbOxvvdCg90gSFs6HOL0vAAf3stPZETd/jHUPw7ka
+    2n0YBMfHnKtMeCj4IK5r8KK1VZtcmvh9iTSlEPrkLoJsMXkQxNRria4DZ5+Pmo7nhJxnXKIYM9Ou
+    wIGRMc6MkZboyVwbi+iUbTkmxGFaTVdZWlXQPFCdm+SNT4jZ1b8dZuIBYvwnpWuO/RDurfgAvmtX
+    s/jMUwIDAQAB
+    -----END PUBLIC KEY-----

helm/polaris/ci/persistence-values.yaml

@@ -20,10 +20,20 @@
 image:
   pullPolicy: Never
 
-persistenceConfigSecret: polaris-persistence
+authentication:
+  tokenBroker:
+    secret:
+      name: polaris-token-broker
 
-polarisServerConfig:
-  metaStoreManager:
-    type: eclipse-link
-    persistence-unit: polaris
-    conf-file: /eclipselink-config/conf.jar!/persistence.xml
+logging:
+  file:
+    enabled: true
+    json: true
+    storage:
+      size: 50Mi
+
+persistence:
+  type: eclipse-link
+  eclipseLink:
+    secret:
+      name: polaris-persistence

helm/polaris/ci/simple-values.yaml

@@ -19,3 +19,9 @@
 
 image:
   pullPolicy: Never
+
+storage:
+  secret:
+    name: polaris-storage
+    awsAccessKeyId: access-key
+    awsSecretAccessKey: secret-key