Deployment documentation updates #7731
Conversation
|
Newest code from mattermost has been published to preview environment for Git SHA 7e0a17e |
|
Newest code from mattermost has been published to preview environment for Git SHA 39bb3de |
|
This is a great docs PR, @nickmisasi! I pulled your branch down and applied fixes to build errors and warnings where needed. Remind me: what's the goal of this docs update? What are we trying to achieve? That will help me formulate potential next step recommendations. |
|
Newest code from mattermost has been published to preview environment for Git SHA a77022b |
|
@cwarnermm High level, this is intended to make it easier to deploy Mattermost. The main focus was on clarity, as well as making sure that our recommendations are not only correct, but actually work (without prior knowledge of deploying Mattermost itself) |
|
@nickmisasi - Thank you! From my perspective, the content of this docs PR is excellent. No concerns at all. I know our structure and navigation needs work, but that's beyond the scope of this lift. Does it make sense to add customer-facing stakeholders as additional technical reviewers at this time? Are there specific perspectives you're looking for prior to us publishing these details? |
|
@nickmisasi - One outstanding thing we'll need to address in this docs PR is H2 redirects. This is something we'll do last, once all stakeholder input is incorporated. I can help with this final step. |
|
@cwarnermm I think it's a good idea to get some stakeholders to view this. Particularly I'd like eyes from @mrckndt, as he has some past work on Docker docs and is probably most familiar with RHEL. I'm open to others if you have anyone in mind. I'll also loop in @toninis as we discussed the Docker docs updates in Hub. |
|
Newest code from mattermost has been published to preview environment for Git SHA e669e4e |
|
Newest code from mattermost has been published to preview environment for Git SHA e6b0c1c |
|
Newest code from mattermost has been published to preview environment for Git SHA 9d7c374 |
|
Adding @gabrieljackson as I've pushed an overhaul to the Kubernetes documentation |
|
Newest code from mattermost has been published to preview environment for Git SHA 40823d2 |
|
Newest code from mattermost has been published to preview environment for Git SHA ddff5a0 |
|
Newest code from mattermost has been published to preview environment for Git SHA 31e3535 |
|
|
||
| Install Mattermost on Kubernetes | ||
| -------------------------------- | ||
| However, managing these components yourself adds complexity and is generally not recommended for production deployments unless you have specific operational requirements. This guide will primarily focus on the recommended approach of using S3-compatible storage and a managed database service. If you choose to use self-managed components, you will need to adapt the instructions accordingly. |
There was a problem hiding this comment.
I like how we are more opinionated of how to install and run Mattermost via the operator, but I think it would be good to walk back some of this wording a bit. In particular generally not recommended for production deployments should probably be clarified so our customers that want to own all of their data know they are using a supported setup.
|
Newest code from mattermost has been published to preview environment for Git SHA 240257a |
|
Newest code from mattermost has been published to preview environment for Git SHA 98198ef |
|
@cwarnermm I think I've addressed everything here. Let me know if there's anything else you need from me! |
|
Newest code from mattermost has been published to preview environment for Git SHA 8a5cb6d |
|
Newest code from mattermost has been published to preview environment for Git SHA 0e493ef |
| @@ -4,48 +4,40 @@ Deploy Mattermost via Docker | |||
| .. include:: ../_static/badges/allplans-selfhosted.rst | |||
| :start-after: :nosearch: | |||
|
|
|||
| .. important:: | |||
| This deployment method is not recommended for production environments. If you're looking to deploy a production Mattermost instance, we recommend using managed container services like AWS ECS, Azure Container Apps, or Google Cloud Run. These services provide better scalability, reliability, and maintenance features suited for production workloads. | |||
There was a problem hiding this comment.
I wonder if this would be better to suggest past a specific size. I can't see why a smaller organization shouldn't run Mattermost via Docker.
There was a problem hiding this comment.
@spirosoik - Can we get a bit more specific about threshold guidance here? See Colton's suggestions below.
|
Newest code from mattermost has been published to preview environment for Git SHA 9752302 |
|
Newest code from mattermost has been published to preview environment for Git SHA e6a787d |
|
/update-branch |
|
Error trying to update the PR. |
Summary
I took a pass of each of the main installation methods, and performed a dry run on a new EC2 instance for each. I have made some documentation updates. For most of these updates, it's primarily for clarity. I also made some adjustments to split out some things that are repeatedly written between the various deployment methods to be more DRY.
The most major change was the overhaul of the Docker deployment. The current docs "for production use" have the reader deploy Mattermost and its database on the same instance. This isn't the best advice in production. I've split the documentation into 2 paths here - Quick Start (essentially the existing docs), and Production Use (adjustments to only deploy the Mattermost application container, suggesting external hosting for db and storage). These changes require
Ticket Link
https://mattermost.atlassian.net/browse/CLD-8785
https://mattermost.atlassian.net/browse/CLD-8848
https://mattermost.atlassian.net/browse/CLD-8849
https://mattermost.atlassian.net/browse/CLD-8850
https://mattermost.atlassian.net/browse/CLD-8851
https://mattermost.atlassian.net/browse/CLD-8852
https://mattermost.atlassian.net/browse/CLD-8853