From fbfb1a25df63b314611161482a4c991040fed020 Mon Sep 17 00:00:00 2001 From: Matt Riedemann Date: Mon, 4 Mar 2019 16:41:58 -0500 Subject: [PATCH] doc: cleanup pci.alias references The admin and user flavor docs on pci.alias were not super helpful by just throwing the user to the config docs or flavor docs and letting them figure it out. This change helps the reader by linking directly to the things being referenced. Also cleans up a pci.passthrough config option reference while in here. Change-Id: Ie2e28a14ff4655e38a5db3925adcd605ac773843 --- doc/source/admin/pci-passthrough.rst | 11 +++++------ doc/source/user/flavors.rst | 4 +++- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/doc/source/admin/pci-passthrough.rst b/doc/source/admin/pci-passthrough.rst index 8a212a633d43..e80d747bbde7 100644 --- a/doc/source/admin/pci-passthrough.rst +++ b/doc/source/admin/pci-passthrough.rst @@ -70,8 +70,7 @@ Configure nova-api (Controller) [pci] alias = { "vendor_id":"8086", "product_id":"154d", "device_type":"type-PF", "name":"a1" } - For more information about the syntax of ``alias``, refer to - :doc:`/configuration/config`. + Refer to :oslo.config:option:`pci.alias` for syntax information. #. Restart the ``nova-api`` service. @@ -86,7 +85,7 @@ Configure a flavor to request two PCI devices, each with ``vendor_id`` of # openstack flavor set m1.large --property "pci_passthrough:alias"="a1:2" For more information about the syntax for ``pci_passthrough:alias``, refer to -:doc:`/user/flavors`. +:ref:`Flavors `. Enable PCI passthrough (Compute) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -137,8 +136,8 @@ Configure PCI devices (Compute) All PCI devices matching the ``vendor_id`` and ``product_id`` are added to the pool of PCI devices available for passthrough to VMs. - For more information about the syntax of ``passthrough_whitelist``, - refer to :doc:`/configuration/config`. + Refer to :oslo.config:option:`pci.passthrough_whitelist` for syntax + information. #. Specify the PCI alias for the device. @@ -156,7 +155,7 @@ Configure PCI devices (Compute) [pci] alias = { "vendor_id":"8086", "product_id":"154d", "device_type":"type-PF", "name":"a1" } - For more information about the syntax of ``alias``, refer to :doc:`/configuration/config`. + Refer to :oslo.config:option:`pci.alias` for syntax information. #. Restart the ``nova-compute`` service. diff --git a/doc/source/user/flavors.rst b/doc/source/user/flavors.rst index 7c3456d13195..51d990e62e75 100644 --- a/doc/source/user/flavors.rst +++ b/doc/source/user/flavors.rst @@ -606,6 +606,8 @@ Large pages allocation backed by huge pages. Otherwise, the guest OS will not be getting the performance benefit it is expecting. +.. _extra-spec-pci-passthrough: + PCI passthrough You can assign PCI devices to a guest by specifying them in the flavor. @@ -618,7 +620,7 @@ PCI passthrough - ALIAS: (string) The alias which correspond to a particular PCI device class as configured in the nova configuration file (see - :doc:`/configuration/config`). + :oslo.config:option:`pci.alias`). - COUNT: (integer) The amount of PCI devices of type ALIAS to be assigned to a guest.