44 lines
2.3 KiB
Plaintext
44 lines
2.3 KiB
Plaintext
# CSI WekaFS Driver
|
|
[](https://opensource.org/licenses/Apache-2.0)
|
|
[](https://artifacthub.io/packages/search?repo=csi-wekafs)
|
|
|
|
This repository hosts the CSI WekaFS driver and all of its build and dependent configuration files to deploy the driver.
|
|
|
|
## Pre-requisite
|
|
- Kubernetes cluster of version 1.18 and up, 1.19 and up recommended
|
|
- Helm v3 must be installed and configured properly
|
|
- Weka system pre-configured and Weka client installed and registered in cluster for each Kubernetes node
|
|
|
|
## Deployment
|
|
```shell
|
|
helm repo add csi-wekafs https://weka.github.io/csi-wekafs
|
|
helm install csi-wekafsplugin csi-wekafs/csi-wekafsplugin --namespace csi-wekafsplugin --create-namespace [--set selinuxSupport=<off | mixed | enforced>]
|
|
```
|
|
|
|
> **NOTE:** Since version 0.8.0, Weka CSI plugin supports installation on SELinux-enabled Kubernetes clusters
|
|
> Refer to [SELinux Support & Installation Notes](https://github.com/weka/csi-wekafs/blob/master/selinux/README.md) for additional information
|
|
|
|
> **NOTE:** Since version 0.7.0, Weka CSI plugin transitions to API-based deployment model which requires API
|
|
> connectivity and credentials parameters to be set in Storage Class.
|
|
>
|
|
> Kubernetes does not allow storage class modification for existing volumes, hence the
|
|
> recommended upgrade process is re-deploying new persistent volumes based on new storage class format.
|
|
>
|
|
> However, for sake of more convenient migration, a `legacySecretName` parameter can be set that will
|
|
> bind existing legacy volumes to a Weka cluster API and allow volume expansion.
|
|
>
|
|
> For further information, refer [Official Weka CSI Plugin documentation](https://docs.weka.io/appendix/weka-csi-plugin)
|
|
|
|
## Usage
|
|
- [Deploy an Example application](https://github.com/weka/csi-wekafs/blob/master/docs/usage.md)
|
|
- [SELinux Support & Installation Notes](https://github.com/weka/csi-wekafs/blob/master/selinux/README.md)
|
|
|
|
## Additional Documentation
|
|
- [Official Weka CSI Plugin documentation](https://docs.weka.io/appendix/weka-csi-plugin)
|
|
|
|
|
|
{{ template "chart.requirementsSection" . }}
|
|
|
|
{{ template "chart.valuesSection" . }}
|
|
|
|
{{ template "helm-docs.versionFooter" . }} |