vt-social/chart
Alex Nordlund 476e74b4c4
Assign unique set of labels to k8s deployments #19703 (#19706)
2022-11-08 17:21:06 +01:00
..
templates Assign unique set of labels to k8s deployments #19703 (#19706) 2022-11-08 17:21:06 +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: Add documentation to run tootctl commands (#19791) 2022-11-05 21:19:25 +01:00
values.yaml chore(chart): Update appVersion in helm chart (#19653) 2022-11-08 17:20:34 +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, its 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.