* helm: Fix consistent list indentation * helm: Add helm lint and helm template tests * helm: Add helm template --validate test * helm: Add helm install test
This is a Helm chart for installing Mastodon into a Kubernetes cluster. The basic usage is:
values.yamlor create a separate yaml file for custom values
helm dep update
helm install --namespace mastodon --create-namespace my-mastodon ./ -f path/to/additional/values.yaml
This chart is tested with k8s 1.21+ and helm 3.6.0+.
The variables that must be configured are:
password and keys in the
redisgroups; if left blank, some of those values will be autogenerated, but will not persist across upgrades.
SMTP settings for your mailer in the
You can run admin CLI commands in the web deployment.
kubectl -n mastodon exec -it deployment/mastodon-web -- bash tootctl accounts modify admin --reset-password
kubectl -n mastodon exec -it deployment/mastodon-web -- tootctl accounts modify admin --reset-password
Currently this chart does not support:
- Hidden services
Because database migrations are managed as a Job separate from the Rails and Sidekiq deployments, it’s possible they will occur in the wrong order. After upgrading Mastodon versions, it may sometimes be necessary to manually delete the Rails and Sidekiq pods so that they are recreated against the latest migration.
Upgrades in 2.1.0
ingressClassName and tls-acme changes
The annotations previously defaulting to nginx have been removed and support for ingressClassName has been added.
ingress: annotations: kubernetes.io/ingress.class: nginx kubernetes.io/tls-acme: "true"
To restore the old functionality simply add the above snippet to your
but the recommendation is to replace these with
ingress.ingressClassName and use
cert-manager's issuer/cluster-issuer instead of tls-acme.
If you're uncertain about your current setup leave
ingressClassName empty and add
ingress.annotations in your
Upgrades in 2.0.0
Because of the changes in #19706 the upgrade may fail with the following error:
Error: UPGRADE FAILED: cannot patch "mastodon-sidekiq"
If you want an easy upgrade and you're comfortable with some downtime then simply delete the -sidekiq, -web, and -streaming Deployments manually.
If you require a no-downtime upgrade then:
helm templateinstead of
- Copy the new -web and -streaming services into
- Copy the new -web and -streaming deployments into
- Append -temp to the name of each deployment in
kubectl apply -f deployments.ymlthen wait until all pods are ready
kubectl apply -f services.yml
- Delete the old -sidekiq, -web, and -streaming deployments manually
helm upgradelike normal
kubectl delete -f deployments.ymlto clear out the temporary deployments
If you've previously installed the chart and you're having problems with
postgres not accepting your password then make sure to set
postgresPassword to the same passwords.
postgresql: auth: username: postgres password: <same password> postgresPassword: <same password>
And make sure to set
password to the same value as
kubectl edit secret mastodon-postgresql