Installer

Container Storage Modules (CSM) for Observability Installer

Starting with Container Storage Module 1.12, all deployments will use images from quay.io by default. New release images will be available on Docker Hub until CSM 1.14 (May 2025), and existing releases will remain on Docker Hub.

CSM for Observability Installer

The installer bootstraps Helm for a simplified and robust deployment by:

  • Checking if Container Storage Modules for Observability is installed
  • Verifying Kubernetes/OpenShift and Helm versions
  • Adding and refreshing the Dell Helm chart repository
  • Creating the CSM namespace and copying secrets
  • Installing CertManager CRDs and the Container Storage Modules Helm chart
  • Waiting for CSM pods to be ready

If Authorization is enabled for CSI drivers in the same Kubernetes cluster:

  • Verifies the karavictl binary is available.
  • Verifies the appropriate Secrets and ConfigMap exist in the CSI driver namespace.
  • Updates the CSM Observability deployment to use the existing Authorization instance if not already enabled.

Prerequisites

  • Helm 3.x
  • The deployment of one or more supported Dell CSI drivers

Online Installer

Follow the instructions below to install Container Storage Module Observability in an environment that has an Internet connection and is capable of downloading the required Helm chart and Docker images. The installer expects CSI drivers are using the default secret and configmap names.

Dependencies

A Linux-based system, with Internet access, will be used to execute the script to install Container Storage Modules Observability into a Kubernetes/Openshift environment that also has Internet access.

Dependency Usage
kubectl kubectl will be used to verify the Kubernetes/OpenShift environment
helm helm will be used to install the Container Storage Module Observability helm chart
jq jq will be used to parse the CContainer Storage Module Authorization configuration file during installation

Installer Usage 

./karavi-observability-install.sh --help

Note: Container Storage Module for Authorization currently does not support the Observability module for PowerStore. Therefore setting enable-authorization is not supported in this case.

Executing the Installer

To perform an online installation of Container Storage Module Observability, the following steps should be performed:

  1. Clone the GitHub repository:

    git clone https://github.com/dell/karavi-observability.git

  2. Change to the installer directory:

    cd karavi-observability/installer

  3. Execute the installation script. The following example will install Container Storage Module Observability into the CSM namespace.

    A sample values.yaml file is located here. This can be copied into a file named myvalues.yaml and modified accordingly for the installer command below. Configuration options are outlined in the Helm chart deployment section.

    Note:

  • The default values.yaml deploys the CSM for Observability Topology service.
  • For CSI PowerFlex with Authorization, configure karaviMetricsPowerflex.authorization in myvalues.yaml.
  • For CSI PowerScale with Authorization, configure karaviMetricsPowerscale.authorization in myvalues.yaml.
  • For CSI PowerMax with Authorization, configure karaviMetricsPowerMax.authorization in myvalues.yaml

```bash

./karavi-observability-install.sh install --namespace [CSM_NAMESPACE] --values myvalues.yaml
```
```
---------------------------------------------------------------------------------
> Installing Karavi Observability in namespace karavi on 1.27
---------------------------------------------------------------------------------
|
|- Karavi Observability is not installed                            Success
|
|- Karavi Authorization will be enabled during installation
|
|- Verifying Kubernetes versions
  |
  |--> Verifying minimum Kubernetes version                         Success
  |
  |--> Verifying maximum Kubernetes version                         Success
|
|- Verifying helm version                                           Success
|
|- Configure helm chart repository
  |
  |--> Adding helm repository https://dell.github.io/helm-charts    Success
  |
  |--> Updating helm repositories                                   Success
|
|- Creating namespace karavi                                        Success
|
|- CSI Driver for PowerFlex is installed                            Success
|
|- Copying Secret from vxflexos to karavi                           Success
|
|- CSI Driver for PowerStore is installed                           Success
|
|- Copying Secret from powerstore to karavi                         Success
|
|- CSI Driver for PowerScale is installed                           Success
|
|- Copying Secret from isilon to karavi                             Success
|
|- CSI Driver for PowerMax is installed                             Success
|
|- Copying ConfigMap from powermax to karavi                        Success
|
|- Copying Secret from powermax to karavi                           Success
|
|- Installing CertManager CRDs                                      Success
|
|- Enabling Karavi Authorization for Karavi Observability
  |
  |--> Copying ConfigMap from vxflexos to karavi                    Success
  |
  |--> Copying Karavi Authorization Secrets from vxflexos to karavi Success
  |
  |--> Copying ConfigMap from isilon to karavi                      Success
  |
  |--> Copying Karavi Authorization Secrets from isilon to karavi   Success
  |
  |--> Copying ConfigMap from powermax to karavi                    Success
  |
  |--> Copying Karavi Authorization Secrets from powermax to karavi Success
|
|- Installing Karavi Observability helm chart                       Success
|
|- Waiting for pods in namespace karavi to be ready                 Success
```