fix(crd): corrects inaccuracies in documentation about CVMI, VMI, VMD (…

…#16) --------- Signed-off-by: Pavel Tishkov <[email protected]>
deckhouse · Mar 2, 2024 · 9d7015c · 9d7015c
1 parent f810c57
commit 9d7015c
Show file tree

Hide file tree

Showing 7 changed files with 44 additions and 86 deletions.
diff --git a/crds/clustervirtualmachineimage.yaml b/crds/clustervirtualmachineimage.yaml
@@ -26,7 +26,9 @@ spec:
         openAPIV3Schema:
           type: object
           description: |
-            Describes a virtual machine disk image that can be used as a data source for new `VirtualMachineDisks` or can be mounted in `VirtualMachines` as is. This resource type is available to all namespaces in the cluster. This resource is immutable, once created, cannot be modified.
+            Describes a virtual machine disk image that can be used as a data source for new `VirtualMachineDisks` or an installation image (iso) to be mounted in `VirtualMachines` directly. This resource type is available for all namespaces in the cluster.
+
+            > This resource cannot be modified once it has been created.
 
             A container image is created under the hood of this resource, which is stored in a dedicated deckhouse virtualization container registry (DVCR).
           required:
@@ -53,10 +55,10 @@ spec:
                       description: |
                         The type of an origin of the image. Options are:
 
-                        * `HTTP` — fill the image with data from some external http/https url.
-                        * `ContainerImage` — use an image, stored in container registry image.
-                        * `VirtualMachineImage` — use another existing `VirtualMachineImage`.
-                        * `ClusterVirtualMachineImage` — use another existing `ClusterVirtualMachineImage`.
+                        * `HTTP` — create an image from a file published on http/https service at a given url
+                        * `ContainerImage` — create the image from image stored in container registry.
+                        * `VirtualMachineImage` — create an image from another existing `VirtualMachineImage`.
+                        * `ClusterVirtualMachineImage`  — create an image from another existing `ClusterVirtualMachineImage`.
                         * `Upload` — fill the image with data, uploaded by user via the special interface.
                     http:
                       type: object

diff --git a/crds/doc-ru-clustervirtualmachineimage.yaml b/crds/doc-ru-clustervirtualmachineimage.yaml
@@ -4,7 +4,9 @@ spec:
       schema:
         openAPIV3Schema:
           description: |
-            Описывает образ диска виртуальной машины, который может использоваться в качестве источника данных для новых `VirtualMachineDisks` или может быть смонтирован в `VirtualMachines` напрямую. Этот тип ресурса доступен для всех пространств имен в кластере. Этот ресурс не может быть изменен после его создания.
+            Описывает образ диска виртуальной машины, который может использоваться в качестве источника данных для новых `VirtualMachineDisks` или установочный образ (iso), который быть смонтирован в `VirtualMachines` напрямую. Этот тип ресурса доступен для всех пространств имен в кластере.
+
+            > Этот ресурс не может быть изменен после его создания.
 
             Под капотом этого ресурса создается образ контейнера, который хранится в специальном container registry (DVCR).
           properties:
@@ -20,8 +22,8 @@ spec:
 
                         * `HTTP` — создать образ из файла, опубликованного на HTTP/HTTPS-сервере.
                         * `ContainerImage` — создать образ из образа в container registry.
-                        * `VirtualMachineImage` — использовать существующий `VirtualMachineImage`.
-                        * `ClusterVirtualMachineImage` — использовать существующий `ClusterVirtualMachineImage`.
+                        * `VirtualMachineImage` — создать новый образ из существующего `VirtualMachineImage`.
+                        * `ClusterVirtualMachineImage` — создать новый образ из существующего `ClusterVirtualMachineImage`.
                         * `Upload` — загрузить образ вручную, через веб-интерфейс.
                     http:
                       description: |

diff --git a/crds/doc-ru-virtualmachinedisk.yaml b/crds/doc-ru-virtualmachinedisk.yaml
@@ -4,7 +4,7 @@ spec:
       schema:
         openAPIV3Schema:
           description: |
-            Описывает диск виртуальной машины, который может быть смонтирован в `VirtualMachines`. После создания только поле `.spec.persistentVolumeClaim.size` доступно для изменения в сторону увеличения, все остальные поля неизменяемы.
+            Описывает диск виртуальной машины, который может быть смонтирован в `VirtualMachines`. После создания ресурса изменить можно только размер диска `.spec.persistentVolumeClaim.size`, все остальные поля неизменяемы.
 
             Под капотом ресурса создается PVC, в который заливаются данные из источника.
           properties:

diff --git a/crds/doc-ru-virtualmachineimage.yaml b/crds/doc-ru-virtualmachineimage.yaml
@@ -5,44 +5,35 @@ spec:
         openAPIV3Schema:
           type: object
           description: |
-            Данный ресурс описывает образ диска виртуальной машины, который может быть использован в качестве источника данных для новых `VirtualMachineDisks` или может быть смонтирован в `VirtualMachines`.  Этот ресурс не может быть изменен после его создания.
+            Описывает образ диска виртуальной машины, который может использоваться в качестве источника данных для новых `VirtualMachineDisks` или установочный образ (iso), который быть смонтирован в `VirtualMachines` напрямую.
 
+            > Этот ресурс не может быть изменен после его создания.
 
-
-            Под капотом этого ресурса создается образ контейнера, который хранится в специальном container registry (DVCR) или PVC, в который заливаются данные из источника.
+            Под капотом этого ресурса создается образ контейнера, хранящийся в специальном container registry (DVCR).
           properties:
             spec:
               properties:
                 storage:
                   description: |
                     Тип хранилища для хранения образа:
 
-                    * `Kubernetes` — использовать PersistentVolumeClaim в текущем кластере K8s. В этом случае образ будет загружен и скопирован на PV как есть.
-
                     * `ContainerRegistry` — использовать container registry (DVCR). В этом случае образы будут загружаться в контейнер, а затем в DVCR (поставляется с модулем виртуализации).
-                persistentVolumeClaim:
-                  description: |
-                    Настройки для создания PVC для хранения диска.
-                  properties:
-                    storageClassName:
-                      description: |
-                        Имя класса StorageClass, требуемого для PersistentVolumeClaim. Дополнительная информация — https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1.
                 dataSource:
                   description: |
-                    Тип источника, из которого будет создан диск. Если источник (.spec.dataSource) отсутствует, будет создан пустой диск.
+                    Тип источника, из которого будет создан образ.
                   properties:
                     type:
                       description: |
-                        Тип источника, из которого будет создан диск:
+                        Тип источника, из которого будет создан образ:
 
-                        * `HTTP` — создать диск из файла, опубликованного на HTTP/HTTPS-сервере.
-                        * `ContainerImage` — создать диск из образа в container registry.
-                        * `VirtualMachineImage` — создать диск из существующего `VirtualMachineImage`.
-                        * `ClusterVirtualMachineImage` — создать диск из существующего `ClusterVirtualMachineImage`.
-                        * `Upload` — загрузить образ диска вручную, через веб-интерфейс.
+                        * `HTTP` — создать образ из файла, опубликованного на HTTP/HTTPS-сервере.
+                        * `ContainerImage` — создать образ из образа в container registry.
+                        * `VirtualMachineImage` — создать образ из другого существующего `VirtualMachineImage`.
+                        * `ClusterVirtualMachineImage` — создать образ из другого существующего `ClusterVirtualMachineImage`.
+                        * `Upload` — загрузить образ вручную, через веб-интерфейс.
                     http:
                       description: |
-                        Создать диск из файла, опубликованного по URL. Поддерживаемые схемы:
+                        Создать образ из файла, опубликованного по URL. Поддерживаемые схемы:
 
                         * HTTP;
                         * HTTPS.
@@ -142,19 +133,16 @@ spec:
                   properties:
                     stored:
                       description: |
-                        Размер образа в DVCR или PVC в человекочитаемом формате.
+                        Размер образа в DVCR в человекочитаемом формате.
                     storedBytes:
                       description:
-                        Размер образа в DVCR или PVC в байтах.
+                        Размер образа в DVCR в байтах.
                     unpacked:
                       description: |
                         Размер распакованного образа в человекочитаемом формате.
                     unpackedBytes:
                       description: |
                         Размер распакованного образа в байтах.
-                capacity:
-                  description: |
-                    Емкость PVC в человекочитаемом формате.
                 cdrom:
                   description: |
                     Является ли образ форматом, который должен быть смонтирован как cdrom, например iso и т. д.
@@ -168,7 +156,7 @@ spec:
                         Имя созданного PersistentVolumeClaim для хранилища Kubernetes.
                 phase:
                   description: |
-                    Текущее состояние ресурса `ClusterVirtualMachineImage`:
+                    Текущее состояние ресурса `VirtualMachineImage`:
 
                     * Pending — ресурс был создан и находится в очереди ожидания.
                     * Provisioning — идет процесс создания ресурса (копирование/загрузка/создание образа).
@@ -177,7 +165,6 @@ spec:
                     * Failed — при создании ресурса возникла проблема, подробности можно увидеть в `.status.failureReason` и `.status.failureMessage`.
                     * NotReady — невозможно получить информацию о дочернем образе из-за невозможности подключения к DVCR. Ресурс не может быть использован.
                     * ImageLost — дочерний образ ресурса отсутствует. Ресурс не может быть использован.
-                    * PVCLost — дочерний PVC ресурса отсутствует. Ресурс не может быть использован.
 
                 progress:
                   description: |

diff --git a/crds/virtualmachinedisk.yaml b/crds/virtualmachinedisk.yaml
@@ -27,7 +27,7 @@ spec:
         openAPIV3Schema:
           type: object
           description: |
-            Describes a virtual machine disk which could be mounted to `VirtualMachines` as is. After creation, only the `.spec.persistentVolumeClaim.size` field is available for upward change, all other fields are immutable.
+            Describes a virtual machine disk that can be mounted in `VirtualMachines`. Once the resource is created, only the disk size `.spec.persistentVolumeClaim.size` can be changed, all other fields are immutable.
 
             A PVC is created under the hood of the resource, into which the data from the source is filled.
           required:
@@ -70,8 +70,8 @@ spec:
                       description: |
                         The type of an origin of the disk. Options are:
 
-                        * `HTTP` — fill the disk with data from some external http/https url.
-                        * `ContainerImage` — fill the disk from an image, stored in container registry image.
+                        * `HTTP` — create an image from a file published on http/https service at a given url
+                        * `ContainerImage` — create the image from image stored in container registry.
                         * `VirtualMachineImage` — fill the disk from another existing `VirtualMachineImage`.
                         * `ClusterVirtualMachineImage` — fill the disk from another existing `ClusterVirtualMachineImage`.
                         * `Upload` — fill the disk with data, uploaded by user via the special interface.
@@ -139,7 +139,7 @@ spec:
                       required:
                       - image
                       description: |
-                        Use an image stored in external container regitry. Use an image stored in external container registry. Only TLS enabled registries are supported. Use caBundle field to provide custom CA chain if needed.
+                        Use an image stored in external container registry. Only TLS enabled registries are supported. Use caBundle field to provide custom CA chain if needed.
                       properties:
                         image:
                           type: string