Skip to content

Commit 28fe152

Browse files
authored
[docs] Clarify NFS Server Configuration Requirements for Deckhouse Platform (#129)
Signed-off-by: Pavel Karpov <[email protected]>
1 parent 39a92ce commit 28fe152

File tree

2 files changed

+17
-14
lines changed

2 files changed

+17
-14
lines changed

docs/README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,18 @@ Creating a StorageClass for the CSI driver `nfs.csi.k8s.io` by the user is prohi
2626

2727
## System requirements and recommendations
2828

29+
{{< alert level="warning" >}}
30+
To use NFS as virtual disk storage in Deckhouse Virtualisation Platform, configure the NFS server with the `no_root_squash` option (see below).
31+
{{< /alert >}}
32+
2933
### Requirements
3034

3135
- Use stock kernels provided with [supported distributions](https://deckhouse.io/documentation/v1/supported_versions.html#linux);
32-
- Ensure the presence of a deployed and configured NFS server;
36+
- Ensure that the NFS server is correctly configured and running:
37+
- For DKP modules where StorageClass is used, it may be necessary to allow access to clients with root privileges. In Linux, this is implemented via the `no_root_squash` option, while on other systems (e.g., BSD or storage systems) a similar setting may have a different name;
38+
- For virtual disk storage in the [Deckhouse Virtualization Platform](https://deckhouse.io/products/virtualization-platform/documentation/), the `no_root_squash` option is mandatory!
3339
- To support RPC-with-TLS, enable `CONFIG_TLS` and `CONFIG_NET_HANDSHAKE` options in the Linux kernel.
3440

35-
{{< alert level="warning" >}}
36-
To use NFS as virtual disk storage in Deckhouse Virtualisation Platform, configure the NFS server with the no_root_squash option.
37-
{{< /alert >}}
38-
3941
### Recommendations
4042

4143
For module pods to restart when the `tlsParameters` parameter is changed in the module settings, the [pod-reloader](https://deckhouse.io/products/kubernetes-platform/documentation/v1/modules/pod-reloader) module must be enabled (enabled by default).

docs/README_RU.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,9 @@ description: "Модуль csi-nfs: общие концепции и полож
1111
При создании снапшотов NFS-томов важно понимать схему их создания и связанные ограничения. Мы рекомендуем по возможности избегать использования snapshots в csi-nfs:
1212

1313
1. CSI-драйвер создает снапшот на уровне NFS-сервера.
14-
2. Для этого используется tar, которой упаковывается содержимое тома, со всеми ограничениями, могущими возникнуть из-за этого
15-
3. **Перед созданием снапшота обязательно остановите рабочую нагрузку** (pods), использующую NFS-том
16-
4. NFS не обеспечивает атомарность операций на уровне файловой системы при создании снапшота
17-
14+
2. Для этого используется tar, которой упаковывается содержимое тома, со всеми ограничениями, могущими возникнуть из-за этого.
15+
3. **Перед созданием снапшота обязательно остановите рабочую нагрузку** (pods), использующую NFS-том.
16+
4. NFS не обеспечивает атомарность операций на уровне файловой системы при создании снапшота.
1817
{{< /alert >}}
1918

2019
{{< alert level="info" >}}
@@ -27,16 +26,18 @@ description: "Модуль csi-nfs: общие концепции и полож
2726

2827
## Системные требования и рекомендации
2928

29+
{{< alert level="warning" >}}
30+
Для работы NFS как хранилища виртуальных дисков в Deckhouse Virtualization Platform настройте NFS-сервер с опцией `no_root_squash` (см. ниже).
31+
{{< /alert >}}
32+
3033
### Требования
3134

3235
- Используйте стоковые ядра, поставляемые вместе с [поддерживаемыми дистрибутивами](https://deckhouse.ru/documentation/v1/supported_versions.html#linux);
33-
- Убедитесь в наличии развернутого и настроенного NFS-сервера;
36+
- Убедитесь, что NFS-сервер корректно настроен и запущен:
37+
- Для модулей DKP, в настройках которых используется StorageClass может потребоваться разрешить доступ клиентам с root-правами. В Linux это реализуется через опцию `no_root_squash`, а на других системах (например, BSD или СХД) аналогичная настройка может иметь иное название;
38+
- Для хранилища виртуальных дисков в [Deckhouse Virtualization Platform](https://deckhouse.ru/products/virtualization-platform/documentation/) опция `no_root_squash` обязательна!.
3439
- Для поддержки RPC-with-TLS включите в ядре Linux опции `CONFIG_TLS` и `CONFIG_NET_HANDSHAKE`.
3540

36-
{{< alert level="warning" >}}
37-
Для работы NFS как хранилища виртуальных дисков в Deckhouse Virtualization Platform настройте NFS-сервер с опцией no_root_squash.
38-
{{< /alert >}}
39-
4041
### Рекомендации
4142

4243
Чтобы поды модуля перезапускались при изменении параметра `tlsParameters` в настройках модуля, должен быть включен модуль [pod-reloader](https://deckhouse.ru/products/kubernetes-platform/documentation/v1/modules/pod-reloader) (включен по умолчанию).

0 commit comments

Comments
 (0)