From 371d79e05915bfd7c9eacd22c8a03be933321b9c Mon Sep 17 00:00:00 2001 From: Vitaliy Filippov Date: Sun, 5 Nov 2023 01:05:26 +0300 Subject: [PATCH] Document vitastor-csi features --- docs/installation/kubernetes.en.md | 13 ++++++++++++- docs/installation/kubernetes.ru.md | 13 ++++++++++++- 2 files changed, 24 insertions(+), 2 deletions(-) diff --git a/docs/installation/kubernetes.en.md b/docs/installation/kubernetes.en.md index 3641ee0b..0a6a166d 100644 --- a/docs/installation/kubernetes.en.md +++ b/docs/installation/kubernetes.en.md @@ -17,4 +17,15 @@ and apply all `NNN-*.yaml` manifests to your Kubernetes installation: for i in ./???-*.yaml; do kubectl apply -f $i; done ``` -After that you'll be able to create PersistentVolumes. See example in [csi/deploy/example-pvc.yaml](../../csi/deploy/example-pvc.yaml). +After that you'll be able to create PersistentVolumes. + +## Features + +Vitastor CSI supports: +- Kubernetes starting with 1.20 (or 1.17 for older vitastor-csi <= 1.1.0) +- Filesystem RWO (ReadWriteOnce) volumes. Example: [PVC](../../csi/deploy/example-pvc.yaml), [pod](../../csi/deploy/example-test-pod.yaml) +- Raw block RWX (ReadWriteMany) volumes. Example: [PVC](../../csi/deploy/example-pvc-block.yaml), [pod](../../csi/deploy/example-test-pod-block.yaml) +- Volume expansion +- Volume snapshots. Example: [snapshot class](../../csi/deploy/example-snapshot-class.yaml), [snapshot](../../csi/deploy/example-snapshot.yaml), [clone](../../csi/deploy/example-snapshot-clone.yaml) + +Remember that to use snapshots with CSI you also have to install [Snapshot Controller and CRDs](https://kubernetes-csi.github.io/docs/snapshot-controller.html#deployment). diff --git a/docs/installation/kubernetes.ru.md b/docs/installation/kubernetes.ru.md index 7795820e..8e83a08a 100644 --- a/docs/installation/kubernetes.ru.md +++ b/docs/installation/kubernetes.ru.md @@ -17,4 +17,15 @@ for i in ./???-*.yaml; do kubectl apply -f $i; done ``` -После этого вы сможете создавать PersistentVolume. Пример смотрите в файле [csi/deploy/example-pvc.yaml](../../csi/deploy/example-pvc.yaml). +После этого вы сможете создавать PersistentVolume. + +## Возможности + +CSI-плагин Vitastor поддерживает: +- Версии Kubernetes, начиная с 1.20 (или с 1.17 для более старых vitastor-csi <= 1.1.0) +- Файловые RWO (ReadWriteOnce) тома. Пример: [PVC](../../csi/deploy/example-pvc.yaml), [под](../../csi/deploy/example-test-pod.yaml) +- Сырые блочные RWX (ReadWriteMany) тома. Пример: [PVC](../../csi/deploy/example-pvc-block.yaml), [под](../../csi/deploy/example-test-pod-block.yaml) +- Расширение размера томов +- Снимки томов. Пример: [класс снимков](../../csi/deploy/example-snapshot-class.yaml), [снимок](../../csi/deploy/example-snapshot.yaml), [клон снимка](../../csi/deploy/example-snapshot-clone.yaml) + +Не забывайте, что для использования снимков нужно сначала установить [контроллер снимков и CRD](https://kubernetes-csi.github.io/docs/snapshot-controller.html#deployment).