Private Mendix Platform Prerequisites

Introduction

This document presents the system requirements for the various parts of the Private Mendix Platform.

Hardware Requirements

For performance reasons, Mendix recommends at least the following minimum hardware requirements.

Kubernetes Hardware Requirements for Private Mendix Platform

Kubernetes Hardware Requirements for an App Running on Private Mendix Platform

Additional Recommendations

Additional services (Prometheus, Grafana, Loki) for observability are recommended. The following versions are currently validated for Private Mendix Platform:

Grafana Endpoints

Private Mendix Platform uses the following Grafana endpoints:

• GET /api/health - This endpoint is used to check the health and status of the Grafana instance itself. It allows Private Mendix Platform to get the Grafana version and verify that Grafana is running before saving the logging and monitoring configuration.
• GET /api/datasources - This endpoint is used to fetch the unique identifiers (IDs) of datasources, like Loki (logs) and Prometheus (metrics). These IDs are required for subsequent queries.
• GET /api/datasources/proxy/uid/:uid/* - This endpoint acts as a proxy for calls to the data source identified by the specified UID. Private Mendix Platform uses this to call Loki and Prometheus APIs to query logs and labels.
• GET /loki/api/v1/query_range - This is the primary endpoint for fetching log data. Private Mendix Platform uses this Loki API to query application logs over a specific time range. The results of this query are used for real-time monitoring, and displayed within the Private Mendix Platform interface.
• GET /api/v1/labels (Prometheus API via Grafana) - This endpoint queries the available labels from Prometheus. Private Mendix Platform uses this to check if a specific label (for ezample, a namespace) exists in Prometheus.
• GET /api/v1/label/pod/values (Prometheus API via Grafana) - This endpoint retrieves the list of all unique pod names for a target environment. This is used to populate the filter dropdown in the Private Mendix Platform interface.
• POST /api/ds/query?ds_type=prometheus - This is a universal Grafana API endpoint for executing queries on a specific data source. Private Mendix Platform uses it to send PromQL queries to the Prometheus data source to fetch metric data for the Metrics dashboard.

General Requirements

• The machine where Private Mendix Platform is installed must have connectivity to the Container Registry and the Kubernetes cluster

• The cluster's internal network policy must allow communication (from ingress) to services on the default port (8080).

• The Mendix Operator must be installed and fully configured:

  • The database plan must be created
  • The database server must be accessible from the Kubernetes cluster
  • The file storage plan must be created
  • The file storage server must be accessible from the Kubernetes cluster

• Mendix Studio Pro must be able to access Private Mendix Platform

• IdP for SSO must be available and configurable during installation process G* it, Jenkins and other services must be accessible on the same virtual network, or allow external bi-directional communication with Private Mendix Platform

• For Mendix Marketplace, a file server must be accessible over HTTP (or HTTPS) on either internal network or through a connection to a Mendix repository

• Private Mendix Platform should be able to access the Kubernetes API directly

Software Resource Requirements

Your Mendix app will be deployed with and run by the Mendix on Kubernetes Operator on top of Kubernetes. The following resources are required to facilitate this:

Platform Portal

Customer Landscape Integrations

Private Mendix Platform must connect to services within your premises. Mandatory services are required for the basic functionality of the portal, and optional services improve the low-code platform experience when integrated into the portal.

Customer Apps

Infrastructure Requirements

For information about the infrastructure requirements, see Supported Providers.