Chapter 4. Helm CLI

Procedure

1. Create a new project:

   $ oc new-project mysql

   Copy to Clipboard Toggle word wrap

2. Add a repository of Helm charts to your local Helm client:

   $ helm repo add stable https://kubernetes-charts.storage.googleapis.com/

   Copy to Clipboard Toggle word wrap

   Example output

   "stable" has been added to your repositories

   Copy to Clipboard Toggle word wrap

3. Update the repository:

   $ helm repo update

   Copy to Clipboard Toggle word wrap

4. Install an example MySQL chart:

   $ helm install example-mysql stable/mysql

   Copy to Clipboard Toggle word wrap

5. 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
   example-mysql mysql 1 2019-12-05 15:06:51.379134163 -0500 EST deployed mysql-1.5.0 5.7.27

   Copy to Clipboard Toggle word wrap

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 Container Platform 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

   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. 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

Procedure

1. To add a new Helm Chart Repository, you must add the Helm Chart Repository custom resource (CR) to your cluster.

   Sample Helm Chart Repository CR

   apiVersion: helm.openshift.io/v1beta1
   kind: HelmChartRepository
   metadata:
     name: <name>
   spec:
    # optional name that might be used by console
    # name: <chart-display-name>
     connectionConfig:
       url: <helm-chart-repository-url>

   Copy to Clipboard Toggle word wrap

   For example, to add an Azure sample chart repository, run:

   $ cat <<EOF | oc apply -f -
   apiVersion: helm.openshift.io/v1beta1
   kind: HelmChartRepository
   metadata:
     name: azure-sample-repo
   spec:
     name: azure-sample-repo
     connectionConfig:
       url: https://raw.githubusercontent.com/Azure-Samples/helm-charts/master/docs
   EOF

   Copy to Clipboard Toggle word wrap
2. Navigate to the Developer Catalog in the web console to verify that the helm charts from the Azure chart repository are displayed.

1. In the openshift-config namespace, create a ConfigMap object with a custom CA certificate in PEM encoded format, and store it under the ca-bundle.crt key within the config map:

   $ oc create configmap helm-ca-cert \
   --from-file=ca-bundle.crt=/path/to/certs/ca.crt \
   -n openshift-config

   Copy to Clipboard Toggle word wrap

2. In the openshift-config namespace, create a Secret object to add the client TLS configurations:

   $ oc create secret generic helm-tls-configs \
   --from-file=tls.crt=/path/to/certs/client.crt \
   --from-file=tls.key=/path/to/certs//client.key \
   -n openshift-config

   Copy to Clipboard Toggle word wrap

   Note that the client certificate and key must be in PEM encoded format and stored under the keys tls.crt and tls.key, respectively.

3. Add the Helm repository as follows:

   $ cat <<EOF | oc apply -f -
   apiVersion: helm.openshift.io/v1beta1
   kind: HelmChartRepository
   metadata:
     name: <helm-repository>
   spec:
     name: <helm-repository>
     connectionConfig:
       url: <URL for the Helm repository>
       tlsConfig:
           name: helm-tls-configs
       ca:
   	name: helm-ca-cert
   EOF

   Copy to Clipboard Toggle word wrap

   The ConfigMap and Secret are consumed in the HelmChartRepository CR using the tlsConfig and ca fields. These certificates are used to connect to the Helm repository URL.

4. By default, all authenticated users have access to all configured charts. However, for chart repositories where certificates are needed, you must provide users with read access to the helm-ca-cert config map and helm-tls-configs secret in the openshift-config namespace, as follows:

   $ cat <<EOF | kubectl apply -f -
   apiVersion: rbac.authorization.k8s.io/v1
   kind: Role
   metadata:
     namespace: openshift-config
     name: helm-chartrepos-tls-conf-viewer
   rules:
   - apiGroups: [""]
     resources: ["configmaps"]
     resourceNames: ["helm-ca-cert"]
     verbs: ["get"]
   - apiGroups: [""]
     resources: ["secrets"]
     resourceNames: ["helm-tls-configs"]
     verbs: ["get"]
   ---
   kind: RoleBinding
   apiVersion: rbac.authorization.k8s.io/v1
   metadata:
     namespace: openshift-config
     name: helm-chartrepos-tls-conf-viewer
   subjects:
     - kind: Group
       apiGroup: rbac.authorization.k8s.io
       name: 'system:authenticated'
   roleRef:
     apiGroup: rbac.authorization.k8s.io
     kind: Role
     name: helm-chartrepos-tls-conf-viewer
   EOF

   Copy to Clipboard Toggle word wrap