Update the helm chart readme

InseeFrLab · Sep 22, 2023 · 9b7e382 · 9b7e382
1 parent 08fa9e8
commit 9b7e382
Showing 1 changed file with 45 additions and 23 deletions.
diff --git a/helm-chart/README.md b/helm-chart/README.md
@@ -1,6 +1,24 @@
 # Helm Chart of [Onyxia](https://onyxia.sh/)
 
--   Complete installation guide: https://onyxia.sh/
+## Installation
+
+```bash
+helm repo add onyxia https://inseefrlab.github.io/onyxia
+
+cat << EOF > ./onyxia-values.yaml
+ingress:
+  enabled: true
+  hosts:
+    - host: datalab.yourdomain.com
+EOF
+
+helm install onyxia onyxia/onyxia --version "4.0.1" -f onyxia-values.yaml
+```
+
+Complete installation guide: https://onyxia.sh/
+
+## Parameters documentation
+
 -   `api` parameters: [../api/README.md](https://github.com/InseeFrLab/onyxia-api/blob/v0.30/README.md#configuration)
 -   `web` parameters: [../.env](../.env)
 
@@ -9,26 +27,30 @@ the parameters of onyxia-web and onyxia-api should be filled in:
 
 `onyxia-values.yaml`
 
-```yaml
-web:
-    env:
-        THEME_ID=ultraviolet
-        TERMS_OF_SERVICES: |
-            {
-              "en": "https://www.sspcloud.fr/tos_en.md",
-              "fr": "https://www.sspcloud.fr/tos_fr.md"
-            }
-        # ...
-api:
-    env:
-        security.cors.allowed_origins: http://localhost:3000
-        authentication.mode: openidconnect
-        keycloak.realm: datalab
-        keycloak.auth-server-url: https://auth.lab.my-domain.net/auth
-    regions:
-        [
-            {
-                "id":"demo",
-                "name":"Demo",
-                # ...
+```diff
+ ingress:
+     enabled: true
+     hosts:
+       - host: datalab.yourdomain.com
++web:
++    env:
++        THEME_ID=ultraviolet
++        TERMS_OF_SERVICES: |
++            {
++              "en": "https://www.sspcloud.fr/tos_en.md",
++              "fr": "https://www.sspcloud.fr/tos_fr.md"
++            }
++        # ...
++api:
++    env:
++        security.cors.allowed_origins: http://localhost:3000
++        authentication.mode: openidconnect
++        keycloak.realm: datalab
++        keycloak.auth-server-url: https://auth.lab.my-domain.net/auth
++    regions:
++        [
++            {
++                "id":"demo",
++                "name":"Demo",
++                # ...
 ```