Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
d1bef90
Updated the Secret store documents
katarzyna-koltun-mx Nov 19, 2026
f96398a
Update pmp-quickstart.md
katarzyna-koltun-mx Nov 19, 2026
0c49a3c
vale
katarzyna-koltun-mx Nov 19, 2026
60a4020
Merge branch 'kk-pmp-quickstart' of https://github.com/mendix/docs in…
katarzyna-koltun-mx Nov 19, 2026
2ea9dde
vale
katarzyna-koltun-mx Nov 19, 2026
1be87d5
Update content/en/docs/private-platform/quickstart/pmp-quickstart-hel…
katarzyna-koltun-mx Nov 20, 2026
0aab314
Update content/en/docs/private-platform/quickstart/pmp-quickstart-hel…
katarzyna-koltun-mx Nov 20, 2026
a9fd04c
Update content/en/docs/private-platform/quickstart/pmp-quickstart-hel…
katarzyna-koltun-mx Nov 20, 2026
8065469
Update content/en/docs/private-platform/quickstart/pmp-quickstart.md
katarzyna-koltun-mx Nov 20, 2026
f9e56dd
Update content/en/docs/private-platform/quickstart/pmp-quickstart-hel…
katarzyna-koltun-mx Nov 20, 2026
c1e40c3
Update content/en/docs/private-platform/quickstart/pmp-quickstart-hel…
katarzyna-koltun-mx Nov 20, 2026
58b8471
sme review
katarzyna-koltun-mx Nov 20, 2026
58af00d
Merge branch 'kk-pmp-quickstart' of https://github.com/mendix/docs in…
katarzyna-koltun-mx Nov 20, 2026
c9f5c06
sme review
katarzyna-koltun-mx Nov 20, 2026
28134d0
sme review
katarzyna-koltun-mx Nov 20, 2026
dbf4dfe
SME review
katarzyna-koltun-mx Nov 20, 2026
14da58c
Update _index.md
katarzyna-koltun-mx Nov 20, 2026
2e21c22
added note about Mac installs
katarzyna-koltun-mx Nov 20, 2026
0117515
Merge branch 'kk-pmp-quickstart' of https://github.com/mendix/docs in…
katarzyna-koltun-mx Nov 20, 2026
f264c67
Update pmp-quickstart.md
katarzyna-koltun-mx Nov 20, 2026
493d163
Merge branch 'development' into kk-pmp-quickstart
katarzyna-koltun-mx Nov 20, 2026
b80c7a7
Update content/en/docs/private-platform/quickstart/pmp-quickstart.md
katarzyna-koltun-mx Nov 20, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ The settings in this section configure the storage for build output artifacts.
azure.workload.identity/client-id: {client-id-pmp}
```

This step is not required if Private Mendix Platform is using a Managed Identity from Azure Managed Identity-based storage plans. In that case, the ServiceAccount already has the correct annotation.
This step is not required when a storage plan already annotates the ServiceAccount, or when you install the platform app from the secret store with `azureWorkloadIdentity.enable` set to `true`. The chart then writes the client id annotation itself. See [Using a Secret Store for the Platform App](/private-mendix-platform/helmfile-installation/#disable-provisioners).

4. Add the following role assignments to the PMP-MI:

Expand All @@ -247,7 +247,7 @@ The settings in this section configure the storage for build output artifacts.
azure.workload.identity/use: "true"
```

This step is not required if Private Mendix Platform is using a MI from Azure Managed Identity-based storage plans. In that case, the customPodLabel is already configured.
This step is not required when a storage plan already sets the label, or when `azureWorkloadIdentity.enable` or `secretProviderclass.azureparameters.useManagedIdentityForBlob` is `true`. The chart then sets `azure.workload.identity/use: "true"` on the platform pod.

6. Restart Private Mendix Platform to ensure that the labels are applied.

Expand Down
5 changes: 4 additions & 1 deletion content/en/docs/private-platform/quickstart/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ aliases:

This document provides a comprehensive guide for installing Private Mendix Platform, along with its optional components, in your own Kubernetes environment.

Private Mendix Platform supports using secret storage. If required, you can store some configuration in a secret vault (for example, AWS, Azure, or Hashicorp) without setting up a storage plan, database plan, PCLM admin and Mendix admin info in the Private Mendix Platform installer.
Private Mendix Platform can use an external secret store (for example, AWS Secrets Manager, Azure Key Vault, or HashiCorp Vault). This is the setup described in [Retrieve Environment-Sensitive Data from a Secret Store](/developerportal/deploy/secret-store-credentials/). The secret store can be used together with a database plan or a storage plan. The Mendix Operator still provisions a resource that has a plan. When you leave the plan unset, you create the database, the file storage, the identity, and the role assignments yourself, before installation. That is the default once the secret store is enabled. For the steps, see [Using a Secret Store for the Platform App](/private-mendix-platform/helmfile-installation/#disable-provisioners) and [What the Secret Store Does Not Provision](/private-mendix-platform/interactive-installation/#secret-store-no-provisioner).

{{% alert color="info" %}}
Using a secret storage incorrectly may reduce the security of your app. Consult your secrets store provider to ensure that it is set up securely for your production environment.
Expand Down Expand Up @@ -79,6 +79,9 @@ Before starting the installation process, make sure that you have all the necess
* A command line terminal that supports the console API and mouse interactions. In Windows, this can be PowerShell or the Windows Command Prompt.
* For OpenShift clusters, OpenShift CLI. For more information, see [Getting started with the CLI](https://docs.openshift.com/container-platform/4.1/cli_reference/getting-started-cli.html).
* Kubectl installed if you are deploying to another Kubernetes platform. For more information, see [Install and Set Up kubectl](https://kubernetes.io/docs/tasks/tools/).
* On a Mac with Apple silicon, Rosetta must be installed before you run the Mac installer binary. The Mac installer is built for Intel processors. Rosetta may already be installed. If it is missing, open Terminal and run `softwareupdate --install-rosetta --agree-to-license`. If Rosetta is already installed, the command reports that.

In case of an upgrade, macOS 27.0 and 27.1 do not restore an existing Rosetta installation. From macOS 27.2, the upgrade no longer removes Rosetta, but it does not put Rosetta back if an earlier upgrade already removed it. This applies only to the Mac installer binary, not to a Helmfile-only installation.

* Optionally, if you plan to install the Svix component:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,8 @@ To download a release from the table, perform the following steps:
3. Click **Download**.
4. Select your platform (Mac, Windows, or Linux).

On a Mac with Apple Silicon, make sure that Rosetta is installed before you run the installer binary. For more information, see [Quick Start Guide: Prerequisites](/private-mendix-platform/quickstart/).

The installer file downloads to your default download location.

{{< figure src="/attachments/private-platform/pmp-downloadportal1.png" class="no-border" >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ For images downloaded from the Private Mendix Platform Download Portal or with t
* For version 2.8.1 and newer, go to **Artifacts Management**, select the version from the **Private Mendix Platform Version** dropdown, and select **Chart** as the **Artifact Type**. Select the charts and click **Export Selection**.
* For version 2.8.0 and older, go to **Releases**, click the three-dot menu (**•••**) for the desired release, and then click **View addons**. Find the *Addons/pmp-charts-x.x.x.zip* file, where `x.x.x` is the version number, and click **Download**.

3. Unzip the release binary to a local folder on your Windows or Linux server. The release binary contains the following files:
3. Unzip the release binary to a local folder on your server. The release binary contains the following files:

* In the *Tools* folder:

Expand All @@ -49,7 +49,8 @@ For images downloaded from the Private Mendix Platform Download Portal or with t
* **mxpc-cli** - Installation tools which can be used to manage or configure the Mendix Operator
* **charts** - Charts, including Private Mendix Platform charts and Svix charts

4. If your clusters can connect to a public registry with a passable network, skip to step 4 below, otherwise initialize the installation by performing the following steps:
4. On a Mac with Apple Silicon, make sure that Rosetta is installed before you run the installer binary. For more information, see [Quick Start Guide: Prerequisites](/private-mendix-platform/quickstart/).
5. If your clusters can connect to a public registry with a passable network, skip to step 6 below, otherwise initialize the installation by performing the following steps:

1. Upload the images to your private repository in an air-gapped environment:

Expand Down Expand Up @@ -88,21 +89,21 @@ For images downloaded from the Private Mendix Platform Download Portal or with t
privatecloud-license-manager_0.3.0 => [REDACTED] privatecloud-license-manager:0.3.0 - ok
```

5. Migrate the files required to install the Private Cloud components by performing the following steps:
6. Migrate the files required to install the Private Cloud components by performing the following steps:

1. Download the *mx-private-cloud.zip* file from your Private Mendix Platform download portal.
2. Unzip the *mx-private-cloud.zip* file.
3. Copy the *images* from the *mx-private-cloud* directory to the *images* sub-directory of the installer by running the following command: `cp -r mx-private-cloud/images/* <your installer>/pmp-binary-linux/images`
4. Upload the directory to your private registry by using the `installer init migrate` command. All the images must be in the same registry.

6. Migrate the files required to enable Maia for Private Mendix Platform by performing the following steps:
7. Migrate the files required to enable Maia for Private Mendix Platform by performing the following steps:

1. Download the *maia-appgen-pmp.zip* file from your Private Mendix Platform download portal.
2. Unzip the *maia-appgen-pmp.zip* file.
3. Copy the *maia-appgen-pmp* directory to the *images* sub-directory of the installer by running the following command: `cp -r maia-appgen-pmp/images/* <your installer>/pmp-binary-linux/images`
4. Upload the Maia directory to your private registry by using the `installer init migrate` command.

7. After the migration is completed, [install Private Mendix Platform in interactive GUI mode](/private-mendix-platform/interactive-installation/).
8. After the migration is completed, [install Private Mendix Platform in interactive GUI mode](/private-mendix-platform/interactive-installation/).

### Images from the Public Mendix Registry

Expand Down
Loading