aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorchrislu <chris.lu@gmail.com>2024-06-22 07:33:08 -0700
committerchrislu <chris.lu@gmail.com>2024-06-22 07:33:08 -0700
commit84b0d756beba54f3b7384c1eea800551e6e3ac8b (patch)
treee9c5b50e3e328a33a27a370c5660fbba36bfcdc1 /README.md
parentbf957fdf70400c276a862b44f0d74a06a2108d64 (diff)
downloadseaweedfs-csi-driver-84b0d756beba54f3b7384c1eea800551e6e3ac8b.tar.xz
seaweedfs-csi-driver-84b0d756beba54f3b7384c1eea800551e6e3ac8b.zip
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 1 insertions, 31 deletions
diff --git a/README.md b/README.md
index 3fe4394..4207de0 100644
--- a/README.md
+++ b/README.md
@@ -51,8 +51,6 @@ git clone https://github.com/seaweedfs/seaweedfs-csi-driver.git
3. Apply the container storage interface for SeaweedFS for your cluster. Use the '-pre-1.17' version for any cluster pre kubernetes version 1.17.
-<br>
-
### To generate an up to date manifest from the helm chart, do:
```
@@ -75,8 +73,6 @@ $ kubectl apply -f deploy/kubernetes/seaweedfs-csi.yaml
$ kubectl get po -n kube-system
```
-<br>
-
### Uninstall
```
@@ -85,8 +81,6 @@ $ kubectl delete -f deploy/kubernetes/sample-seaweedfs-pvc.yaml
$ kubectl delete -f deploy/kubernetes/seaweedfs-csi.yaml
```
-<br>
-
## Kubernetes (helm)
### Install
@@ -100,16 +94,12 @@ git clone https://github.com/seaweedfs/seaweedfs-csi-driver.git
helm install --set seaweedfsFiler=<filerHost:port> seaweedfs-csi-driver ./seaweedfs-csi-driver/deploy/helm/seaweedfs-csi-driver
```
-<br>
-
### Uninstall
```bash
helm uninstall seaweedfs-csi-driver
```
-<br>
-
# Update (Safe rollout)
Updating seaweed-csi-driver DaemonSet (DS) will break processeses who implement fuse mount:
newly created pods will not remount net device.
@@ -122,8 +112,6 @@ For safe update set `node.updateStrategy.type: OnDelete` for manual update. Step
4. delete DS pod on node
5. uncordon or remove taint on node
6. repeat all steps on [all nodes]
-
-<br>
# Testing
@@ -144,8 +132,6 @@ $ kubectl apply -f deploy/kubernetes/sample-busybox-pod.yaml
$ kubectl exec my-csi-app -- df -h
```
-<br>
-
# Static and dynamic provisioning
By default, driver will create separate folder (`/buckets/<volume-id>`) and will use separate collection (`volume-id`)
@@ -207,8 +193,6 @@ spec:
storage: 1Gi
```
-<br>
-
# DataLocality
DataLocality (inspired by [Longhorn](https://longhorn.io/docs/latest/high-availability/data-locality/)) allows instructing the storage-driver which volume-locations will be used or preferred in Pods to read & write.
@@ -216,8 +200,6 @@ DataLocality (inspired by [Longhorn](https://longhorn.io/docs/latest/high-availa
It auto-sets mount-options based on the location a pod is scheduled in and the locality-option wanted.
The option can be set and overridden in *Driver*, *StorageClass* and *PersistentVolume*.
-<br>
-
## Setup
Change the type of locality
@@ -230,27 +212,19 @@ PersistentVolume | `spec.csi.volumeAttributes.dataLocality`
Driver < StorageClass < PersistentVolume
-<br>
-
## Available options
Option | Effect
----------------------- | ------
-`none`* | Changes nothing
+`none` (default) | Changes nothing
`write_preferLocalDc` | Sets the `DataCenter`-mount-option to the current Node-DataCenter, making writes local and allowing reads to occur wherever read data is stored. [More Details](#`write_preferLocalDc`)
-\* Default
-
-<br>
-
## Requirements
Volume-Servers and the CSI-Driver-Node need to have the locality-option `DataCenter` correctly set (currently only this option is required).
This can be done manually (although quite tedious) or injected by the Container-Orchestration.
-<br>
-
### Automatic injection
**Kubernetes**
@@ -265,12 +239,8 @@ You can activate it in the Helm-Chart `values.yaml` -> `node.injectTopologyInfoF
It is recommended to use [well-known labels](https://kubernetes.io/docs/reference/labels-annotations-taints/#topologykubernetesioregion) to avoid confusion.
-<br>
-
# License
[Apache v2 license](https://www.apache.org/licenses/LICENSE-2.0)
-<br>
-
# Code of conduct
Participation in this project is governed by [Kubernetes/CNCF code of conduct](https://github.com/kubernetes/community/blob/master/code-of-conduct.md)