diff --git a/doc/source/support-matrix.ini b/doc/source/support-matrix.ini index 6cc19e3e..3d7a844a 100644 --- a/doc/source/support-matrix.ini +++ b/doc/source/support-matrix.ini @@ -82,14 +82,22 @@ notes=The attach volume operation provides a means to hotplug hotplug extra storage is for those cases where the instance is considered to be more of a pet than cattle. Therefore this operation is not considered to be mandatory to support. -cli= +cli=nova volume-attach driver-impl-powervm=complete +[operation.attach-tagged-volume] +title=Attach tagged block device to instance +status=optional +notes=Attach a block device with a tag to an existing server instance. See + "Device tags" for more information. +cli=nova volume-attach [--tag ] +driver-impl-powervm=missing + [operation.detach-volume] title=Detach block volume from instance status=optional notes=See notes for attach volume operation. -cli= +cli=nova volume-detach driver-impl-powervm=complete [operation.extend-volume] @@ -105,8 +113,35 @@ notes=The extend volume operation provides a means to extend Therefore this operation is not considered to be mandatory to support. cli=cinder extend driver-impl-powervm=partial -driver-notes-powervm=Extend volume only supported for NPIV, FileIO, and iSCSI - volumes. +driver-notes-powervm=Only supported for NPIV, FileIO, and iSCSI volumes. + +[operation.attach-interface] +title=Attach virtual network interface to instance +status=optional +notes=The attach interface operation provides a means to hotplug + additional interfaces to a running instance. Hotplug support + varies between guest OSes and some guests require a reboot for + new interfaces to be detected. This operation allows interface + capabilities to be expanded without interruption of service. + In a cloud model it would be more typical to just spin up a + new instance with more interfaces. +cli=nova interface-attach +driver-impl-powervm=complete + +[operation.attach-tagged-interface] +title=Attach tagged virtual network interface to instance +status=optional +notes=Attach a virtual network interface with a tag to an existing + server instance. See "Device tags" for more information. +cli=nova interface-attach [--tag ] +driver-impl-powervm=missing + +[operation.detach-interface] +title=Detach virtual network interface from instance +status=optional +notes=See notes for attach-interface operation. +cli=nova interface-detach +driver-impl-powervm=complete [operation.maintenance-mode] title=Set the host in a maintenance mode @@ -116,10 +151,9 @@ notes=This operation allows a host to be placed into maintenance instances to an alternative host and preventing new instances from being launched. This is not considered to be a mandatory operation to support. - The CLI command is "nova host-update ". The driver methods to implement are "host_maintenance_mode" and "set_host_enabled". -cli= +cli=nova host-update driver-impl-powervm=complete [operation.evacuate] @@ -144,25 +178,32 @@ notes=A possible use case is additional attributes need to be set and remakes the VM with given information such as 'metadata' and 'personalities'. Though this is not considered to be a mandatory operation to support. -cli=nova rebuild ; +cli=nova rebuild driver-impl-powervm=complete [operation.get-guest-info] title=Guest instance status status=mandatory -notes=Provides a quick report on information about the guest instance, - including the power state, memory allocation, CPU allocation, number - of vCPUs and cummulative CPU execution time. As well as being - informational, the power state is used by the compute manager for - tracking changes in guests. Therefore this operation is considered - mandatory to support. +notes=Provides realtime information about the power state of the guest + instance. Since the power state is used by the compute manager for + tracking changes in guests, this operation is considered mandatory to + support. cli= driver-impl-powervm=complete -[operation.get-host-info] -title=Guest host status +[operation.get-host-uptime] +title=Guest host uptime status=optional -notes=Unclear what this refers to +notes=Returns the result of host uptime since power on, + it's used to report hypervisor status. +cli= +driver-impl-powervm=complete + +[operation.get-host-ip] +title=Guest host ip +status=optional +notes=Returns the ip of this host, it's used when doing + resize and migration. cli= driver-impl-powervm=complete @@ -180,9 +221,25 @@ notes=Live migration provides a way to move an instance off one support for the live migration operation, particularly those built on the container based virtualization. Therefore this operation is not considered mandatory to support. -cli= +cli=nova live-migration ;nova host-evacuate-live driver-impl-powervm=complete +[operation.force-live-migration-to-complete] +title=Force live migration to complete +status=optional +notes=Live migration provides a way to move a running instance to another + compute host. But it can sometimes fail to complete if an instance has + a high rate of memory or disk page access. + This operation provides the user with an option to assist the progress + of the live migration. The mechanism used to complete the live + migration depends on the underlying virtualization subsystem + capabilities. If libvirt/qemu is used and the post-copy feature is + available and enabled then the force complete operation will cause + a switch to post-copy mode. Otherwise the instance will be suspended + until the migration is completed or aborted. +cli=nova live-migration-force-complete +driver-impl-powervm=missing + [operation.launch] title=Launch instance status=mandatory @@ -204,7 +261,7 @@ notes=Stopping an instances CPUs can be thought of as roughly generally discourage use of this feature and some do not even implement it. Therefore this operation is considered optional to support in drivers. -cli= +cli=nova pause driver-impl-powervm=missing [operation.reboot] @@ -215,7 +272,7 @@ notes=It is reasonable for a guest OS administrator to trigger a graceful reboot requires guest co-operation and a non-graceful reboot can be achieved by a combination of stop+start. Therefore this operation is considered optional. -cli= +cli=nova reboot driver-impl-powervm=complete [operation.rescue] @@ -229,7 +286,7 @@ notes=The rescue operation starts an instance in a special an instance breaks the general expectation is that it be thrown away and a new instance created. Therefore this operation is considered optional to support in drivers. -cli= +cli=nova rescue driver-impl-powervm=complete [operation.resize] @@ -243,30 +300,20 @@ notes=The resize operation allows the user to change a running support the alteration of all relevant config settings for a running instance. Therefore this operation is considered optional to support in drivers. -cli= +cli=nova resize driver-impl-powervm=complete [operation.resume] title=Restore instance status=optional notes=See notes for the suspend operation -cli= -driver-impl-powervm=missing - -[operation.service-control.wtf.com] -title=Service control -status=optional -notes=Something something, dark side, something something. - Hard to claim this is mandatory when no one seems to know - what "Service control" refers to in the context of virt - drivers. -cli= +cli=nova resume driver-impl-powervm=missing [operation.set-admin-password] title=Set instance admin password status=optional -notes=Provides a mechanism to re(set) the password of the administrator +notes=Provides a mechanism to (re)set the password of the administrator account inside the instance operating system. This requires that the hypervisor has a way to communicate with the running guest operating system. Given the wide range of operating systems in existence it is @@ -277,7 +324,7 @@ notes=Provides a mechanism to re(set) the password of the administrator login to the guest and change the password in the normal manner, so this is just a convenient optimization. Therefore this operation is not considered mandatory for drivers to support. -cli= +cli=nova set-password driver-impl-powervm=missing [operation.snapshot] @@ -293,7 +340,7 @@ notes=The snapshot operation allows the current state of the that the root disks are ephemeral so the ability to take a snapshot cannot be assumed. Therefore this operation is not considered mandatory to support. -cli= +cli=nova image-create driver-impl-powervm=complete [operation.suspend] @@ -314,7 +361,7 @@ notes=Suspending an instance can be thought of as roughly since with cattle it would be simpler to just terminate the instance instead of suspending. Therefore this operation is considered optional to support. -cli= +cli=nova suspend driver-impl-powervm=missing [operation.swap-volume] @@ -328,7 +375,7 @@ notes=The swap volume operation is a mechanism for changing a running the pet use case rather than cattle, however, it is required for volume migration to work in the volume service. This is considered optional to support. -cli= +cli=nova volume-update driver-impl-powervm=missing [operation.terminate] @@ -338,7 +385,7 @@ notes=The ability to terminate a virtual machine is required in order for a cloud user to stop utilizing resources and thus avoid indefinitely ongoing billing. Therefore this operation is mandatory to support in drivers. -cli= +cli=nova delete driver-impl-powervm=complete [operation.trigger-crash-dump] @@ -349,21 +396,22 @@ notes=The trigger crash dump operation is a mechanism for triggering injecting an NMI (Non-maskable Interrupt) into the instance. It provides a means to dump the production memory image as a dump file which is useful for users. Therefore this operation is considered optional to support. -cli= +cli=nova trigger-crash-dump driver-impl-powervm=missing [operation.unpause] title=Resume instance CPUs (unpause) status=optional notes=See notes for the "Stop instance CPUs" operation -cli= +cli=nova unpause driver-impl-powervm=missing -[guest.disk.autoconfigure.wtf.com] +[guest.disk.autoconfig] title=Auto configure disk status=optional -notes=something something, dark side, something something. - Unclear just what this is about. +notes=Partition and resize FS to match the size specified by + flavors.root_gb, As this is hypervisor specific feature. + Therefore this operation is considered optional to support. cli= driver-impl-powervm=missing @@ -376,7 +424,7 @@ notes=The ability to set rate limits on virtual disks allows for operations to the hypervisor with its default settings, instead of doing fine grained tuning. Therefore this is not considered to be an mandatory configuration to support. -cli= +cli=nova limits driver-impl-powervm=missing [guest.setup.configdrive] @@ -387,7 +435,7 @@ notes=The config drive provides an information channel into administrator password, file injection, registration of SSH keys, etc. Since cloud images typically ship with all login methods locked, a mechanism to set the administrator - password of keys is required to get login access. Alternatives + password or keys is required to get login access. Alternatives include the metadata service and disk injection. At least one of the guest setup mechanisms is required to be supported by drivers, in order to enable login access. @@ -419,7 +467,7 @@ notes=This allows for static networking configuration (IP configured in the guest OS which is a non-trivial problem considering the vast number of operating system types. The problem of configuring networking is better solved by DHCP - or by obtaining static config via the metadata service or + or by obtaining static config via config drive. Therefore this operation is considered optional to support. cli= @@ -436,7 +484,7 @@ notes=This allows the administrator to interact with the graphical easier consumption. Therefore support for this operation is not mandatory, however, a driver is required to support at least one of the listed console access operations. -cli= +cli=nova get-rdp-console driver-impl-powervm=missing [console.serial.log] @@ -451,7 +499,7 @@ notes=This allows the administrator to query the logs of data only support graphical consoles. Therefore support for this operation is not mandatory, however, a driver is required to support at least one of the listed console access operations. -cli= +cli=nova console-log driver-impl-powervm=missing [console.serial.interactive] @@ -481,7 +529,7 @@ notes=This allows the administrator to interact with the graphical easier consumption. Therefore support for this operation is not mandatory, however, a driver is required to support at least one of the listed console access operations. -cli= +cli=nova get-spice-console driver-impl-powervm=missing [console.vnc] @@ -495,7 +543,7 @@ notes=This allows the administrator to interact with the graphical easier consumption. Therefore support for this operation is not mandatory, however, a driver is required to support at least one of the listed console access operations. -cli= +cli=nova get-vnc-console driver-impl-powervm=complete [storage.block] @@ -506,7 +554,7 @@ notes=Block storage provides instances with direct attached As an alternative to direct attached disks, an instance may choose to use network based persistent storage. OpenStack provides object storage via the Swift service, or a traditional filesystem - such as NFS/GlusterFS may be used. Some types of instances may + such as NFS may be used. Some types of instances may not require persistent storage at all, being simple transaction processing systems reading requests & sending results to and from the network. Therefore support for this configuration is not @@ -556,7 +604,7 @@ notes=This refers to the ability to boot an instance from an image there would be no way to get block volumes populated and reliance on external PXE servers is out of scope. Therefore this is considered a mandatory storage feature to support. -cli= +cli=nova boot --image driver-impl-powervm=complete [networking.firewallrules] @@ -599,8 +647,8 @@ driver-impl-powervm=complete [networking.topology.vlan] title=VLAN networking status=choice(networking.topology) -notes=Provide network connectivity to guests using VLANs - to define the topology. At least one of the networking +notes=Provide network connectivity to guests using VLANs to define the + topology when using nova-network. At least one of the networking configurations is mandatory to support in the drivers. cli= driver-impl-powervm=complete @@ -611,3 +659,49 @@ status=optional notes=This allows users to boot a guest with uefi firmware. cli= driver-impl-powervm=missing + +[operation.device-tags] +title=Device tags +status=optional +notes=This allows users to set tags on virtual devices when creating a + server instance. Device tags are used to identify virtual device + metadata, as exposed in the metadata API and on the config drive. + For example, a network interface tagged with "nic1" will appear in + the metadata along with its bus (ex: PCI), bus address + (ex: 0000:00:02.0), MAC address, and tag (nic1). If multiple networks + are defined, the order in which they appear in the guest operating + system will not necessarily reflect the order in which they are given + in the server boot request. Guests should therefore not depend on + device order to deduce any information about their network devices. + Instead, device role tags should be used. Device tags can be + applied to virtual network interfaces and block devices. +cli=nova boot +driver-impl-powervm=missing + +[operation.quiesce] +title=quiesce +status=optional +notes=Quiesce the specified instance to prepare for snapshots. + For libvirt, guest filesystems will be frozen through qemu + agent. +cli= +driver-impl-powervm=missing + +[operation.unquiesce] +title=unquiesce +status=optional +notes=See notes for the quiesce operation +cli= +driver-impl-powervm=missing + +[operation.multiattach-volume] +title=Attach block volume to multiple instances +status=optional +notes=The multiattach volume operation is an extension to + the attach volume operation. It allows to attach a + single volume to multiple instances. This operation is + not considered to be mandatory to support. + Note that for the libvirt driver, this is only supported + if qemu<2.10 or libvirt>=3.10. +cli=nova volume-attach +driver-impl-powervm=missing