Install Private Mendix Platform in GUI Mode

Introduction

In interactive mode, you manually install Private Mendix Platform components. If you would like to perform an automatic installation instead, see Install Private Mendix Platform with Helmfile.

Preparing the Installation Files

Before you start the installation, download the required files by performing the following steps:

1. Download the release binary from your Private Mendix Platform download portal. If you do not have access to the download portal, contact your Mendix partner for information.

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

   • Tools - 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
   • Installer - installer tools
   • 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

   

Optional: Initializing the Installation for Air-Gapped Environments

If your clusters can connect to a public registry with a passable network, skip to the next section, 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}.

2. The registryurl and repo are read from the input parameters. The tag is automatically read by the installer. 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

3. By default, mxpc-cli tools install the latest version of Mendix Operator. You can specify a different Mendix Operator version by using the following command: ./installer operator init -v="version number"

Installing the Mendix Operator

Install the Mendix Operator by doing the following steps:

1. Run one of the following commands, where -n indicates the namespace:

   • ./mxpc-cli installer -n=<namespace name> - To install the Operator in Standard mode
   • ./mxpc-cli installer --global -n=<namespace name> - To install the Operator in Global mode; you must use a Global namespace for this installation type.

   In order to install and configure a cluster with a Global installation of the Operator and the Agent, you must use Operator version 2.21.2 or above.

2. Click Base Installation, and then select the cluster type.

   

3. Click Run Installer to install the Mendix Operator in your cluster.

Configuring the Namespace

Configure the namespace by doing the following steps:

1. Click Configure Namespace.
2. Optional: If you want to run the Operator in Global mode, click Global Operator.

You must use a different namespace here than the Global namespace that you selected in step 4 above. Ensure that you do not use a namespace that is intended to be a managed namespace, that is, a namespace where you plan to deploy a Mendix app. The Global Operator namespace must be separate from managed namespaces, otherwise you may encounter unexpected results.

3. Optional: If you are not using the AWS Secret Manager, click Database Plan and fill out the required information.

   

4. Optional: If you are not using the AWS Secret Manager, click Storage Plan and fill out the required information.

5. Click Ingress and fill out the required information.

   

6. Click Registry and fill out the required information.

7. Click Review and Apply > Evaluate Configuration.

8. Make any required changes or click Apply Configuration.

   

9. Click Exit Installer > OK.

   

Optional: Configuring the AWS Secret Manager

To use the secret provider option for your database plan or storage plan, configure the following keys in your AWS Secret Manager:

Database Plan Keys

Storage Plan Keys

Administrator Passwords

Optional: Configuring Azure Key Vault

To use the secret provider option for your database plan or storage plan, configure the following keys in your Azure Key Vault. All keys are required unless noted otherwise.

Database Plan Keys

Storage Plan Keys

Administrator Passwords

Installing Private Cloud License Manager

Private Cloud License Manager is a required component of Private Mendix Platform. Before you install the Platform, install PCLM by doing the following steps:

1. Run the command ./installer component -n=<namespace name>, where -n indicates a namespace. The namespace must be the same as the namespace that you plan to use for Private Mendix Platform.

2. Select PCLM to install PCLM.

3. Specify the following parameters:

   • Databasetype – The database type, either postgres (default) or sqlserver.
   • DB Authentication mode - The authentication mode for the database:
     • static (default)
     • aws-irsa
     • azure-wi
   • Host – The host name of the database service.
   • Port – The port used to access the database. The default value is 5432.
   • Database Name – The name of the database where you want to hold the PCLM data.
   • Database User – A database user with the rights described in the prerequisites section.
   • Database Password – The password for the database user. This setting is available only when DB Authentication mode is set to static.
   • AWS-iam-Role – The AWS IAM role. This setting is available only when DB Authentication mode is set to aws-irsa.
   • Azure-client-id – The Azure client ID. This setting is available only when DB Authentication mode is set to azure-wi.
   • ImageRepo – The location of the image repo, for example, private-cloud.registry.mendix.com/privatecloud-license-manager.
   • Imagetag – The docker image tag, for example, 0.3.0.
   • DB SSL cert file – If your database uses strict TLS, provide the location of the SSL Root certificate file. If not, leave this field blank.
   • Admin Password – A new PCLM admin password. When the PCLM server is set up, it contains an administrator user with a default password. This password should be modified immediately.
   • PCLM Operator User – A new PCLM operator user.
   • PCLM Operator Password – A new PCLM operator password.
   • Global Operator Namespace - If you are using Mendix Operator in Global mode, enter the Global namespace information. If not, leave this field blank.
   • Customized cluster domain - The default is cluster.local. Change the value if you are using a different internal cluster domain.

4. Click Install PCLM.

Uninstalling PCLM

If you want to uninstall PCLM, run the following commands:

kubectl delete deployments/mendix-pclm -n=<Private Mendix Platform namespace>
kubectl delete svc/mx-privatecloud-license-manager -n=<Private Mendix Platform namespace>

Optional: Installing the Svix Component

Svix is required if you want to use webhooks. Install the Svix component by doing the following steps:

1. Optional: If you want to use AWS Secret Manager, configure it by performing the following steps:

   1. Configure the secret in AWS Secret Manager by providing the following information:

      • POSTGRES DSN - The key is svix-db-dsn; an example value may be similar to postgresql://postgres:postgres@pgbouncer/postgres.
      • Redis DSN - This value is only required if you also use Redis for Svix. The key is svix-redis-dsn; an example value may be similar to redis://redis:6379.

   2. Configure an IAM role with the secretsmanager:GetSecretValue and secretsmanager:DescribeSecret permissions and allow it to assume the Service Account which the Svix pod will use to retrieve the secret info.

2. Optional: If you are using a self-signed TLS certificate, build and deploy a private Svix server with custom self-signed TLS certification by performing the following steps:

   1. Prepare the following Docker file to build a private Svix server image:

      # Base build
      FROM svix/svix-server:v1.25.0
      # Add customer certification into system cert trust chain
      COPY ./customer.crt /usr/local/share/ca-certificates/
      USER root
      RUN update-ca-certificates
      # Start svix service
      USER appuser
      CMD \
          set -ex ; \
          if [ ! -z "$WAIT_FOR" ]; then \
              WAIT_FOR_ARG="--wait-for 15"; \
          fi ; \
          exec svix-server --run-migrations $WAIT_FOR_ARG

   2. Build your private Svix server image with the above Docker file and your self-signed TLS certificate file by running the following command:

      docker build -t {customer-private-image-registry-url}/svix/svix-server:v1.25.tls

   3. Push your private Svix server image to your private image registry by running the following command:

      docker push {customer-private-image-registry-url}/svix/svix-server:v1.25.tls

3. Run the command ./installer component -n=<namespace name>, where -n indicates a namespace. The namespace must be the same as the namespace that you plan to use for Private Mendix Platform.

4. Select Svix, and then specify the following parameters:

   • Image Prefix - The registry and namespace (if it exists) where the svix-server image is located

   • Image Name - The image name, for example, svix-server

   • Image Tag - The image tag of the Svix-server image

   • Use Secret Provider - Optional. Select this option to use the AWS Secret Manager or the Azure Key Vault. Selecting this option enables the following additional fields:

     • For AWS Secret Manager:

       • Secret Provider - Set to AWS.
       • AWS-Role-ARN - An AWS role ARN which can access the specified Secret Manager.
       • AWS SecretManager Name - The AWS Secret Manager name where the sensitive data is stored.

     • For Azure Key Vault:

       • Secret Provider - Set to Azure.
       • Client ID - Enter a Client ID assigned to the Azure Managed Identity which enables Private Mendix Platform to access Azure resources.
       • Tenant ID - Enter the Directory ID of the key vault.
       • Key Vault Name - Enter the key vault name.
       • Use identity auth for Blob - Set to True if you use the Azure Blob Storage with managed identity auth; the default value is false.

   • POSTGRES_DSN - Available only if you do not use the AWS Secret Manager. A Postgres DSN, for example, postgresql://postgres:postgres@pgbouncer/postgres.

   • Use Redis - Optional. Select this check box if you want to use Redis for message cache and queues.

   • REDIS_DSN - Available only if you do not use the AWS Secret Manager. The Redis DSN, for example, redis://redis:6379. This field is only available if you select the Use Redis check box.

5. Click Install Svix or Upgrade Svix.

Uninstalling Svix

If you want to uninstall Svix, you must do it manually, by running the following command: helm helm uninstall svix-server -n=<Private Mendix Platform namespace>.

Optional: Installing Private Cloud Components for Connected Mode

Private Mendix Platform now supports installation in Connected mode. To enable this functionality, you must install the relevant Private Cloud components.

Database Prerequisites

To enable connected mode, you must create the database Authenticator and Collector, and install NATS at your cluster.

• For the Authenticator, run the following commands:

  CREATE Database <your database name, for example, authenticator>; 
  // granted with Login permissions to the DB and CRUD tables, extends installation
  CREATE ROLE <your user name, for example, authuser> WITH LOGIN;
  ALTER ROLE <your user name> WITH PASSWORD '<your password>';
  ALTER ROLE <your user name> VALID UNTIL 'infinity';
  GRANT ALL PRIVILEGES  ON DATABASE <your database name> to <your user name>;
  \c <your database name>  
  GRANT ALL ON SCHEMA public to <your user name>;

• For the Collector, run the following commands:

  //preare the database for collector services; 
  Create database <your database name, for example, collector>; 
  //prepare the roles, the role need has permission to the database 
  CREATE ROLE <your user name, for example, colluser> WITH LOGIN;
  ALTER ROLE <your user name> WITH PASSWORD '<your password>';
  ALTER ROLE <your user name> VALID UNTIL 'infinity';
  GRANT ALL PRIVILEGES ON DATABASE <your database name> to <your user name>;
  \c <your database name>;  
  GRANT ALL ON SCHEMA public to <your user name>;

• To install NATS at your cluster, run the following commands:

  > helm repo add nats https://nats-io.github.io/k8s/helm/charts/
  > helm repo update
  > helm repo list
  NAME          	URL 
  nats          	https://nats-io.github.io/k8s/helm/charts/
  > helm install nats nats/nats  --set cluster.enabled=true,cluster.name=nats -n <yourns>

After NATS is installed, you can see the NATS service at your cluster at the URL nats://nats:4222.

Installing the Private Cloud Components

To install the Private Cloud components, perform 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.

5. Run the following command: ./installer component -n=<Private Mendix Platform namespace>.

6. Click Install Private Cloud.

7. Configure the General Options:

   • Image Prefix - The registry and namespace (if it exists) where the mx-private-cloud images are located
   • Nats Address - The address of your NATS server

8. Configure the Authenticator and Collector options:

   • Host - Database Host
   • Port - Database port
   • DB Name - Database name
   • DB User - Database user
   • DB Password - Database password
   • DB CA File Path - If your database connection should use SSL, specify the CA file path, otherwise leave blank

9. Configure the Interactor options.

   • Enable Ingress - Enable this setting to expose the Interactor Bridge with a generic Ingress template

   • Ingress Class Name - The Ingress class name

   • Class as Annotation - This option adds the legacy kubernetes.io/ingress.class annotation to set the Ingress class, instead of using the Ingress class name; enable it to add the legacy annotation

   • Enable TLS - Enable this option if your TLS Certifcate is bound to Ingress

   • TLS secret - The TLS secret name

     To allow other clusters to connect to Private Mendix Platform, you must expose the Interactor Bridge Service. Currently, the installer only supports using the generic Ingress template to expose the service. If you want to expose the Interactor Bridge with other method (for example, Openshift Route), contact the Private Mendix Platform team.

10. Optional: To support AWS IRSA and Azure workload identity for database connection, configure the following options:

    • Use AMI only - Set to enabled.
    • Provider - Enter AWS or Azure.
    • Client ID - When using Azure, enter the Azure Managed Identity Client ID.
    • AWS-Role-ARN - When using AWS, enter an AWS role ARN which can access the specified Secret Manager.

11. Optional: To use the AWS Secret Manager or the Azure Key Vault as secret provider, configure the following options:

    • Use Secret Provider - Set to enabled.

    • Secret Provider - Enter AWS or Azure.

    • For Azure, configure the following settings:

      • Client ID - Enter a Client ID assigned to the Azure Managed Identity which enables Private Mendix Platform to access Azure resources.
      • Tenant ID - Enter the Directory ID of the key vault.
      • Key Vault Name - Enter the key vault name.

    • For AWS, configure the following settings:

      • AWS-Role-ARN - When using AWS, enter an AWS role ARN which can access the specified Secret Manager.
      • AWS SecretManager Name - When using AWS, enter the AWS Secret Manager name where the sensitive data is stored.

12. If you enabled the Use Secret Provider option, create the following secrets in your key vault or secret manager:

    • authenticator-db-name - The Authenticator database name, for example, authenticator
    • authenticator-db-host - The Authenticator database host, for example, postgres.example.com
    • authenticator-db-port - The Authenticator database port, for example, 5432
    • authenticator-db-user - The Authenticator database username, for example, auth_user
    • authenticator-db-pass - The Authenticator database password, for example, StrongPassword123
    • collector-db-name - The Collector database name, for example, collector
    • collector-db-host - The Collector database host, for example, `postgres.example.com
    • collector-db-port - The Collector database port, for example, 5432
    • collector-db-user - The Collector database username, for example, collector_user
    • collector-db-pass - The Collector database password, for example, StrongPassword456

13. Click Review and Apply > Apply Configuration.

Uninstalling the Private Cloud Components

If you want to uninstall the Private Cloud components and delete the secret, run the following commands:

helm uninstall mx-privatecloud -n=<Private Mendix Platform namespace>
helm uninstall  mx-privatecloud-secret -n=<Private Mendix Platform namespace>

Optional: Installing the Build Agent

The Build agent is required if you want to be able to build packages without having to enable Kubernetes API access in the Admin Build Settings. Install the Build agent by doing the following steps:

1. Download the mxplatform-kube-agent.zip file from your Private Mendix Platform download portal.

2. Unzip the mxplatform-kube-agent.zip file.

3. Copy the images from the mxplatform-kube-agent directory to the images sub-directory of the installer by running the following command: cp -r mxplatform-kube-agent/images/* <your installer>/pmp-binary-linux/images

4. Upload the directory to your private registry by using the installer init migrate command.

5. Run the following command: ./installer component -n=<Private Mendix Platform namespace>.

6. In the Components at any ns section, select Build Agent.

7. Configure the following settings:

   • Namespace - The namespace where the Build agent will be installed
   • Image Prefix - The registry and namespace (if it exists) where the kube-agent image is located
   • Image Name - The image name, for example, mxplatform-kube-agent
   • Image Tag - The image tag of the mxplatform-kube-agent

8. Click Install Build Agent.

Uninstalling the Build Agent

If you want to uninstall the Build agent, perform the following steps:

1. Unstall the component from its namespace by running the following command: helm uninstall mxplatform-kube-agent -n=<component namespace>.
2. Edit the pmp-component-config configmap in your Private Mendix Platform namespace by running the following command: kubectl edit configmap/pmp-component-config -n=<Private Mendix Platform namespace>.
3. Remove the BuildAgent data from the configmap.

Installing the Private Mendix Platform

Install the Private Mendix Platform by doing the following steps:

1. Run the command ./installer platform -n=<namespace name>, where -n is the same namespace as the one where you installed Svix and PCLM.

2. Click Configure Namespace.

   

3. Click Configure, and then specify the following parameters:

   • AppName - The default app name is mxplatform. You can change it as required.

   • DatabasePlan - If you want to use AWS Secret Manager, select USE-Secret-Provider; the installer then uses the database configuration set in AWS Secret Manager. Otherwise, enter the name of the database plan that you created in Installing and Configuring the Mendix Operator.

   • Storageplan - If you want to use AWS Secret Manager, select USE-Secret-Provider; the installer then uses the storage configuration set in AWS Secret Manager. Otherwise, enter the name of the storage plan that you created in Installing and Configuring the Mendix Operator.

   • StoragePlanwithIRSA - If your storage plan uses AWS IRSA or Azure Workload Identity, set this to enabled.

     Enabling this option disables the secretprovider option. This is because for IRSA and Azure Workload Identity storage plans, the Service account is created by the Operator instead of Helm.

   • AppUrl - The endpoint where you can connect to your running app. It must be a URL which is supported by your platform. If you leave it blank, Mendix Operator will create it.

   • EnableTLS - Allows you to enable or disable TLS for the Mendix app's Ingress or OpenShift Router. The default value is use the default settings.

   • TLS option - Allows you to use an existing kubernetes.io/tls secret containing the TLS certificate, or to provide the tls.crt and tls.key values directly.

   • TLS Secret - An existing kubernetes.io/tls secret containing the TLS certificate. Cannot be used together with certificate and key. If you leave it blank, the default TLS certificate from the Ingress Controller or OpenShift Router will be used.

   • TLS certificate and TLS key – Allows you to provide the tls.crt and tls.key values directly (not recommended for production environments). Cannot be used together with secretName.

   • SourceUrl - The location of the deployment package, in the format oci-image://<your image location>. This location must be accessible from your cluster.

   • Replicas – When you deploy your app, one replica is deployed automatically. Do not increase the number of replicas yourself, as this may cause data to be duplicated.

   

4. Click Runtime, and then specify the following parameters:

   • MxAdminPassword - Optional. The password for the admin user, required if you are not planning to use the AWS Secret Manager. It must have at least one number, one upper case letter, one lower case letter and one symbol, with a minimum length of 12 characters.

   • dtapmode - For production deployments, leave this value set to P. For the development of the app, for example acceptance testing, set the value to D.

   • ApplicationRootUrl - Optional. Manually specify the URL of your Private Mendix Platform, for example, for use with SSO or when sending emails. For more information about this functionality, see ApplicationRootUrl Needs to be Set Manually.

   • Use Secret Provider - Optional. Select this option to use the AWS Secret Manager or the Azure Key Vault. Selecting this option enables the following additional fields:

     • For AWS Secret Manager:

       • Secret Provider - Set to AWS.
       • AWS-Role-ARN - An AWS role ARN which can access the specified Secret Manager.
       • AWS SecretManager Name - The AWS Secret Manager name where the sensitive data is stored.

     • For Azure Key Vault:

       • Secret Provider - Set to Azure.
       • Client ID - Enter a Client ID assigned to the Azure Managed Identity which enables Private Mendix Platform to access Azure resources.
       • Tenant ID - Enter the Directory ID of the key vault.
       • Key Vault Name - Enter the key vault name.
       • Use identity auth for Blob - Set to True if you use the Azure Blob Storage with managed identity auth; the default value is false.

5. In the Enabled Functions section, select or clear the functions that you want to enable or disable:

   • Persist Config - When enabled, this setting locks the Private Mendix Platform configuration, so that it can no longer be modified from the user interface.
   • Project Management - Recommended. Enables you to create and manage your app projects. Enables app projects and related settings across the portal. Must be enabled for CI/CD capabilities.
   • Marketplace - Recommended. Enables you to use the Private Platform's Marketplace capabilities to upload, import and manage Marketplace contents. The Marketplace enabled here is hosted entirely within your Private Mendix Platform.
   • Marketplace Approvals - Optional. If enabled, contents that users publish to the private Marketplace require administrator approval before publishing.
   • Marketplace Import - Optional. Enables content import with an external source.
   • IDP - Optional. Enable users to login using SSO by configuring your IdP integration.
   • Webhook - Optional. Webhooks allow to send information between platform and external systems, and can be triggered by events around Apps, Users, Groups, Marketplace and CI/CD.

6. Click Review and Apply > Evaluate Configuration.

7. Make any required changes or click Run Test App.

   

8. After the test installation is completed, keep the installer open so you can reuse the settings and apply them to the installation later.

9. Open the endpoint URL that you configured as the AppURL in step 3 above and verify that you can upload a test file.

10. In the Private Mendix Platform installer, click Apply Configuration.

11. Click OK to remove the test installation and install Private Mendix Platform.

Installing Maia for the Private Mendix Platform

Mendix AI Assistance (Maia) refers to Mendix Platform capabilities that leverage artificial intelligence (AI) and machine learning (ML) to assist developers in application development. Private Mendix Platform currently offers support for Maia-assisted app creation. Other Maia capabilities, such as Maia Chat, will be made available in future releases.

To enable Maia for Private Mendix Platform, perform 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.

5. Run the following command: ./installer component -n=<Private Mendix Platform namespace>. Maia must be installed at the same namespace as Private Mendix Platform.

6. In the Components at PMP ns section, select Maia.

7. Configure the following settings:

   • Image Prefix - The registry and namespace (if it exists) where the maia-appgen-pmp image is located
   • Image Name - The image name, for example, maia-appgen-pmp
   • Image Tag - The image tag of the AppGen image
   • Enable Ingress - Enable or disable Nginx ingress
   • MXASSIST_COPILOT_MXID3_URL - The OIDC URL of Private Mendix Platform, in the following format: <your Private Mendix Platform URL>/oidc/

Installing the LLM Gateway

Because Private Mendix Platform instances are hosted within the enterprise firewall, selecting an LLM provider other than the default Mendix Platform requires you to also configure the LLM Gateway URL.

1. Download the maia-llm-gateway.zip file from your Private Mendix Platform download portal.

2. Unzip the maia-llm-gateway.zip file.

3. Copy the maia-llm-gateway directory to the images sub-directory of the installer by running the following command: cp -r maia-llm-gateway/images/* <your installer>/pmp-binary-linux/images

4. Upload the Maia directory to your private registry by using the installer init migrate command.

5. Run the following command: ./installer component -n=<Private Mendix Platform namespace>. Maia must be installed at the same namespace as Private Mendix Platform.

6. In the Components at PMP ns section, select Maia LLM Gateway.

7. Configure the following settings:

   • Image Prefix - The registry and namespace (if it exists) where the maia-llm-gateway image is located
   • Image Name - The image name, for example, maia-llm-gateway
   • Image Tag - The image tag of the LLM Gateway image
   • Enable Ingress - Enable or disable Nginx ingress
   • MXASSIST_COPILOT_MXID3_URL - The OIDC URL of Private Mendix Platform, in the following format: <your Private Mendix Platform URL>/oidc/

Uninstalling Maia

If you want to uninstall Maia, run the following command: helm unistall maia-appgen -n=<Private Mendix Platform namespace>.

Installing PDF Document Generation for the Private Mendix Platform

The PDF Document Generation module allows you to generate pixel-perfect PDF documents based on regular pages in your app.

To enable PDF Document Generation for Private Mendix Platform, perform the following steps:

1. Download the document-generation-service.zip file from your Private Mendix Platform download portal.

2. Unzip the document-generation-service.zip file.

3. Copy the document-generation-service directory to the images sub-directory of the installer by running the following command: cp -r document-generation-service <your installer>/pmp-binary-linux/images

4. Upload the directory to your private registry by using the installer init migrate command.

5. Run the following command: ./installer component -n=<Private Mendix Platform namespace>. PDF Document Generation can be installed at the same namespace as Private Mendix Platform, or at any other namespace.

6. In the Components at PMP ns section, select PDF Gen.

7. Configure the following settings:

   • Namespace - The namespace where PDF Document Generation will be installed
   • Image Prefix - The registry and namespace (if it exists) where the document-generation-service image is located
   • Image Name - The image name, for example, document-generation-service
   • Image Tag - The image tag of the AppGen image, for example, 1.0.2

Uninstalling PDF Document Generation

If you want to uninstall PDF Document Generation, perform the following steps:

1. Unstall the component from its namespace by running the following command: helm uninstall mx-private-document-generation -n=<component namespace>.
2. Edit the pmp-component-config configmap in your Private Mendix Platform namespace by running the following command: kubectl edit configmap/pmp-component-config -n=<Private Mendix Platform namespace>.
3. Remove the PDFGen data from the configmap.

Adding Additional Components After Installing the Private Mendix Platform

To ensure that components such as svix, PCLM, the Build agent, or Private Cloud components work correctly, you should install them before you install the Private Mendix Platform itself. If you want to add a component after the Platform installation (for example, if you want to install svix because you decided to enable webhooks), you must perform the following steps:

1. Install the component as described above.
2. Run the command ./installer platform -n=<namespace name>, where -n is the same namespace as the one where you installed Svix and PCLM.

Re-running the installation command ensures that the installer fetches the relevant information from the components that you added.