Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs #5

Merged
merged 2 commits into from
May 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "The csi-nfs module: FAQ"
description: CSI NFS module FAQ
---

## Is it possible to change the parameters of an NFS server for already created PVs?

No, the connection data to the NFS server is stored directly in the PV manifest and cannot be changed. Changing the Storage Class also does not affect the connection settings in already existing PVs.
8 changes: 8 additions & 0 deletions docs/FAQ_RU.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "Модуль csi-nfs: FAQ"
description: FAQ по модулю CSI NFS
---

## Возможно ли изменение параметров NFS-сервера уже созданных PV?

Нет, данные для подключения к NFS-серверу сохраняются непосредственно в манифесте PV, и не подлежат изменению. Изменение Storage Class также не повлечет изменений настроек подключения в уже существующих PV.
43 changes: 43 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: "The csi-nfs module"
description: "The csi-nfs module: General Concepts and Principles."
moduleStatus: experimental
---

This module provides CSI that manages volumes based on `NFS`.

> **Caution!** The user is not allowed to create a `StorageClass` for the `nfs.csi.k8s.io` CSI driver.

## Quickstart guide

Note that all commands must be run on a machine that has administrator access to the Kubernetes API.

### Enabling modules

- Enable the `csi-nfs` module. This will result in the following actions across all cluster nodes:
- registration of the CSI driver;
- launch of service pods for the `csi-nfs` components.

```shell
kubectl apply -f - <<EOF
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: csi-nfs
spec:
enabled: true
version: 1
EOF
```

- Wait for the module to become `Ready`.

```shell
kubectl get mc csi-nfs -w
```

- Make sure that all pods in `d8-csi-nfs` namespaces are `Running` or `Completed` and are running on all nodes.

```shell
kubectl -n d8-csi-nfs get pod -owide -w
```
43 changes: 43 additions & 0 deletions docs/README_RU.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: "Модуль csi-nfs"
description: "Модуль csi-nfs: общие концепции и положения."
moduleStatus: experimental
---

Модуль предоставляет CSI для управления томамим на основе `NFS`.

> **Внимание!** Создание `StorageClass` для CSI-драйвера `nfs.csi.k8s.io` пользователем запрещено.

## Быстрый старт

Все команды следует выполнять на машине, имеющей доступ к API Kubernetes с правами администратора.

### Включение модулей

- Включить модуль `csi-nfs`. Это приведет к тому, что на всех узлах кластера будет:
- зарегистрирован CSI драйвер;
- запущены служебные поды компонентов `csi-nfs`.

```shell
kubectl apply -f - <<EOF
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: csi-nfs
spec:
enabled: true
version: 1
EOF
```

- Дождаться, когда модуль перейдет в состояние `Ready`.

```shell
kubectl get mc csi-nfs -w
```

- Проверить, что в namespace `d8-csi-nfs` все поды в состоянии `Running` или `Completed` и запущены на всех узлах.

```shell
kubectl -n d8-csi-nfs get pod -owide -w
```