feat(api): add Name suffix

README.md

@@ -12,6 +12,7 @@ It offers the following features:
 
 - A simple and intuitive interface for declarative creation and management of virtual machines and their resources.
 - The ability to run legacy applications that for some reason cannot or are difficult to run in a container.
+- Ability to run applications that require non-Linux operating systems.
 - Ability to run virtual machines and containerized applications in the same environment.
 - Integration with the existing Deckhouse ecosystem to leverage its capabilities for virtual machines.
 
@@ -20,24 +21,37 @@ It offers the following features:
 The following conditions are required to run the module:
 
 - A processor with x86_64 architecture and support for Intel-VT or AMD-V instructions.
+- Cluster resource requirements and configuration specifics are available for reading on [this](https://deckhouse.io/guides/production.html) page.
+- Any [compatible](https://deckhouse.io/documentation/v1/supported_versions.html#linux) Linux-based OS is supported for installation.
 - The Linux kernel on the cluster nodes must be version 5.7 or newer.
-- The [CNI Cilium](https://deckhouse.ru/documentation/v1/modules/021-cni-cilium/) module to provide network connectivity for virtual machines.
-- Modules SDS-DRBD or [Ceph](https://deckhouse.ru/documentation/v1/modules/031-ceph-csi/) for storing virtual machine data. It is also possible to use other storage options that support the creation of block devices with `RWX` (`ReadWriteMany`) access mode.
+- The [CNI Cilium](/documentation/v1/modules/021-cni-cilium/) module to provide network connectivity for virtual machines.
+- Modules [SDS-DRBD](https://deckhouse.io/modules/sds-drbd/stable/) or [CEPH-CSI](/documentation/v1/modules/031-ceph-csi/) for storing virtual machine data. It is also possible to use other storage options that support the creation of block devices with `RWX` (`ReadWriteMany`) access mode.
+
+The command line utility [d8](https://github.com/deckhouse/deckhouse-cli) is used to create cluster resources and connect to virtual machines. For users of the EE-version the ability to manage resources via UI is available.
+
+## What do I need to enable the module?
+
+Procedure for enabling the module
+
+1. Configure the deckhouse cluster
+2. Enable the [CNI Cilium](/documentation/v1/modules/021-cni-cilium/) module
+3. Install and configure SDS-DRBD/CEPH/etc storage
+4. Enable the virtualization module
 
 ## Architecture
 
 The module includes the following components:
 
 - The module core, based on the KubeVirt project and uses QEMU/KVM + libvirtd to run virtual machines.
 - Deckhouse Virtualization Container Registry (DVCR) - repository for storing and caching virtual machine images.
-- Virtualization-controller - API for creating and managing virtual machine resources.
+- Virtualization-API - controller that implements a user API for creating and managing virtual machine resources.
 
 The API provides capabilities for creating and managing the following resources:
 
-- Images
-- Disks
+- Virtual Images
+- Virtual Disks
 - Virtual machines
-- Operations
+- Virtual Machine Operations
 
 ## How to enable module
 
@@ -57,8 +71,8 @@ spec:
           size: 50G # size of DVCR storage
         type: PersistentVolumeClaim
     virtualMachineCIDRs:
-    - 10.66.10.0/24
-    - 10.66.20.0/24
-    - 10.66.30.0/24
+      - 10.66.10.0/24
+      - 10.66.20.0/24
+      - 10.66.30.0/24
   version: 1
 ```

api/core/v1alpha2/virtual_disk.go

@@ -64,11 +64,11 @@ type VirtualDiskDownloadSpeed struct {
 }
 
 type DiskTarget struct {
-	PersistentVolumeClaim string `json:"persistentVolumeClaim"`
+	PersistentVolumeClaim string `json:"persistentVolumeClaimName"`
 }
 
 type VirtualDiskPersistentVolumeClaim struct {
-	StorageClass *string            `json:"storageClass,omitempty"`
+	StorageClass *string            `json:"storageClassName,omitempty"`
 	Size         *resource.Quantity `json:"size,omitempty"`
 }
 

api/core/v1alpha2/virtual_machine.go

@@ -29,7 +29,7 @@ type VirtualMachineSpec struct {
 
 	// VirtualMachineIPAddressClaim specifies a name for the associated
 	// `VirtualMachineIPAddressClaim` resource. Defaults to `{vm name}`.
-	VirtualMachineIPAddressClaim string `json:"virtualMachineIPAddressClaim,omitempty"`
+	VirtualMachineIPAddressClaim string `json:"virtualMachineIPAddressClaimName,omitempty"`
 
 	// TopologySpreadConstraints specifies how to spread matching pods among the given topology.
 	TopologySpreadConstraints []corev1.TopologySpreadConstraint `json:"topologySpreadConstraints,omitempty"`
@@ -91,7 +91,7 @@ const (
 )
 
 type CPUSpec struct {
-	VirtualMachineCPUModel string `json:"virtualMachineCPUModel"`
+	VirtualMachineCPUModel string `json:"virtualMachineCPUModelName"`
 	Cores                  int    `json:"cores"`
 	CoreFraction           string `json:"coreFraction"`
 }
@@ -143,8 +143,8 @@ const (
 
 type VirtualMachineStatus struct {
 	Phase                        MachinePhase                             `json:"phase"`
-	Node                         string                                   `json:"node"`
-	VirtualMachineIPAddressClaim string                                   `json:"virtualMachineIPAddressClaim"`
+	Node                         string                                   `json:"nodeName"`
+	VirtualMachineIPAddressClaim string                                   `json:"virtualMachineIPAddressClaimName"`
 	IPAddress                    string                                   `json:"ipAddress"`
 	BlockDeviceRefs              []BlockDeviceStatusRef                   `json:"blockDeviceRefs"`
 	GuestOSInfo                  virtv1.VirtualMachineInstanceGuestOSInfo `json:"guestOSInfo"`

api/core/v1alpha2/virtual_machine_block_disk_attachment.go

@@ -29,7 +29,7 @@ type VirtualMachineBlockDeviceAttachmentList struct {
 }
 
 type VirtualMachineBlockDeviceAttachmentSpec struct {
-	VirtualMachine string         `json:"virtualMachine"`
+	VirtualMachine string         `json:"virtualMachineName"`
 	BlockDeviceRef VMBDAObjectRef `json:"blockDeviceRef"`
 }
 

api/core/v1alpha2/virtual_machine_ip_address_claim.go

@@ -26,7 +26,7 @@ type VirtualMachineIPAddressClaimList struct {
 // VirtualMachineIPAddressClaimSpec is the desired state of `VirtualMachineIPAddressClaim`.
 type VirtualMachineIPAddressClaimSpec struct {
 	// The issued `VirtualMachineIPAddressLease`, managed automatically.
-	VirtualMachineIPAddressLease string `json:"virtualMachineIPAddressLease"`
+	VirtualMachineIPAddressLease string `json:"virtualMachineIPAddressLeaseName"`
 	// The requested IP address. If omitted the next available IP address will be assigned.
 	Address string `json:"address"`
 	// Determines the behavior of VirtualMachineIPAddressLease upon VirtualMachineIPAddressClaim deletion.
@@ -36,11 +36,11 @@ type VirtualMachineIPAddressClaimSpec struct {
 // VirtualMachineIPAddressClaimStatus is the observed state of `VirtualMachineIPAddressClaim`.
 type VirtualMachineIPAddressClaimStatus struct {
 	// Represents the virtual machine that currently uses this IP address.
-	VirtualMachine string `json:"virtualMachine,omitempty"`
+	VirtualMachine string `json:"virtualMachineName,omitempty"`
 	// Assigned IP address.
 	Address string `json:"address,omitempty"`
 	// The issued `VirtualMachineIPAddressLease`, managed automatically.
-	Lease string `json:"virtualMachineIPAddressLease,omitempty"`
+	Lease string `json:"virtualMachineIPAddressLeaseName,omitempty"`
 	// Represents the current state of IP address claim.
 	Phase VirtualMachineIPAddressClaimPhase `json:"phase,omitempty"`
 	// Detailed description of the error.

api/core/v1alpha2/virtual_machine_operation.go

@@ -20,7 +20,7 @@ type VirtualMachineOperation struct {
 
 type VirtualMachineOperationSpec struct {
 	Type           VMOPOperation `json:"type"`
-	VirtualMachine string        `json:"virtualMachine"`
+	VirtualMachine string        `json:"virtualMachineName"`
 	Force          bool          `json:"force,omitempty"`
 }
 

crds/clustervirtualimage.yaml

@@ -41,6 +41,8 @@ spec:
               properties:
                 dataSource:
                   type: object
+                  description: |
+                    An origin of the image.
                   required:
                     - type
                   properties:
@@ -151,7 +153,8 @@ spec:
                             YWFhCg==
                     objectRef:
                       type: object
-                      description: Reference to existing `VirtualImage` or `ClusterVirtualImage`.
+                      description: |
+                        Use an existing `VirtualImage` or `ClusterVirtualImage` to create an image.
                       required: ["kind", "name"]
                       properties:
                         kind:
@@ -293,10 +296,10 @@ spec:
                   type: string
                   description: |
                     Detailed description of the error. human-readable
-                usedInVMs:
+                attachedToVirtualMachines:
                   type: array
                   description: |
-                    A list of virtual s and namespaces that use the image
+                    A list of virtual machines and namespaces that use the image
                   example:
                     [
                       { name: "VM100", namespace: "customer1" },