docs: migrate docs to GitHub repository #403
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,7 +3,7 @@ Helm chart for Deployment of WekaIO Container Storage Interface (CSI) plugin for | |
|
|
||
| [](https://opensource.org/licenses/Apache-2.0) | ||
| [](https://artifacthub.io/packages/search?repo=csi-wekafs) | ||
|    | ||
|
|
||
| ## Homepage | ||
| https://github.com/weka/csi-wekafs | ||
|
|
@@ -15,44 +15,40 @@ https://github.com/weka/csi-wekafs | |
| | WekaIO, Inc. | <[email protected]> | <https://weka.io> | | ||
|
|
||
| ## Pre-requisite | ||
| - **Kubernetes cluster**: Version 1.18 or later (version 1.19 or later is recommended). | ||
| - **Helm**: Helm v3 must be installed and properly configured. | ||
| - **WEKA system**: The WEKA system must be pre-configured, with the WEKA client installed and registered on each Kubernetes node within the cluster. | ||
|
|
||
| ## 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:** As of version 0.8.0, the WEKA CSI plugin supports installation on Kubernetes clusters with SELinux enabled. | ||
| > For more details, refer to the [SELinux Support & Installation Notes](https://github.com/weka/csi-wekafs/blob/master/selinux/README.md). | ||
|
|
||
| > **NOTE:** Starting with version 0.7.0, the WEKA CSI plugin adopts an API-based deployment model. | ||
| > This model requires API connectivity and the configuration of credential parameters within the Storage Class. | ||
| > | ||
| > Kubernetes does not support modifying the storage class of existing volumes. | ||
| > Therefore, the recommended upgrade process involves re-deploying new persistent volumes using the updated storage class format. | ||
| > | ||
| > To facilitate a smoother migration process, the legacySecretName parameter can be configured. | ||
| > This parameter binds existing legacy volumes to the Weka Cluster API, enabling volume expansion. | ||
|
|
||
|
|
||
| ## 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) | ||
|
|
||
|
There was a problem hiding this comment. Same should be done on README.md.gotmpl There was a problem hiding this comment. I've already removed the reference to the official doc from the README.md.gotml. |
||
| ## Values | ||
|
|
||
| | Key | Type | Default | Description | | ||
| |-----|------|---------|-------------| | ||
| | dynamicProvisionPath | string | `"csi-volumes"` | Directory in root of file system where dynamic volumes are provisioned | | ||
| | csiDriverName | string | `"csi.weka.io"` | Name of the driver (and provisioner) | | ||
| | csiDriverVersion | string | `"2.5.1-SNAPSHOT.44.0a35d77"` | CSI driver version | | ||
| | images.livenessprobesidecar | string | `"registry.k8s.io/sig-storage/livenessprobe:v2.14.0"` | CSI liveness probe sidecar image URL | | ||
| | images.attachersidecar | string | `"registry.k8s.io/sig-storage/csi-attacher:v4.7.0"` | CSI attacher sidecar image URL | | ||
| | images.provisionersidecar | string | `"registry.k8s.io/sig-storage/csi-provisioner:v5.1.0"` | CSI provisioner sidecar image URL | | ||
|
|
@@ -61,7 +57,7 @@ helm install csi-wekafsplugin csi-wekafs/csi-wekafsplugin --namespace csi-wekafs | |
| | images.snapshottersidecar | string | `"registry.k8s.io/sig-storage/csi-snapshotter:v8.1.0"` | CSI snapshotter sidecar image URL | | ||
| | images.nodeinfo | string | `"quay.io/weka.io/csi-wekafs"` | CSI nodeinfo sidecar image URL, used for reading node metadata | | ||
| | images.csidriver | string | `"quay.io/weka.io/csi-wekafs"` | CSI driver main image URL | | ||
| | images.csidriverTag | string | `"2.5.1-SNAPSHOT.44.0a35d77"` | CSI driver tag | | ||
| | imagePullSecret | string | `""` | image pull secret required for image download. Must have permissions to access all images above. Should be used in case of private registry that requires authentication | | ||
| | globalPluginTolerations | list | `[{"effect":"NoSchedule","key":"node-role.kubernetes.io/master","operator":"Exists"}]` | Tolerations for all CSI driver components | | ||
| | controllerPluginTolerations | list | `[{"effect":"NoSchedule","key":"node-role.kubernetes.io/master","operator":"Exists"}]` | Tolerations for CSI controller component only (by default same as global) | | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same should be done on README.md.gotmpl
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've removed the reference to the official doc.