chore(module): update

Signed-off-by: Pavel Tishkov <[email protected]>
deckhouse · Oct 8, 2024 · 85f3052 · 85f3052
1 parent de3691c
commit 85f3052
Show file tree

Hide file tree

Showing 11 changed files with 57 additions and 45 deletions.
diff --git a/docs/ADMIN_GUIDE.md b/docs/ADMIN_GUIDE.md
@@ -7,7 +7,7 @@ This section provides information on creating and managing resources that are av
 
 ## Images
 
-The `ClusterVirtualImage` resource is used to load virtual machine images into the intra-cluster storage, after which it can be used to create virtual machine disks. It is available in all cluster namespaces\projects.
+The `ClusterVirtualImage` resource is used to load virtual machine images into the intra-cluster storage, after which it can be used to create virtual machine disks. It is available in all cluster namespaces/projects.
 
 The image creation process includes the following steps:
 

diff --git a/docs/ADMIN_GUIDE_RU.md b/docs/ADMIN_GUIDE_RU.md
@@ -7,7 +7,7 @@ weight: 40
 
 ## Образы
 
-Ресурс `ClusterVirtualImage` служит для загрузки образов виртуальных машин во внутрикластерное хранилище, после чего с его помощью можно создавать диски виртуальных машин. Он доступен во всех пространствах имен\проектах кластера.
+Ресурс `ClusterVirtualImage` служит для загрузки образов виртуальных машин во внутрикластерное хранилище, после чего с его помощью можно создавать диски виртуальных машин. Он доступен во всех пространствах имен/проектах кластера.
 
 Процесс создания образа включает следующие шаги:
 

diff --git a/docs/INSTALL.md b/docs/INSTALL.md
@@ -41,7 +41,7 @@ The following minimum resources are recommended for infrastructure nodes, depend
 5. Enable the `virtualization` module:
 
 {{< alert level="warning" >}}
-Attention! Enabling the `virtualization` module involves restarting kubelet\containerd on all nodes where virtual machines are supposed to start. This is necessary to configure the connectivity of containerd and DVCR.
+Attention! Enabling the `virtualization` module involves restarting kubelet/containerd on all nodes where virtual machines are supposed to start. This is necessary to configure the connectivity of containerd and DVCR.
 {{< /alert >}}
 
 To enable the `virtualization` module, you need to create a `ModuleConfig` resource containing the module settings.

diff --git a/docs/INSTALL_RU.md b/docs/INSTALL_RU.md
@@ -45,7 +45,7 @@ weight: 15
 5. Включите модуль `virtualization`:
 
 {{< alert level="warning" >}}
-Внимание! Включение модуля `virtualization` предполагает рестарт kubelet\containerd на всех узлах, где предполагается запуск виртуальных машин. Это необходимо для настройки связности containerd и DVCR.
+Внимание! Включение модуля `virtualization` предполагает рестарт kubelet/containerd на всех узлах, где предполагается запуск виртуальных машин. Это необходимо для настройки связности containerd и DVCR.
 {{< /alert >}}
 
 Для включения модуля `virtualization`, необходимо создать ресурс `ModuleConfig` содержащий настройки модуля.

diff --git a/docs/README.md b/docs/README.md
@@ -31,6 +31,8 @@ The platform includes the following components:
 - Deckhouse Virtualization Container Registry (DVCR) - repository for storing and caching virtual machine images.
 - Virtualization API (API) - A controller that implements a user API for creating and managing virtual machine resources.
 
+![](images/arch.png)
+
 List of controllers and operators deployed in the `d8-virtualization` namespace after the module is enabled:
 
 | Name                          | Component | Comment                                                                                                                              |
@@ -48,6 +50,10 @@ List of controllers and operators deployed in the `d8-virtualization` namespace
 | `virtualization-controller-*` | API       | API for creating and managing module resources (images, disks, VMs, ...)                                                             |
 | `vm-route-forge-*`            | CORE      | Router for configuring routes to VMs. Must be present on all cluster nodes where VMs will be started.                                |
 
+The virtual machine runs inside the pod, which allows you to manage virtual machines as regular Kubernetes resources and utilize all the platform features, including load balancers, network policies, automation tools, etc.
+
+![](images/vm.png)
+
 The API provides the ability to declaratively create, modify, and delete the following underlying resources:
 
 - virtual machine images and boot images;

diff --git a/docs/README_RU.md b/docs/README_RU.md
@@ -29,6 +29,8 @@ DVP функционирует на базе [Deckhouse Kubernetes Platform](htt
 - Deckhouse Virtualization Container Registry (DVCR) — репозиторий для хранения и кэширования образов виртуальных машин.
 - Virtualization API (API) — контроллер, реализующий API пользователя для создания и управления ресурсами виртуальных машин.
 
+![](images/arch.ru.png)
+
 Перечень контроллеров и операторов, разворачивающихся в пространстве имен `d8-virtualization` после включения модуля:
 
 | Название                      | Компонент | Комментарий                                                                                                                             |
@@ -46,6 +48,10 @@ DVP функционирует на базе [Deckhouse Kubernetes Platform](htt
 | `virtualization-controller-*` | API       | API для создания и управления ресурсами модуля (образы, диски, ВМ, ..)                                                                  |
 | `vm-route-forge-*`            | CORE      | Маршрутизатор для настройки маршрутов до ВМ. Должен присутствовать на всех узлах кластера, где будут запускаться ВМ.                    |
 
+Виртуальная машина запускается внутри пода, что позволяет управлять виртуальными машинами как обычными ресурсами Kubernetes и использовать все возможности платформы, включая балансировщики нагрузки, сетевые политики, средства автоматизации и т. д.
+
+![](images/vm.ru.png)
+
 API предоставляет возможность для декларативного создания, модификации и удаления следующих базовых ресурсов:
 
 - образы виртуальных машин и загрузочные образы;

diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md
@@ -853,7 +853,7 @@ spec:
       ...
 ```
 
-For longer scenarios and\or the presence of private data, the script for initial initial initialization of the virtual machine can be created in Secret. An example of Secret with a CloudInit script is shown below:
+For longer scenarios and/or the presence of private data, the script for initial initial initialization of the virtual machine can be created in Secret. An example of Secret with a CloudInit script is shown below:
 
 ```yaml
 apiVersion: v1

diff --git a/docs/USER_GUIDE_RU.md b/docs/USER_GUIDE_RU.md
@@ -857,7 +857,7 @@ spec:
       ...
 ```
 
-При более длинных сценариях и\или наличия приватных данных, сценарий начальной инициализации виртуальной машины может быть создан в Secret'е. Пример Secret'а со сценарием CloudInit приведен ниже:
+При более длинных сценариях и/или наличия приватных данных, сценарий начальной инициализации виртуальной машины может быть создан в Secret'е. Пример Secret'а со сценарием CloudInit приведен ниже:
 
 ```yaml
 apiVersion: v1
-Original file line number
+Diff line change
@@ Expand Up / @@ -853,7 +853,7 @@ spec: @@
           ...
     ```
-    For longer scenarios and\or the presence of private data, the script for initial initial initialization of the virtual machine can be created in Secret. An example of Secret with a CloudInit script is shown below:
+    For longer scenarios and/or the presence of private data, the script for initial initial initialization of the virtual machine can be created in Secret. An example of Secret with a CloudInit script is shown below:
     ```yaml
     apiVersion: v1
@@ Expand Down @@