Skip to main content
Version: 2.0 🆕

Deploy Charts

Introduction​

This document helps you deploy, update, upgrade, disable, and delete Helm charts.

Configure and Deploy Charts​

Who Can Perform This Action?

Only a Super-Admin or an Admin can configure and deploy charts.

To configure and deploy Helm, follow the instructions below:

  1. Navigate to Chart Store.

  2. Enter your preferred chart name in the search bar at the top-left corner of the screen.

  3. Select your preferred chart. The chart page is displayed.

    Figure 1: Discover a Chart

    SectionDescription
    AboutA short description of the chart
    README.mdContains the instructions, configurations, and everything related to the configuration and deployment of the chart
    DeploymentsDisplays the list of projects under which the chart is deployed

  4. Click Configure & Deploy. Configuring a Helm chart gives you the flexibility to customize it to your needs instead of relying on the default values of the chart.

    To predefine configurations and make future deployments across environments easier, refer to Preset Values.

    Figure 2: Configure & Deploy

  5. Enter your application name in the App Name field.

  6. Select your project in the Project drop-down box.

  7. Select the environment where you want to deploy the chart in the Deploy to Environment drop-down box. When you select an environment, the How do you want to deploy? section is displayed.

    Figure 3: Deployment Methods

    How do you want to deploy?

    MethodDescription
    HelmSelect this option if you do not want version tracking for deployments and would like to directly deploy charts into the cluster
    GitOps (Via Argo CD)Select this option if you want Git to track every deployment via Argo CD. As a prerequisite:
    • The GitOps (Argo CD) module should be installed in your Devtron instance for this option to be displayed
    • GitOps should be configured in the Global Configurations page. Refer to GitOps for more information
    GitOps (Via Flux CD)Select this option if you want Git to track every deployment via Flux CD. As a prerequisite:
    • The Flux CD controller should be installed in your preferred cluster to deploy using GitOps (Via Flux CD). Refer Enable GitOps Deployments with FluxCD for more information.
    • GitOps should be configured in the Global Configurations page. Refer to GitOps for more information.
Note

The deployment method cannot be changed once the chart is deployed.

  1. Select the chart version you prefer to deploy in the Chart Version drop-down box.

  2. Select the chart values you prefer to use in the Chart Values drop-down box. Kindly refer to Preset Values.

  3. Click Deploy Chart.

Once you have deployed a chart, you will be redirected automatically to the App Details tab where the deployment status is shown.

Figure 4: Check Deployment Status

The Application Status should be Healthy, indicating that the application has been successfully deployed.

Refetch Charts​

When you click on Refetch Charts, the system fetches the latest Helm charts (e.g., stable/mySQL, bitnami/mySQL) and their latest available versions (e.g., v1.0, v1.1) that include improvements, features, and fixes. You can then either update a chart version or upgrade the chart itself in your environment.

To check the latest charts and chart versions, follow the instructions below:

  1. Navigate to the Configure tab of your helm application.

    Figure 5: Update Charts

  2. Click Refetch Charts. All the latest charts are displayed in the Helm Chart drop-down box and all the latest versions of a chart will be displayed in the Chart Version drop-down box.

Update Charts​

Who Can Perform This Action?

Only a Super-Admin or an Admin can update charts.

When you update a Helm chart, the system actually deploys the selected latest version of a chart (e.g., 12.4.2) in your environment, just like how you'd install the latest version of an app from the app store.

Follow the below instructions to update a Helm chart:

  1. Navigate back to the Configure tab of your Helm application.

  2. Select your preferred chart version from the Chart Version drop-down box.

    You can also compare the existing configured values of the previous chart version with the default values of the newer chart version by clicking the Compare Values button in the top-right corner of the page.

    Figure 6: Compare Values

  3. Click Update And Deploy.

Upgrade Charts​

Who Can Perform This Action?

Only a Super-Admin or an Admin can upgrade charts.

If the chart you're already using is deprecated or for other business reasons you wish to move from one chart to another (e.g., stable/mySQL to bitnami/mySQL), consider upgrading your charts.

Follow the below instructions to upgrade a Helm chart:

  1. Navigate back to the Configure tab of your Helm application.

  2. Select your preferred chart from the Helm Chart drop-down box.

    Figure 7: Upgrade Chart

Note

When you upgrade your helm chart, ensure that the values are compatible with the new chart.

  1. Click Update And Deploy.

Security Scan ​

Enabling the Security scan toggle scans the image(s) in the chart for vulnerabilities and license risks. To know more about security scan, refer to Vulnerability Scanning.

Disable Chart Source​

Who Can Perform This Action?

Only a Super-Admin can disable a chart source in the Chart Store.

Disabling a Helm chart source (e.g., Bitnami) does not display all associated charts in the Chart Store. When you previously used charts from a particular chart source, but no longer want to use it, you can simply disable the chart source by following the instructions below:

  1. Navigate to Application Management → Chart Store → Source.

  2. Disable the toggle next to your preferred chart source (e.g., Bitnami).

    Figure 8: Disable chart repository

The chart source (e.g., Bitnami) will no longer be displayed in the Chart Source drop-down box, and all its associated charts will no longer be displayed in the All Charts section of the Chart Store page.

You can always enable the chart source again anytime by enabling the toggle next to the chart source.

Delete Chart Source​

Who Can Perform This Action?

Only a Super-Admin can delete a chart source in Devtron.

When you delete a chart source in Devtron, all associated charts will be removed from the Chart Store, and you will no longer be able to view or deploy them. You can consider deleting a chart source when you no longer have any applications running on its charts or when the chart repository is no longer relevant to your business needs.

Disabling Chart Source vs Deleting Chart Source

Disabling charts only hides specific chart repositories and their associated charts from appearing on the Chart Store page. They are not removed from Devtron. However, deleting a chart source removes the chart repository or OCI registry from Devtron entirely, along with all its associated charts.

You can delete a chart source in the following two ways:

You cannot disable or delete the default charts provided by Devtron.

Extras​

Preset Values​

If you frequently deploy a particular chart, you can then predefine its configurations as a template, making it easier to deploy across environments.

To predefine the configurations for a chart, follow the instructions below:

  1. Click the Preset Values button.

    Figure 9: Preset Values

  2. Enter your preferred preset value name in the Name field.

    Figure 10: Editing Preset Values

  3. Select the chart version for which you'd like to create a preset value from the Chart Version drop-down box.

  4. Edit the chart values as per your needs.

  5. Click on the Save Value button.

A preset value for the selected chart version is now created and will be displayed in the Chart Values drop-down box whenever you wish to deploy the same chart again.

Example​

Deploying mySQL Helm Chart​

Discover the mySQL Helm Chart in Chart Store​

  1. Navigate to Chart Store.

    Figure 11: Chart Store

  2. Enter mySQL in the search bar at the top-left corner of the Chart Store page.

  3. Select bitnami/mySQL from the list of available charts.

Configure and Deploy the Chart​

Once you have clicked on the bitnami/mySQL, follow the set of instructions below:

  1. Read the README.md file to know more about the chart configurations.

    Figure 12: Configure and Deploy Chart

  2. Refer to the tables below and fill in the details:

    Figure 13: Configure Values

    KeyDescription
    App NameEnter the name of your application
    ProjectSelect your project
    EnvironmentSelect the environment where you want to deploy the chart
    Chart VersionSelect the chart version you prefer to deploy
    Chart ValueSelect the chart value you prefer to use. Kindly refer to Preset Values
    ParametersDescription
    mysqlRootPasswordPassword for the root user. Ignored if existing secret is provided
    mysqlDatabaseName of your MySQL database
    mysqluserUsername of new user to create
    mysqlPasswordPassword for the new user. Ignored if existing secret is provided

  3. Click Deploy Chart to deploy the chart.

Check the Deployment Status​

When you deploy the chart, you will be redirected to the App Details tab of the Helm application.

Figure 14: Deployment Status

The Application Status should be Healthy, indicating that the application has been successfully deployed.

Extract the Service Name​

Service names makes it easier to find, connect to, and interact with your application. To extract the service name, navigate to K8s Resources → Networking → Service. The service name(s) are displayed in the Name column along with the URL in the URL column.

Figure 15: Service Name