Rename vgpu options to mdev

As a prerequisite for blueprint generic-mdevs we need to rename the
existing enabled_vgpu_types options and dynamically generated groups
into enabled_mdev_types.
There is no upgrade impact for existing users, as the original
options are still accepted.

NOTE(sbauza): As we have a lot of methods and objects named gpu-ish
let's just change what we need here and provide followups for
fixing internal tech debt later.

Change-Id: Idba094f6366a24965804b88da0bc1b9754549c99
Partially-Implements: blueprint generic-mdevs

Author: sbauza

doc/source/admin/virtual-gpu.rst

@@ -33,25 +33,25 @@ Enable GPU types (Compute)
 
 #. Specify which specific GPU type(s) the instances would get.
 
-   Edit :oslo.config:option:`devices.enabled_vgpu_types`:
+   Edit :oslo.config:option:`devices.enabled_mdev_types`:
 
    .. code-block:: ini
 
       [devices]
-      enabled_vgpu_types = nvidia-35
+      enabled_mdev_types = nvidia-35
 
    If you want to support more than a single GPU type, you need to provide a
    separate configuration section for each device. For example:
 
    .. code-block:: ini
 
       [devices]
-      enabled_vgpu_types = nvidia-35, nvidia-36
+      enabled_mdev_types = nvidia-35, nvidia-36
 
-      [vgpu_nvidia-35]
+      [mdev_nvidia-35]
       device_addresses = 0000:84:00.0,0000:85:00.0
 
-      [vgpu_nvidia-36]
+      [mdev_nvidia-36]
       device_addresses = 0000:86:00.0
 
    where you have to define which physical GPUs are supported per GPU type.

nova/conf/devices.py

@@ -16,36 +16,39 @@
     name='devices',
     title='physical or virtual device options')
 
-vgpu_opts = [
-    cfg.ListOpt('enabled_vgpu_types',
+mdev_opts = [
+    cfg.ListOpt('enabled_mdev_types',
         default=[],
+        deprecated_name='enabled_vgpu_types',
         help="""
-The vGPU types enabled in the compute node.
+The mdev types enabled in the compute node.
 
-Some pGPUs (e.g. NVIDIA GRID K1) support different vGPU types. User can use
-this option to specify a list of enabled vGPU types that may be assigned to a
+Some hardware (e.g. NVIDIA GRID K1) support different mdev types. User can use
+this option to specify a list of enabled mdev types that may be assigned to a
 guest instance.
 
-If more than one single vGPU type is provided, then for each *vGPU type* an
-additional section, ``[vgpu_$(VGPU_TYPE)]``, must be added to the configuration
+If more than one single mdev type is provided, then for each *mdev type* an
+additional section, ``[mdev_$(MDEV_TYPE)]``, must be added to the configuration
 file. Each section then **must** be configured with a single configuration
 option, ``device_addresses``, which should be a list of PCI addresses
-corresponding to the physical GPU(s) to assign to this type.
+corresponding to the physical GPU(s) or mdev-capable hardware to assign to this
+type.
 
 If one or more sections are missing (meaning that a specific type is not wanted
-to use for at least one physical GPU) or if no device addresses are provided,
-then Nova will only use the first type that was provided by
-``[devices]/enabled_vgpu_types``.
+to use for at least one physical device) or if no device addresses are provided
+, then Nova will only use the first type that was provided by
+``[devices]/enabled_mdev_types``.
 
 If the same PCI address is provided for two different types, nova-compute will
 return an InvalidLibvirtGPUConfig exception at restart.
 
-An example is as the following::
+As an interim period, old configuration groups named ``[vgpu_$(MDEV_TYPE)]``
+will be accepted. A valid configuration could then be::
 
     [devices]
-    enabled_vgpu_types = nvidia-35, nvidia-36
+    enabled_mdev_types = nvidia-35, nvidia-36
 
-    [vgpu_nvidia-35]
+    [mdev_nvidia-35]
     device_addresses = 0000:84:00.0,0000:85:00.0
 
     [vgpu_nvidia-36]
@@ -57,7 +60,7 @@
 
 def register_opts(conf):
     conf.register_group(devices_group)
-    conf.register_opts(vgpu_opts, group=devices_group)
+    conf.register_opts(mdev_opts, group=devices_group)
 
 
 def register_dynamic_opts(conf):
@@ -66,14 +69,15 @@ def register_dynamic_opts(conf):
     This must be called by the service that wishes to use the options **after**
     the initial configuration has been loaded.
     """
-    opt = cfg.ListOpt('device_addresses', default=[],
-                      item_type=cfg.types.String())
 
-    # Register the '[vgpu_$(VGPU_TYPE)]/device_addresses' opts, implicitly
-    # registering the '[vgpu_$(VGPU_TYPE)]' groups in the process
-    for vgpu_type in conf.devices.enabled_vgpu_types:
-        conf.register_opt(opt, group='vgpu_%s' % vgpu_type)
+    # Register the '[mdev_$(MDEV_TYPE)]/device_addresses' opts, implicitly
+    # registering the '[mdev_$(MDEV_TYPE)]' groups in the process
+    for mdev_type in conf.devices.enabled_mdev_types:
+        opt = cfg.ListOpt('device_addresses', default=[],
+                          item_type=cfg.types.String(),
+                          deprecated_group='vgpu_%s' % mdev_type)
+        conf.register_opt(opt, group='mdev_%s' % mdev_type)
 
 
 def list_opts():
-    return {devices_group: vgpu_opts}
+    return {devices_group: mdev_opts}

nova/tests/functional/libvirt/test_reshape.py

@@ -79,7 +79,7 @@ def test_create_servers_with_vgpu(
 
         # start a compute with vgpu support disabled so the driver will
         # ignore the content of the above HostMdevDeviceInfo
-        self.flags(enabled_vgpu_types='', group='devices')
+        self.flags(enabled_mdev_types='', group='devices')
 
         hostname = self.start_compute(
             hostname='compute1',
@@ -106,7 +106,7 @@ def test_create_servers_with_vgpu(
 
         # enabled vgpu support
         self.flags(
-            enabled_vgpu_types=fakelibvirt.NVIDIA_11_VGPU_TYPE,
+            enabled_mdev_types=fakelibvirt.NVIDIA_11_VGPU_TYPE,
             group='devices')
         # We don't want to restart the compute service or it would call for
         # a reshape but we still want to accept some vGPU types so we call

nova/tests/functional/libvirt/test_vgpu.py

@@ -132,7 +132,7 @@ def setUp(self):
 
         # Start compute1 supporting only nvidia-11
         self.flags(
-            enabled_vgpu_types=fakelibvirt.NVIDIA_11_VGPU_TYPE,
+            enabled_mdev_types=fakelibvirt.NVIDIA_11_VGPU_TYPE,
             group='devices')
 
         # for the sake of resizing, we need to patch the two methods below
@@ -293,7 +293,7 @@ def setUp(self):
         self.flavor = self._create_flavor(extra_spec=extra_spec)
 
         self.flags(
-            enabled_vgpu_types=[fakelibvirt.NVIDIA_11_VGPU_TYPE,
+            enabled_mdev_types=[fakelibvirt.NVIDIA_11_VGPU_TYPE,
                                 fakelibvirt.NVIDIA_12_VGPU_TYPE],
             group='devices')
         # we need to call the below again to ensure the updated
@@ -304,8 +304,8 @@ def setUp(self):
         #  - 0000:81:01.0 will only support nvidia-12
         pgpu1_pci_addr = self.libvirt2pci_address(fakelibvirt.PGPU1_PCI_ADDR)
         pgpu2_pci_addr = self.libvirt2pci_address(fakelibvirt.PGPU2_PCI_ADDR)
-        self.flags(device_addresses=[pgpu1_pci_addr], group='vgpu_nvidia-11')
-        self.flags(device_addresses=[pgpu2_pci_addr], group='vgpu_nvidia-12')
+        self.flags(device_addresses=[pgpu1_pci_addr], group='mdev_nvidia-11')
+        self.flags(device_addresses=[pgpu2_pci_addr], group='mdev_nvidia-12')
 
         # Prepare traits for later on
         self._create_trait('CUSTOM_NVIDIA_11')

nova/tests/unit/conf/test_devices.py

@@ -20,15 +20,15 @@
 class DevicesConfTestCase(test.NoDBTestCase):
 
     def test_register_dynamic_opts(self):
-        self.flags(enabled_vgpu_types=['nvidia-11', 'nvidia-12'],
+        self.flags(enabled_mdev_types=['nvidia-11', 'nvidia-12'],
                    group='devices')
 
-        self.assertNotIn('vgpu_nvidia-11', CONF)
-        self.assertNotIn('vgpu_nvidia-12', CONF)
+        self.assertNotIn('mdev_nvidia-11', CONF)
+        self.assertNotIn('mdev_nvidia-12', CONF)
 
         nova.conf.devices.register_dynamic_opts(CONF)
 
-        self.assertIn('vgpu_nvidia-11', CONF)
-        self.assertIn('vgpu_nvidia-12', CONF)
-        self.assertEqual([], getattr(CONF, 'vgpu_nvidia-11').device_addresses)
-        self.assertEqual([], getattr(CONF, 'vgpu_nvidia-12').device_addresses)
+        self.assertIn('mdev_nvidia-11', CONF)
+        self.assertIn('mdev_nvidia-12', CONF)
+        self.assertEqual([], getattr(CONF, 'mdev_nvidia-11').device_addresses)
+        self.assertEqual([], getattr(CONF, 'mdev_nvidia-12').device_addresses)