rancher-partner-charts/charts/hpe-csi-driver
actions 37d594af16 Generated changes 2021-02-25 22:46:38 +00:00
..
crds Generated changes 2021-02-25 22:46:38 +00:00
files Generated changes 2020-09-25 22:06:59 +00:00
templates Generated changes 2021-02-25 22:46:38 +00:00
Chart.yaml Generated changes 2021-02-25 22:46:38 +00:00
README.md Generated changes 2021-02-25 22:46:38 +00:00
app-readme.md Generated changes 2020-09-25 22:06:59 +00:00
questions.yml Generated changes 2021-02-25 22:46:38 +00:00
values.yaml Generated changes 2021-02-25 22:46:38 +00:00

README.md

HPE CSI Driver for Kubernetes Helm chart

The HPE CSI Driver for Kubernetes leverages HPE storage platforms to provide scalable and persistent storage for stateful applications.

Prerequisites

  • Upstream Kubernetes version >= 1.15
  • Most Kubernetes distributions are supported
  • Recent Ubuntu, SLES, CentOS or RHEL compute nodes connected to their respective official package repositories
  • Helm 3 (Version >= 3.2.0 required)

Depending on which Container Storage Provider (CSP) is being used, other prerequisites and requirements may apply, such as storage platform OS and features.

Configuration and installation

The following table lists the configurable parameters of the HPE-CSI chart and their default values.

Parameter Description Default
logLevel Log level. Can be one of info, debug, trace, warn and error. info
imagePullPolicy Image pull policy (Always, IfNotPresent, Never). IfNotPresent
disableNodeConformance Disable automatic installation of iSCSI/Multipath Packages. false
iscsi.chapUser Username for iSCSI CHAP authentication. ""
iscsi.chapPassword Password for iSCSI CHAP authentication. ""
registry Registry to pull HPE CSI Driver container images from. quay.io

It's recommended to create a values.yaml file from the corresponding release of the chart and edit it to fit the environment the chart is being deployed to. Download and edit a sample file.

These are the bare minimum required parameters for a successful deployment to an iSCSI environment if CHAP authentication is required.

iscsi:
  chapUser: "<username>"
  chapPassword: "<password>"

Tweak any additional parameters to suit the environment or as prescribed by HPE.

Installing the chart

To install the chart with the name my-hpe-csi-driver:

Add HPE helm repo:

helm repo add hpe-storage https://hpe-storage.github.io/co-deployments/
helm repo update

Install the latest chart:

kubectl create ns hpe-storage
helm install my-hpe-csi-driver hpe-storage/hpe-csi-driver -n hpe-storage -f myvalues.yaml

Note: values.yaml is optional if no parameters are overridden from defaults.

Upgrading the chart

Due to the helm limitation to not support upgrade of CRDs between different chart versions, hpe-csi-driver helm chart upgrade is not supported. Our recommendation is to uninstall the existing chart and install the chart with the desired version. CRDs will be preserved between uninstall and install.

Uninstalling the chart

To uninstall the my-hpe-csi-driver chart:

helm uninstall my-hpe-csi-driver -n hpe-storage

Note: Due to a limitation in Helm, CRDs are not deleted as part of the chart uninstall.

Alternative install method

In some cases it's more practical to provide the local configuration via the helm CLI directly. Specify each parameter using the --set key=value[,key=value] argument to helm install. These will take precedence over entries in values.yaml. For example:

helm install my-hpe-csi-driver hpe-storage/hpe-csi-driver -n hpe-storage \
  --set iscsi.chapUsername=admin \
  --set iscsi.chapPassword=xxxxxxxx

Using persistent storage with Kubernetes

Enable dynamic provisioning of persistent storage by creating a StorageClass API object that references a Secret which maps to a supported HPE primary storage backend. Refer to the HPE CSI Driver for Kubernetes documentation on HPE Storage Container Orchestration Documentation. Also, it's helpful to be familiar with persistent storage concepts in Kubernetes prior to deploying stateful workloads.

Support

The HPE CSI Driver for Kubernetes Helm chart is covered by your HPE support contract. Please file any issues, questions or feature requests here or contact HPE through the regular support channels. You may also join our Slack community to chat with HPE folks close to this project. We hang out in #NimbleStorage, #3par-primera and #Kubernetes at hpedev.slack.com, sign up here: slack.hpedev.io.

Contributing

We value all feedback and contributions. If you find any issues or want to contribute, please feel free to open an issue or file a PR. More details in CONTRIBUTING.md

License

This is open source software licensed using the Apache License 2.0. Please see LICENSE for details.