Install Private Mendix Platform 2.8.0 for Air-Gapped Environments

Last modified: September 25, 2026

Introduction

This document describes how you can migrate artifacts (images and charts), in order to perform an air-gapped installation using one of the following methods:

Image Migration for Private Mendix Platform

The 2.8.0 release of Private Mendix Platform requires some manual steps to migrate images from various sources to the customer's air-gapped container registry:

  • Some platform component images are provided as tarballs in one of the following ways:

  • Some Platform components and Mendix images are provided through the Mendix public image registry

Either set uses a different tool to migrate. For more information, refer to the following sections.

Images in a Zip File

For images downloaded from the Private Mendix Platform Download Portal or with the installer file, perform the following steps.

  1. Log in to your Private Mendix Platform Download Portal. If you do not have access to the Download Portal, contact your Mendix partner for information.

  2. Download the release binary from by performing the following steps, depending on your Private Mendix Platform version:

    • 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:

  • In the Tools folder:

    • mx-pclm-cli, which can be used to manage PCLM
    • helm and helmfile tools, which are used to deploy and manage Private Mendix Platform charts and Svix charts
    • images - Private Mendix Platform image, PCLM image, Svix image, test application image

  • In the Installer folder:

    • 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

  1. 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:

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

      ~/mpp-binary-linux$ ./installer init  migrate --help
Migrate Mendix Private Platform related image to your own registry

Usage:
installer init migrate [flags]
Flags:
    -h, --help                 help for migrate
    -r, --registryurl string   registry url (required)
    -e, --repo string          Repository name
    -u, --username string      Username (required) for your private registry

      The destination image is named ${registryurl }/${repo}/mendix-private-platform: ${tag}. The registryurl and repo are read from the input parameters. The tag is automatically read by the installer.

    2. If the repository does not exist, you must create it before running the init migrate command:

      ~/mpp-binary-linux$ ./installer init migrate   -r [registry] -u  user -e [repositoryName]
Please enter user password: ******************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************

Confirm password: ******************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************************
the config checksum is empty
The image destination[REDACTED] svix-server:v0.75.0
The image destiation [REDACTED] mendix-private-platform:1.4.0.80d447b1
the config checksum is empty
The image destiation [REDACTED] mxpc-test:1.0
the config checksum is empty
The image destiation [REDACTED] privatecloud-license-manager:0.3.0
svix-server_v0.75.0 => [REDACTED] svix-server:v0.75.0 - ok
mendix-private-platform_1.4.0.80d447b1 => [REDACTED] mendix-private-platform:1.4.0.80d447b1 - ok
mxpc-test_1.0 => [REDACTED] mxpc-test:1.0 - ok
privatecloud-license-manager_0.3.0 => [REDACTED] privatecloud-license-manager:0.3.0 - ok

  2. 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.

  3. 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.

  4. After the migration is completed, install Private Mendix Platform in interactive GUI mode.

Images from the Public Mendix Registry

For SVIX, the Mendix Operator and its subcomponents (for example, sidecars, storage provisioners, image builder), as well as Mendix runtime base images and app building blocks for supported Mendix versions, you have the option to use an AIP tool to download and migrate to a local registry. You can use the oras cp command instead, if your registry allows it.

Accessing Mendix Container Images

To install Private Mendix Platform in an air-gapped environment, you must provision a list of images in your registry.

  1. Download an aip tool for your operating system.

    Mendix has created aip tools for different operating systems. Download them from the following links:

  2. Export the image list.

    1. In the https://privateplatform.mendix.com/, go to Artifact Management and select a Private Mendix Platform version.
    2. Filter by Category and ArtifactType to select the images, charts, and Helm file.
    3. Click Export Selection to export the list to a file named export-images-vx.x.x.json, where x.x.x corresponds to a Private Mendix Platform version.

  3. In the Mendix Portal, create a Personal Access Token (PAT) for private images that require a PAT for authentication.

    1. Sign in to Mendix and go to User Settings > Developer Settings > Personal Access Token
    2. Click New Token.
    3. Under OCI registry, select the mx:registry:access as scope.

  4. Fetch the images by using the following aip commands:

    mkdir pmp-images
cd pmp-images

# Initialize aip with the exported image list
aip init ~/Downloads/export-images-v2.7.0.json

# Log in to the Mendix registry
aip login -u pat -p <your-pat> registry.mendix.com

# Download all images from source registry to local folder.
aip pull

# Configure the destination registry
aip set-base-destination <myprivate.registry.com>

# Log in to the new registry
aip login -u <user> -p <password> <myprivate.registry.com>

# Upload all the images to new registry.
aip push

  5. If your registry requires you to create a repository before pushing, use the following command:

    # get list of required repositories - these will need to be created before you can push to them
jq -r '.["images", "charts", "custom-artifacts"][] .destination' state.json

  6. After the migration is completed, install Private Mendix Platform with Helmfile.

Download Package API

The following Download Portal APIs enable automating package downloads through manifest files.

Get Private Mendix Platform Release Version List

GET https://privateplatform.mendix.com/rest/pmpreleaseservice/v1/versions

Get the Manifest of a Specific Private Mendix Platform Version

GET https://privateplatform.mendix.com/rest/pmpreleaseservice/v1/versions/{version}/manifest