Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
@@ -0,0 +1,66 @@
---
title: "Installing Components through Helm Chart UI"
url: /developerportal/deploy/helm-charts/
description: "Describes how to configure your installation with Helm charts in Mendix on Kubernetes."
weight: 50
beta: true
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Set the beta to false.

---

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add the note:

Before using Helm charts, kindly ensure to go through the official Helm documentation.

## Introduction

By default, Mendix on Kubernetes uses the mxpc-cli tool for configuring namespaces and performing base installations. However, customers can also integrate Helm charts into their pipelines in order to directly install components and run the configurations through the Helm chart UI.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

General note: Can you make this document as a second person instead of mentioning the "customers can", use something like "U can integrate Helm chart ......"


The solution consists of two main components: the Helm charts themselves, and a tool called Mendix CLI. The Mendix CLI acts as a UI for customers, allowing them to input configurations and then generate Helm charts from those inputs.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace "and then generate Helm charts from those inputs."
with "and then generate Helm charts values from the helm charts"

### Benefits of Using the Helm Charts

Using the solution offers the following advantages when compared to the traditional method of using the mxpc-cli tool:

* Helm-based installation does not require elevated permissions, and can be run on individual workstations. Because of that, it can be implemented by customers who use GitOps and similar DevOps practices.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace this with
Helm is industry standard for integration and our helm charts use all your existing workflows.

* By using Helm charts, customers can integrate configuration deployment into their existing pipelines. This reduces the need for manual intervention. For customers who are already familiar with Helm charts, it is a more intuitive and preferred method compared to manual CLI operations.
* The deployment process is streamlined, consistent, and repeatable.
* Configuration is easy and can be fine-tuned to specific requirements.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace this with:
Managing the configurations is easy.

* The upgrade process is simplified.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace this with "In future releases, upgrade process will be simplified"

* Components can be cleanly uninstalled when no longer needed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove this


### Current Limitations

The solution currently has the following limitations compared to using the mxpc-cli tool:

* The Helm chart UI cannot be used to configure the Global Operator.
* Upgrading namespaces is not supported.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace this with : We dont have any UI driven upgrade approach

* Namespaces initially created with mxpc-cli cannot be migrated and managed with Helm charts.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the current release, Namespaces initially created with mxpc-cli cannot be managed with Helm charts.


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Helm chart does not cover Advanced operator configurations such as https://docs.mendix.com/developerportal/deploy/private-cloud-cluster/#advanced-operator-configuration.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adde another Limitation:

  1. Currently, we don't provide a public repository to download the helm chart. The Helm charts are currently only be downloaded via our in house mx-ops-cli web-ui.

## Installing the Operator with Helm Charts
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace with:
Installing and Configuring the Mendix on Kubernetes with Helm Charts


To install the solution, perform the following steps:

1. [Create a Mendix on Kubernetes cluster.](/developerportal/deploy/private-cloud-cluster/)
2. Create a namespace in your cluster.
3. Download the Helm charts from the *privatecloud-ops-cli* Gitlab.
4. Run the following command: `./mx-ops-cli web-ui`.

The Web UI application opens locally in your browser. You can now select one of the following options:

* **Start from Scratch** - Creates a new configuration file.
* **Import from File** - Allows you to import configurations from an existing yaml file.
* **Download Helm Charts** - Downloads the latest Helm charts so you can open and view them. You can use this option to check the expected Helm chart format, so you can use them as a template for your own charts.

5. For an initial configuration, select **Start from Scratch**. The configuration wizard opens.

{{< figure src="/attachments/deployment/private-cloud/private-cloud-cluster/helm-chart-wizard.png" >}}

6. In the **General Settings** tab, enter the cluster that you created in step 1.
7. Follow the wizard to configure the other options according to your requirements.

You must specify the database, [storage plan](/developerportal/deploy/private-cloud-storage-plans/), [ingress](/deploy/private-cloud-cluster/private-cloud-ingress-settings/), and [registry](/developerportal/deploy/private-cloud-registry/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think it would make sense if we can add separate sections such as Database, Storage, Proxy, Ingress etc. Along with that we can add the screenshots for them


8. Click **Generate & Download** to generate the yaml file with the configurations that you provided.

9. Run the following command: `helm install -n <your namespace> -f <yaml file name> <your namespace> ./mx-privatecloud-operator-installer`.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add :
Once you run above command, ensure that your cluster have access to Mendix on Kubernetes portal for adding the Storage Plans. The Private cloud portal should be safelisted in the cluster.

The installer performs the basic installation and applies the configurations at the same time.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a new section:

Uninstall Mendix on Kubernetes

If u want to uninstall, follow the official documentation.

## Upgrading the Operator with Helm Charts
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace :
Applying the configuration changes with Helm Charts


If you want to update your configuration (for example, change the database), recreate the yaml file by using the same wizard as above, and then run the following command: `helm update -n <your namespace> -f <yaml file name> <your namespace> ./mx-privatecloud-operator-installer`.
Comment on lines +51 to +66
Copy link
Contributor

@ilholbea ilholbea Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The screenshot must be updated since now have a Service Account section.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.