Clarification note added to install guide docs (r5 and r6)

Added a note to clarify the user about using sriov. Closes-bug: 1943600 Signed-off-by: Elaine Fonaro <elaine.fonaro@windriver.com> Change-Id: I60c7ba32ce62f85821748b7ef80402c8726bfd7f
2022-04-14 11:11:50 -03:00 · 2022-04-14 11:11:50 -03:00 · e54422cf2b
commit e54422cf2b
parent 8180f26641
12 changed files with 126 additions and 14 deletions
--- a/doc/source/deploy_install_guides/r5_release/bare_metal/aio_duplex_install_kubernetes.rst
+++ b/doc/source/deploy_install_guides/r5_release/bare_metal/aio_duplex_install_kubernetes.rst
@ -269,7 +269,15 @@ Configure controller-0
            system host-label-assign controller-0 openstack-control-plane=enabled
            system host-label-assign controller-0 openstack-compute-node=enabled
            system host-label-assign controller-0 |vswitch-label|
-            system host-label-assign controller-0 sriov=enabled
+
+         .. note::
+
+            If you have a |NIC| that supports |SRIOV|, then you can enable it by
+            using the following:
+
+            .. code-block:: none
+
+               system host-label-assign controller-0 sriov=enabled

      .. only:: partner

@ -720,7 +728,15 @@ Configure controller-1
            system host-label-assign controller-1 openstack-control-plane=enabled
            system host-label-assign controller-1 openstack-compute-node=enabled
            system host-label-assign controller-1 |vswitch-label|
-            system host-label-assign controller-1 sriov=enabled
+
+         .. note::
+
+            If you have a |NIC| that supports |SRIOV|, then you can enable it by
+            using the following:
+
+            .. code-block:: none
+
+               system host-label-assign controller-0 sriov=enabled

      .. only:: partner

--- a/doc/source/deploy_install_guides/r5_release/bare_metal/aio_simplex_install_kubernetes.rst
+++ b/doc/source/deploy_install_guides/r5_release/bare_metal/aio_simplex_install_kubernetes.rst
@ -252,7 +252,15 @@ The newly installed controller needs to be configured.
            system host-label-assign controller-0 openstack-control-plane=enabled
            system host-label-assign controller-0 openstack-compute-node=enabled
            system host-label-assign controller-0 |vswitch-label|
-            system host-label-assign controller-0 sriov=enabled
+
+         .. note::
+
+            If you have a |NIC| that supports |SRIOV|, then you can enable it by
+            using the following:
+
+            .. code-block:: none
+
+               system host-label-assign controller-0 sriov=enabled

      .. only:: partner

--- a/doc/source/deploy_install_guides/r5_release/bare_metal/controller_storage_install_kubernetes.rst
+++ b/doc/source/deploy_install_guides/r5_release/bare_metal/controller_storage_install_kubernetes.rst
@ -631,9 +631,17 @@ Configure worker nodes
         for NODE in worker-0 worker-1; do
           system host-label-assign $NODE  openstack-compute-node=enabled
           system host-label-assign $NODE  |vswitch-label|
-           system host-label-assign $NODE  sriov=enabled
         done

+      .. note::
+
+         If you have a |NIC| that supports |SRIOV|, then you can enable it by
+         using the following:
+
+         .. code-block:: none
+
+            system host-label-assign controller-0 sriov=enabled
+
   #. **For OpenStack only:** Configure the host settings for the vSwitch.

      If using |OVS-DPDK| vswitch, run the following commands:
--- a/doc/source/deploy_install_guides/r5_release/virtual/aio_duplex_install_kubernetes.rst
+++ b/doc/source/deploy_install_guides/r5_release/virtual/aio_duplex_install_kubernetes.rst
@ -464,7 +464,15 @@ OpenStack-specific host configuration
    system host-label-assign controller-1 openstack-control-plane=enabled
    system host-label-assign controller-1 openstack-compute-node=enabled
    system host-label-assign controller-1 |vswitch-label|
-    system host-label-assign controller-1 sriov=enabled
+
+   .. note::
+
+      If you have a |NIC| that supports |SRIOV|, then you can enable it by
+      using the following:
+
+      .. code-block:: none
+
+         system host-label-assign controller-0 sriov=enabled

 #. **For OpenStack only:** Set up disk partition for nova-local volume group,
   which is needed for |prefix|-openstack nova ephemeral disks:
--- a/doc/source/deploy_install_guides/r5_release/virtual/aio_simplex_install_kubernetes.rst
+++ b/doc/source/deploy_install_guides/r5_release/virtual/aio_simplex_install_kubernetes.rst
@ -301,7 +301,15 @@ OpenStack-specific host configuration
     system host-label-assign controller-0 openstack-control-plane=enabled
     system host-label-assign controller-0 openstack-compute-node=enabled
     system host-label-assign controller-0 |vswitch-label|
-     system host-label-assign controller-0 sriov=enabled
+
+   .. note::
+
+      If you have a |NIC| that supports |SRIOV|, then you can enable it by
+      using the following:
+
+      .. code-block:: none
+
+         system host-label-assign controller-0 sriov=enabled

 #. **For OpenStack only:** A vSwitch is required.

--- a/doc/source/deploy_install_guides/r5_release/virtual/controller_storage_install_kubernetes.rst
+++ b/doc/source/deploy_install_guides/r5_release/virtual/controller_storage_install_kubernetes.rst
@ -511,9 +511,17 @@ OpenStack-specific host configuration
      for NODE in worker-0 worker-1; do
        system host-label-assign $NODE  openstack-compute-node=enabled
        system host-label-assign $NODE  openvswitch=enabled
-        system host-label-assign $NODE  sriov=enabled
      done

+   .. note::
+
+      If you have a |NIC| that supports |SRIOV|, then you can enable it by
+      using the following:
+
+      .. code-block:: none
+
+         system host-label-assign controller-0 sriov=enabled
+
 #. **For OpenStack only:** Set up disk partition for nova-local volume group,
   which is needed for |prefix|-openstack nova ephemeral disks:

--- a/doc/source/deploy_install_guides/r6_release/bare_metal/aio_duplex_install_kubernetes.rst
+++ b/doc/source/deploy_install_guides/r6_release/bare_metal/aio_duplex_install_kubernetes.rst
@ -272,7 +272,15 @@ Configure controller-0
            system host-label-assign controller-0 openstack-control-plane=enabled
            system host-label-assign controller-0 openstack-compute-node=enabled
            system host-label-assign controller-0 |vswitch-label|
-            system host-label-assign controller-0 sriov=enabled
+
+         .. note::
+
+            If you have a |NIC| that supports |SRIOV|, then you can enable it by
+            using the following:
+
+            .. code-block:: none
+
+               system host-label-assign controller-0 sriov=enabled

      .. only:: partner

@ -765,7 +773,15 @@ Configure controller-1
            system host-label-assign controller-1 openstack-control-plane=enabled
            system host-label-assign controller-1 openstack-compute-node=enabled
            system host-label-assign controller-1 |vswitch-label|
-            system host-label-assign controller-1 sriov=enabled
+
+         .. note::
+
+            If you have a |NIC| that supports |SRIOV|, then you can enable it by
+            using the following:
+
+            .. code-block:: none
+
+               system host-label-assign controller-0 sriov=enabled

      .. only:: partner

--- a/doc/source/deploy_install_guides/r6_release/bare_metal/aio_simplex_install_kubernetes.rst
+++ b/doc/source/deploy_install_guides/r6_release/bare_metal/aio_simplex_install_kubernetes.rst
@ -253,7 +253,15 @@ The newly installed controller needs to be configured.
            system host-label-assign controller-0 openstack-control-plane=enabled
            system host-label-assign controller-0 openstack-compute-node=enabled
            system host-label-assign controller-0 |vswitch-label|
-            system host-label-assign controller-0 sriov=enabled
+
+         .. note::
+
+            If you have a |NIC| that supports |SRIOV|, then you can enable it by
+            using the following:
+
+            .. code-block:: none
+
+               system host-label-assign controller-0 sriov=enabled

      .. only:: partner

--- a/doc/source/deploy_install_guides/r6_release/bare_metal/controller_storage_install_kubernetes.rst
+++ b/doc/source/deploy_install_guides/r6_release/bare_metal/controller_storage_install_kubernetes.rst
@ -633,9 +633,17 @@ Configure worker nodes
         for NODE in worker-0 worker-1; do
           system host-label-assign $NODE  openstack-compute-node=enabled
           system host-label-assign $NODE  |vswitch-label|
-           system host-label-assign $NODE  sriov=enabled
         done

+      .. note::
+
+         If you have a |NIC| that supports |SRIOV|, then you can enable it by
+         using the following:
+
+         .. code-block:: none
+
+            system host-label-assign controller-0 sriov=enabled
+
   #. **For OpenStack only:** Configure the host settings for the vSwitch.

      If using |OVS-DPDK| vswitch, run the following commands:
--- a/doc/source/deploy_install_guides/r6_release/virtual/aio_duplex_install_kubernetes.rst
+++ b/doc/source/deploy_install_guides/r6_release/virtual/aio_duplex_install_kubernetes.rst
@ -465,7 +465,15 @@ OpenStack-specific host configuration
    system host-label-assign controller-1 openstack-control-plane=enabled
    system host-label-assign controller-1 openstack-compute-node=enabled
    system host-label-assign controller-1 openvswitch=enabled
-    system host-label-assign controller-1 sriov=enabled
+
+   .. note::
+
+      If you have a |NIC| that supports |SRIOV|, then you can enable it by
+      using the following:
+
+      .. code-block:: none
+
+         system host-label-assign controller-0 sriov=enabled

 #. **For OpenStack only:** Set up disk partition for nova-local volume group,
   which is needed for |prefix|-openstack nova ephemeral disks:
--- a/doc/source/deploy_install_guides/r6_release/virtual/aio_simplex_install_kubernetes.rst
+++ b/doc/source/deploy_install_guides/r6_release/virtual/aio_simplex_install_kubernetes.rst
@ -301,7 +301,15 @@ OpenStack-specific host configuration
     system host-label-assign controller-0 openstack-control-plane=enabled
     system host-label-assign controller-0 openstack-compute-node=enabled
     system host-label-assign controller-0 |vswitch-label|
-     system host-label-assign controller-0 sriov=enabled
+
+   .. note::
+
+      If you have a |NIC| that supports |SRIOV|, then you can enable it by
+      using the following:
+
+      .. code-block:: none
+
+         system host-label-assign controller-0 sriov=enabled

 #. **For OpenStack only:** A vSwitch is required.

--- a/doc/source/deploy_install_guides/r6_release/virtual/controller_storage_install_kubernetes.rst
+++ b/doc/source/deploy_install_guides/r6_release/virtual/controller_storage_install_kubernetes.rst
@ -511,9 +511,17 @@ OpenStack-specific host configuration
      for NODE in worker-0 worker-1; do
        system host-label-assign $NODE  openstack-compute-node=enabled
        system host-label-assign $NODE  openvswitch=enabled
-        system host-label-assign $NODE  sriov=enabled
      done

+   .. note::
+
+      If you have a |NIC| that supports |SRIOV|, then you can enable it by
+      using the following:
+
+      .. code-block:: none
+
+         system host-label-assign controller-0 sriov=enabled
+
 #. **For OpenStack only:** Set up disk partition for nova-local volume group,
   which is needed for |prefix|-openstack nova ephemeral disks: