Skip to content

Commit

Permalink
Merge pull request #4 from LinuxForHealth/lee-main
Browse files Browse the repository at this point in the history
update sample usage section with new postgresql values
  • Loading branch information
lmsurpre committed Jan 24, 2023
2 parents 04fc277 + 438a688 commit b3bfd1f
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 22 deletions.
14 changes: 2 additions & 12 deletions charts/fhir-server/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
apiVersion: v2
description: Helm chart for the LinuxForHealth FHIR Server
name: fhir-server
version: 0.9.0
version: 0.9.1
appVersion: 5.1.1
dependencies:
- name: postgresql
Expand All @@ -26,14 +26,4 @@ annotations:
# When using the list of objects option the valid supported kinds are
# added, changed, deprecated, removed, fixed, and security.
- kind: changed
description: bumped to LinuxForHealth version 5.1.1
- kind: changed
description: bumped to codecentric keycloak chart version 18.4.0
- kind: changed
description: bumped to bitnami postgresql chart version 11.9.13
- kind: changed
description: split db user creds in two; now uses separate admin user for schematool
- kind: removed
description: support for Db2 and all Db2-related values
- kind: removed
description: support for networking.k8s.io/v1/beta (kubernetes <1.19)
description: README updates
28 changes: 23 additions & 5 deletions charts/fhir-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,35 @@ with a focus on performance and configurability.
This helm chart will help you install the LinuxForHealth FHIR Server in a Kubernetes environment and uses
ConfigMaps and Secrets to support the wide range of configuration options available for the server.

This chart requires a minimum helm version of 3.7.0.

## Sample usage

```sh
helm repo add linuxforhealth https://linuxforhealth.github.io/lfh-helm
export POSTGRES_PASSWORD=$(openssl rand -hex 20)
helm upgrade --install --render-subchart-notes fhir-server linuxforhealth/fhir-server --set postgresql.postgresqlPassword=${POSTGRES_PASSWORD} --set ingress.hostname=example.com --set 'ingress.tls[0].secretName=cluster-tls-secret'
export POSTGRES_ADMIN_PASSWORD=$(openssl rand -hex 20)
export POSTGRES_USER_PASSWORD=$(openssl rand -hex 20)
helm upgrade --install --render-subchart-notes fhir-server linuxforhealth/fhir-server \
--set postgresql.auth.postgresPassword=${POSTGRES_ADMIN_PASSWORD} \
--set postgresql.auth.password=${POSTGRES_USER_PASSWORD} \
--set ingress.hostname=example.com \
--set 'ingress.tls[0].secretName=cluster-tls-secret'
```

This will install the latest version if the LinuxForHealth FHIR Server using an included PostgreSQL database for persistence.
Note that `postgresql.postgresqlPassword` must be set for all upgrades that use the embedded postgresql chart,
otherwise [the postgresql password will be overwritten and lost](https://artifacthub.io/packages/helm/bitnami/postgresql#troubleshooting).
This will install the latest version of the LinuxForHealth FHIR Server using an included PostgreSQL database for persistence.

Note that, to upgrade, either:

* `postgresql.auth.postgresPassword` and `postgresql.auth.password` must be set to these same values (`$POSTGRES_ADMIN_PASSWORD` and `$POSTGRES_USER_PASSWORD` respectively); or
* `postgresql.auth.existingSecret` must be set to the name of the secret created from the initial installation.

Otherwise the passwords in the secret may become [out-of-sync](https://docs.bitnami.com/general/how-to/troubleshoot-helm-chart-issues/#credential-errors-while-upgrading-chart-releases)
with the passwords in the persistent volume claim.

Often it is easiest to specify a [values override file](https://helm.sh/docs/chart_template_guide/values_files),
as opposed to setting the values from the command line on each installation / upgrade.

### Transport Layer Security

By default, the LinuxForHealth FHIR Server will only serve HTTPS traffic.
With the [NGINX Ingress Controller](https://kubernetes.github.io/ingress-nginx),
Expand Down
28 changes: 23 additions & 5 deletions charts/fhir-server/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,35 @@ with a focus on performance and configurability.
This helm chart will help you install the LinuxForHealth FHIR Server in a Kubernetes environment and uses
ConfigMaps and Secrets to support the wide range of configuration options available for the server.

This chart requires a minimum helm version of 3.7.0.

## Sample usage

```sh
helm repo add linuxforhealth https://linuxforhealth.github.io/lfh-helm
export POSTGRES_PASSWORD=$(openssl rand -hex 20)
helm upgrade --install --render-subchart-notes fhir-server linuxforhealth/fhir-server --set postgresql.postgresqlPassword=${POSTGRES_PASSWORD} --set ingress.hostname=example.com --set 'ingress.tls[0].secretName=cluster-tls-secret'
export POSTGRES_ADMIN_PASSWORD=$(openssl rand -hex 20)
export POSTGRES_USER_PASSWORD=$(openssl rand -hex 20)
helm upgrade --install --render-subchart-notes fhir-server linuxforhealth/fhir-server \
--set postgresql.auth.postgresPassword=${POSTGRES_ADMIN_PASSWORD} \
--set postgresql.auth.password=${POSTGRES_USER_PASSWORD} \
--set ingress.hostname=example.com \
--set 'ingress.tls[0].secretName=cluster-tls-secret'
```

This will install the latest version if the LinuxForHealth FHIR Server using an included PostgreSQL database for persistence.
Note that `postgresql.postgresqlPassword` must be set for all upgrades that use the embedded postgresql chart,
otherwise [the postgresql password will be overwritten and lost](https://artifacthub.io/packages/helm/bitnami/postgresql#troubleshooting).
This will install the latest version of the LinuxForHealth FHIR Server using an included PostgreSQL database for persistence.

Note that, to upgrade, either:

* `postgresql.auth.postgresPassword` and `postgresql.auth.password` must be set to these same values (`$POSTGRES_ADMIN_PASSWORD` and `$POSTGRES_USER_PASSWORD` respectively); or
* `postgresql.auth.existingSecret` must be set to the name of the secret created from the initial installation.

Otherwise the passwords in the secret may become [out-of-sync](https://docs.bitnami.com/general/how-to/troubleshoot-helm-chart-issues/#credential-errors-while-upgrading-chart-releases)
with the passwords in the persistent volume claim.

Often it is easiest to specify a [values override file](https://helm.sh/docs/chart_template_guide/values_files),
as opposed to setting the values from the command line on each installation / upgrade.

### Transport Layer Security

By default, the LinuxForHealth FHIR Server will only serve HTTPS traffic.
With the [NGINX Ingress Controller](https://kubernetes.github.io/ingress-nginx),
Expand Down

0 comments on commit b3bfd1f

Please sign in to comment.