🏭 UDS Mattermost Package

This package is designed for use as part of a UDS Software Factory bundle deployed on UDS Core.

Mattermost is a secure collaboration platform that accelerates mission-critical work by offering persistent chat, workflow automation, and integrated voice, screen, file, and content sharing. It is built for organizations with rigorous and complex environments, such as government, defense, and critical infrastructure.

Important

The arm64 package includes amd64 images due to lack of availability of arm64 images from upstream projects at this time. This means you can deploy the arm64 package on an arm64 kubernetes cluster, but some of the images contained in the package will require emulation (e.g., qemu or rosetta) to run properly.

Tip

To add additional environment variables to Mattermost you can do so by overriding the extraEnv key in the uds-mattermost-config chart.

overrides:
  mattermost:
    uds-mattermost-config:
      values:
        - path: "extraEnv"
          value:
            MY_ENV_VAR: "an env var value"

Prerequisites

Mattermost requires two dependencies, postgres and s3 compatible object storage. Wiring Mattermost to your dependencies is done primarily via helm values and you can learn more about configuring these and other options in the configuration documentation.

Monitoring

Important

Mattermost supports emitting metrics to feed into Prometheus, but only if you have a license. This package configures the necessary service monitor to enable metrics, but only when a license has been provided via the MM_LICENSE var. By default (no license), it does not provision the Service Monitor as it will show unhealthy because metrics is not enabled via the license.

Releases

The released packages can be found in ghcr.

UDS Tasks (for local dev and CI)

*For local dev, this requires you install uds-cli

✅ Tip: To get a list of tasks to run you can use uds run --list!

Contributing

Please see the CONTRIBUTING.md

Development

When developing this package it is ideal to utilize the json schemas for UDS Bundles, Zarf Packages and Maru Tasks. This involves configuring your IDE to provide schema validation for the respective files used by each application. For guidance on how to set up this schema validation, please refer to the guide in uds-common.