<!-- vale Canonical.007-Headings-sentence-case = NO -->

# Mattermost K8s charm

<!-- vale Canonical.007-Headings-sentence-case = YES -->

A [Juju](https://juju.is/) [charm](https://canonical.com/juju/docs/juju-cli/3.6/reference/charm/#charm)
deploying and managing [Mattermost](https://mattermost.com/) 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](https://microk8s.io/) to [Charmed Kubernetes](https://ubuntu.com/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](https://canonical.com/juju/docs/mattermost-k8s-charm/latest/tutorial/index.html.md#deploy-the-mattermost-charm-for-the-first-time)                                                                                                                                                                                                                                                               |
| **Deployment**  | [Charm configuration](https://canonical.com/juju/docs/mattermost-k8s-charm/latest/reference/configurations/index.html.md#reference-configurations) | [High-level deployment](https://canonical.com/juju/docs/mattermost-k8s-charm/latest/reference/charm-architecture/index.html.md#reference-charm-architecture) | [Provide a certificate](https://canonical.com/juju/docs/mattermost-k8s-charm/latest/how-to/provide-certificate/index.html.md#how-to-provide-certificate)                                                                           |
| **Operations**  | [Back up and restore](https://canonical.com/juju/docs/mattermost-k8s-charm/latest/how-to/back-up-restore/index.html.md#how-to-back-up-restore) | [Integrate with COS](https://canonical.com/juju/docs/mattermost-k8s-charm/latest/how-to/integrate-with-cos/index.html.md#how-to-integrate-with-cos) | [Manage push notifications](https://canonical.com/juju/docs/mattermost-k8s-charm/latest/how-to/manage-push-notifications/index.html.md#how-to-manage-push-notifications) | [Upgrade](https://canonical.com/juju/docs/mattermost-k8s-charm/latest/how-to/upgrade/index.html.md#how-to-upgrade) |
| **Design**      | [Architecture](https://canonical.com/juju/docs/mattermost-k8s-charm/latest/reference/charm-architecture/index.html.md#reference-charm-architecture)                                                                                                                                                                                                                                                                                    |
| **Security**    | [Overview](https://canonical.com/juju/docs/mattermost-k8s-charm/latest/explanation/security/index.html.md#explanation-security)                                                                                                                                                                                                                                                                                                |

## How this documentation is organized

This documentation uses the
[Diátaxis documentation structure](https://diataxis.fr/).

* The [Tutorial](https://canonical.com/juju/docs/mattermost-k8s-charm/latest/tutorial/index.html.md#deploy-the-mattermost-charm-for-the-first-time) takes you step-by-step through a basic deployment of the Mattermost charm.
* The [How-to guides](https://canonical.com/juju/docs/mattermost-k8s-charm/latest/how-to/index.html.md#how-to-index) assume you have basic familiarity with the Mattermost charm. Learn more about setting up, using, maintaining, and contributing to this charm.
* [Reference](https://canonical.com/juju/docs/mattermost-k8s-charm/latest/reference/index.html.md#reference-index) provides a guide to actions, configurations, relations, and other technical details.
* [Explanation](https://canonical.com/juju/docs/mattermost-k8s-charm/latest/explanation/index.html.md#explanation-index) holds discussion and clarification of key concepts behind the charm, such as security.
* [Release notes](https://canonical.com/juju/docs/mattermost-k8s-charm/latest/release-notes/landing-page/index.html.md#release-notes-landing-page) 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](https://canonical.com/juju/docs/mattermost-k8s-charm/latest/how-to/contribute/index.html.md#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](https://github.com/canonical/mattermost-k8s-operator/issues).

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

- [Code of conduct](https://ubuntu.com/community/code-of-conduct)
- [Get support](https://discourse.charmhub.io/)
- [Join our online chat](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)
- [Contribute](https://canonical.com/juju/docs/mattermost-k8s-charm/latest/how-to/contribute/index.html.md#how-to-contribute)

Thinking about using the Mattermost K8s charm for your next project?
[Get in touch](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)!
