diff --git a/source/deployment-guide/cloud-providers/azure/mattermost-vm-image-offer.rst b/source/deployment-guide/cloud-providers/azure/mattermost-vm-image-offer.rst new file mode 100644 index 00000000000..3e856815fbe --- /dev/null +++ b/source/deployment-guide/cloud-providers/azure/mattermost-vm-image-offer.rst @@ -0,0 +1,27 @@ +:orphan: +:nosearch: + +This Azure Marketplace VM image deploys a Mattermost-ready Linux virtual machine in your own subscription. + +What the image includes +~~~~~~~~~~~~~~~~~~~~~~~~ + +This uses a Linux base image from Canonical Ubuntu Pro 24.04 LTS. + +- Mattermost Enterprise Edition +- Common operational dependencies + + - ``jq``: for JSON processing (Mattermost configuration is stored in JSON files) + - ``nfs-common``: NFS client utilities, for mounting Azure Files when you use the NFS protocol + +- High-availability–oriented OS tuning (file descriptor limits and kernel parameters). See :doc:`high-availability-cluster-based-deployment ` for further details. + + - ``/etc/security/limits.conf``: raises open-file limits for the Mattermost process + - ``/etc/sysctl.conf``: kernel tuning (e.g. increases the maximum number of WebSocket connections). + +What you need to provide +~~~~~~~~~~~~~~~~~~~~~~~~~ + +You still provide and operate the surrounding Azure layers: Network / Proxy, Mattermost Application (will use this VM image), Database, and File Storage. + +Please check :doc:`server architecture ` for further details. diff --git a/source/deployment-guide/cloud-providers/azure/quick-start-evaluation.rst b/source/deployment-guide/cloud-providers/azure/quick-start-evaluation.rst new file mode 100644 index 00000000000..a23bf8720d4 --- /dev/null +++ b/source/deployment-guide/cloud-providers/azure/quick-start-evaluation.rst @@ -0,0 +1,79 @@ + +:orphan: +:nosearch: + +Mattermost is published as an **Azure Marketplace** solution that deploys a single Ubuntu virtual machine with Mattermost, PostgreSQL, network configurations, and the necessary Azure resources. This quick start evaluation option is preferred for customers already using Azure, as it integrates seamlessly within their existing infrastructure. + +Prerequisites +------------- + +* An active **Azure subscription** with permission to create resources and accept **Azure Marketplace** billing terms for the offer. +* Familiarity with the **Azure portal** (resource groups, networking, and virtual machines). + +What gets deployed +------------------ + +The template provisions a small, self-contained stack in the resource group you select, including: + +1. **Virtual machine (Linux):** Runs Mattermost, PostgreSQL, and the reverse proxy. +2. **Public IP address:** Allows access to the Mattermost workspace over the public internet, enabling users to connect to the platform securely. +3. **Network interface:** Facilitates communication between the Virtual Machine and other Azure resources through a defined network layer. +4. **Network security group:** Acts as a virtual firewall, controlling inbound and outbound traffic to protect the deployed resources from unauthorized access. +5. **Managed OS disk:** Provides persistent storage mounted to the Virtual Machine for storing files generated by Mattermost, including uploaded documents and system configurations. +6. **Virtual network:** An isolated network environment for the deployed resources, enabling private and controlled connectivity between infrastructure components. This can be a newly created or existing environment depending on your selection in the portal. + + +Step 1: Select a plan and start creation +---------------------------------------- + +Go to the `Mattermost - Quick Start Evaluation (VM) `_ Azure Marketplace application to begin. Click **Get it now**, then select the **Mattermost - Quick Start Evaluation (VM)** plan, and click **Create** to open the deployment wizard. + + +Step 2: Basic Configuration +--------------------------- + +On the **Basics** tab, configure the following: + +1. **Subscription:** Choose the Azure subscription where the deployment will live. +2. **Resource group:** Either select an existing resource group or create a new one. Using a **new** resource group keeps evaluation resources easy to find. +3. **Region:** Select the deployment region for your Virtual Machine (for example, **East US** or **West Europe**). +4. **Virtual Machine name:** Provide a unique name for your Virtual Machine. +5. **Username:** Linux administrator account on the VM. +6. **Email:** Used for Let's Encrypt registration when the instance requests a TLS certificate. Use a mailbox you can access since you may receive operational emails from the certificate authority. +7. **Support email:** Contact email for end users to reach the instance administrator for troubleshooting. +8. **Authentication type:** **Password** or **SSH public key** only for Linux sign-in to the VM. Password is often simpler for a quick trial; SSH key is appropriate if your organization requires key-based Linux access. + +Step 3: Virtual Machine Settings and Network Configuration +---------------------------------------------------------- + +On **Virtual Machine Settings** tab, configure the following: + +1. **Virtual machine size:** For trials, we recommend **Standard_F2s_v2** size but you can choose any other size available in your region. +2. **Public IP address:** Typically **create new**. You must set a **DNS prefix** (label) that is **globally unique** in Azure; it forms part of your URL. This DNS will allow public access to your workspace. It is important that you do not already have a matching DNS name within your Azure subscription, or your deployment may fail later in the process. +3. **Virtual network:** **Create new** with the suggested address space, or attach an existing VNet and subnet that meet the constraints. Using a new virtual network avoids collisions with overlapping address spaces in the same subscription. + +The portal may show a preview of your URL in the form ``https://..cloudapp.azure.com``. That is the address you will use once TLS and Mattermost are ready. + +Step 4: Review and create +------------------------- + +Review settings, accept any **Marketplace** terms if prompted, then select **Create**. Provisioning usually takes a few minutes, and the first-boot configuration may take more time before HTTPS works reliably. + +**After deployment completes:** + +* In the Azure portal, open the **resource group** you used. +* Open the **Public IP address** resource (often named ``-ip`` unless you changed it). +* Under **Essentials**, note the **DNS name**. Your site URL is: + +``https://..cloudapp.azure.com`` + +Example: ``https://myorg.eastus.cloudapp.azure.com`` + +Use **https**; the deployment is intended to serve Mattermost over TLS. + +Step 5: Open Mattermost and create your administrator +----------------------------------------------------- + +In a browser, go to your **HTTPS** URL. Mattermost will prompt you to **create the first user**, which becomes the **System Administrator**. That account is different from the **Linux** username and password (or SSH key) you configured in Step 3. + +Congratulations! You’ve successfully deployed Mattermost for evaluation. \ No newline at end of file diff --git a/source/deployment-guide/cloud-providers/cloud-providers-index.rst b/source/deployment-guide/cloud-providers/cloud-providers-index.rst new file mode 100644 index 00000000000..746884a017c --- /dev/null +++ b/source/deployment-guide/cloud-providers/cloud-providers-index.rst @@ -0,0 +1,15 @@ +Cloud Providers +=============== + +This section provides instructions for deploying Mattermost on various cloud providers. + +.. toctree:: + :maxdepth: 1 + :titlesonly: + :hidden: + + Quick Start Evaluation + Mattermost VM Image + +* :doc:`Quick Start Evaluation ` - Quickly evaluate Mattermost. +* :doc:`Mattermost VM Image ` - Deploy Mattermost using a Mattermost VM Image on your own infrastructure. diff --git a/source/deployment-guide/cloud-providers/mattermost-vm-image-offer.rst b/source/deployment-guide/cloud-providers/mattermost-vm-image-offer.rst new file mode 100644 index 00000000000..1052dc2b3ac --- /dev/null +++ b/source/deployment-guide/cloud-providers/mattermost-vm-image-offer.rst @@ -0,0 +1,12 @@ +Mattermost VM Image +=================== + +Use Mattermost Enterprise Edition VM image on your own cloud infrastructure. + +This guide provides instructions for deploying a Mattermost-ready Linux VM in your cloud environment with Mattermost Enterprise Edition pre-installed and HA-oriented OS settings, leaving startup and configuration to your deployment process. + +.. tab:: Azure Marketplace + :parse-titles: + + .. include:: azure/mattermost-vm-image-offer.rst + :start-after: :nosearch: diff --git a/source/deployment-guide/cloud-providers/quick-start-evaluation.rst b/source/deployment-guide/cloud-providers/quick-start-evaluation.rst new file mode 100644 index 00000000000..313e72ed4a7 --- /dev/null +++ b/source/deployment-guide/cloud-providers/quick-start-evaluation.rst @@ -0,0 +1,10 @@ +Quick Start Evaluation +====================== + +This guide provides instructions for quickly trying out Mattermost in multiple cloud providers. + +.. tab:: Azure Marketplace + :parse-titles: + + .. include:: azure/quick-start-evaluation.rst + :start-after: :nosearch: diff --git a/source/deployment-guide/deployment-guide-index.rst b/source/deployment-guide/deployment-guide-index.rst index 17c63200316..1eaa6e6c33a 100644 --- a/source/deployment-guide/deployment-guide-index.rst +++ b/source/deployment-guide/deployment-guide-index.rst @@ -13,6 +13,7 @@ Whether you're deploying the server application, desktop application, or mobile Quick Start Evaluation Reference Architecture Server Deployment + Cloud Providers Desktop App Deployment Mobile App Deployment Deployment Troubleshooting