gearheads
/
mastodon
Archived
2
0
Fork 0
Code Releases 4 Activity
This repository has been archived on 2024-06-09. You can view files and clone it, but cannot push or open issues/pull-requests.
mastodon/chart
History
Sheogorath e868f41923
fix(chart): Fix gitops-incompatible random rolling (#20184) 
This patch reworks the Pod rolling mechanism, which is supposed to update Pods
with each migration run, but since the it generates a new random value on each
helm execution, this will constantly roll all pods in a GitOps driven deployment,
which reconciles the helm release.

This is resolved by fixing the upgrade to the `.Release.Revision`, which should
stay identical, unless config or helm release version have been changed. Further
it introduces automatic rolls based on adjustments to the environment variables
and secrets.

The implementation uses a helper template, following the 1-2-N rule, and omitting
code duplication.

References:
https://helm.sh/docs/chart_template_guide/builtin_objects/
https://helm.sh/docs/howto/charts_tips_and_tricks/#automatically-roll-deployments
 		2022-11-10 19:10:38 +01:00
..
templates fix(chart): Fix gitops-incompatible random rolling (#20184) 2022-11-10 19:10:38 +01:00
.helmignore Fix broken dependencies in helm chart and allow using existing secrets in the chart (#18941) 2022-08-10 17:12:58 +02:00
Chart.lock Fix broken dependencies in helm chart and allow using existing secrets in the chart (#18941) 2022-08-10 17:12:58 +02:00
Chart.yaml chore(chart): Update appVersion in helm chart (#19653) 2022-11-08 17:20:34 +01:00
readme.md Helm update readme.md (#20154) 2022-11-10 19:09:54 +01:00
values.yaml Helm update readme.md (#20154) 2022-11-10 19:09:54 +01:00

readme.md

Introduction

This is a Helm chart for installing Mastodon into a Kubernetes cluster. The basic usage is:

  1. edit values.yaml or create a separate yaml file for custom values
  2. helm dep update
  3. helm install --namespace mastodon --create-namespace my-mastodon ./ -f path/to/additional/values.yaml

This chart has been tested on Helm 3.0.1 and above.

Configuration

The variables that must be configured are:

  • password and keys in the mastodon.secrets, postgresql, and redis groups; if left blank, some of those values will be autogenerated, but will not persist across upgrades.

  • SMTP settings for your mailer in the mastodon.smtp group.

Administration

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

or

kubectl -n mastodon exec -it deployment/mastodon-web -- tootctl accounts modify admin --reset-password

Missing features

Currently this chart does not support:

  • Hidden services
  • Swift

Upgrading

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.0.0

Fixed labels

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:

  1. run helm template instead of helm upgrade
  2. Copy the new -web and -streaming services into services.yml
  3. Copy the new -web and -streaming deployments into deployments.yml
  4. Append -temp to the name of each deployment in deployments.yml
  5. kubectl apply -f deployments.yml then wait until all pods are ready
  6. kubectl apply -f services.yml
  7. Delete the old -sidekiq, -web, and -streaming deployments manually
  8. helm upgrade like normal
  9. kubectl delete -f deployments.yml to clear out the temporary deployments

PostgreSQL passwords

If you've previously installed the chart and you're having problems with postgres not accepting your password then make sure to set username to postgres and password and 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 postgres-password in your mastodon-postgresql secret: kubectl edit secret mastodon-postgresql