diff --git a/content/en/docs/deployment/private-cloud/private-cloud-cluster/private-cloud-helm-charts.md b/content/en/docs/deployment/private-cloud/private-cloud-cluster/private-cloud-helm-charts.md new file mode 100644 index 00000000000..42a4a210e37 --- /dev/null +++ b/content/en/docs/deployment/private-cloud/private-cloud-cluster/private-cloud-helm-charts.md @@ -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 +--- + +## 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. + +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. + +### 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. +* 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. +* The upgrade process is simplified. +* Components can be cleanly uninstalled when no longer needed. + +### 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. +* Namespaces initially created with mxpc-cli cannot be migrated and managed with Helm charts. + +## Installing the Operator 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/). + +8. Click **Generate & Download** to generate the yaml file with the configurations that you provided. + +9. Run the following command: `helm install -n -f ./mx-privatecloud-operator-installer`. + +The installer performs the basic installation and applies the configurations at the same time. + +## Upgrading the Operator 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 -f ./mx-privatecloud-operator-installer`. \ No newline at end of file diff --git a/static/attachments/deployment/private-cloud/private-cloud-cluster/helm-chart-wizard.png b/static/attachments/deployment/private-cloud/private-cloud-cluster/helm-chart-wizard.png new file mode 100644 index 00000000000..0d4eab00128 Binary files /dev/null and b/static/attachments/deployment/private-cloud/private-cloud-cluster/helm-chart-wizard.png differ