Skip to content

Commit 3cd04a4

Browse files
authored
[docs] update docs about volume cleanup and quickstart guide (#133)
Signed-off-by: v.oleynikov <[email protected]>
1 parent 707b841 commit 3cd04a4

File tree

3 files changed

+20
-0
lines changed

3 files changed

+20
-0
lines changed
File renamed without changes.

docs/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,15 @@ spec:
9393
nfsVersion: "4.1"
9494
reclaimPolicy: Delete
9595
volumeBindingMode: WaitForFirstConsumer
96+
workloadNodes:
97+
nodeSelector:
98+
matchLabels:
99+
storage: "true"
96100
EOF
97101
```
98102

103+
Note that the CSI driver control pods are placed on cluster nodes according to the workloadnodes parameters of all NFSStorageClass. If they are missing, the module workload will not be placed!
104+
99105
A directory `<directory from share>/<PV name>` will be created for each PV.
100106

101107
### Checking module health
@@ -104,6 +110,10 @@ You can verify the functionality of the module using the instructions [in FAQ](.
104110

105111
### Selects the method to clean the volume before deleting the PV
106112

113+
{{< alert level="warning" >}}
114+
**Volume cleanup functionality is only available in commercial editions of Deckhouse.**
115+
{{< /alert >}}
116+
107117
Files with user data may remain on the volume to be deleted. These files will be deleted and will not be accessible to other users via NFS.
108118

109119
However, the deleted files' data may be available to other clients if the server grants block-level access to its storage.

docs/README_RU.md renamed to docs/README.ru.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,15 @@ spec:
9393
nfsVersion: "4.1"
9494
reclaimPolicy: Delete
9595
volumeBindingMode: WaitForFirstConsumer
96+
workloadNodes:
97+
nodeSelector:
98+
matchLabels:
99+
storage: "true"
96100
EOF
97101
```
98102

103+
Обратите внимание, что управляющие pod csi-драйвера размещаются на узлах кластера согласно параметрам workloadnodes всех NFSStorageClass. При их отсутствии полезная нагрузка модуля размещена не будет!
104+
99105
Для каждого PV будет создаваться каталог `<директория из share>/<имя PV>`.
100106

101107
### Проверка работоспособности модуля
@@ -104,6 +110,10 @@ EOF
104110

105111
### Выбор метода очистки тома перед удалением PV
106112

113+
{{< alert level="warning" >}}
114+
**Функционал очистки тома доступен только в коммерческих редакциях Deckhouse.**
115+
{{< /alert >}}
116+
107117
На удаляемом томе могут остаться файлы с пользовательскими данными. Эти файлы будут удалены и не будут доступны другим пользователям через NFS.
108118

109119
Однако данные удаленных файлов могут оказаться доступными другим клиентам, если сервер предоставит доступ к своему хранилищу на уровне блочных устройств.

0 commit comments

Comments
 (0)