-
Notifications
You must be signed in to change notification settings - Fork 775
Helm charts for PC #10848
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: development
Are you sure you want to change the base?
Helm charts for PC #10848
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| 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 | ||
| --- | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Replace "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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Replace this with |
||
| * 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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Replace this with: |
||
| * The upgrade process is simplified. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. |
||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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.
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Adde another Limitation:
|
||
| ## Installing the Operator with Helm Charts | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Replace with: |
||
|
|
||
| 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/). | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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`. | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Add : |
||
| The installer performs the basic installation and applies the configurations at the same time. | ||
|
|
||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Replace : |
||
|
|
||
| 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
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The screenshot must be updated since now have a Service Account section. |
||
There was a problem hiding this comment.
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.