Quickstart Guide

The IBM Spectrum Scale CSI Operator runs within a Kubernetes cluster providing a means to deploy and manage the CSI plugin for spectrum scale. For more in depth documentation please refer to the README.

This operator should be used to deploy the CSI plugin.

The configuration process is as follows:

  1. Spectrum Scale GUI Setup
  2. Custom Resource Configuration

Spectrum Scale GUI Setup

NOTE: This step only needs to be preformed once per GUI.
WARNING: If your daemonset pods (driver pods) do not come up, generally this means you have a secret that has not been defined in the correct namespace.
  1. Ensure the Spectrum Scale GUI is running by pointing your browser to the IP hosting the GUI:

    https://user-images.githubusercontent.com/1195452/67230992-6d2d9700-f40c-11e9-96d5-3f0e5bcb2d9a.png

    If you do not see a login follow on screen instructions, or review the GUI Documentation

  2. Create a CsiAdmin group account on in the GUI (currently requires a CLI call):

    
    export USERNAME="SomeUser"
    export PASSWORD="SomePassword"
    /usr/lpp/mmfs/gui/cli/mkuser ${USERNAME} -p ${PASSWORD} -g CsiAdmin
    
  3. Create a Kubernetes secret for the CsiAdmin user:


export USERNAME_B64=$(echo $USERNAME | base64)
export PASSWORD_B64=$(echo $PASSWORD | base64)
export OPERATOR_NAMESPACE="ibm-spectrum-scale-csi-driver"  # Set this to the namespace you deploy the operator in.


cat << EOF > /tmp/csisecret.yaml
apiVersion: v1
data:
  password: ${PASSWORD_B64}
  username: ${USERNAME_B64}
kind: Secret
type: Opaque
metadata:
  name: csisecret    # This should be in your CSIScaleOperator definition
  namespace: ${OPERATOR_NAMESPACE} 
  labels:
    app.kubernetes.io/name: ibm-spectrum-scale-csi-operator # Used by the operator to detect changes, set on load of CR change if secret matches name in CR and namespace.
EOF


kubectl create -f /tmp/csisecret.yaml
rm -f /tmp/csisecret.yaml

Custom Resource Configuration

The bundled Custom Resource example represents the minimum settings needed to run the operator. If your environment needs more advanced settings (e.g. remote clusters, node mapping, etc.) please refer to the sample Custom Resource.