updated helm chart to use version 6.1.0 of the image

2022-08-25 23:21:19 +02:00
parent 4790c4372f
commit bdc621e535
4 changed files with 108 additions and 26 deletions
--- a/charts/hapi-fhir-jpaserver/README.md
+++ b/charts/hapi-fhir-jpaserver/README.md
@@ -1,6 +1,6 @@
 # HAPI FHIR JPA Server Starter Helm Chart

-![Version: 0.10.0](https://img.shields.io/badge/Version-0.10.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v6.x](https://img.shields.io/badge/AppVersion-v6.x-informational?style=flat-square)
+![Version: 0.10.1](https://img.shields.io/badge/Version-0.10.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v6.x](https://img.shields.io/badge/AppVersion-v6.x-informational?style=flat-square)

 This helm chart will help you install the HAPI FHIR JPA Server in a Kubernetes environment.

@@ -32,7 +32,7 @@ helm install --render-subchart-notes hapi-fhir-jpaserver hapifhir/hapi-fhir-jpas
 | image.pullPolicy | string | `"IfNotPresent"` | image pullPolicy to use |
 | image.registry | string | `"docker.io"` | registry where the HAPI FHIR server image is hosted |
 | image.repository | string | `"hapiproject/hapi"` | the path inside the repository |
-| image.tag | string | `"v6.0.1@sha256:63c98d8be3dadc77b47dca3115490f22bf99512f363f779f7bbcb42f569aeac3"` | the image tag. As of v5.7.0, this is the `distroless` flavor by default, add `-tomcat` to use the Tomcat-based image. |
+| image.tag | string | `"v6.1.0@sha256:253f87bb1f5b7627f8e25f76a4b0aa7a83f31968c6e111ad74d3cc4ad9ae812e"` | the image tag. As of v5.7.0, this is the `distroless` flavor by default, add `-tomcat` to use the Tomcat-based image. |
 | 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. |
 | ingress.enabled | bool | `false` | whether to create an Ingress to expose the FHIR server HTTP endpoint |
@@ -89,8 +89,8 @@ helm install --render-subchart-notes hapi-fhir-jpaserver hapifhir/hapi-fhir-jpas

 ## 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)
+To update the Helm chart when a new version of the `hapiproject/hapi` image is released, [values.yaml](values.yaml) `image.tag` and the [Chart.yaml](Chart.yaml)'s
+`version` and optionally the `appVersion` field on major releases need to be updated. Afterwards, re-generate the [README.md](README.md)
 by running:

 ```sh
@@ -99,5 +99,54 @@ 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
 ```

+## Enable Distributed Tracing based on the OpenTelemtry Java Agent
+
+The container image includes the [OpenTelemetry Java agent JAR](https://github.com/open-telemetry/opentelemetry-java-instrumentation)
+which can be used to enable distributed tracing. It can be configured entirely using environment variables,
+see <https://opentelemetry.io/docs/instrumentation/java/automatic/agent-config/> for details.
+
+Here's an example setup deploying [Jaeger](https://www.jaegertracing.io/) as a tracing backend:
+
+```sh
+# required by the Jaeger Operator
+kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.9.1/cert-manager.yaml
+kubectl create namespace observability
+kubectl create -f https://github.com/jaegertracing/jaeger-operator/releases/download/v1.37.0/jaeger-operator.yaml -n observability
+
+cat <<EOF | kubectl apply -n observability -f -
+# simple, all-in-one Jaeger installation. Not suitable for production use.
+apiVersion: jaegertracing.io/v1
+kind: Jaeger
+metadata:
+  name: simplest
+EOF
+```
+
+Use this chart's `extraEnv` value to set the required environment variables:
+
+```yaml
+extraEnv:
+  - name: JAVA_TOOL_OPTIONS
+    value: "-javaagent:/app/opentelemetry-javaagent.jar"
+  - name: OTEL_METRICS_EXPORTER
+    value: "none"
+  - name: OTEL_LOGS_EXPORTER
+    value: "none"
+  - name: OTEL_TRACES_EXPORTER
+    value: "jaeger"
+  - name: OTEL_SERVICE_NAME
+    value: "hapi-fhir-jpaserver"
+  - name: OTEL_EXPORTER_JAEGER_ENDPOINT
+    value: "http://simplest-collector.observability.svc:14250"
+```
+
+Finally, you can open the Jaeger query UI by running:
+
+```sh
+kubectl port-forward -n observability service/simplest-query 16686:16686
+```
+
+and opening <http://localhost:16686/> in your browser.
+
 ----------------------------------------------
 Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)