Merge pull request #293 from chgl/updated-helm-chart

updated helm chart to use image v5.6.0

.github/workflows/chart-release.yaml

@@ -21,11 +21,6 @@ jobs:
           git config user.name "$GITHUB_ACTOR"
           git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
 
-      - name: Install Helm
-        uses: azure/setup-helm@v1
-        with:
-          version: v3.7.0
-
       - name: Add bitnami repo
         run: helm repo add bitnami https://charts.bitnami.com/bitnami
 

.github/workflows/chart-test.yaml

@@ -43,11 +43,6 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Set up Helm
-        uses: azure/setup-helm@v1
-        with:
-          version: v3.7.0
-
       - name: Set up chart-testing
         uses: helm/chart-testing-action@v2.1.0
 

charts/hapi-fhir-jpaserver/Chart.yaml

@@ -18,6 +18,9 @@ annotations:
     # added, changed, deprecated, removed, fixed, and security.
     - kind: changed
       description: |
-        updated HAPI FHIR starter image to 5.5.1
+        updated HAPI FHIR starter image to 5.6.0
-appVersion: v5.5.1
+    - kind: added
-version: 0.6.0
+      description: |
+        added support for configuring PodDisruptionBudget for the server pods
+appVersion: v5.6.0
+version: 0.7.0

charts/hapi-fhir-jpaserver/README.md

@@ -1,6 +1,6 @@
 # HAPI FHIR JPA Server Starter Helm Chart
 
-![Version: 0.6.0](https://img.shields.io/badge/Version-0.6.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v5.5.1](https://img.shields.io/badge/AppVersion-v5.5.1-informational?style=flat-square)
+![Version: 0.7.0](https://img.shields.io/badge/Version-0.7.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v5.6.0](https://img.shields.io/badge/AppVersion-v5.6.0-informational?style=flat-square)
 
 This helm chart will help you install the HAPI FHIR JPA Server in a Kubernetes environment.
 
@@ -11,6 +11,9 @@ helm repo add hapifhir https://hapifhir.github.io/hapi-fhir-jpaserver-starter/
 helm install --render-subchart-notes hapi-fhir-jpaserver hapifhir/hapi-fhir-jpaserver
 ```
 
+> ⚠ By default, the included [PostgreSQL Helm chart](https://github.com/bitnami/charts/tree/master/bitnami/postgresql#upgrading)
+> auto-generates a random password for the database which may cause problems when upgrading the chart (see [here for details](https://github.com/bitnami/charts/tree/master/bitnami/postgresql#upgrading)).
+
 ## Values
 
 | Key | Type | Default | Description |
@@ -24,11 +27,12 @@ helm install --render-subchart-notes hapi-fhir-jpaserver hapifhir/hapi-fhir-jpas
 | externalDatabase.password | string | `""` | database password |
 | externalDatabase.port | int | `5432` | database port number |
 | externalDatabase.user | string | `"fhir"` | username for the external database |
+| extraEnv | list | `[]` | extra environment variables to set on the server container |
 | fullnameOverride | string | `""` | override the chart fullname |
 | image.flavor | string | `"distroless"` | the flavor or variant of the image to use. appended to the image tag by `-`. |
-| image.pullPolicy | string | `"IfNotPresent"` |  |
+| image.pullPolicy | string | `"IfNotPresent"` | image pullPolicy to use |
-| image.registry | string | `"docker.io"` |  |
+| image.registry | string | `"docker.io"` | registry where the HAPI FHIR server image is hosted |
-| image.repository | string | `"hapiproject/hapi"` |  |
+| image.repository | string | `"hapiproject/hapi"` | the path inside the repository |
 | image.tag | string | `""` | defaults to `Chart.appVersion` |
 | imagePullSecrets | list | `[]` | image pull secrets to use when pulling the image |
 | ingress.annotations | object | `{}` | provide any additional annotations which may be required. Evaluated as a template. |
@@ -43,6 +47,9 @@ helm install --render-subchart-notes hapi-fhir-jpaserver hapifhir/hapi-fhir-jpas
 | networkPolicy.explicitNamespacesSelector | object | `{}` | a Kubernetes LabelSelector to explicitly select namespaces from which ingress traffic could be allowed |
 | nodeSelector | object | `{}` | node selector for the pod |
 | podAnnotations | object | `{}` | annotations applied to the server pod |
+| podDisruptionBudget.enabled | bool | `false` | Enable PodDisruptionBudget for the server pods. uses policy/v1/PodDisruptionBudget thus requiring k8s 1.21+ |
+| podDisruptionBudget.maxUnavailable | string | `""` | maximum unavailable instances |
+| podDisruptionBudget.minAvailable | int | `1` | minimum available instances |
 | podSecurityContext | object | `{}` | pod security context |
 | postgresql.containerSecurityContext.allowPrivilegeEscalation | bool | `false` |  |
 | postgresql.containerSecurityContext.capabilities.drop[0] | string | `"ALL"` |  |
@@ -61,8 +68,8 @@ helm install --render-subchart-notes hapi-fhir-jpaserver hapifhir/hapi-fhir-jpas
 | securityContext.readOnlyRootFilesystem | bool | `true` |  |
 | securityContext.runAsNonRoot | bool | `true` |  |
 | securityContext.runAsUser | int | `65532` |  |
-| service.port | int | `8080` |  |
+| service.port | int | `8080` | port where the server will be exposed at |
-| service.type | string | `"ClusterIP"` |  |
+| service.type | string | `"ClusterIP"` | service type |
 | startupProbe.failureThreshold | int | `10` |  |
 | startupProbe.initialDelaySeconds | int | `60` |  |
 | startupProbe.periodSeconds | int | `30` |  |
@@ -70,5 +77,17 @@ helm install --render-subchart-notes hapi-fhir-jpaserver hapifhir/hapi-fhir-jpas
 | startupProbe.timeoutSeconds | int | `30` |  |
 | tolerations | list | `[]` | pod tolerations |
 
+## Development
+
+To update the Helm chart when a new version of the `hapiproject/hapi` image is released, the [Chart.yaml](Chart.yaml)'s
+`appVersion` and `version` fields need to be updated accordingly. Afterwards, re-generate the [README.md](README.md)
+by running:
+
+```sh
+$ helm-docs
+INFO[2021-11-20T12:38:04Z] Found Chart directories [charts/hapi-fhir-jpaserver]
+INFO[2021-11-20T12:38:04Z] Generating README Documentation for chart /usr/src/app/charts/hapi-fhir-jpaserver
+```
+
 ----------------------------------------------
 Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)

charts/hapi-fhir-jpaserver/README.md.gotmpl

@@ -11,6 +11,21 @@ helm repo add hapifhir https://hapifhir.github.io/hapi-fhir-jpaserver-starter/
 helm install --render-subchart-notes hapi-fhir-jpaserver hapifhir/hapi-fhir-jpaserver
 ```
 
+> ⚠ By default, the included [PostgreSQL Helm chart](https://github.com/bitnami/charts/tree/master/bitnami/postgresql#upgrading)
+> auto-generates a random password for the database which may cause problems when upgrading the chart (see [here for details](https://github.com/bitnami/charts/tree/master/bitnami/postgresql#upgrading)).
+
 {{ template "chart.valuesSection" . }}
 
+## Development
+
+To update the Helm chart when a new version of the `hapiproject/hapi` image is released, the [Chart.yaml](Chart.yaml)'s
+`appVersion` and `version` fields need to be updated accordingly. Afterwards, re-generate the [README.md](README.md)
+by running:
+
+```sh
+$ helm-docs
+INFO[2021-11-20T12:38:04Z] Found Chart directories [charts/hapi-fhir-jpaserver]
+INFO[2021-11-20T12:38:04Z] Generating README Documentation for chart /usr/src/app/charts/hapi-fhir-jpaserver
+```
+
 {{ template "helm-docs.versionFooter" . }}

charts/hapi-fhir-jpaserver/templates/poddisruptionbudget.yaml

@@ -0,0 +1,18 @@
+{{- if .Values.podDisruptionBudget.enabled }}
+kind: PodDisruptionBudget
+apiVersion: policy/v1
+metadata:
+  name: {{ include "hapi-fhir-jpaserver.fullname" . }}
+  labels:
+    {{- include "hapi-fhir-jpaserver.labels" . | nindent 4 }}
+spec:
+  {{- if .Values.podDisruptionBudget.minAvailable }}
+  minAvailable: {{ .Values.podDisruptionBudget.minAvailable }}
+  {{- end }}
+  {{- if .Values.podDisruptionBudget.maxUnavailable }}
+  maxUnavailable: {{ .Values.podDisruptionBudget.maxUnavailable }}
+  {{- end }}
+  selector:
+    matchLabels:
+      {{- include "hapi-fhir-jpaserver.selectorLabels" . | nindent 6 }}
+{{- end }}

charts/hapi-fhir-jpaserver/values.yaml

@@ -2,13 +2,16 @@
 replicaCount: 1
 
 image:
+  # -- registry where the HAPI FHIR server image is hosted
   registry: docker.io
+  # -- the path inside the repository
   repository: hapiproject/hapi
   # -- defaults to `Chart.appVersion`
   tag: ""
   # -- the flavor or variant of the image to use.
   # appended to the image tag by `-`.
   flavor: "distroless"
+  # -- image pullPolicy to use
   pullPolicy: IfNotPresent
 
 # -- image pull secrets to use when pulling the image
@@ -42,7 +45,9 @@ securityContext:
 
 # service to expose the server
 service:
+  # -- service type
   type: ClusterIP
+  # -- port where the server will be exposed at
   port: 8080
 
 ingress:
@@ -157,3 +162,18 @@ networkPolicy:
   #       matchLabels:
   #         app.kubernetes.io/name: {{ $.Release.Name }}
   allowedFrom: []
+
+# -- extra environment variables to set on the server container
+extraEnv:
+  []
+  # - name: SPRING_FLYWAY_BASELINE_ON_MIGRATE
+  #   value: "true"
+
+podDisruptionBudget:
+  # -- Enable PodDisruptionBudget for the server pods.
+  # uses policy/v1/PodDisruptionBudget thus requiring k8s 1.21+
+  enabled: false
+  # -- minimum available instances
+  minAvailable: 1
+  # -- maximum unavailable instances
+  maxUnavailable: ""