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

docs: update descriptions in CRDs #613

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
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
139 changes: 65 additions & 74 deletions crds/clustervirtualimages.yaml

Large diffs are not rendered by default.

89 changes: 45 additions & 44 deletions crds/doc-ru-clustervirtualimages.yaml

Large diffs are not rendered by default.

120 changes: 61 additions & 59 deletions crds/doc-ru-virtualdisks.yaml

Large diffs are not rendered by default.

26 changes: 13 additions & 13 deletions crds/doc-ru-virtualdisksnapshots.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ spec:
description: |
Предоставляет ресурс для создания снимков существующих виртуальных дисков, которые могут быть использованы в качестве источников данных для создания новых виртуальных дисков.

В процессе выполнения автоматически создается ресурс `VolumeSnapshot`.
В процессе выполнения автоматически создаётся ресурс VolumeSnapshot.
properties:
spec:
properties:
Expand All @@ -20,27 +20,27 @@ spec:
description: |
Создавать снимок диска подключённой виртуальной машины только в том случае, если возможно заморозить её через агента.

Если значение установлено в true, снимок виртуального диска будет создан, если выполняется хотя бы одно из следующих правил:
Если установлено значение `True`, снимок виртуального диска будет создан, если выполняется хотя бы одно из следующих условий:
- виртуальный диск не подключен ни к одной виртуальной машине;
- виртуальный диск подключен к виртуальной машине, которая выключена;
- виртуальный диск подключен к виртуальной машине с агентом, и операция заморозки прошла успешно.
status:
properties:
conditions:
description: |
Последнее подтвержденное состояние данного ресурса.
Последнее подтверждённое состояние данного ресурса.
items:
description: |
condition содержит подробные сведения об одном аспекте текущего состояния этого ресурса API.
Подробные сведения об одном аспекте текущего состояния данного API-ресурса.
properties:
lastTransitionTime:
description: Время перехода условия из одного состояния в другое.
message:
description: Удобочитаемое сообщение с подробной информацией о последнем переходе.
observedGeneration:
description: |
observedGeneration представляет собой .metadata.generation, на основе которого было установлено условие.
Например, если .metadata.generation в настоящее время имеет значение 12, а .status.conditions[x].observedgeneration имеет значение 9, то условие устарело.
`.metadata.generation`, на основе которого было установлено условие.
Например, если `.metadata.generation` в настоящее время имеет значение `12`, а `.status.conditions[x].observedgeneration` имеет значение `9`, то условие устарело.
reason:
description: Краткая причина последнего перехода состояния.
status:
Expand All @@ -50,19 +50,19 @@ spec:
description: Тип условия.
volumeSnapshotName:
description: |
Имя созданного ресурса `VolumeSnapshot`.
Имя созданного ресурса VolumeSnapshot.
consistent:
description: |
Снимок виртуального диска консистентен.
phase:
description: |
Текущее состояние ресурса `VirtualDiskSnapshot`:
Текущее состояние ресурса VirtualDiskSnapshot:

* Pending — ресурс был создан и находится в очереди ожидания.
* InProgress — идет процесс создания снимка виртуального диска.
* Ready — создание снимка успешно завершено, и снимок виртуального диска доступен для использования.
* Failed — произошла ошибка во время процесса создания снимка виртуального диска.
* Terminating — ресурс находится в процессе удаления.
* `Pending` — ресурс был создан и находится в очереди ожидания;
* `InProgress`идёт процесс создания снимка виртуального диска;
* `Ready` — создание снимка успешно завершено, и снимок виртуального диска доступен для использования;
* `Failed` — во время создания снимка виртуального диска произошла ошибка;
* `Terminating` — ресурс находится в процессе удаления.
observedGeneration:
description: |
Поколение ресурса, которое в последний раз обрабатывалось контроллером.
Loading
Loading