From c37da31b9d29dbd72e039ac6d1b112d3bede5a8a Mon Sep 17 00:00:00 2001 From: aesoft <43991222+aeppling@users.noreply.github.com> Date: Fri, 27 Sep 2024 16:45:11 +0200 Subject: [PATCH] fix: values doc & more docs --- README.md | 64 ++++++++++++++++++++++++++- charts/kexa-chart/templates/NOTES.txt | 3 ++ charts/kexa-chart/values.yaml | 25 ++--------- 3 files changed, 70 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 0fe37b8..370e392 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,7 @@ uselocalRules: true or when installing the chart ```yaml - helm install kexa-helm kexa/kexa -n kexa --set hostConfigPath="/mnt/host/c/your/path/to/tmpconfig" --set uselocalRules=true + helm install kexa-helm kexa/kexa -n kexa --set hostConfigPath="/mnt/host/c/your/path/to/tmpconfig" --set uselocalRules="true" ``` ## Install the chart @@ -134,3 +134,65 @@ Now you can schedule Kexa as you wish through Cronicle *Read the instructions in your console!* + +## Custom Values + +```yaml +# app name +appname: kexa-helm + +namespace: kexa + +# local rules folder mount +hostConfigPath: /mnt/host/c/your/path/to/tmpconfig +hostConfigFolder: tmpconfig +uselocalRules: false + +# kubernetes addon +kubernetesAddon: + enabled: true + mountPath: kubernetesconfigurations + +# kubernetes cronjob (instead of using Cronicle) +kexaKubeCronJob: "0 0 29 2 1" + +# Kexa version +kexaScript: + image: innovtech/kexa + tag: latest + +# database connection +# can only be reconfigured here +grafana.ini: + database: + type: "postgres" + host: "my-postgresql.kexa.svc.cluster.local" + name: "kexa_export_database" + user: "kexa_postgres_user" + password: "my_postgres_password" + ssl_mode: "disable" + + +# postgres +postgresql: + image: + tag: "15.0.0" + livenessProbe: + initialDelaySeconds: 200 + readinessProbe: + initialDelaySeconds: 200 + host: my-postgresql.kexa.svc.cluster.local + fullnameOverride: "my-postgresql" + connectionString: "postgresql://kexa_postgres_user:my_postgres_password@my-postgresql.kexa.svc.cluster.local:5432/kexa_export_database" + auth: + postgresPassword: my_postgres_password + username: kexa_postgres_user + password: my_postgres_password + database: kexa_export_database + persistence: + enabled: true + size: 10Gi + primary: + service: + port: 5432 +``` \ No newline at end of file diff --git a/charts/kexa-chart/templates/NOTES.txt b/charts/kexa-chart/templates/NOTES.txt index 8025c07..2f6110c 100644 --- a/charts/kexa-chart/templates/NOTES.txt +++ b/charts/kexa-chart/templates/NOTES.txt @@ -36,6 +36,9 @@ kubectl port-forward svc/YOUR_RELEASE_NAME-grafana 8080:80 -n kexa # Forwarding port kubectl port-forward svc/kexa-helm-cronicle-svc 3012:80 -n kexa +# Login +With admin/admin + #### Kexa Logs #### # Find logs from cronjob diff --git a/charts/kexa-chart/values.yaml b/charts/kexa-chart/values.yaml index b688f7c..f851517 100644 --- a/charts/kexa-chart/values.yaml +++ b/charts/kexa-chart/values.yaml @@ -1,7 +1,7 @@ appname: kexa-helm namespace: kexa -hostConfigPath: /mnt/host/c/path/to/your/tmpconfig +hostConfigPath: /mnt/host/c/your/path/to/tmpconfig hostConfigFolder: tmpconfig uselocalRules: false kubernetesAddon: @@ -12,12 +12,6 @@ kexaKubeCronJob: "0 0 29 2 1" # Use "0 0 29 2 1" for never if you're using the postgresql: image: tag: "15.0.0" - global: - postgresql: - auth: - postgresPassword: my_postgres_password - username: kexa_postgres_user - password: my_postgres_password livenessProbe: initialDelaySeconds: 200 readinessProbe: @@ -30,8 +24,9 @@ postgresql: username: kexa_postgres_user password: my_postgres_password database: kexa_export_database - service: - port: 5432 + persistence: + enabled: true + size: 10Gi primary: service: port: 5432 @@ -131,18 +126,6 @@ grafana: kexaScript: image: innovtech/kexa tag: latest - volumeMounts: - - name: configuration-files - mountPath: /app/config - volumes: - - name: configuration-files - configMap: - name: kexa-configuration-files - saveAddon: - type: postgres - name: "Clever Cloud Postgresql" - urlName: postgres_connect - description: "Database to save the data (clever-cloud)" cronicle: