docs: a tighter create_vm_from_cloud_init docstring
driver / standard (pull_request) Successful in 16s
driver / lint (pull_request) Successful in 18s
driver / types (pull_request) Successful in 1m7s
driver / test (3.12) (pull_request) Successful in 1m12s
driver / lowest (pull_request) Successful in 35s
driver / test (3.13) (pull_request) Successful in 1m11s
driver / build (pull_request) Successful in 30s
driver / security (pull_request) Successful in 1m6s
CI / driver (pull_request) Successful in 2m52s
driver / publish (pull_request) Skipped

The VMProvisionIncomplete entry pushed the method past its recorded
length in the quality baseline. The image-cache note joins the
paragraph it repeated, and the Raises entry takes two lines; nothing
it says is dropped.
This commit is contained in:
christianmanivong committed 2026-11-01 23:02:46 +01:00
1 parent 4938056d20
commit 73771aba00
1 file changed
+7 -10
+7 -10
View File
@@ -473,13 +473,11 @@ class HypervisorDriver(PackageManagementMixin, HealthMetricsMixin, DeviceTypeDri
"""
Create a new virtual machine from a cloud image via Cloud-Init.
Downloads the cloud image (qcow2/raw) directly on the hypervisor if not
already cached there, creates a new VM shell, imports the image as its
root disk, configures virtual network interfaces, and injects Cloud-Init
configuration via a storage snippet or similar mechanism. The resulting
VM is left in a running state.
Implementations cache downloaded images on the hypervisor by URL/filename.
Downloads the cloud image (qcow2/raw) directly on the hypervisor unless it is
cached there already (implementations cache by URL/filename), creates a new VM
shell, imports the image as its root disk, configures virtual network interfaces,
and injects Cloud-Init configuration via a storage snippet or similar mechanism.
The resulting VM is left in a running state.
Args:
name (string) - new VM display name
@@ -533,9 +531,8 @@ class HypervisorDriver(PackageManagementMixin, HealthMetricsMixin, DeviceTypeDri
Raises:
RuntimeError - if provisioning fails (download failure, checksum
mismatch, storage unavailable, invalid config, timeout, etc.)
VMProvisionIncomplete - a RuntimeError for a failure after the VM
was created: it carries that VM's ``vmid`` and ``node``, so the
caller can ``destroy_vm`` it, and the failure as its cause.
VMProvisionIncomplete - a RuntimeError for a failure after the VM was created,
with that VM's ``vmid`` and ``node`` for ``destroy_vm`` and the failure as cause.
"""
...