Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 5. Working with Helm charts

5.1. Understanding Helm
Copy link

Helm is a software package manager that simplifies deployment of applications and services to OpenShift Dedicated clusters.

Helm uses a packaging format called charts. A Helm chart is a collection of files that describes the OpenShift Dedicated resources.

Creating a chart in a cluster creates a running instance of the chart known as a release.

Each time a chart is created, or a release is upgraded or rolled back, an incremental revision is created.

5.1.1. Key features
Copy link

Helm provides the ability to:

  • Search through a large collection of charts stored in the chart repository.
  • Modify existing charts.
  • Create your own charts with OpenShift Dedicated or Kubernetes resources.
  • Package and share your applications as charts.

You can choose to verify and certify your Helm charts by Red Hat for all the components you will be deploying on the Red Hat OpenShift Dedicated. Charts go through an automated Red Hat OpenShift certification workflow that guarantees security compliance as well as best integration and experience with the platform. Certification assures the integrity of the chart and ensures that the Helm chart works seamlessly on Red Hat OpenShift clusters.

5.2. Installing Helm
Copy link

The following section describes how to install Helm on different platforms using the CLI.

You can also find the URL to the latest binaries from the OpenShift Dedicated web console by clicking the ? icon in the upper-right corner and selecting Command Line Tools.

Prerequisites

  • You have installed Go, version 1.13 or higher.

5.2.1. On Linux
Copy link

  1. Download the Linux x86_64 or Linux amd64 Helm binary and add it to your path: 

    # curl -L https://mirror.openshift.com/pub/openshift-v4/clients/helm/latest/helm-linux-amd64 -o /usr/local/bin/helm
    Copy to Clipboard Toggle word wrap

  2. Make the binary file executable: 

    # chmod +x /usr/local/bin/helm
    Copy to Clipboard Toggle word wrap

  3. Check the installed version: 

    $ helm version
    Copy to Clipboard Toggle word wrap

    Example output

    version.BuildInfo{Version:"v3.0", GitCommit:"b31719aab7963acf4887a1c1e6d5e53378e34d93", GitTreeState:"clean", GoVersion:"go1.13.4"}
    Copy to Clipboard Toggle word wrap

5.2.2. On Windows 7/8
Copy link

  1. Download the latest .exe file and put in a directory of your preference.
  2. Right click Start and click Control Panel.
  3. Select System and Security and then click System.
  4. From the menu on the left, select Advanced systems settings and click Environment Variables at the bottom.
  5. Select Path from the Variable section and click Edit.
  6. Click New and type the path to the folder with the .exe file into the field or click Browse and select the directory, and click OK.

5.2.3. On Windows 10
Copy link

  1. Download the latest .exe file and put in a directory of your preference.
  2. Click Search and type env or environment.
  3. Select Edit environment variables for your account.
  4. Select Path from the Variable section and click Edit.
  5. Click New and type the path to the directory with the exe file into the field or click Browse and select the directory, and click OK.

5.2.4. On MacOS
Copy link

  1. Download the Helm binary and add it to your path: 

    # curl -L https://mirror.openshift.com/pub/openshift-v4/clients/helm/latest/helm-darwin-amd64 -o /usr/local/bin/helm
    Copy to Clipboard Toggle word wrap

  2. Make the binary file executable: 

    # chmod +x /usr/local/bin/helm
    Copy to Clipboard Toggle word wrap

  3. Check the installed version: 

    $ helm version
    Copy to Clipboard Toggle word wrap

    Example output

    version.BuildInfo{Version:"v3.0", GitCommit:"b31719aab7963acf4887a1c1e6d5e53378e34d93", GitTreeState:"clean", GoVersion:"go1.13.4"}
    Copy to Clipboard Toggle word wrap

5.3. Configuring custom Helm chart repositories
Copy link

The Developer Catalog, in the Developer perspective of the web console, displays the Helm charts available in the cluster. By default, it lists the Helm charts from the Red Hat OpenShift Helm chart repository. For a list of the charts, see the Red Hat Helm index file.

As a cluster administrator, you can add multiple cluster-scoped and namespace-scoped Helm chart repositories, separate from the default cluster-scoped Helm repository, and display the Helm charts from these repositories in the Developer Catalog.

As a regular user or project member with the appropriate role-based access control (RBAC) permissions, you can add multiple namespace-scoped Helm chart repositories, apart from the default cluster-scoped Helm repository, and display the Helm charts from these repositories in the Developer Catalog.

In the Developer perspective of the web console, you can use the Helm page to:

  • Create Helm Releases and Repositories using the Create button.
  • Create, update, or delete a cluster-scoped or namespace-scoped Helm chart repository.
  • View the list of the existing Helm chart repositories in the Repositories tab, which can also be easily distinguished as either cluster scoped or namespace scoped.

You can use either the Developer perspective in the web console or the CLI to select and create a release from the Helm charts listed in the Developer Catalog. You can create Helm releases by installing Helm charts and see them in the Developer perspective of the web console.

Prerequisites

  • You have logged in to the web console and have switched to the Developer perspective.

Procedure

To create Helm releases from the Helm charts provided in the Developer Catalog:

  1. In the Developer perspective, navigate to the +Add view and select a project. Then click Helm Chart option to see all the Helm Charts in the Developer Catalog.
  2. Select a chart and read the description, README, and other details about the chart.

  3. Click Create.

    Figure 5.1. Helm charts in developer catalog

    odc helm chart devcatalog new
    View larger image
    odc helm chart devcatalog new

  4. In the Create Helm Release page:

    1. Enter a unique name for the release in the Release Name field.
    2. Select the required chart version from the Chart Version drop-down list.

    3. Configure your Helm chart by using the Form View or the YAML View.

      Note

      Where available, you can switch between the YAML View and Form View. The data is persisted when switching between the views.

    4. Click Create to create a Helm release. The web console displays the new release in the Topology view.

      If a Helm chart has release notes, the web console displays them.

      If a Helm chart creates workloads, the web console displays them on the Topology or Helm release details page. The workloads are DaemonSet, CronJob, Pod, Deployment, and DeploymentConfig.

    5. View the newly created Helm release in the Helm Releases page.

You can upgrade, rollback, or delete a Helm release by using the Actions button on the side panel or by right-clicking a Helm release.

5.3.2. Using Helm in the web terminal
Copy link

You can use Helm by Accessing the web terminal in the Developer perspective of the web console.

Procedure

  1. Create a new project: 

    $ oc new-project nodejs-ex-k
    Copy to Clipboard Toggle word wrap

  2. Download an example Node.js chart that contains OpenShift Dedicated objects: 

    $ git clone https://github.com/redhat-developer/redhat-helm-charts
    Copy to Clipboard Toggle word wrap

  3. Go to the directory with the sample chart: 

    $ cd redhat-helm-charts/alpha/nodejs-ex-k/
    Copy to Clipboard Toggle word wrap

  4. Edit the Chart.yaml file and add a description of your chart: 

    apiVersion: v2
    1 
    
name: nodejs-ex-k
    2 
    
description: A Helm chart for OpenShift
    3 
    
icon: https://static.redhat.com/libs/redhat/brand-assets/latest/corp/logo.svg
    4 
    
version: 0.2.1
    5
    Copy to Clipboard Toggle word wrap
    1
    The chart API version. It should be v2 for Helm charts that require at least Helm 3.
    2
    The name of your chart.
    3
    The description of your chart.
    4
    The URL to an image to be used as an icon.
    5
    The Version of your chart as per the Semantic Versioning (SemVer) 2.0.0 Specification.

  5. Verify that the chart is formatted properly: 

    $ helm lint
    Copy to Clipboard Toggle word wrap

    Example output

    [INFO] Chart.yaml: icon is recommended

1 chart(s) linted, 0 chart(s) failed
    Copy to Clipboard Toggle word wrap

  6. Navigate to the previous directory level: 

    $ cd ..
    Copy to Clipboard Toggle word wrap

  7. Install the chart: 

    $ helm install nodejs-chart nodejs-ex-k
    Copy to Clipboard Toggle word wrap

  8. Verify that the chart has installed successfully: 

    $ helm list
    Copy to Clipboard Toggle word wrap

    Example output

    NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
nodejs-chart nodejs-ex-k 1 2019-12-05 15:06:51.379134163 -0500 EST deployed nodejs-0.1.0  1.16.0
    Copy to Clipboard Toggle word wrap

You can filter Helm charts based on their certification level in the Developer Catalog.

Procedure

  1. In the Developer perspective, navigate to the +Add view and select a project.
  2. From the Developer Catalog tile, select the Helm Chart option to see all the Helm charts in the Developer Catalog.

  3. Use the filters to the left of the list of Helm charts to filter the required charts:

    • Use the Chart Repositories filter to filter charts provided by Red Hat Certification Charts or OpenShift Helm Charts.
    • Use the Source filter to filter charts sourced from Partners, Community, or Red Hat. Certified charts are indicated with the ( odc verified icon ) icon.
Note

The Source filter will not be visible when there is only one provider type.

You can now select the required chart and install it.

5.4. Working with Helm releases
Copy link

You can use the Developer perspective in the web console to update, rollback, or delete a Helm release.

5.4.1. Prerequisites
Copy link

  • You have logged in to the web console and have switched to the Developer perspective.

5.4.2. Upgrading a Helm release
Copy link

You can upgrade a Helm release to upgrade to a new chart version or update your release configuration.

Procedure

  1. In the Topology view, select the Helm release to see the side panel.
  2. Click Actions Upgrade Helm Release.
  3. In the Upgrade Helm Release page, select the Chart Version you want to upgrade to, and then click Upgrade to create another Helm release. The Helm Releases page displays the two revisions.

5.4.3. Rolling back a Helm release
Copy link

If a release fails, you can rollback the Helm release to a previous version.

Procedure

To rollback a release using the Helm view:

  1. In the Developer perspective, navigate to the Helm view to see the Helm Releases in the namespace.
  2. Click the Options menu kebab adjoining the listed release, and select Rollback.
  3. In the Rollback Helm Release page, select the Revision you want to rollback to and click Rollback.
  4. In the Helm Releases page, click on the chart to see the details and resources for that release.

  5. Go to the Revision History tab to see all the revisions for the chart.

    Figure 5.2. Helm revision history

    odc helm revision history
    View larger image
    odc helm revision history
  6. If required, you can further use the Options menu kebab adjoining a particular revision and select the revision to rollback to.

5.4.4. Deleting a Helm release
Copy link

Procedure

  1. In the Topology view, right-click the Helm release and select Delete Helm Release.
  2. In the confirmation prompt, enter the name of the chart and click Delete.
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat