feat(vm): calculate sockets count by cores count (#747)

## Description
Update CPU configuration to dynamically calculate the number of sockets based on the number of cores and set a maximum of 8 sockets.

## Why do we need it, and what problem does it solve?
Currently, each core has its own socket. However, some operating systems do not function correctly with this setup.

## What is the expected result?
The system will dynamically calculate the number of sockets based on the number of cores, ensuring compatibility with various operating systems. The maximum number of sockets will be limited to 8.

---------

Signed-off-by: Daniil Antoshin <daniil.antoshin@flant.com>
Signed-off-by: mortelumina98 <ekaterina.matseevska@flant.com>
Signed-off-by: Ekaterina Matseevska <ekaterina.matseevska@flant.com>
Co-authored-by: Pavel Tishkov <pavel.tishkov@flant.com>
Co-authored-by: mortelumina98 <ekaterina.matseevska@flant.com>

Author: 3 people

api/core/v1alpha2/virtual_machine.go

@@ -159,6 +159,7 @@ type CPUSpec struct {
 	// +kubebuilder:validation:Format:=int32
 	// +kubebuilder:validation:Minimum=1
 	Cores int `json:"cores"`
+
 	// Guaranteed share of CPU that will be allocated to the VM. Specified as a percentage.
 	// +kubebuilder:default:="100%"
 	// +kubebuilder:validation:Enum:={"5%", "10%", "25%", "50%", "100%"}
@@ -353,6 +354,16 @@ type CPUStatus struct {
 	RequestedCores resource.Quantity `json:"requestedCores,omitempty"`
 	// runtime overhead.
 	RuntimeOverhead resource.Quantity `json:"runtimeOverhead,omitempty"`
+	// Topology with Cores count and Sockets count.
+	Topology Topology `json:"topology,omitempty"`
+}
+
+// Topology defines count of used CPU cores and sockets.
+type Topology struct {
+	// Current number of cores inside the VM.
+	CoresPerSocket int `json:"coresPerSocket"`
+	// Current number of cores inside the VM.
+	Sockets int `json:"sockets"`
 }
 
 // MemoryStatus defines statistics about the Memory resource usage.

api/core/v1alpha2/zz_generated.deepcopy.go

@@ -679,9 +679,16 @@ spec:
                         cores:
                           description: Текущее количество ядер виртуальной машины.
                         requestedCores:
-                          description: Запрошенные ядра.
+                          description: Количество ядер CPU, запрошенных виртуальной машиной.
                         runtimeOverhead:
                           description: Накладные расходы на CPU во время выполнения.
+                        topology:
+                          description: Информация о текущей топологии CPU.
+                          properties:
+                            coresPerSocket:
+                              description: Количество ядер CPU на один сокет виртуальной машины.
+                            sockets:
+                              description: Текущее количество сокетов виртуальной машины.
                     memory:
                       description: Статистика использования ресурсов памяти.
                       properties:

api/pkg/apiserver/api/generated/openapi/zz_generated.openapi.go

@@ -1204,11 +1204,24 @@ spec:
                           description: CPU overhead required by the runtime.
                           pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
                           x-kubernetes-int-or-string: true
+                        topology:
+                          description: Information on the current CPU topology.
+                          type: object
+                          required:
+                            - coresPerSocket
+                            - sockets
+                          properties:
+                            coresPerSocket:
+                              description: Current number of CPU cores per socket.
+                              type: integer
+                            sockets:
+                              description: Current number of CPU sockets.
+                              type: integer
                       required:
                         - cores
                       type: object
                     memory:
-                      description: Statistics on used memory resources.
+                      description: Memory usage statistics.
                       properties:
                         runtimeOverhead:
                           anyOf:

crds/doc-ru-virtualmachines.yaml

@@ -157,7 +157,7 @@ There are different types of images:
 - ISO image - an installation image used for the initial installation of an operating system. Such images are released by OS vendors and are used for installation on physical and virtual servers.
 - Preinstalled disk image - contains an already installed and configured operating system ready for use after the virtual machine is created. These images are offered by several vendors and can be provided in formats such as qcow2, raw, vmdk, and others.
 
-Example of resource for obtaining virtual machine images **Ubuntu**: https://cloud-images.ubuntu.com
+Example of resource for obtaining virtual machine images **Ubuntu**: <https://cloud-images.ubuntu.com>.
 
 Once a share is created, the image type and size are automatically determined, and this information is reflected in the share status.
 
@@ -742,6 +742,54 @@ Example output:
 
 After creation, the virtual machine will automatically get an IP address from the range specified in the module settings (`virtualMachineCIDRs` block).
 
+### Automatic CPU Topology Configuration
+
+The number of sockets is calculated automatically and depends on the number of cores.
+
+For .spec.cpu.cores <= 16:
+
+- One socket is created with the number of cores equal to the specified value.
+- Core increment step: 1
+- Allowed values: any number from 1 to 16 inclusive.
+
+For 16 < .spec.cpu.cores <= 32:
+
+- Two sockets are created with the same number of cores in each.
+- Core increment step: 2
+- Allowed values: 18, 20, 22, ..., 32.
+- Minimum cores per socket: 9
+- Maximum cores per socket: 16
+
+For 32 < .spec.cpu.cores <= 64:
+
+- Four sockets are created with the same number of cores in each.
+- Core increment step: 4
+- Allowed values: 36, 40, 44, ..., 64.
+- Minimum cores per socket: 9
+- Maximum cores per socket: 16
+
+For .spec.cpu.cores > 64:
+
+- Eight sockets are created with the same number of cores in each.
+- Core increment step: 8
+- Allowed values: 72, 80, ...
+- Minimum cores per socket: 8
+
+The current VM topology (actual number of sockets and cores) is displayed in the VM status in the following format:
+
+```yaml
+status:
+  resources:
+    cpu:
+      coreFraction: 100%
+      cores: 18
+      requestedCores: "18"
+      runtimeOverhead: "0"
+      topology:
+        sockets: 2
+        coresPerSocket: 9
+```
+
 ### Connecting to a virtual machine
 
 The following methods are available for connecting to the virtual machine:

crds/virtualmachines.yaml

@@ -159,9 +159,9 @@ weight: 50
 
 Примеры ресурсов для получения образов виртуальной машины:
 
-- **Ubuntu**: https://cloud-images.ubuntu.com.
-- **Alt Linux**: https://ftp.altlinux.ru/pub/distributions/ALTLinux/platform/images/cloud/x86_64.
-- **Astra Linux**: https://download.astralinux.ru/ui/native/mg-generic/alse/cloudinit.
+- **Ubuntu**: <https://cloud-images.ubuntu.com>.
+- **Alt Linux**: <https://ftp.altlinux.ru/pub/distributions/ALTLinux/platform/images/cloud/x86_64>.
+- **Astra Linux**: <https://download.astralinux.ru/ui/native/mg-generic/alse/cloudinit>.
 
 После создания ресурса, тип и размер образа определяются автоматически и эта информация отражается в статусе ресурса.
 
@@ -426,6 +426,7 @@ EOF
 Можно создать образ из [снимка](#снимки). Для этого необходимо чтобы снимок диска находился в фазе готовности.
 
 Пример создания образа из моментального снимка диска:
+
 ```yaml
 d8 k apply -f - <<EOF
 apiVersion: virtualization.deckhouse.io/v1alpha2
@@ -748,6 +749,54 @@ d8 k get vm linux-vm
 
 После создания виртуальная машина автоматически получит IP-адрес из диапазона, указанного в настройках модуля (блок `virtualMachineCIDRs`).
 
+### Автоматическая конфигурация топологии CPU
+
+Количество сокетов рассчитывается автоматически и зависит от количества ядер.
+
+Для .spec.cpu.cores <= 16:
+
+- Создается один сокет с количеством ядер, равным указанному значению.
+- Шаг инкремента ядер: 1
+- Допустимые значения: любое число от 1 до 16 включительно.
+
+Для 16 < .spec.cpu.cores <= 32:
+
+- Создается два сокета с одинаковым количеством ядер в каждом.
+- Шаг инкремента ядер: 2
+- Допустимые значения: 18, 20, 22, ..., 32.
+- Минимум ядер в сокете: 9
+- Максимум ядер в сокете: 16
+
+Для 32 < .spec.cpu.cores <= 64:
+
+- Создается четыре сокета с одинаковым количеством ядер в каждом.
+- Шаг инкремента ядер: 4
+- Допустимые значения: 36, 40, 44, ..., 64.
+- Минимум ядер в сокете: 9
+- Максимум ядер в сокете: 16
+
+Для .spec.cpu.cores > 64:
+
+- Создается восемь сокетов с одинаковым количеством ядер в каждом.
+- Шаг инкремента ядер: 8
+- Допустимые значения: 72, 80, ...
+- Минимум ядер в сокете: 8
+
+Текущая топология ВМ (реальное количество сокетов и ядер) отображается в статусе ВМ в следующем формате:
+
+```yaml
+status:
+  resources:
+    cpu:
+      coreFraction: 100%
+      cores: 18
+      requestedCores: "18"
+      runtimeOverhead: "0"
+      topology:
+        sockets: 2
+        coresPerSocket: 9
+```
+
 ### Подключение к виртуальной машине
 
 Для подключения к виртуальной машине доступны следующие способы:

docs/USER_GUIDE.md

@@ -0,0 +1,53 @@
+# Number of CPU cores
+
+## Logic for calculating the number of sockets and cores
+
+For .spec.cpu.cores <= 16:
+
+- One socket is created with the number of cores equal to the specified value.
+- Core increment step: 1
+- Allowed values: any number from 1 to 16 inclusive.
+
+For 16 < .spec.cpu.cores <= 32:
+
+- Two sockets are created with the same number of cores in each.
+- Core increment step: 2
+- Allowed values: 18, 20, 22, ..., 32.
+- Minimum cores per socket: 9
+- Maximum cores per socket: 16
+
+For 32 < .spec.cpu.cores <= 64:
+
+- Four sockets are created with the same number of cores in each.
+- Core increment step: 4
+- Allowed values: 36, 40, 44, ..., 64.
+- Minimum cores per socket: 9
+- Maximum cores per socket: 16
+
+For .spec.cpu.cores > 64:
+
+- Eight sockets are created with the same number of cores in each.
+- Core increment step: 8
+- Allowed values: 72, 80, ...
+- Minimum cores per socket: 8
+
+## Value validation
+
+Validation of .spec.cpu.cores values is performed via a webhook.
+
+## Displaying VM topology
+
+The current VM topology (actual number of sockets and cores) is displayed in the VM status in the following format:
+
+```yaml
+status:
+  resources:
+    cpu:
+      coreFraction: 100%
+      cores: 18
+      requestedCores: "18"
+      runtimeOverhead: "0"
+      topology:
+        sockets: 2
+        coresPerSocket: 9
+```