Update documentation, fix ingress

Aidbox · Apr 15, 2024 · 798acbe · 798acbe
1 parent 553a01e
commit 798acbe
Show file tree

Hide file tree

Showing 9 changed files with 41 additions and 17 deletions.
diff --git a/aidbox/Chart.yaml b/aidbox/Chart.yaml
@@ -5,4 +5,4 @@ home: https://www.health-samurai.io/aidbox
 icon: https://aidbox.github.io/helm-charts/icon.png?1712669999
 name: aidbox
 type: application
-version: 0.1.5
+version: 0.1.6
diff --git a/aidbox/README.md b/aidbox/README.md
@@ -2,11 +2,12 @@
 
 [Aidbox](https://docs.aidbox.app/) is an efficient and scalable FHIR server built to handle healthcare data effectively, empowering healthcare providers and developers alike with its comprehensive platform for storing, accessing, and exchanging healthcare information in accordance with FHIR standards.
 
-![Version: 0.1.5](https://img.shields.io/badge/Version-0.1.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: edge](https://img.shields.io/badge/AppVersion-edge-informational?style=flat-square)
+![Version: 0.1.6](https://img.shields.io/badge/Version-0.1.6-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: edge](https://img.shields.io/badge/AppVersion-edge-informational?style=flat-square)
 
 ## Installation
 
-Prepare the configuration file. Please refer to the [Aidbox environment variables](https://docs.aidbox.app/reference/configuration/environment-variables) for details.
+1. Obtain a [license](https://docs.aidbox.app/~/changes/cP0dGveACDeqsL8PvFlu/overview/editions-and-pricing#aidbox-licenses).
+2. Prepare the configuration file. Please refer to the [Aidbox environment variables](https://docs.aidbox.app/reference/configuration/environment-variables) for details.
 
 ```yaml
 host: <your host here, e.g. my.domain.tld>
@@ -26,8 +27,9 @@ config:
 ```
 
 ```console
+helm repo add aidbox https://aidbox.github.io/helm-charts
+
 helm upgrade --install aidbox aidbox \
-  --repo https://aidbox.github.io/helm-charts \
   --namespace aidbox --create-namespace \
   --values /path/to/config/file
 ```

diff --git a/aidbox/README.md.gotmpl b/aidbox/README.md.gotmpl
@@ -6,7 +6,8 @@
 
 ## Installation
 
-Prepare the configuration file. Please refer to the [Aidbox environment variables](https://docs.aidbox.app/reference/configuration/environment-variables) for details.
+1. Obtain a [license](https://docs.aidbox.app/~/changes/cP0dGveACDeqsL8PvFlu/overview/editions-and-pricing#aidbox-licenses).
+2. Prepare the configuration file. Please refer to the [Aidbox environment variables](https://docs.aidbox.app/reference/configuration/environment-variables) for details.
 
 ```yaml
 host: <your host here, e.g. my.domain.tld>
@@ -27,8 +28,9 @@ config:
 
 
 ```console
+helm repo add aidbox https://aidbox.github.io/helm-charts
+
 helm upgrade --install aidbox aidbox \
-  --repo https://aidbox.github.io/helm-charts \
   --namespace aidbox --create-namespace \
   --values /path/to/config/file
 ```

diff --git a/aidbox/templates/configmap.yaml b/aidbox/templates/configmap.yaml
@@ -6,9 +6,13 @@ metadata:
     {{- include "aidbox.labels" . | nindent 4 }}
 data:
   {{- range $key, $val := .Values.config }}
-  {{- if and (ne $key "PGUSER") (ne $key "PGPASSWORD") (ne $key "AIDBOX_CLIENT_ID") (ne $key "AIDBOX_CLIENT_SECRET") (ne $key "AIDBOX_ADMIN_ID") (ne $key "AIDBOX_ADMIN_PASSWORD") (ne $key "AIDBOX_LICENSE") }}
+  {{- if and (ne $key "PGUSER") (ne $key "PGPASSWORD") (ne $key "AIDBOX_CLIENT_ID") (ne $key "AIDBOX_CLIENT_SECRET") (ne $key "AIDBOX_ADMIN_ID") (ne $key "AIDBOX_ADMIN_PASSWORD") (ne $key "AIDBOX_LICENSE") (ne $key "AIDBOX_FHIR_VERSION") (ne $key "PGHOST") (ne $key "PGPORT") (ne $key "AIDBOX_PORT") (ne $key "PGDATABASE") }}
   {{ $key }}: {{ $val | quote }}
   {{- end }}
   {{- end }}
   AIDBOX_BASE_URL: {{ required "missing protocol value" .Values.protocol }}://{{ required "missing host value" .Values.host }}
+  AIDBOX_FHIR_VERSION: {{ required "missing config AIDBOX_FHIR_VERSION value" .Values.config.AIDBOX_FHIR_VERSION | quote }}
+  AIDBOX_PORT: {{ required "missing config AIDBOX_PORT value" .Values.config.AIDBOX_PORT | quote }}
+  PGDATABASE: {{ required "missing config PGDATABASE value" .Values.config.PGDATABASE | quote }}
   PGHOST: {{ required "missing config PGHOST value" .Values.config.PGHOST | quote }}
+  PGPORT: {{ required "missing config PGPORT value" .Values.config.PGPORT | quote }}
diff --git a/aidbox/templates/ingress.yaml b/aidbox/templates/ingress.yaml
@@ -30,5 +30,5 @@ spec:
               service:
                 name: {{ $fullName }}-api
                 port:
-                  number: {{ int .Values.config.AIDBOX_PORT }}
+                  number: {{ int .Values.service.apiPort }}
 {{- end }}
diff --git a/aidboxdb/Chart.yaml b/aidboxdb/Chart.yaml
@@ -5,4 +5,4 @@ home: https://www.health-samurai.io/aidbox
 icon: https://aidbox.github.io/helm-charts/icon.png?1712669999
 name: aidboxdb
 type: application
-version: 0.1.5
+version: 0.1.6
diff --git a/aidboxdb/README.md b/aidboxdb/README.md
@@ -2,13 +2,18 @@
 
 [AidboxDB](https://docs.aidbox.app/storage-1/aidboxdb-image) is a specialized version of the open-source PostgreSQL database, tailored for use as the data storage backend for Aidbox. It serves various purposes, including initializing and operating as a master database for Aidbox, functioning as a streaming replica, optimizing FHIR search queries, and supporting backup and maintenance functionalities.
 
-![Version: 0.1.5](https://img.shields.io/badge/Version-0.1.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 16.1](https://img.shields.io/badge/AppVersion-16.1-informational?style=flat-square)
+![Version: 0.1.6](https://img.shields.io/badge/Version-0.1.6-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 16.1](https://img.shields.io/badge/AppVersion-16.1-informational?style=flat-square)
+
+## Add the helm repository
+
+```console
+helm repo add aidbox https://aidbox.github.io/helm-charts
+```
 
 ## Installation with the PostgreSQL default credentials
 
 ```console
 helm upgrade --install aidboxdb aidboxdb \
-  --repo https://aidbox.github.io/helm-charts \
   --namespace postgres --create-namespace
 ```
 
@@ -32,17 +37,20 @@ and apply it
 
 ```console
 helm upgrade --install aidboxdb aidboxdb \
-  --repo https://aidbox.github.io/helm-charts \
   --namespace postgres --create-namespace \
   --values /path/to/values.yaml
 ```
 
+## Database backup
+
+AidboxDB image contains [WAL-G](https://github.com/wal-g/wal-g). For more information see [documentation](https://docs.aidbox.app/storage-1/backup-and-restore/archiving)
+
 ## Values
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | config | string | `"max_wal_size = '4GB'\nshared_buffers = '2GB'"` | PostgreSQL config |
-| env | object | [AidboxDB environment variables](https://docs.aidbox.app/reference/configuration/environment-variables/aidboxdb-environment-variables) | Environment variables |
+| env | object | `{"PGDATA":"/data/pg","POSTGRES_DB":"postgres","POSTGRES_PASSWORD":"postgres","POSTGRES_USER":"postgres"}` | [AidboxDB environment variables](https://docs.aidbox.app/reference/configuration/environment-variables/aidboxdb-environment-variables) |
 | fullnameOverride | string | `""` |  |
 | image.pullPolicy | string | `"IfNotPresent"` |  |
 | image.repository | string | `"healthsamurai/aidboxdb"` |  |

diff --git a/aidboxdb/README.md.gotmpl b/aidboxdb/README.md.gotmpl
@@ -4,11 +4,16 @@
 
 {{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
 
+## Add the helm repository
+
+```console
+helm repo add aidbox https://aidbox.github.io/helm-charts
+```
+
 ## Installation with the PostgreSQL default credentials
 
 ```console
 helm upgrade --install aidboxdb aidboxdb \
-  --repo https://aidbox.github.io/helm-charts \
   --namespace postgres --create-namespace
 ```
 
@@ -32,10 +37,14 @@ and apply it
 
 ```console
 helm upgrade --install aidboxdb aidboxdb \
-  --repo https://aidbox.github.io/helm-charts \
   --namespace postgres --create-namespace \
   --values /path/to/values.yaml
 ```
 
+## Database backup
+
+AidboxDB image contains [WAL-G](https://github.com/wal-g/wal-g). For more information see [documentation](https://docs.aidbox.app/storage-1/backup-and-restore/archiving)
+
+
 
 {{ template "chart.valuesSection" . }}
diff --git a/aidboxdb/values.yaml b/aidboxdb/values.yaml
@@ -3,8 +3,7 @@ config: |-
   max_wal_size = '4GB'
   shared_buffers = '2GB'
 
-# -- Environment variables
-# @default -- [AidboxDB environment variables](https://docs.aidbox.app/reference/configuration/environment-variables/aidboxdb-environment-variables)
+# -- [AidboxDB environment variables](https://docs.aidbox.app/reference/configuration/environment-variables/aidboxdb-environment-variables)
 env:
   PGDATA: /data/pg
   POSTGRES_PASSWORD: postgres