Skip to content

Commit 39f34a1

Browse files
Revise readme
1 parent 4920347 commit 39f34a1

1 file changed

Lines changed: 11 additions & 4 deletions

File tree

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,13 @@ Deployment resources for [Ontoserver](https://ontoserver.csiro.au) — a FHIR te
1111

1212
## Helm Charts (Kubernetes)
1313

14-
Two charts are published from this repository:
14+
Three charts are published from this repository:
1515

1616
| Chart | Description |
1717
|-------|-------------|
1818
| [`ontoserver`](charts/ontoserver/) | Main chart — single/scaled deployments, Gateway API or Ingress, optional Postgres sidecar, Prometheus, OTel, External Secrets |
1919
| [`ontoserver-extras`](charts/ontoserver-extras/) | Optional add-ons — Varnish cache, OTel Collector, PersistentVolume |
20+
| [`ontoserver-indexer`](charts/ontoserver-indexer/) | One-shot Job to index SNOMED CT or LOINC and publish to a syndication server and/or write to a PVC |
2021

2122
### Installing
2223

@@ -29,11 +30,15 @@ helm install my-ontoserver ontoserver/ontoserver -f your-values.yaml
2930

3031
**From OCI (GitHub Container Registry):**
3132
```bash
32-
helm install my-ontoserver oci://ghcr.io/aehrc/ontoserver --version 1.0.0 -f your-values.yaml
33-
helm install my-ontoserver-extras oci://ghcr.io/aehrc/ontoserver-extras --version 1.0.0 -f your-extras-values.yaml
33+
helm install my-ontoserver oci://ghcr.io/aehrc/ontoserver --version <version> -f your-values.yaml
34+
helm install my-ontoserver-extras oci://ghcr.io/aehrc/ontoserver-extras --version <version> -f your-extras-values.yaml
35+
helm install my-indexer oci://ghcr.io/aehrc/ontoserver-indexer --version <version> -f your-indexer-values.yaml
3436
```
3537

36-
See [`charts/ontoserver/README.md`](charts/ontoserver/README.md) for full configuration reference and platform-specific examples (AKS, EKS, local k3d).
38+
See each chart's README for full configuration reference:
39+
- [`charts/ontoserver/README.md`](charts/ontoserver/README.md) — platform-specific examples (AKS, EKS, local k3d)
40+
- [`charts/ontoserver-extras/README.md`](charts/ontoserver-extras/README.md)
41+
- [`charts/ontoserver-indexer/README.md`](charts/ontoserver-indexer/README.md) — SNOMED CT and LOINC indexing examples
3742

3843
### Prerequisites
3944

@@ -46,6 +51,8 @@ Depending on features enabled, you may need these cluster components:
4651
| `ontoserver.opentelemetry.instrumentation.enabled` | [OpenTelemetry Operator](https://opentelemetry.io/docs/kubernetes/operator/) |
4752
| `ontoserver.externalSecret.enabled` | [External Secrets Operator](https://external-secrets.io/) |
4853
| TLS certificates | [cert-manager](https://cert-manager.io/) |
54+
| `ontoserver-indexer` with spot nodes | Node pool with `kubernetes.azure.com/scalesetpriority=spot` taint |
55+
| `ontoserver-indexer` with local output | PersistentVolumeClaim (e.g. Azure Files CSI) pre-created in the target namespace |
4956

5057
**Installing cert-manager with a Let's Encrypt ClusterIssuer:**
5158
```bash

0 commit comments

Comments
 (0)