-
Notifications
You must be signed in to change notification settings - Fork 773
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
Open
katarzyna-koltun-mx
wants to merge
3
commits into
development
Choose a base branch
from
kk-pc-helm
base: development
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Helm charts for PC #10848
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
66 changes: 66 additions & 0 deletions
66
...ocs/deployment/private-cloud/private-cloud-cluster/private-cloud-helm-charts.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
| --- | ||
|
|
||
| ## 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 <your namespace> -f <yaml file name> <your namespace> ./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 <your namespace> -f <yaml file name> <your namespace> ./mx-privatecloud-operator-installer`. | ||
Binary file added
BIN
+189 KB
...ttachments/deployment/private-cloud/private-cloud-cluster/helm-chart-wizard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
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.
The screenshot must be updated since now have a Service Account section.