1. Documentation
    2. history bug_report picture_as_pdf
×

Configuring custom Helm chart repositories

edit

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.

edit

Creating Helm releases using the Developer perspective

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.

    odc helm chart devcatalog new
    Figure 1. Helm charts in developer catalog

  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.

      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.

edit

Using Helm in the web terminal

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

edit

Creating a custom Helm chart on Red Hat OpenShift Service on AWS

Procedure

  1. Create a new project:

    $ oc new-project nodejs-ex-k

  2. Download an example Node.js chart that contains Red Hat OpenShift Service on AWS objects:

    $ git clone https://github.com/redhat-developer/redhat-helm-charts

  3. Go to the directory with the sample chart:

    $ cd redhat-helm-charts/alpha/nodejs-ex-k/

  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)
    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
    Example output
    [INFO] Chart.yaml: icon is recommended

1 chart(s) linted, 0 chart(s) failed

  6. Navigate to the previous directory level:

    $ cd ..

  7. Install the chart:

    $ helm install nodejs-chart nodejs-ex-k

  8. Verify that the chart has installed successfully:

    $ helm list
    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
edit

Filtering Helm Charts by their certification level

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.

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

You can now select the required chart and install it.