diff --git a/deploy-guide/source/app-bridge-interface-configuration.rst b/deploy-guide/source/app-bridge-interface-configuration.rst index 896197f..963a59b 100644 --- a/deploy-guide/source/app-bridge-interface-configuration.rst +++ b/deploy-guide/source/app-bridge-interface-configuration.rst @@ -1,6 +1,6 @@ -========================================== -Appendix V: Bridge interface configuration -========================================== +============================== +Bridge interface configuration +============================== Overview -------- diff --git a/deploy-guide/source/app-hardware-offload.rst b/deploy-guide/source/app-hardware-offload.rst index c5bb932..a2cf769 100644 --- a/deploy-guide/source/app-hardware-offload.rst +++ b/deploy-guide/source/app-hardware-offload.rst @@ -1,6 +1,6 @@ -================================ -Appendix S: NIC hardware offload -================================ +=========================== +Network hardware offloading +=========================== Overview -------- diff --git a/deploy-guide/source/app-octavia.rst b/deploy-guide/source/app-octavia.rst index dd747b6..943b176 100644 --- a/deploy-guide/source/app-octavia.rst +++ b/deploy-guide/source/app-octavia.rst @@ -1,6 +1,6 @@ -========================= -Appendix H: Octavia LBaaS -========================= +============= +Octavia LBaaS +============= Overview -------- diff --git a/deploy-guide/source/app-ovn.rst b/deploy-guide/source/app-ovn.rst index aaf7071..17d4ed7 100644 --- a/deploy-guide/source/app-ovn.rst +++ b/deploy-guide/source/app-ovn.rst @@ -1,6 +1,6 @@ -====================================== -Appendix O: Open Virtual Network (OVN) -====================================== +========================== +Open Virtual Network (OVN) +========================== Overview -------- @@ -104,7 +104,7 @@ for use with hardware offloading and make them available to OpenStack. To use the feature you need to use supported network interface card (NIC) hardware. We have done feature validation using the Mellanox ConnectX-5 NICs. -Please refer to the `NIC hardware offload`_ appendix for more background on the +Please refer to `Network hardware offloading`_ for more background on the feature. Hardware offload support makes use of SR-IOV as an underlying mechanism to @@ -121,8 +121,8 @@ with appropriate driver and firmware support. Prerequisites ^^^^^^^^^^^^^ -Please refer to the `SR-IOV for networking support`_ section and the `NIC -hardware offload`_ appendix for information on hardware and kernel +Please refer to the `SR-IOV for networking support`_ section and the `Network +hardware offloading`_ page for information on hardware and kernel configuration. Charm configuration @@ -1017,7 +1017,7 @@ Perform migration .. _DPDK supported hardware page: http://core.dpdk.org/supported/ .. _MAAS: https://maas.io/ .. _Customizing instance huge pages allocations: https://docs.openstack.org/nova/latest/admin/huge-pages.html#customizing-instance-huge-pages-allocations -.. _NIC hardware offload: app-hardware-offload +.. _Network hardware offloading: app-hardware-offload.html .. _SR-IOV for networking support: app-ovn.html#sr-iov-for-networking-support .. _traffic control monitor: http://manpages.ubuntu.com/manpages/focal/man8/tc.8.html#monitor .. _data path control tools: http://manpages.ubuntu.com/manpages/focal/man8/ovs-dpctl.8.html diff --git a/deploy-guide/source/index.rst b/deploy-guide/source/index.rst index 5087bbe..56975b8 100644 --- a/deploy-guide/source/index.rst +++ b/deploy-guide/source/index.rst @@ -54,26 +54,31 @@ contribution`_. app-nova-cells app-pci-passthrough-gpu +.. toctree:: + :caption: Networking + :maxdepth: 1 + + app-ovn + app-hardware-offload + app-octavia + app-bridge-interface-configuration + .. toctree:: :caption: Appendices :maxdepth: 1 Managing TLS certificates with Vault Encryption at Rest - Octavia LBaaS Ceph erasure coding Ceph RADOS Gateway multisite replication Ceph RBD mirroring Ceph charm deprecation Masakari - OVN Managing power events Manila Ganesha Swift usage - NIC hardware offload High availability TrilioVault Data Protection - Bridge interface configuration .. LINKS .. _file an issue: https://bugs.launchpad.net/charm-deployment-guide/+filebug