Private Mendix Platform

https://docs.mendix.com/private-mendix-platform/
Admin
Private Mendix Platform provides an end-to-end Mendix developer experience on private infrastructure...
Tokens:62,067
Snippets:1,091
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Run Component Installer

Source: https://docs.mendix.com/private-mendix-platform/quickstart

Command to launch the component installation process for a specific namespace.

```bash
./installer component -n=<Private Mendix Platform namespace>
```

--------------------------------

### Install Private Mendix Platform via CLI

Source: https://docs.mendix.com/private-mendix-platform/quickstart

Execute this command to initiate the platform installation within a specific namespace.

```bash
./installer platform -n=<namespace name>
```

--------------------------------

### Copy Images to Installer

Source: https://docs.mendix.com/private-mendix-platform/quickstart

Command to move images from the downloaded zip directory to the installer directory.

```bash
cp -r mx-private-cloud/images/* <your installer>/pmp-binary-linux/images
```

--------------------------------

### Install NATS via Helm

Source: https://docs.mendix.com/private-mendix-platform/quickstart

Commands to add the NATS repository and install the NATS chart in the cluster.

```bash

> 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>
```

--------------------------------

### Copying the service directory

Source: https://docs.mendix.com/private-mendix-platform/quickstart

Copies the unzipped service directory into the installer images folder.

```bash
cp -r document-generation-service <your installer>/pmp-binary-linux/images
```

--------------------------------

### Initialize Maia migration

Source: https://docs.mendix.com/private-mendix-platform/quickstart

Uploads the Maia directory to the private registry using the installer utility.

```bash
installer init migrate
```

--------------------------------

### Copy Maia images to installer directory

Source: https://docs.mendix.com/private-mendix-platform/quickstart

Moves the unzipped Maia application generator images into the installer's binary directory.

```bash
cp -r maia-appgen-pmp/images/* <your installer>/pmp-binary-linux/images
```

--------------------------------

### Verify Svix installation

Source: https://docs.mendix.com/private-mendix-platform/uninstallation

Check the status of the svix-server release in the specified namespace.

```bash
helm status svix-server -n=<Private Mendix Platform namespace>
```

--------------------------------

### View Migrate Command Help

Source: https://docs.mendix.com/private-mendix-platform/quickstart

Displays the help documentation for the migration command used to move images to a private registry.

```bash
~/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
```

--------------------------------

### Create Database for Authenticator

Source: https://docs.mendix.com/private-mendix-platform/quickstart

SQL commands to initialize the database and user roles for the Authenticator service.

```sql

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>;
```

--------------------------------

### Install Mendix Operator in Standard or Global mode

Source: https://docs.mendix.com/private-mendix-platform/quickstart

Execute the installer command to deploy the operator in either standard or global mode within a specified namespace.

```bash
./mxpc-cli installer -n=<namespace name>
```

```bash
./mxpc-cli installer --global -n=<namespace name>
```

--------------------------------

### GET /api/v1/labels

Source: https://docs.mendix.com/private-mendix-platform/prerequisites

Queries available labels from Prometheus.

```APIDOC
## GET /api/v1/labels

### Description
This endpoint queries the available labels from Prometheus. Private Mendix Platform uses this to check if a specific label exists in Prometheus.

### Method
GET

### Endpoint
/api/v1/labels
```

--------------------------------

### Configure Service Account and RBAC with Help Me Feature

Source: https://docs.mendix.com/private-mendix-platform/configure-k8s

Use this script when enabling the 'Help Me' feature, which requires additional permissions for monitoring deployments, pods, and events.

```bash

# create ServiceAccount, ClusterRole, and ClusterRoleBinding
kubectl apply -f << EOF -
apiVersion: v1
kind: ServiceAccount
metadata:
  name: mxplatform-cicd
  namespace: kube-system
---
apiVersion: v1
kind: Secret
metadata:
  name: mxplatform-cicd
  namespace: kube-system
  annotations:
    kubernetes.io/service-account.name: mxplatform-cicd
type: kubernetes.io/service-account-token
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
    name: mxplatform-cicd
rules:
- apiGroups:
    - ""
    resources:
    - namespaces
    verbs:
    - list
- apiGroups:
    - ""
    resources:
    - deployments
    verbs:
    - get
    - list
    - watch
- apiGroups:
    - ""
    resources:
    - pods
    verbs:
    - get
    - list
- apiGroups:
    - ""
    resources:
    - pods/log
    verbs:
    - get
- apiGroups:
    - ""
    resources:
    - events
    verbs:
    - get
    - list
- apiGroups:
    - privatecloud.mendix.com
    resources:
    - storageplans
    verbs:
    - list
- apiGroups:
    - privatecloud.mendix.com
    resources:
    - mendixapps
    verbs:
    - '*'
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
    name: mxplatform-cicd
subjects:
- kind: ServiceAccount
    name: mxplatform-cicd
    namespace: kube-system
roleRef:
    kind: ClusterRole
    name: mxplatform-cicd
    apiGroup: rbac.authorization.k8s.io
EOF

# get service account token:
kubectl get secret mxplatform-cicd -nkube-system -o jsonpath='{.data.token}'|base64 -d
# for openshift cluster
kubectl get secret mxplatform-cicd -nkube-system -o jsonpath='{.metadata.annotations.openshift\.io/token-secret\.value}'
```

--------------------------------

### Create Database for Collector

Source: https://docs.mendix.com/private-mendix-platform/quickstart

SQL commands to initialize the database and user roles for the Collector service.

```sql

//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>;
```

--------------------------------

### GET /api/datasources

Source: https://docs.mendix.com/private-mendix-platform/prerequisites

Fetches unique identifiers for configured datasources.

```APIDOC
## GET /api/datasources

### Description
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.

### Method
GET

### Endpoint
/api/datasources
```

--------------------------------

### GET /loki/api/v1/query_range

Source: https://docs.mendix.com/private-mendix-platform/prerequisites

Fetches log data from Loki over a specific time range.

```APIDOC
## GET /loki/api/v1/query_range

### Description
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.

### Method
GET

### Endpoint
/loki/api/v1/query_range
```

--------------------------------

### GET /api/health

Source: https://docs.mendix.com/private-mendix-platform/prerequisites

Checks the health and status of the Grafana instance and retrieves the version.

```APIDOC
## GET /api/health

### Description
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.

### Method
GET

### Endpoint
/api/health
```

--------------------------------

### GET /api/v1/label/pod/values

Source: https://docs.mendix.com/private-mendix-platform/prerequisites

Retrieves a list of all unique pod names for a target environment.

```APIDOC
## GET /api/v1/label/pod/values

### Description
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.

### Method
GET

### Endpoint
/api/v1/label/pod/values
```
Tokens:
Raw