fixing postgresql parameter to match bitnami's primary.initdb.scriptsConfigMap and updating ci to do a repo add of coturn subchart (#9)

Author: jessebot

.github/workflows/ci-helm-release.yml

@@ -29,6 +29,7 @@ jobs:
 
       - name: Add dependency chart repos
         run: |
+          helm repo add coturn https://jessebot.github.io/coturn-chart/
           helm dep update charts/matrix
 
       - name: Run chart-releaser

README.md

@@ -1,31 +1,40 @@
 # Matrix Chart
 
-A Helm chart for deploying a Matrix homeserver stack in Kubernetes. This is a fork of [Arkaniad/matrix-chart](https://github.com/Arkaniad/matrix-chart), which is a fork of [typokign/matrix-chart](https://github.com/typokign/matrix-chart).
+A Helm chart for deploying a Matrix homeserver stack in Kubernetes. This is a fork of [Arkaniad/matrix-chart](https://github.com/Arkaniad/matrix-chart), which is a fork of [typokign/matrix-chart](https://github.com/typokign/matrix-chart). 
 
-## Features
+## TLDR
 
-- Latest version of [Synapse](https://github.com/matrix-org/synapse)
-- Ingress definition for federated Synapse and Element
+See [charts/matrix/README.md](./charts/matrix/README.md) for docs auto-generated from the [`values.yaml`](./charts/matrix/values.yaml).
+Read through the parameters and modify them locally before installing the chart:
+
+```bash
+helm repo add matrix https://jessebot.github.io/matrix-chart
+helm install my-release-name matrix --values values.yaml
+```
+
+
+## Current Features
+
+- Latest version of [Synapse](https://github.com/matrix-org/synapse) (the official homeserver edition of matrix)
+- Ingress definitions for federated Synapse (Matrix homeserver) and Element (frontend and CMS for matrix)
+- Use (existing) Kubernetes Secrets for confidential data, such as passwords
+
+### Optional Features
 
-### Opptional Features
 - Latest version of [Element](https://element.io/)
+- [Bitnami PostgreSQL subchart](https://github.com/bitnami/charts/tree/main/bitnami/postgresql) to deploy a cluster - needs some work to standardize though, so we also support external postgresql servers
+
+#### ⚠️ Optional Features (Untested Since Fork)
+
+These features still need to be tested, but are technically baked into the chart:
 - Choice of lightweight Exim relay or external mail server for email notifications
-- [Coturn TURN server sub-chart](https://github.com/jessebot/coturn-chart) for VoIP calls
-- [Bitnami PostgreSQL sub-chart](https://github.com/bitnami/charts/tree/main/bitnami/postgresql) to deploy a cluster - needs some work to standardize though, so we also support external postgresql servers
+- [Coturn TURN server subchart](https://github.com/jessebot/coturn-chart) for VoIP calls
+- [Half-Shot/matrix-appservice-discord](https://github.com/Half-Shot/matrix-appservice-discord) Discord bridge
 - [matrix-org/matrix-appservice-irc](https://github.com/matrix-org/matrix-appservice-irc) IRC bridge
 - [tulir/mautrix-whatsapp](https://github.com/tulir/mautrix-whatsapp) WhatsApp bridge
-- [Half-Shot/matrix-appservice-discord](https://github.com/Half-Shot/matrix-appservice-discord) Discord bridge
-
-## Installation
 
-Some documentation is available in [`values.yaml`](./charts/matrix/values.yaml). See [charts/matrix/README.md](./charts/matrix/README.md) for docs auto-generated from the `values.yaml`.
 
-### 
+## Status
+This chart is now maintained mostly by me, @jessebot, but I'd love contributors as well! My goal is to provide regular updates using dependabot (maybe renovatebot soon) and provide some level of basic security from a k8s perspective. The aim as of right now has been removing any plaintext secrets and allowing for existing PVCs. I'm also trying to standardize the chart more by following predictable values.yaml patterns.
 
-This is released normally, so you should be able to do:
-
-```bash
-helm repo add matrix https://jessebot.github.io/matrix-chart
-helm repo update
-helm install my-release-name matrix
-```
+Note: I may stop supporting this if a larger entity maintains a better matrix chart (e.g. Bitnami releases a matrix helm chart), as then I'll just write PRs directly to them. At that time I'll put in a note in this README before publically archiving the repo.

charts/matrix/Chart.yaml

@@ -8,7 +8,7 @@ sources:
 
 type: application
 
-version: 4.0.1
+version: 4.0.2
 appVersion: v1.88.0
 
 maintainers:

charts/matrix/README.md

@@ -1,6 +1,6 @@
 # matrix
 
-![Version: 4.0.1](https://img.shields.io/badge/Version-4.0.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v1.88.0](https://img.shields.io/badge/AppVersion-v1.88.0-informational?style=flat-square)
+![Version: 4.0.2](https://img.shields.io/badge/Version-4.0.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v1.88.0](https://img.shields.io/badge/AppVersion-v1.88.0-informational?style=flat-square)
 
 A Helm chart to deploy a Matrix homeserver stack into Kubernetes
 
@@ -218,9 +218,9 @@ A Helm chart to deploy a Matrix homeserver stack into Kubernetes
 | postgresql.global.postgresql.auth.secretKeys.databaseUsername | string | `"username"` | key in existingSecret with username for matrix to connect to db |
 | postgresql.global.postgresql.auth.secretKeys.userPasswordKey | string | `"password"` | key in existingSecret with password for matrix to connect to db |
 | postgresql.global.postgresql.auth.username | string | `"matrix"` | username of matrix postgres user |
-| postgresql.primary.initdbScriptsConfigMap | string | `"{{ .Release.Name }}-postgresql-initdb"` | If postgresql.enabled, stable/postgresql will run the scripts in: templates/postgresql/initdb-configmap.yaml If using an external Postgres server, make sure to configure the database ref: https://github.com/matrix-org/synapse/blob/master/docs/postgres.md |
-| postgresql.primary.persistence | object | `{"enabled":true,"size":"8Gi"}` | persistent volume claim configuration for postgresql to persist data |
-| postgresql.primary.persistence.enabled | bool | `true` | Enable PostgreSQL Primary data persistence using PVC |
+| postgresql.primary.initdb | object | `{"scriptsConfigMap":"{{ .Release.Name }}-postgresql-initdb"}` | run the scripts in templates/postgresql/initdb-configmap.yaml If using an external Postgres server, make sure to configure the database ref: https://github.com/matrix-org/synapse/blob/master/docs/postgres.md |
+| postgresql.primary.persistence | object | `{"enabled":false,"size":"8Gi"}` | persistent volume claim configuration for postgresql to persist data |
+| postgresql.primary.persistence.enabled | bool | `false` | Enable PostgreSQL Primary data persistence using PVC |
 | postgresql.primary.persistence.size | string | `"8Gi"` | size of postgresql volume claim |
 | postgresql.primary.podSecurityContext.enabled | bool | `true` |  |
 | postgresql.primary.podSecurityContext.fsGroup | int | `1000` |  |

charts/matrix/values.yaml

@@ -308,15 +308,15 @@ postgresql:
     # -- persistent volume claim configuration for postgresql to persist data
     persistence:
       # -- Enable PostgreSQL Primary data persistence using PVC
-      enabled: true
+      enabled: false
       # -- size of postgresql volume claim
       size: 8Gi
 
-    # -- If postgresql.enabled, stable/postgresql will run the scripts in:
-    # templates/postgresql/initdb-configmap.yaml
+    # -- run the scripts in templates/postgresql/initdb-configmap.yaml
     # If using an external Postgres server, make sure to configure the database
     # ref: https://github.com/matrix-org/synapse/blob/master/docs/postgres.md
-    initdbScriptsConfigMap: "{{ .Release.Name }}-postgresql-initdb"
+    initdb:
+      scriptsConfigMap: "{{ .Release.Name }}-postgresql-initdb"
 
     podSecurityContext:
       enabled: true