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

[doc] update how to make a rsc default #220

Merged
merged 5 commits into from
Feb 20, 2025
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
3 changes: 0 additions & 3 deletions crds/doc-ru-replicatedstorageclass.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ spec:
properties:
spec:
properties:
isDefault:
description: |
Назначить ли дочерний StorageClass классом по умолчанию.
storagePool:
description: |
Имя Storage Pool в бэкенде LINSTOR.
Expand Down
15 changes: 13 additions & 2 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,18 @@ There are two options:

## How do I set the default StorageClass?

Set the `spec.IsDefault` field to `true` in the corresponding [ReplicatedStorageClass](./cr.html#replicatedstorageclass) custom resource.
Add corresponding StorageClass name to `spec.settings.defaultClusterStorageClass` of `ModuleConfig/global` config.

```shell
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: global
spec:
version: 2
settings:
defaultClusterStorageClass: 'default-fast'
```

## How do I add the existing LVM Volume Group or LVMThin pool?

Expand Down Expand Up @@ -284,7 +295,7 @@ Yes, this is the expected behavior. Currently, the `sds-replicated-volume` modul

## I am unable to update the fields in the ReplicatedStorageClass resource spec. Is this the expected behavior?

Yes, this is the expected behavior. Only the `isDefault` field is editable in the `spec`. All the other fields in the resource `spec` are made immutable.
Yes, this is the expected behavior. All `spec` fields of the resource made immutable.

## When you delete a ReplicatedStorageClass resource, its child StorageClass in Kubernetes is not deleted. What can I do in this case?

Expand Down
15 changes: 13 additions & 2 deletions docs/FAQ_RU.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,18 @@ description: Диагностика проблем LINSTOR. Когда след

## Как назначить StorageClass по умолчанию?

В соответствующем пользовательском ресурсе [ReplicatedStorageClass](./cr.html#replicatedstorageclass) в поле `spec.isDefault` указать `true`.
Добавить в имя соответствующего StorageClass в поле `spec.settings.defaultClusterStorageClass` для конфигурации `ModuleConfig/global`.

```shell
apiVersion: deckhouse.io/v1alpha1
kind: ModuleConfig
metadata:
name: global
spec:
version: 2
settings:
defaultClusterStorageClass: 'default-fast'
```

## Как добавить существующую LVM Volume Group или LVMThin-пул?

Expand Down Expand Up @@ -303,7 +314,7 @@ dmesg | grep 'Remote failed to finish a request within'

## Я не могу обновить поля в spec у ресурса ReplicatedStorageClass. Это ожидаемое поведение?

Да, поведение ожидаемое. В `spec` можно изменять только поле `isDefault`. Остальные поля в `spec` ресурса сделаны неизменяемыми.
Да, поведение ожидаемое. Все поля 'spec' ReplicatedStorageClass неизменяемы.

## При удалении ресурса ReplicatedStorageClass не удаляется его дочерний StorageClass в Kubernetes. Что делать?

Expand Down
4 changes: 2 additions & 2 deletions docs/USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,13 +131,13 @@ More examples with different usage scenarios and layouts [can be found here](./l

The `sds-replicated-volume-controller` will then analyze the user's ReplicatedStorageClass resource and create the corresponding Storage Class in Kubernetes.

> Please note that all fields of `spec` section of the ReplicatedStorageClass resource are **immutable** except for the `spec.isDefault` field.
> Please note that all fields of `spec` section of the ReplicatedStorageClass resource are **immutable**.

The `sds-replicated-volume-controller` will automatically keep the `status` field up to date to reflect the results of the ongoing operations.

#### Updating the ReplicatedStorageClass resource

Currently, the `sds-replicated-volume-controller` only supports changing the `isDefault` field. It is **not possible** to change other configuration parameters of the StorageClass created via the ReplicatedStorageClass resource.
It is currently **not possible** to change configuration parameters of the StorageClass created via the ReplicatedStorageClass resource.

#### Deleting the ReplicatedStorageClass resource

Expand Down
5 changes: 2 additions & 3 deletions docs/USAGE_RU.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,14 +126,13 @@ spec:

Результатом обработки ресурса ReplicatedStorageClass станет создание необходимого StorageClass в Kubernetes.

> Обратите внимание, что все поля, кроме поля `isDefault` в поле `spec` ресурса ReplicatedStorageClass, являются **неизменяемыми**.
> Обратите внимание, что все поля в `spec` ресурса ReplicatedStorageClass, являются **неизменяемыми**.

Поле `status` будет обновляться `sds-replicated-volume-controller'ом` для отображения информации о результатах проводимых операций.

#### Обновление ресурса ReplicatedStorageClass

`sds-replicated-volume-controller` в настоящий момент поддерживает только изменение поля `isDefault`. Поменять остальные параметры
StorageClass, созданного через ресурс ReplicatedStorageClass, на данный момент **невозможно**.
Поменять параметры StorageClass, созданного через ресурс ReplicatedStorageClass, на данный момент **невозможно**.

#### Удаление ресурса ReplicatedStorageClass

Expand Down
Loading