Skip to content

Commit

Permalink
Add GL4F CSI driver beta (#400)
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Mattsson <[email protected]>
  • Loading branch information
datamattsson authored Sep 24, 2024
1 parent cc5c7aa commit 1b1c24a
Show file tree
Hide file tree
Showing 31 changed files with 5,334 additions and 1 deletion.
Binary file added docs/hpe-greenlake-file-csi-driver-1.0.0-beta.tgz
Binary file not shown.
38 changes: 37 additions & 1 deletion docs/index.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1375,4 +1375,40 @@ entries:
urls:
- hpe-flexvolume-driver-3.0.0.tgz
version: 3.0.0
generated: "2024-08-01T03:20:00.451286-07:00"
hpe-greenlake-file-csi-driver:
- annotations:
artifacthub.io/category: storage
artifacthub.io/containsSecurityUpdates: "false"
artifacthub.io/license: Apache-2.0
artifacthub.io/links: |
- name: Release Highlights
url: https://scod.hpedev.io/filex_csi_driver/index.html#latest_release
- name: Documentation
url: https://scod.hpedev.io/filex_csi_driver
- name: Chart Source
url: https://github.com/hpe-storage/co-deployments
artifacthub.io/prerelease: "true"
artifacthub.io/recommendations: |
- url: https://artifacthub.io/packages/helm/hpe-storage/hpe-csi-driver
apiVersion: v1
appVersion: 2.4.1
created: "2024-09-20T12:14:10.799353-07:00"
description: A Helm chart for installing the HPE GreenLake for File Storage CSI
Driver
digest: cccf4a390e28fca2651d9190c22be8691f353e17400566796d722a4518c7c465
home: https://hpe.com/storage/containers
icon: https://raw.githubusercontent.com/hpe-storage/co-deployments/master/docs/assets/hpedev.png
keywords:
- HPE
- Storage
- CSI
maintainers:
- email: [email protected]
name: datamattsson
name: hpe-greenlake-file-csi-driver
sources:
- https://github.com/hpe-storage/co-deployments
urls:
- hpe-greenlake-file-csi-driver-1.0.0-beta.tgz
version: 1.0.0-beta
generated: "2024-09-20T12:14:10.798873-07:00"
23 changes: 23 additions & 0 deletions helm/charts/hpe-greenlake-file-csi-driver/.helmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Patterns to ignore when building packages.
# This supports shell glob matching, relative path matching, and
# negation (prefixed with !). Only one pattern per line.
.DS_Store
# Common VCS dirs
.git/
.gitignore
.bzr/
.bzrignore
.hg/
.hgignore
.svn/
# Common backup files
*.swp
*.bak
*.tmp
*.orig
*~
# Various IDEs
.project
.idea/
*.tmproj
.vscode/
30 changes: 30 additions & 0 deletions helm/charts/hpe-greenlake-file-csi-driver/Chart.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
apiVersion: v1
version: "1.0.0-beta"
appVersion: "2.4.1"
annotations:
artifacthub.io/prerelease: "true"
artifacthub.io/containsSecurityUpdates: "false"
artifacthub.io/license: Apache-2.0
artifacthub.io/category: storage
artifacthub.io/links: |
- name: Release Highlights
url: https://scod.hpedev.io/filex_csi_driver/index.html#latest_release
- name: Documentation
url: https://scod.hpedev.io/filex_csi_driver
- name: Chart Source
url: https://github.com/hpe-storage/co-deployments
artifacthub.io/recommendations: |
- url: https://artifacthub.io/packages/helm/hpe-storage/hpe-csi-driver
description: A Helm chart for installing the HPE GreenLake for File Storage CSI Driver
icon: https://raw.githubusercontent.com/hpe-storage/co-deployments/master/docs/assets/hpedev.png
maintainers:
- name: datamattsson
email: [email protected]
sources:
- https://github.com/hpe-storage/co-deployments
name: hpe-greenlake-file-csi-driver
home: https://hpe.com/storage/containers
keywords:
- HPE
- Storage
- CSI
103 changes: 103 additions & 0 deletions helm/charts/hpe-greenlake-file-csi-driver/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
# HPE GreenLake for File Storage CSI Driver Helm chart

The [HPE GreenLake for File Storage CSI Driver](https://scod.hpedev.io/filex_csi_driver/index.html) leverages HPE GreenLake for File Storage to provide scalable and persistent storage for stateful and ephemeral applications running on Kubernetes.

## Release highlights

The HPE GreenLake for File Storage CSI Driver Helm chart is the primary delivery vehicle for the HPE GreenLake for File Storage CSI Driver.

- All resources for HPE CSI drivers are available on [HPE Storage Container Orchestrator Documentation](https://scod.hpedev.io/) (SCOD).
- Visit [the latest release](https://scod.hpedev.io/filex_csi_driver/index.html#latest_release) on SCOD to learn what's new in this chart.

## Prerequisites

- Most recent Kubernetes distributions are supported
- Recent Ubuntu, SLES or RHEL (and its derives) compute nodes connected to their respective official package repositories
- Helm 3 (Version >= 3.2.0 required)

Refer to [Compatibility & Support](https://scod.hpedev.io/filex_csi_driver/index.html#compatibility_and_support) for currently supported versions of Kubernetes and compute node operating systems.

## Configuration and installation

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

| Parameter | Description | Default |
|---------------------------|-----------------------------------------------------------------------|------------------|
| disableNodeConformance | Disable automatic installation of NFS utilities on the compute nodes. | false |
| kubeletRootDir | The kubelet root directory path. | /var/lib/kubelet |
| controller.labels | Additional labels for the CSI driver controller Pod. | {} |
| controller.nodeSelector | Node labels for the CSI driver controller Pod assignment. | {} |
| controller.affinity | Affinity rules for the CSI driver controller Pod. | {} |
| controller.tolerations | Node taints to tolerate for the CSI driver controller Pod. | [] |
| controller.resources | A resource block with requests and limits for controller containers. | From values.yaml |
| node.labels | Additional labels for CSI driver node Pods. | {} |
| node.nodeSelector | Node labels for the CSI driver node Pods assignment. | {} |
| node.affinity | Affinity rules for the CSI driver node Pods. | {} |
| node.tolerations | Node taints to tolerate for the CSI driver node Pods. | [] |
| node.resources | A resource block with requests and limits for node containers. | From values.yaml |
| images | Key/value pairs of CSI driver runtime images. | From values.yaml |
| imagePullPolicy | Image pull policy (`Always`, `IfNotPresent`, `Never`). | IfNotPresent |

`*` = Disabling node conformance and configuration may prevent the CSI driver from functioning properly. See the [manual node configuration](https://scod.hpedev.io/csi_driver/operations.html#manual_node_configuration) section on SCOD to understand the consequences.

It's recommended to create a [values.yaml](https://github.com/hpe-storage/co-deployments/blob/master/helm/values/hpe-greenlake-file-csi-driver) 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](https://github.com/hpe-storage/co-deployments/blob/master/helm/values/hpe-greenlake-file-csi-driver).

**Note:** The chart is installed with all components and features enabled using reasonable defaults if no tweaks are needed.

### Installing the chart

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

Add HPE storage helm repo:

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

Install the latest chart:

```
helm install --create-namespace -n hpe-storage my-hpe-greenlake-file-csi-driver hpe-storage/hpe-greenlake-file-csi-driver
```

**Note**: By default, the latest stable chart will be installed. If it's labeled with `prerelease` and a "beta" version tag, add `--version X.Y.Z-beta` to the command line to install a "beta" chart.

### Upgrading the chart

Refresh the Helm repository cache and upgrade.

```
helm repo update
helm upgrade -n hpe-storage my-hpe-greenlake-file-csi-driver hpe-storage/hpe-greenlake-file-csi-driver
```

#### Uninstalling the chart

To uninstall the `hpe-greenlake-file-csi-driver` chart:

```
helm uninstall hpe-greenlake-file-csi-driver -n hpe-storage
```

## 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 storage backend. Refer to the [HPE GreenLake for File Storage CSI Driver](https://scod.hpedev.io/filex_csi_driver/deployment.html#add_a_storage_backend) documentation on SCOD. Also, it's helpful to be familiar with [persistent storage concepts](https://kubernetes.io/docs/concepts/storage/volumes/) in Kubernetes prior to deploying stateful workloads.

## Support

The HPE GreenLake for File Storage CSI Driver Helm chart is fully supported by HPE.

Formal support statements for each HPE backend is [available on SCOD](https://scod.hpedev.io/legal/support). Use this facility for formal support of your HPE storage products, including the Helm chart.

## Community

Please file any issues, questions or feature requests you may have [here](https://github.com/hpe-storage/co-deployments/issues) (do not use this facility for support inquiries of your HPE storage product, see [SCOD](https://scod.hpedev.io/legal/support) for support). You may also join our Slack community to chat with HPE folks close to this project. We hang out in `#Alletra`, `#HPE-GreenLake-Data-Services`, and `#Kubernetes`. Sign up at [developer.hpe.com/slack-signup](https://developer.hpe.com/slack-signup) and login at [hpedev.slack.com](https://hpedev.slack.com/)

## 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](https://github.com/hpe-storage/co-deployments/blob/master/CONTRIBUTING.md)

## License

This is open source software licensed using the Apache License 2.0. Please see [LICENSE](https://github.com/hpe-storage/co-deployments/blob/master/LICENSE) for details.
Empty file.
52 changes: 52 additions & 0 deletions helm/charts/hpe-greenlake-file-csi-driver/templates/_helpers.tpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
{{/*
Expand the name of the chart.
*/}}
{{- define "hpe-greenlake-file-csi-driver.name" -}}
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
{{- end }}

{{/*
Create a default fully qualified app name.
We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
If release name contains chart name it will be used as a full name.
*/}}
{{- define "hpe-greenlake-file-csi-driver.fullname" -}}
{{- if .Values.fullnameOverride }}
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }}
{{- else }}
{{- $name := default .Chart.Name .Values.nameOverride }}
{{- if contains $name .Release.Name }}
{{- .Release.Name | trunc 63 | trimSuffix "-" }}
{{- else }}
{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }}
{{- end }}
{{- end }}
{{- end }}

{{/*
Create chart name and version as used by the chart label.
*/}}
{{- define "hpe-greenlake-file-csi-driver.chart" -}}
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
{{- end }}

{{/*
Common labels
*/}}
{{- define "hpe-greenlake-file-csi-driver.labels" -}}
helm.sh/chart: {{ include "hpe-greenlake-file-csi-driver.chart" . }}
{{ include "hpe-greenlake-file-csi-driver.selectorLabels" . }}
{{- if .Chart.AppVersion }}
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
{{- end }}
app.kubernetes.io/managed-by: {{ .Release.Service }}
{{- end }}

{{/*
Selector labels
*/}}
{{- define "hpe-greenlake-file-csi-driver.selectorLabels" -}}
app.kubernetes.io/name: {{ include "hpe-greenlake-file-csi-driver.name" . }}
app.kubernetes.io/instance: {{ .Release.Name }}
{{- end }}

Loading

0 comments on commit 1b1c24a

Please sign in to comment.