Update air-gapped-deployment.rst #8363

esethna · 2025-09-09T02:01:50Z

No description provided.

esethna · 2025-09-09T02:02:35Z

@cwarnermm interested to get your thoughts and feedback on this skeleton based on the conversations we had with Colton and Stu, re air gapped docs improvements

github-actions · 2025-09-09T02:05:08Z

Newest code from mattermost has been published to preview environment for Git SHA 8bfdc11

github-actions · 2025-09-09T02:10:00Z

Newest code from mattermost has been published to preview environment for Git SHA 2bd8de9

cwarnermm · 2025-09-09T13:04:01Z

@esethna - It's a good set of updates. I've provided editorial and code-level review updates in a separate commit to this PR for links, readability, and formatting.

github-actions · 2025-09-09T13:06:12Z

Newest code from mattermost has been published to preview environment for Git SHA 09438c2

sadohert

Shared my thoughts. A couple areas needing clarification (or maybe discussion)

sadohert · 2025-09-15T14:01:35Z

source/deployment-guide/server/air-gapped-deployment.rst

-A private container registry securely stores Docker images for air-gapped deployments, ensuring compliance with data isolation requirements. Use it to enable local deployments in Kubernetes or Docker.
+    - :doc:`Mattermost tarball </product-overview/version-archive>`. We recommend using the latest :ref:`ESR <product-overview/release-policy:extended support releases>` for extended support where server upgrades may be infrequent)
+    - Database: PostgreSQL `installation packages <https://www.postgresql.org/download/>`_ or container images for your Linux distribution
+    - File Storage: 


This feels tricky to keep high level, but we could try:

File Storage: For single node deployments ensure the Mattermost host has local storage capacity to handle anticipated volume of attachments 1️⃣. For high availability deployments we recommend the Minio service deployed to match your Mattermost deployment method.

1️⃣ We have similar, but slight different Storage Estimation subsections in each of our Scaling Guidance docs like this - https://docs.mattermost.com/administration-guide/scale/scale-to-2000-users.html#lifetime-storage. We could say "Consult the "Lifetime Storage" section of the scaling guide that matches your user population size. E.g., for a 2000 user deployment see this link"
2️⃣ The absence of "NFS" in our docs as an option for high-availability filestore gives me "pause". As far as I've seen, customers end up using it because they don't have the capability/approval to stand up a new service (minio). I guess we can continue to only document what we're prepared to officially support, but I think customers are going to go to NFS anyway.

Thanks @sadohert, re #1 I think we should filter what's special to air-gapped in this doc. Is this process of sizing something unique to airgapped or something that needs be taken into consideration before going offline?

Re 2, what would be our opinionated recommendation (and alternative options) for file storage in airgapped if deploying via tarball? For example, we can recommend MinIO but then state that NFS can be used. We do mention NFS briefly as an option in the Kube deployment docs: http://mattermost-docs-preview-pulls.s3-website-us-east-1.amazonaws.com/8363/deployment-guide/server/deploy-kubernetes.html#where-is-data-stored-in-a-self-hosted-kubernetes-deployment

Its not specific to air-gapped.

I'd support your suggestion: "recommend MinIO but then state that NFS can be used."

sadohert · 2025-09-15T14:02:45Z

source/deployment-guide/server/air-gapped-deployment.rst

+    - :doc:`Mattermost tarball </product-overview/version-archive>`. We recommend using the latest :ref:`ESR <product-overview/release-policy:extended support releases>` for extended support where server upgrades may be infrequent)
+    - Database: PostgreSQL `installation packages <https://www.postgresql.org/download/>`_ or container images for your Linux distribution
+    - File Storage: 
+    - Load balancer: If you already have a load balancer you can skip this, otherwise you'll need 


"otherwise we recommend Nginx. https://docs.mattermost.com/deployment-guide/server/setup-nginx-proxy.html"

sadohert · 2025-09-15T14:03:21Z

source/deployment-guide/server/air-gapped-deployment.rst

-   1. **Install Docker Registry**:
+    - Mattermost `Helm charts <https://helm.mattermost.com>`_ and `operator values <https://github.com/mattermost/mattermost-helm/blob/master/charts/mattermost-operator/values.yaml>`_ 
+    - Database: We recommend the `Postgres Operator <https://github.com/CrunchyData/postgres-operator/>`_ from Crunchy Data for air-gapped Kubernetes deployments. 
+    - File Storage: 


sadohert · 2025-09-15T14:04:37Z

source/deployment-guide/server/air-gapped-deployment.rst

+    **Bill of Materials**

-   1. **Install Docker Registry**:
+    - Mattermost `Helm charts <https://helm.mattermost.com>`_ and `operator values <https://github.com/mattermost/mattermost-helm/blob/master/charts/mattermost-operator/values.yaml>`_ 


I'm not deep with K8s and Mattermost. Do Air-gapped customers need to use our Helm chart, versus our Operator? This BoM line feels really sparse.

@coltoneshaw what do you think?

sadohert · 2025-09-15T14:12:17Z

source/deployment-guide/server/air-gapped-deployment.rst

+    - Mattermost `Helm charts <https://helm.mattermost.com>`_ and `operator values <https://github.com/mattermost/mattermost-helm/blob/master/charts/mattermost-operator/values.yaml>`_ 
+    - Database: We recommend the `Postgres Operator <https://github.com/CrunchyData/postgres-operator/>`_ from Crunchy Data for air-gapped Kubernetes deployments. 
+    - File Storage: 
+    - Private container registry: If you don't have a Docker container registry we recommend following the instructions `here <https://www.digitalocean.com/community/developer-center/how-to-set-up-digitalocean-container-registry>`_.


I could be missing something, but I don't know if this DI approach covers what we need. From a cursory review it seems to be very DI-centric.

I would think something like this resource from Docker would be more relevant:

https://www.docker.com/blog/how-to-use-your-own-registry-2/

And we add a line to call out the images the admin needs to find: Mattermost Enterprise, Calls-Offloader.

sadohert · 2025-09-15T14:12:36Z

source/deployment-guide/server/air-gapped-deployment.rst

+    **Bill of Materials**

-      .. code-block:: bash
+    - Private container registry: If you don't have a Docker container registry we recommend following the instructions `here <https://www.digitalocean.com/community/developer-center/how-to-set-up-digitalocean-container-registry>`_. 


Same feedback as in the K8s Private registry case.

sadohert · 2025-09-15T14:13:39Z

source/deployment-guide/server/air-gapped-deployment.rst

+Consider gathering additional resources if you plan to enable these optional components:

-   3. **Create a mirror configuration**:
+- :doc:`Mattermost Calls </administration-guide/configure/calls-deployment>`: For self-hosted audio and screensharing capabilities


Maybe need a brief note "The Calls Offloader depends on specific Mattermost Docker image. See ".

github-actions · 2025-09-15T19:51:45Z

Newest code from mattermost has been published to preview environment for Git SHA 3e1dfdd

Add private registry/mirror FAQ

github-actions · 2025-09-15T20:59:21Z

Newest code from mattermost has been published to preview environment for Git SHA e8e92c3

github-actions · 2025-09-15T21:40:27Z

Newest code from mattermost has been published to preview environment for Git SHA a020230

github-actions · 2025-09-15T21:49:16Z

Newest code from mattermost has been published to preview environment for Git SHA b19eb48

github-actions · 2025-09-15T21:58:31Z

Newest code from mattermost has been published to preview environment for Git SHA eaac3a6

github-actions · 2025-09-15T22:01:06Z

Newest code from mattermost has been published to preview environment for Git SHA 7f80a39

github-actions · 2025-09-15T22:09:43Z

Newest code from mattermost has been published to preview environment for Git SHA 0207645

github-actions · 2025-09-15T22:14:14Z

Newest code from mattermost has been published to preview environment for Git SHA eda32ed

github-actions · 2025-09-15T22:15:12Z

Newest code from mattermost has been published to preview environment for Git SHA d9e06e0

github-actions · 2025-09-16T22:48:01Z

Newest code from mattermost has been published to preview environment for Git SHA b22ab27

github-actions · 2025-09-18T22:22:15Z

Newest code from mattermost has been published to preview environment for Git SHA 5e296cc

github-actions · 2025-09-18T22:22:52Z

Newest code from mattermost has been published to preview environment for Git SHA d8769ce

esethna · 2025-09-18T22:29:36Z

@cwarnermm @coltoneshaw @sadohert this doc is ready for review based on the latest working session. Thank you!

sadohert · 2025-09-19T14:09:14Z

source/deployment-guide/server/air-gapped-deployment.rst

+-----------------

-      b. Run the registry with TLS:
+On an internet connect machine, you must gather all required packages, container images, and dependencies needed for the installation process. The resources you'll need will depend on your deployment method, specifically:


"internet connected"

cwarnermm · 2025-09-19T15:58:43Z

@esethna - I've pushed a commit fixing build errors and warnings.

github-actions · 2025-09-19T16:01:24Z

Newest code from mattermost has been published to preview environment for Git SHA 337f483

github-actions · 2025-09-19T16:01:30Z

Newest code from mattermost has been published to preview environment for Git SHA 6c87ee9

esethna · 2025-09-19T18:24:23Z

Thanks! @coltoneshaw and @sadohert any more feedback before we merge these changes?

github-actions · 2025-09-22T19:15:50Z

Newest code from mattermost has been published to preview environment for Git SHA fe89fc3

esethna · 2025-09-24T18:52:58Z

@coltoneshaw @sadohert friendly ping on reviewing this if you have any additional feedback before we merge please :)

github-actions · 2025-09-24T20:25:00Z

Newest code from mattermost has been published to preview environment for Git SHA 037c11a

sadohert

Feedback in the comments

source/deployment-guide/server/air-gapped-deployment.rst

sadohert · 2025-09-26T13:14:44Z

source/deployment-guide/server/air-gapped-deployment.rst


-   For a simpler approach:
+         cat > /etc/apt/sources.list << EOF
+         deb http://mirror.example.com/debian bullseye main contrib non-free


Who has validated these steps? I haven't tried them myself. I feel like there's some missing info between step 5 and step 7... do we "Publish a snapshot", then push that snapshot over to the air-gapped environment, and then run aptly serve on that side pointing it at the snapshot?

I'm second guessing even putting any of the "Private Registry/Private Mirror" docs in here. The K8s and Docker steps don't look wrong, but they seem to be missing some steps (like "Make sure these specific packages/images are downloaded and pushed to the mirror", and "Copy XYZ files over to the air-gapped environment"). I feel like they need to be complete, end-to-end, or don't put them in, and direct people to a better online resource.

@esethna - Any further actions needed here?

@sadohert we're going to go ahead and merge this given the steps in the doc PR are no different than what we have in the current version of this doc - the PR just organizes by deployment method and has them moved to the FAQ, rather than being the primary focus of the doc.

If we feel strongly about removing them entirely or making them more clear I'm happy to work with you on that in a follow-up PR

coltoneshaw

other than the comments, looks good. nice work.

source/deployment-guide/server/air-gapped-deployment.rst

github-actions · 2025-09-26T21:42:16Z

Newest code from mattermost has been published to preview environment for Git SHA 20e43d2

github-actions · 2025-09-29T17:22:57Z

Newest code from mattermost has been published to preview environment for Git SHA 3a21669

github-actions · 2025-09-29T17:34:39Z

Newest code from mattermost has been published to preview environment for Git SHA aa68c76

Update air-gapped-deployment.rst

8bfdc11

Update air-gapped-deployment.rst

2bd8de9

Editorial review

09438c2

sadohert reviewed Sep 15, 2025

View reviewed changes

Update air-gapped-deployment.rst

3e1dfdd

Update air-gapped-deployment.rst

e8e92c3

Add private registry/mirror FAQ

Update air-gapped-deployment.rst

a020230

Update air-gapped-deployment.rst

b19eb48

esethna added 2 commits September 15, 2025 14:55

Update air-gapped-deployment.rst

eaac3a6

Update air-gapped-deployment.rst

7f80a39

Update air-gapped-deployment.rst

0207645

esethna added 2 commits September 15, 2025 15:11

Update air-gapped-deployment.rst

eda32ed

Update air-gapped-deployment.rst

d9e06e0

Update air-gapped-deployment.rst

b22ab27

Update air-gapped-deployment.rst

4c7bfc4

cwarnermm added the Guidance label Sep 19, 2025

sadohert reviewed Sep 19, 2025

View reviewed changes

cwarnermm added 2 commits September 19, 2025 11:58

Fixed build warnings & errors

337f483

Merge branch 'master' into esethna-air-gapped

6c87ee9

cwarnermm approved these changes Sep 19, 2025

View reviewed changes

Merge branch 'master' into esethna-air-gapped

fe89fc3

Merge branch 'master' into esethna-air-gapped

037c11a

sadohert reviewed Sep 26, 2025

View reviewed changes

coltoneshaw requested changes Sep 26, 2025

View reviewed changes

source/deployment-guide/server/air-gapped-deployment.rst Show resolved Hide resolved

source/deployment-guide/server/air-gapped-deployment.rst Outdated Show resolved Hide resolved

source/deployment-guide/server/air-gapped-deployment.rst Show resolved Hide resolved

Update air-gapped-deployment.rst

20e43d2

mattermost deleted a comment from coltoneshaw Sep 26, 2025

Merge branch 'master' into esethna-air-gapped

3a21669

Update air-gapped-deployment.rst

aa68c76

coltoneshaw approved these changes Sep 29, 2025

View reviewed changes

cwarnermm added the 3: Reviews Complete All reviewers have approved the pull request label Sep 30, 2025

esethna merged commit af1bd04 into master Sep 30, 2025
9 checks passed

esethna deleted the esethna-air-gapped branch September 30, 2025 17:21

Update air-gapped-deployment.rst #8363

Update air-gapped-deployment.rst #8363

Conversation

esethna commented Sep 9, 2025

Uh oh!

esethna commented Sep 9, 2025

Uh oh!

github-actions bot commented Sep 9, 2025

Uh oh!

github-actions bot commented Sep 9, 2025

Uh oh!

cwarnermm commented Sep 9, 2025

Uh oh!

github-actions bot commented Sep 9, 2025

Uh oh!

sadohert left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Sep 15, 2025

Uh oh!

github-actions bot commented Sep 15, 2025

Uh oh!

github-actions bot commented Sep 15, 2025

Uh oh!

github-actions bot commented Sep 15, 2025

Uh oh!

github-actions bot commented Sep 15, 2025

Uh oh!

github-actions bot commented Sep 15, 2025

Uh oh!

github-actions bot commented Sep 15, 2025

Uh oh!

github-actions bot commented Sep 15, 2025

Uh oh!

github-actions bot commented Sep 15, 2025

Uh oh!

github-actions bot commented Sep 16, 2025

Uh oh!

github-actions bot commented Sep 18, 2025

Uh oh!

github-actions bot commented Sep 18, 2025

Uh oh!

esethna commented Sep 18, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cwarnermm commented Sep 19, 2025

Uh oh!

github-actions bot commented Sep 19, 2025

Uh oh!

github-actions bot commented Sep 19, 2025

Uh oh!

esethna commented Sep 19, 2025

Uh oh!

github-actions bot commented Sep 22, 2025

Uh oh!

esethna commented Sep 24, 2025

Uh oh!

github-actions bot commented Sep 24, 2025

Uh oh!

sadohert left a comment

Choose a reason for hiding this comment