Mattermost K8s charm

A Juju charm deploying and managing Mattermost on Kubernetes. Mattermost is a flexible, open source messaging platform that enables secure team collaboration.

Like any Juju charm, this charm supports one-line deployment, configuration, integration, scaling, and more. For the Mattermost K8s charm, this includes:

  • High-availability clustering with Mattermost Enterprise Edition.

  • S3-backed file storage and backups.

  • Integration with the Canonical Observability Stack (COS).

  • SMTP and OAuth integrations.

The Mattermost K8s charm allows for deployment on many different Kubernetes platforms, from MicroK8s to Charmed Kubernetes to public cloud Kubernetes offerings.

This charm will make operating Mattermost simple and straightforward for DevOps or SRE teams through Juju’s clean interface.

In this documentation

Get started

Guided tutorial

Deployment

Charm configuration | High-level deployment

Operations

Back up and restore | Integrate with COS | Upgrade

Design

Architecture

Security

Overview

How this documentation is organized

This documentation uses the Diátaxis documentation structure.

  • The Tutorial takes you step-by-step through a basic deployment of the Mattermost charm.

  • The How-to guides assume you have basic familiarity with the Mattermost charm. Learn more about setting up, using, maintaining, and contributing to this charm.

  • Reference provides a guide to actions, configurations, relations, and other technical details.

  • Explanation holds discussion and clarification of key concepts behind the charm, such as security.

  • Release notes holds all the release notes for the charm, including any system or upgrade requirements.

Contributing to this documentation

Documentation is an important part of this project, and we take the same open-source approach to the documentation as the code. As such, we welcome community contributions, suggestions, and constructive feedback on our documentation. See How to contribute for more information.

If there’s a particular area of documentation that you’d like to see that’s missing, please file a bug.

Project and community

The Mattermost K8s charm is a member of the Ubuntu family. It’s an open-source project that warmly welcomes community projects, contributions, suggestions, fixes, and constructive feedback.

Thinking about using the Mattermost K8s charm for your next project? Get in touch!