10.2 Basic Terminologies of Kubernetes

10.2.1 Kubernetes Keywords and Their Usage in Access Manager

The following table includes the basic terminologies that are used in the proceeding sections.

Term

Description

Container

An executable image that contains the Access Manager components (Administration Console, Identity Server, or Access Gateway) and all of its dependencies.

Pod

A pod consists of a set of running Access Manager containers that share the same networking and storage resources.

Worker Node or Node

A worker node is a virtual or physical machine where the Access Manager pods run.

Master Node

The master node controls and manages the worker nodes.

Kubernetes Cluster

A set of master and worker nodes to run the Access Manager pods.

Kubelet

An agent that runs on each node in the cluster to ensure that the containers are running in a pod.

Kube-scheduler

Scheduling means assigning a pod to a node. Kube-scheduler is the default Kubernetes scheduler that finds and assigns the optimal node for every newly created pod. It also assigns node for any other unscheduled pod. Kubelet runs the pods in a node. For more information, see Kubernetes Scheduler.

Namespace

A virtual Kubernetes cluster. For more information, see Namespaces.

Release

An instance of a chart that is running in a Kubernetes cluster. You can install the same chart multiple times to create many releases.

Ingress

Ingress manages the external access to the Access Manager services in a Kubernetes cluster. For more information, see Ingress.

Ingress Controller

Ingress controller makes the Ingress resources to work. For more information, see Ingress Controllers.

IngressClassName

From Access Manager 5.0 Service Pack 2 onwards this additional attribute can be used to configure the ingress controller provider.

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.