Skip to content

Latest commit

 

History

History
50 lines (39 loc) · 2.13 KB

README.md

File metadata and controls

50 lines (39 loc) · 2.13 KB

Mattermost Operator

A Juju charm deploying and managing Mattermost on Kubernetes. Mattermost is an open-source, self-hostable online chat service with file sharing, search, and integrations.

This charm simplifies initial deployment and “day N” operations of Mattermost on Kubernetes, such as scaling the number of instances and clustering, access to S3 and more. It allows for deployment on many different Kubernetes platforms, from MicroK8s to Charmed Kubernetes to public cloud Kubernetes offerings.

As such, the charm makes it easy for those looking to take control of their own chat system whilst keeping operations simple, and gives them the freedom to deploy on the Kubernetes platform of their choice.

For DevOps or SRE teams this charm will make operating Mattermost simple and straightforward through Juju’s clean interface. It will allow easy deployment into multiple environments for testing of changes, and supports scaling out for enterprise deployments.

Deployment options overview

For overall concepts related to using Juju see the Juju overview page. For easy local testing we recommend this how to on using MicroK8s with Juju.

How to deploy this charm (quick guide)

To deploy the charm and relate it to the PostgreSQL K8s charm within a Juju Kubernetes model:

juju deploy postgresql-k8s
juju deploy mattermost-k8s
juju relate mattermost-k8s postgresql-k8s:db
juju expose mattermost-k8s

Once the deployment has completed and the "mattermost-k8s" workload state in juju status has changed to "active" you can visit http://mattermost-k8s in a browser (assuming mattermost-k8s resolves to the IP(s) of your k8s ingress) and log in to your Mattermost instance, and you'll be presented with a screen to create an initial admin account. Further accounts must be created using this admin account, or by setting up an external authentication source, such as SAML.

For further details, see the charm’s detailed documentation.