10.2.2 Helm Charts

Helm is a package manager for Kubernetes. The Helm packaging format is called Charts or Helm Charts. Using Helm, you can deploy, configure, and upgrade Access Manager components on Kubernetes clusters. Helm provides this functionality through a command-line tool called Kubectl.

The Access Manager Helm chart defines several Kubernetes resources as a set. The default Access Manager chart contains a minimum of a deployment template and a service template. This reduces the number of Kubernetes commands that you need to run to create and configure resources.

The following table describes the files and directories of Helm:

File or Directory

Description

Helm Charts or Charts

A collection of YAML template files that describe the Kubernetes resources.

Chart.yaml

A YAML file that contains general information about the Access Manager chart such as chart name and version, version number, and search keywords.

values.yaml

A YAML file that contains the default Access Manager configuration values for the chart. As per your requirement, modify this file before installing Access Manager. See Configuring Ingress to configure the Ingress rules.

NOTE:Do not modify any other configuration file.

charts/

This directory that contains the charts of Access Manager components.

templates/

This directory that contains the following template files that are combined with configuration values and rendered into Kubernetes manifests:

  • _am-templates.tpl

  • _helpers.tpl

  • image-secret.yml

  • ingress-http-rule.yml

  • ingress-https-rule.yml

  • NOTES.txt

templates/NOTES.txt

A text file which prints to a user’s terminal when the user installs the chart. This file contains the following post-installation information:

  • Command to check the status of the components.

  • Command to retrieve the Administration Console URL.

  • Administration Console Service URL.

  • Identity Server Service URL.

  • Access Gateway Service URL.

NOTE:The service URLs of Administration Console, Identity Server, and Access Gateway will be displayed when Ingress is enabled.

To check the version of the Helm client installed on your machine, run command helm version.

To view the Kubernetes version running on the client and server, run command kubectl version.

For more information about Helm and Helm Charts, see Helm and Kubernetes.

Helm Upgrade

Access Manager 5.0 Service Pack 1 supports Helm chart version 1.0.1. You can check the version of the Helm client installed on your machine, by using the command helm version and then update to this version using the command helm upgrade. For more information, see Helm Version.