matrix-authentication-service-chart
Matrix Authentication Service Helm chart
A helm chart for deploying the matrix-authentication-service on Kubernetes.
TLDR
Read through the parameters and modify them locally before installing the chart:
# add the helm repo locally
helm repo add matrix-authentication-service https://small-hack.github.io/matrix-authentication-service-chart
# downloads the values.yaml locally
helm show values matrix-authentication-service/matrix-authentication-service > values.yaml
# install the chart
helm install my-release-name matrix-authentication-service/matrix-authentication-service --values values.yaml
Notes
You can find the official docs for the Matrix Authentication Service at matrix-org.github.io/matrix-authentication-service for now, but this is expected to change to element-hq.github.io/matrix-authentication-service in the near future.
Database
By default, no database is enabled. To enable the built-in Bitnami hosted postgresql sub chart, use:
postgresql:
enabled: true
To enable using an external database instead of the built-in sub chart, use:
externalDatabase:
enabled: true
NOTE: You can only use externalDatabase.enabled=True OR postgresql.enabled=True. You cannot use both. You must pick one. If you’re still using Bitnami postgresql, but not the one that is bundled as a subchart to this one, you want to use the externalDatabase section.
Config.yaml
Matrix Authentication Service requires a config.yaml to function. You can set it up by either using the values under mas, or you can provide your own complete config file via an existing Kubernetes Secret.
Providing an existing Kubernetes secret for config.yaml
You can can provide your own complete config file via an existing Kubernetes Secret with config.yaml as the secret key via values.yaml:
# -- Existing Kubernetes Secret for entire matrix authentication service `config.yaml` file.
# If set, everything under the mas section of the values.yaml is ignored.
existingMasConfigSecret: "my-mas-secret-name"
You can also do it an argument to helm install with --set=existingMasConfigSecret.my-mas-secret-name.
Status
This chart was developed for use with the small-hack/matrix-chart. We’re still testing this chart. Feel free to open PRs and Issues if you see anything broken or want a feature.