Helm Chart addition for reg service

reg/helm/.helmignore

@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

reg/helm/Chart.yaml

@@ -0,0 +1,24 @@
+apiVersion: v2
+name: reg
+description: Helm chart to deploy the reg IVOA Registry Service (reg/ application) on Kubernetes
+
+# A chart can be either an 'application' or a 'library' chart.
+#
+# Application charts are a collection of templates that can be packaged into versioned archives
+# to be deployed.
+#
+# Library charts provide useful utilities or functions for the chart developer. They're included as
+# a dependency of application charts to inject those utilities and functions into the rendering
+# pipeline. Library charts do not define any templates and therefore cannot be deployed.
+type: application
+
+# This is the chart version. This version number should be incremented each time you make changes
+# to the chart and its templates, including the app version.
+# Versions are expected to follow Semantic Versioning (https://semver.org/)
+version: 1.2.1
+
+# This is the version number of the application being deployed. This version number should be
+# incremented each time you make changes to the application. Versions are not expected to
+# follow Semantic Versioning. They should reflect the version the application is using.
+# It is recommended to use it with quotes.
+appVersion: "1.2.1"

reg/helm/README.md

@@ -0,0 +1,120 @@
+# reg
+
+IVOA Registry Service Helm Chart
+
+| Chart | AppVersion | Type |
+|:-----:|:----------:|:----:|
+|1.2.0<!-- x-release-please-version --> | 1.2.1 | application |
+
+## Overview
+
+This Helm chart deploys the **reg** IVOA Registry Service on Kubernetes.
+
+The chart runs the application built from the [`reg/`](../reg/) directory in this repository — the deployable WAR, Docker image, and runtime configuration described in [`reg/README.md`](../reg/README.md). Other modules in the repository (`cadc-registry`, `cadc-vosi`, and so on) are libraries consumed by that application; this chart does not deploy them separately.
+
+The default container image is `images.opencadc.org/core/reg`, with tag matching the chart `appVersion` (aligned with [`reg/VERSION`](../reg/VERSION)).
+
+## Install
+
+From the repository root:
+
+```bash
+helm install my-reg ./helm -f my-values.yaml
+```
+
+`application.serviceEntries` is required. A minimal values file:
+
+```yaml
+application:
+  serviceEntries:
+    - id: "ivo://example.org/reg"
+      url: "https://example.org/my-service/capabilities"
+```
+
+## Configuration
+
+The chart renders a ConfigMap mounted at `/config` in the container. That produces the property files documented in [`reg/README.md`](../reg/README.md):
+
+| ConfigMap key | Purpose |
+|---------------|---------|
+| `catalina.properties` | Tomcat and proxy settings (`tomcat.connector.*`) |
+| `reg-resource-caps.properties` | VOSI-enabled API entries (from `application.serviceEntries`) |
+| `reg-applications.properties` | Web application entries (from `application.applicationEntries`, optional) |
+| `cadc-log.properties` | Dynamic logging control (optional) |
+
+### Application settings (`application.*`)
+
+- **`application.serviceEntries`** (required): list of `{ id, url }` pairs for VOSI-enabled APIs (web services). Rendered into `reg-resource-caps.properties` ([reg-resource-caps.properties](https://github.com/opencadc/reg/tree/main/reg#reg-resource-capsproperties-optional)).
+- **`application.logging`**: users, groups, or DNs granted enhanced logging.
+- **`application.applicationEntries`**: optional web application (user interface) feature ID to URL mappings ([reg-applications.properties](https://github.com/opencadc/reg/tree/main/reg#reg-applicationsproperites-optional-experimental)).
+
+### Public URL (`tomcat.connector`)
+
+When the service sits behind a reverse proxy, Tomcat needs the public URL clients use (equivalent to `X-Forwarded-Proto`, `X-Forwarded-Host`, and `X-Forwarded-Port`). These values are written to `catalina.properties` as `tomcat.connector.*` and affect VOSI capabilities output: `accessURL` hostnames are rewritten to match the request URL.
+
+Resolution order for each field:
+
+1. Explicit value in `tomcat.connector`
+2. Auto-derived from `httpRoute` (if enabled) or `ingress` (if enabled)
+3. Omitted when `proxyName` cannot be resolved
+
+**Internal-only deployment (defaults):** with `ingress.enabled=false`, `httpRoute.enabled=false`, `service.type=ClusterIP`, and empty `tomcat.connector` fields, no `tomcat.connector.*` properties are emitted. The service stays ClusterIP-only (reachable by Pods in the cluster) and Tomcat uses each incoming request URL as-is.
+
+Set `tomcat.connector` explicitly when the public URL differs from the ingress or HTTPRoute hostname — for example, when a CDN or external load balancer sits in front of the cluster.
+
+### Service exposure
+
+| Mechanism | Values key | Default |
+|-----------|------------|---------|
+| In-cluster only | `service.type: ClusterIP` | yes |
+| Ingress | `ingress.enabled` | `false` |
+| Gateway API HTTPRoute | `httpRoute.enabled` | `false` |
+
+When ingress or HTTPRoute is enabled and `tomcat.connector` fields are left empty, the public URL is derived from the configured hostnames.
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| affinity | object | `{}` |  |
+| application.logging | string | `nil` |  |
+| application.applicationEntries | list | `[]` | Web application (user interface) entries ([reg-applications.properties](https://github.com/opencadc/reg/tree/main/reg#reg-applicationsproperites-optional-experimental)) |
+| application.serviceEntries | list | `[]` | VOSI-enabled API (web service) entries ([reg-resource-caps.properties](https://github.com/opencadc/reg/tree/main/reg#reg-resource-capsproperties-optional)) |
+| autoscaling.enabled | bool | `false` |  |
+| autoscaling.maxReplicas | int | `100` |  |
+| autoscaling.minReplicas | int | `1` |  |
+| autoscaling.targetCPUUtilizationPercentage | int | `80` |  |
+| fullnameOverride | string | `""` |  |
+| httpRoute | object | `{"annotations":{},"enabled":false,"hostnames":["chart-example.local"],"parentRefs":[{"name":"gateway","sectionName":"http"}],"rules":[{"matches":[{"path":{"type":"PathPrefix","value":"/headers"}}]}]}` | Expose the service via gateway-api HTTPRoute Requires Gateway API resources and suitable controller installed within the cluster (see: https://gateway-api.sigs.k8s.io/guides/) |
+| image.pullPolicy | string | `"IfNotPresent"` |  |
+| image.repository | string | `"images.opencadc.org/core/reg"` |  |
+| image.tag | string | `"1.2.1"` |  |
+| imagePullSecrets | list | `[]` |  |
+| ingress.annotations | object | `{}` |  |
+| ingress.className | string | `""` |  |
+| ingress.enabled | bool | `false` |  |
+| ingress.hosts | list | `[]` |  |
+| ingress.tls | list | `[]` |  |
+| livenessProbe | string | `nil` |  |
+| nameOverride | string | `""` |  |
+| nodeSelector | object | `{}` |  |
+| podAnnotations | object | `{}` |  |
+| podLabels | object | `{}` |  |
+| podSecurityContext | object | `{}` |  |
+| readinessProbe | string | `nil` |  |
+| replicaCount | int | `1` |  |
+| resources | object | `{}` |  |
+| securityContext | object | `{}` |  |
+| service.port | int | `8080` |  |
+| service.type | string | `"ClusterIP"` |  |
+| serviceAccount.annotations | object | `{}` |  |
+| serviceAccount.automount | bool | `true` |  |
+| serviceAccount.create | bool | `true` |  |
+| serviceAccount.name | string | `""` |  |
+| tolerations | list | `[]` |  |
+| tomcat.connector | object | `{"proxyName":"","proxyPort":"","scheme":""}` | Public URL for Tomcat behind a reverse proxy. Written to catalina.properties as tomcat.connector.* (X-Forwarded-Proto/Host/Port equivalent). Affects VOSI accessURL hostnames. Auto-derived from httpRoute or ingress when fields are empty; omitted for internal-only ClusterIP deployments. |
+| tomcat.connector.proxyName | string | `""` | Public URL hostname. Auto-derived from httpRoute.hostnames[0] or ingress.hosts[0].host. |
+| tomcat.connector.proxyPort | string | `""` | Public URL port. Auto-derived as 443 (https) or 80 (http). |
+| tomcat.connector.scheme | string | `""` | Public URL scheme. Auto-derived as https (httpRoute or ingress with TLS) or http. |
+| volumeMounts | list | `[]` |  |
+| volumes | list | `[]` |  |

reg/helm/templates/NOTES.txt

@@ -0,0 +1,44 @@
+OAI publishing is {{ ternary "enabled" "not enabled" (not (empty .Values.application.authority)) }}.
+
+1. Get the application URL by running these commands:
+{{- if .Values.httpRoute.enabled }}
+{{- if .Values.httpRoute.hostnames }}
+    export APP_HOSTNAME={{ .Values.httpRoute.hostnames | first }}
+{{- else }}
+    export APP_HOSTNAME=$(kubectl get --namespace {{(first .Values.httpRoute.parentRefs).namespace | default .Release.Namespace }} gateway/{{ (first .Values.httpRoute.parentRefs).name }} -o jsonpath="{.spec.listeners[0].hostname}")
+  {{- end }}
+{{- if and .Values.httpRoute.rules (first .Values.httpRoute.rules).matches (first (first .Values.httpRoute.rules).matches).path.value }}
+    echo "Visit http://$APP_HOSTNAME{{ (first (first .Values.httpRoute.rules).matches).path.value }} to use your application"
+
+    NOTE: Your HTTPRoute depends on the listener configuration of your gateway and your HTTPRoute rules.
+    The rules can be set for path, method, header and query parameters.
+    You can check the gateway configuration with 'kubectl get --namespace {{(first .Values.httpRoute.parentRefs).namespace | default .Release.Namespace }} gateway/{{ (first .Values.httpRoute.parentRefs).name }} -o yaml'
+{{- end }}
+{{- else if .Values.ingress.enabled }}
+{{- range $host := .Values.ingress.hosts }}
+  {{- range .paths }}
+  http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}
+  {{- end }}
+{{- end }}
+{{- else if contains "NodePort" .Values.service.type }}
+  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "reg.fullname" . }})
+  export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
+  echo http://$NODE_IP:$NODE_PORT
+{{- else if contains "LoadBalancer" .Values.service.type }}
+     NOTE: It may take a few minutes for the LoadBalancer IP to be available.
+           You can watch its status by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "reg.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "reg.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
+  echo http://$SERVICE_IP:{{ .Values.service.port }}
+{{- else if contains "ClusterIP" .Values.service.type }}
+  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "reg.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
+  export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}")
+  echo "Visit http://127.0.0.1:8080 to use your application"
+  kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT
+{{- end }}
+
+{{- with .Values.application.serviceEntries }}
+Configured entries are:
+  {{- range $index, $element := . }}
+  {{ $element.id }} = {{ $element.url }}
+  {{- end }}
+{{- end }}

reg/helm/templates/_helpers.tpl

@@ -0,0 +1,109 @@
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "reg.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "reg.fullname" -}}
+{{- if .Values.fullnameOverride }}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- $name := default .Chart.Name .Values.nameOverride }}
+{{- if contains $name .Release.Name }}
+{{- .Release.Name | trunc 63 | trimSuffix "-" }}
+{{- else }}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
+{{- end }}
+{{- end }}
+{{- end }}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "reg.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
+{{- end }}
+
+{{/*
+Common labels
+*/}}
+{{- define "reg.labels" -}}
+helm.sh/chart: {{ include "reg.chart" . }}
+{{ include "reg.selectorLabels" . }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end }}
+
+{{/*
+Selector labels
+*/}}
+{{- define "reg.selectorLabels" -}}
+app.kubernetes.io/name: {{ include "reg.name" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- end }}
+
+{{/*
+Create the name of the service account to use
+*/}}
+{{- define "reg.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create }}
+{{- default (include "reg.fullname" .) .Values.serviceAccount.name }}
+{{- else }}
+{{- default "default" .Values.serviceAccount.name }}
+{{- end }}
+{{- end }}
+
+{{/*
+Resolve tomcat.connector settings for catalina.properties.
+Returns YAML with scheme, proxyName, and proxyPort when proxyName can be resolved; empty otherwise.
+*/}}
+{{- define "reg.tomcatConnector" -}}
+{{- $conn := .Values.tomcat.connector | default dict -}}
+{{- $proxyName := $conn.proxyName -}}
+{{- $scheme := $conn.scheme -}}
+{{- $proxyPort := $conn.proxyPort -}}
+{{- if not $proxyName -}}
+{{- if .Values.httpRoute.enabled -}}
+{{- if .Values.httpRoute.hostnames -}}
+{{- $proxyName = index .Values.httpRoute.hostnames 0 -}}
+{{- end -}}
+{{- else if .Values.ingress.enabled -}}
+{{- if .Values.ingress.hosts -}}
+{{- $proxyName = (index .Values.ingress.hosts 0).host -}}
+{{- end -}}
+{{- end -}}
+{{- end -}}
+{{- if $proxyName -}}
+{{- if not $scheme -}}
+{{- if .Values.httpRoute.enabled -}}
+{{- $scheme = "https" -}}
+{{- else if .Values.ingress.enabled -}}
+{{- if .Values.ingress.tls -}}
+{{- $scheme = "https" -}}
+{{- else -}}
+{{- $scheme = "http" -}}
+{{- end -}}
+{{- else -}}
+{{- $scheme = "https" -}}
+{{- end -}}
+{{- end -}}
+{{- if not $proxyPort -}}
+{{- if eq $scheme "https" -}}
+{{- $proxyPort = 443 -}}
+{{- else -}}
+{{- $proxyPort = 80 -}}
+{{- end -}}
+{{- end -}}
+proxyName: {{ $proxyName | quote }}
+scheme: {{ $scheme | quote }}
+proxyPort: {{ $proxyPort }}
+{{- end -}}
+{{- end -}}

reg/helm/templates/configmap.yaml

@@ -0,0 +1,53 @@
+{{- if empty .Values.application.serviceEntries }}
+{{- fail "Service entries must be provided in reg application values." }}
+{{- end }}
+{{- $connYaml := include "reg.tomcatConnector" . -}}
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: {{ include "reg.fullname" . }}-config
+  labels:
+    {{- include "reg.labels" . | nindent 4 }}
+data:
+  catalina.properties: |-
+{{- if $connYaml }}
+{{- $conn := $connYaml | fromYaml }}
+    tomcat.connector.scheme={{ $conn.scheme }}
+    tomcat.connector.proxyName={{ $conn.proxyName }}
+    tomcat.connector.proxyPort={{ $conn.proxyPort }}
+    tomcat.connector.secure={{ $conn.secure }}
+{{- end }}
+    ca.nrc.cadc.util.Log4jInit.messageOnly=true
+
+  reg-resource-caps.properties:
+{{ with .Values.application.serviceEntries }}
+{{ range $index, $element := . }}
+    {{ $element.id }} = {{ $element.url }}
+{{ end }}
+{{ end }}
+
+{{ with .Values.application.applicationEntries }}
+  reg-applications.properties:
+  {{ range $index, $element := . }}
+    {{ $element.id }} = {{ $element.url }}
+  {{ end }}
+{{ end }}
+
+{{- with .Values.application.logging }}
+  cadc-log.properties:
+{{ with .userDistinguishedNames }}
+    {{- range $index, $element := . }}
+    user = {{ $element }}
+    {{- end }}
+{{ end }}
+{{ with .usernames }}
+    {{- range $index, $element := . }}
+    username = {{ $element }}
+    {{- end }}
+{{ end }}
+{{ with .groups }}
+    {{- range $index, $element := . }}
+    group = {{ $element }}
+    {{- end }}
+{{ end }}
+{{ end }}