diff --git a/doc/source/admin/config-address-scopes.rst b/doc/source/admin/config-address-scopes.rst index 21cb8f79612..2b7c6f3c01a 100644 --- a/doc/source/admin/config-address-scopes.rst +++ b/doc/source/admin/config-address-scopes.rst @@ -1,7 +1,7 @@ .. _config-address-scopes: ============== -Address scopes +Address Scopes ============== Address scopes build from subnet pools. While subnet pools provide a mechanism diff --git a/doc/source/admin/config-az.rst b/doc/source/admin/config-az.rst index 45269378ad0..37fff234a8c 100644 --- a/doc/source/admin/config-az.rst +++ b/doc/source/admin/config-az.rst @@ -1,7 +1,7 @@ .. _config-az: ================== -Availability zones +Availability Zones ================== An availability zone groups network nodes that run services like DHCP, L3, FW, diff --git a/doc/source/admin/config-bgp-dynamic-routing.rst b/doc/source/admin/config-bgp-dynamic-routing.rst index e150a0cbf29..34e94c9215f 100644 --- a/doc/source/admin/config-bgp-dynamic-routing.rst +++ b/doc/source/admin/config-bgp-dynamic-routing.rst @@ -1,7 +1,7 @@ .. _config-bgp-dynamic-routing: =================== -BGP dynamic routing +BGP Dynamic Routing =================== BGP dynamic routing enables advertisement of self-service (private) network diff --git a/doc/source/admin/config-bgp-floating-ip-over-l2-segmented-network.rst b/doc/source/admin/config-bgp-floating-ip-over-l2-segmented-network.rst index dcedcf827a8..0f6321194c4 100644 --- a/doc/source/admin/config-bgp-floating-ip-over-l2-segmented-network.rst +++ b/doc/source/admin/config-bgp-floating-ip-over-l2-segmented-network.rst @@ -1,8 +1,8 @@ .. _config-bgp-floating-ip-over-l2-segmented-network: -========================================== -BGP floating IPs over l2 segmented network -========================================== +=========================================== +BGP Floating IPs over L2 Segmented Networks +=========================================== The general principle is that L2 connectivity will be bound to a single rack. Everything outside the switches of the rack will be routed using BGP. To diff --git a/doc/source/admin/config-dhcp-ha.rst b/doc/source/admin/config-dhcp-ha.rst index fcfbc87d40b..ca6637670e4 100644 --- a/doc/source/admin/config-dhcp-ha.rst +++ b/doc/source/admin/config-dhcp-ha.rst @@ -1,8 +1,8 @@ .. _config-dhcp-ha: -========================== -High-availability for DHCP -========================== +====================== +DHCP High-availability +====================== This section describes how to use the agent management (alias agent) and scheduler (alias agent_scheduler) extensions for DHCP agents diff --git a/doc/source/admin/config-dns-int-ext-serv.rst b/doc/source/admin/config-dns-int-ext-serv.rst index 7bceae0d428..9dbfcf4bb13 100644 --- a/doc/source/admin/config-dns-int-ext-serv.rst +++ b/doc/source/admin/config-dns-int-ext-serv.rst @@ -1,7 +1,7 @@ .. _config-dns-int-ext-serv: ======================================== -DNS integration with an external service +DNS Integration with an External Service ======================================== This page serves as a guide for how to use the DNS integration functionality of diff --git a/doc/source/admin/config-dns-int.rst b/doc/source/admin/config-dns-int.rst index 79d8410eb3c..edd9559e22d 100644 --- a/doc/source/admin/config-dns-int.rst +++ b/doc/source/admin/config-dns-int.rst @@ -1,7 +1,7 @@ .. _config-dns-int: =============== -DNS integration +DNS Integration =============== This page serves as a guide for how to use the DNS integration functionality of diff --git a/doc/source/admin/config-dns-res.rst b/doc/source/admin/config-dns-res.rst index c7b5601a587..2c13afdc48e 100644 --- a/doc/source/admin/config-dns-res.rst +++ b/doc/source/admin/config-dns-res.rst @@ -1,7 +1,7 @@ .. _config-dns-res: ============================ -DNS resolution for instances +DNS Resolution for Instances ============================ The Networking service offers several methods to configure name diff --git a/doc/source/admin/config-experimental-framework.rst b/doc/source/admin/config-experimental-framework.rst index 6d520ff6075..4a8553ee826 100644 --- a/doc/source/admin/config-experimental-framework.rst +++ b/doc/source/admin/config-experimental-framework.rst @@ -1,7 +1,7 @@ .. _config-experimental-framework: =============================== -Experimental features framework +Experimental Features Framework =============================== Some Neutron features are not supported because the community doesn't have diff --git a/doc/source/admin/config-fip-port-forwardings.rst b/doc/source/admin/config-fip-port-forwardings.rst index 7493b02c3ae..530b013d39f 100644 --- a/doc/source/admin/config-fip-port-forwardings.rst +++ b/doc/source/admin/config-fip-port-forwardings.rst @@ -1,7 +1,7 @@ .. _config-fip-port-forwardings: =========================== -Floating IP port forwarding +Floating IP Port Forwarding =========================== Floating IP port forwarding enables users to forward traffic from a diff --git a/doc/source/admin/config-ipam.rst b/doc/source/admin/config-ipam.rst index 1f0b4f34488..f43f9b5ee9f 100644 --- a/doc/source/admin/config-ipam.rst +++ b/doc/source/admin/config-ipam.rst @@ -1,7 +1,7 @@ .. _config-ipam: ================== -IPAM configuration +IPAM Configuration ================== Starting with the Liberty release, OpenStack Networking includes a pluggable diff --git a/doc/source/admin/config-logging.rst b/doc/source/admin/config-logging.rst index ba1953738c7..4abcfc1c48c 100644 --- a/doc/source/admin/config-logging.rst +++ b/doc/source/admin/config-logging.rst @@ -1,8 +1,8 @@ .. _config-logging: -================================ -Neutron Packet Logging Framework -================================ +======================== +Packet Logging Framework +======================== Packet logging service is designed as a Neutron plug-in that captures network packets for relevant resources (e.g. security group or firewall group) when the diff --git a/doc/source/admin/config-macvtap.rst b/doc/source/admin/config-macvtap.rst index 11857959414..d90a75fff44 100644 --- a/doc/source/admin/config-macvtap.rst +++ b/doc/source/admin/config-macvtap.rst @@ -1,7 +1,7 @@ .. _config-macvtap: ======================== -Macvtap mechanism driver +Macvtap Mechanism Driver ======================== The Macvtap mechanism driver for the ML2 plug-in generally increases diff --git a/doc/source/admin/config-metadata-caching.rst b/doc/source/admin/config-metadata-caching.rst index be2e8921e12..19938964652 100644 --- a/doc/source/admin/config-metadata-caching.rst +++ b/doc/source/admin/config-metadata-caching.rst @@ -1,7 +1,7 @@ .. _config-metadata-caching: ======================== -Metadata service caching +Metadata Service Caching ======================== The OpenStack Networking service proxies requests that VMs send to the diff --git a/doc/source/admin/config-metadata-rate-limiting.rst b/doc/source/admin/config-metadata-rate-limiting.rst index a5a61ce6dd9..8fcdf339d6f 100644 --- a/doc/source/admin/config-metadata-rate-limiting.rst +++ b/doc/source/admin/config-metadata-rate-limiting.rst @@ -1,7 +1,7 @@ .. _config-metadata-rate-limiting: ==================================== -Metadata service query rate limiting +Metadata Service Query Rate-limiting ==================================== The OpenStack Networking service proxies the requests that VMs send to the diff --git a/doc/source/admin/config-ml2.rst b/doc/source/admin/config-ml2.rst index f2818946d28..1ae205f7550 100644 --- a/doc/source/admin/config-ml2.rst +++ b/doc/source/admin/config-ml2.rst @@ -1,7 +1,7 @@ .. _config-plugin-ml2: =========== -ML2 plug-in +ML2 Plug-in =========== Architecture diff --git a/doc/source/admin/config-mtu.rst b/doc/source/admin/config-mtu.rst index 78892c75630..f0b3ce85e81 100644 --- a/doc/source/admin/config-mtu.rst +++ b/doc/source/admin/config-mtu.rst @@ -1,7 +1,7 @@ .. _config-mtu: ================== -MTU considerations +MTU Considerations ================== The Networking service uses the MTU of the underlying physical network to diff --git a/doc/source/admin/config-ndp-proxy.rst b/doc/source/admin/config-ndp-proxy.rst index 02ab946c297..f73274f65e8 100644 --- a/doc/source/admin/config-ndp-proxy.rst +++ b/doc/source/admin/config-ndp-proxy.rst @@ -1,7 +1,7 @@ .. _config-ndp-proxy: ========= -NDP proxy +NDP Proxy ========= If NDP proxy is set on a router, it is used to publish IPv6 addresses to diff --git a/doc/source/admin/config-network-segment-ranges.rst b/doc/source/admin/config-network-segment-ranges.rst index 3dafe787bbb..cbfc0360afc 100644 --- a/doc/source/admin/config-network-segment-ranges.rst +++ b/doc/source/admin/config-network-segment-ranges.rst @@ -1,7 +1,7 @@ .. _config-network-segment-ranges: ====================== -Network segment ranges +Network Segment Ranges ====================== The network segment range service exposes the segment range management to be diff --git a/doc/source/admin/config-ovs-dpdk.rst b/doc/source/admin/config-ovs-dpdk.rst index 98d747c2428..0bc0f1212f3 100644 --- a/doc/source/admin/config-ovs-dpdk.rst +++ b/doc/source/admin/config-ovs-dpdk.rst @@ -1,7 +1,7 @@ .. _config-ovs-dpdk: =============================== -Open vSwitch with DPDK datapath +Open vSwitch with DPDK Datapath =============================== This page serves as a guide for how to use the OVS with DPDK datapath diff --git a/doc/source/admin/config-ovs-offload.rst b/doc/source/admin/config-ovs-offload.rst index c3709693741..f990ba1dce6 100644 --- a/doc/source/admin/config-ovs-offload.rst +++ b/doc/source/admin/config-ovs-offload.rst @@ -1,7 +1,7 @@ .. _config-ovs-offload: ================================ -Open vSwitch hardware offloading +Open vSwitch Hardware Offloading ================================ The purpose of this page is to describe how to enable Open vSwitch hardware diff --git a/doc/source/admin/config-ovsfwdriver.rst b/doc/source/admin/config-ovsfwdriver.rst index e3f5f680bf2..b6495562a91 100644 --- a/doc/source/admin/config-ovsfwdriver.rst +++ b/doc/source/admin/config-ovsfwdriver.rst @@ -1,7 +1,7 @@ .. _config-ovsfwdriver: =================================== -Native Open vSwitch firewall driver +Open vSwitch Native Firewall Driver =================================== Historically, Open vSwitch (OVS) could not interact directly with *iptables* diff --git a/doc/source/admin/config-service-subnets.rst b/doc/source/admin/config-service-subnets.rst index 7c5e1a12056..8c7a0e37768 100644 --- a/doc/source/admin/config-service-subnets.rst +++ b/doc/source/admin/config-service-subnets.rst @@ -1,7 +1,7 @@ .. _config-service-subnets: =============== -Service subnets +Service Subnets =============== Service subnets enable operators to define valid port types for each diff --git a/doc/source/admin/config-services-agent.rst b/doc/source/admin/config-services-agent.rst index 43dbfd99790..3647aafaa0a 100644 --- a/doc/source/admin/config-services-agent.rst +++ b/doc/source/admin/config-services-agent.rst @@ -1,7 +1,7 @@ .. _config-services-agent: =================== -Services and agents +Agents and Services =================== A usual neutron setup consists of multiple services and agents running on one diff --git a/doc/source/admin/config-sfc.rst b/doc/source/admin/config-sfc.rst index 258ba8926e1..fec3ee50ba8 100644 --- a/doc/source/admin/config-sfc.rst +++ b/doc/source/admin/config-sfc.rst @@ -1,7 +1,7 @@ .. _adv-config-sfc: ========================= -Service function chaining +Service Function Chaining ========================= Service function chain (SFC) essentially refers to the diff --git a/doc/source/admin/config-subnet-onboard.rst b/doc/source/admin/config-subnet-onboard.rst index c7632baa01c..0a89aeee64f 100644 --- a/doc/source/admin/config-subnet-onboard.rst +++ b/doc/source/admin/config-subnet-onboard.rst @@ -1,8 +1,8 @@ .. _config-subnet-onboard: -============== -Subnet onboard -============== +================= +Subnet Onboarding +================= The subnet onboard feature allows you to take existing subnets that have been created outside of a subnet pool and move them into an existing subnet pool. diff --git a/doc/source/admin/config-subnet-pools.rst b/doc/source/admin/config-subnet-pools.rst index b3a1ea7b60f..a15b373f368 100644 --- a/doc/source/admin/config-subnet-pools.rst +++ b/doc/source/admin/config-subnet-pools.rst @@ -1,7 +1,7 @@ .. _config-subnet-pools: ============ -Subnet pools +Subnet Pools ============ Subnet pools have been made available since the Kilo release. It is a simple diff --git a/doc/source/admin/config-wsgi.rst b/doc/source/admin/config-wsgi.rst index bae46aadd61..6d257b2225c 100644 --- a/doc/source/admin/config-wsgi.rst +++ b/doc/source/admin/config-wsgi.rst @@ -1,9 +1,9 @@ .. _config-wsgi: -Installing Neutron API via WSGI +WSGI Usage with the Neutron API =============================== -This document is a guide to deploying neutron using WSGI. There are two ways to +This document is a guide to deploying Neutron using WSGI. There are two ways to deploy using WSGI: ``uwsgi`` and Apache ``mod_wsgi``. Please note that if you intend to use mode uwsgi, you should install the diff --git a/doc/source/admin/config.rst b/doc/source/admin/config.rst index fa61f7a5868..cb598beedab 100644 --- a/doc/source/admin/config.rst +++ b/doc/source/admin/config.rst @@ -7,12 +7,12 @@ Configuration .. toctree:: :maxdepth: 2 - config-services-agent - config-ml2 config-address-scopes + config-services-agent config-auto-allocation config-az config-bgp-dynamic-routing + config-bgp-floating-ip-over-l2-segmented-network config-dhcp-ha config-dns-int config-dns-int-ext-serv @@ -22,27 +22,27 @@ Configuration config-fip-port-forwardings config-ipam config-ipv6 - config-logging config-macvtap config-metadata-caching config-metadata-rate-limiting + config-ml2 config-mtu config-ndp-proxy config-network-segment-ranges config-ovs-dpdk config-ovs-offload config-ovsfwdriver + config-logging config-qos config-qos-min-bw config-qos-min-pps config-rbac config-routed-networks - config-sfc config-sriov - config-subnet-pools - config-subnet-onboard + config-sfc config-service-subnets - config-bgp-floating-ip-over-l2-segmented-network + config-subnet-onboard + config-subnet-pools config-trunking config-wsgi diff --git a/doc/source/contributor/internals/address_scopes.rst b/doc/source/contributor/internals/address_scopes.rst index d16d64eedc4..a2b25c03bf2 100644 --- a/doc/source/contributor/internals/address_scopes.rst +++ b/doc/source/contributor/internals/address_scopes.rst @@ -1,4 +1,4 @@ -Subnet Pools and Address Scopes +Address Scopes and Subnet Pools =============================== This page discusses subnet pools and address scopes diff --git a/doc/source/contributor/internals/agent_extensions.rst b/doc/source/contributor/internals/agent_extensions.rst index 56339655e9e..137c623f2b5 100644 --- a/doc/source/contributor/internals/agent_extensions.rst +++ b/doc/source/contributor/internals/agent_extensions.rst @@ -21,7 +21,7 @@ (Avoid deeper levels because they do not render well.) -Agent extensions +Agent Extensions ================ All reference agents utilize a common extension mechanism that allows for the diff --git a/doc/source/contributor/internals/api_layer.rst b/doc/source/contributor/internals/api_layer.rst index d4c08ee4201..ab0f36a8e9f 100644 --- a/doc/source/contributor/internals/api_layer.rst +++ b/doc/source/contributor/internals/api_layer.rst @@ -21,8 +21,8 @@ (Avoid deeper levels because they do not render well.) -Neutron WSGI/HTTP API layer -=========================== +API Layer for Neutron WSGI/HTTP +=============================== This section will cover the internals of Neutron's HTTP API, and the classes in Neutron that can be used to create Extensions to the Neutron API. diff --git a/doc/source/contributor/internals/code_profiling.rst b/doc/source/contributor/internals/code_profiling.rst index da6126c44dd..1acde376ba1 100644 --- a/doc/source/contributor/internals/code_profiling.rst +++ b/doc/source/contributor/internals/code_profiling.rst @@ -21,8 +21,8 @@ (Avoid deeper levels because they do not render well.) -Profiling Neutron Code -====================== +Code Profiling +============== As more functionality is added to Neutron over time, efforts to improve performance become more difficult, given the rising complexity of the code. diff --git a/doc/source/contributor/internals/db_layer.rst b/doc/source/contributor/internals/db_layer.rst index 4cedbe81ee3..d5b6010754e 100644 --- a/doc/source/contributor/internals/db_layer.rst +++ b/doc/source/contributor/internals/db_layer.rst @@ -21,8 +21,8 @@ (Avoid deeper levels because they do not render well.) -Neutron Database Layer -====================== +Database Layer +============== This section contains some common information that will be useful for developers that need to do some database changes as well as to execute queries diff --git a/doc/source/contributor/internals/db_models.rst b/doc/source/contributor/internals/db_models.rst index edb112f662f..9b52058bda6 100644 --- a/doc/source/contributor/internals/db_models.rst +++ b/doc/source/contributor/internals/db_models.rst @@ -12,8 +12,8 @@ under the License. -Relocation of Database Models -============================= +Database Models Relocation +========================== This document is intended to track and notify developers that db models in neutron will be centralized and moved to a new tree under neutron/db/models. diff --git a/doc/source/contributor/internals/dns_order.rst b/doc/source/contributor/internals/dns_order.rst index cdac01464a2..8370f061791 100644 --- a/doc/source/contributor/internals/dns_order.rst +++ b/doc/source/contributor/internals/dns_order.rst @@ -21,8 +21,8 @@ (Avoid deeper levels because they do not render well.) -Keep DNS Nameserver Order Consistency In Neutron -================================================ +DNS Nameserver Order Consistency +================================ In Neutron subnets, DNS nameservers are given priority when created or updated. This means if you create a subnet with multiple DNS servers, the order will diff --git a/doc/source/contributor/internals/external_dns_integration.rst b/doc/source/contributor/internals/external_dns_integration.rst index 4261fc67c4a..a8552c80717 100644 --- a/doc/source/contributor/internals/external_dns_integration.rst +++ b/doc/source/contributor/internals/external_dns_integration.rst @@ -12,8 +12,8 @@ under the License. -Integration with external DNS services -====================================== +External DNS Service Integration +================================ Since the Mitaka release, neutron has an interface defined to interact with an external DNS service. This interface is based on an abstract driver that can be diff --git a/doc/source/contributor/internals/i18n.rst b/doc/source/contributor/internals/i18n.rst index 51d6c9b9202..c68d0bb528a 100644 --- a/doc/source/contributor/internals/i18n.rst +++ b/doc/source/contributor/internals/i18n.rst @@ -21,8 +21,8 @@ (Avoid deeper levels because they do not render well.) -Neutron Stadium i18n -==================== +i18n for the Neutron Stadium +============================ * Refer to oslo_i18n documentation for the general mechanisms that should be used: https://docs.openstack.org/oslo.i18n/latest/user/usage.html diff --git a/doc/source/contributor/internals/index.rst b/doc/source/contributor/internals/index.rst index 52776d6ae6a..a3d4c50798a 100644 --- a/doc/source/contributor/internals/index.rst +++ b/doc/source/contributor/internals/index.rst @@ -53,6 +53,7 @@ Neutron Internals objects_usage openvswitch_agent openvswitch_firewall + ovn/index ovs_vhostuser plugin-api policy @@ -69,4 +70,3 @@ Neutron Internals sriov_nic_agent tag upgrade - ovn/index diff --git a/doc/source/contributor/internals/l2_agent_extensions.rst b/doc/source/contributor/internals/l2_agent_extensions.rst index 0a4e7782581..ca647d202a7 100644 --- a/doc/source/contributor/internals/l2_agent_extensions.rst +++ b/doc/source/contributor/internals/l2_agent_extensions.rst @@ -21,7 +21,7 @@ (Avoid deeper levels because they do not render well.) -L2 agent extensions +L2 Agent Extensions =================== L2 agent extensions are part of a generalized L2/L3 extension framework. See diff --git a/doc/source/contributor/internals/l3_agent_extensions.rst b/doc/source/contributor/internals/l3_agent_extensions.rst index 6ae17273733..733d53109ae 100644 --- a/doc/source/contributor/internals/l3_agent_extensions.rst +++ b/doc/source/contributor/internals/l3_agent_extensions.rst @@ -21,7 +21,7 @@ (Avoid deeper levels because they do not render well.) -L3 agent extensions +L3 Agent Extensions =================== L3 agent extensions are part of a generalized L2/L3 extension framework. See diff --git a/doc/source/contributor/internals/layer3.rst b/doc/source/contributor/internals/layer3.rst index d8f5e0a6ec2..8e0f2092a2e 100644 --- a/doc/source/contributor/internals/layer3.rst +++ b/doc/source/contributor/internals/layer3.rst @@ -21,8 +21,8 @@ (Avoid deeper levels because they do not render well.) -Layer 3 Networking in Neutron - via Layer 3 agent & OpenVSwitch -=============================================================== +Layer 3 Networking via Layer 3 & OpenVSwitch Agents +=================================================== This page discusses the usage of Neutron with Layer 3 functionality enabled. diff --git a/doc/source/contributor/internals/linuxbridge_agent.rst b/doc/source/contributor/internals/linuxbridge_agent.rst index 14b345cd0cf..37a74a3ce85 100644 --- a/doc/source/contributor/internals/linuxbridge_agent.rst +++ b/doc/source/contributor/internals/linuxbridge_agent.rst @@ -21,8 +21,8 @@ (Avoid deeper levels because they do not render well.) -L2 Networking with Linux Bridge -=============================== +Linux Bridge Networking L2 Agent +================================ This Agent uses the `Linux Bridge `_ to diff --git a/doc/source/contributor/internals/objects_usage.rst b/doc/source/contributor/internals/objects_usage.rst index 7a02aa52fa5..ea2af4ad457 100644 --- a/doc/source/contributor/internals/objects_usage.rst +++ b/doc/source/contributor/internals/objects_usage.rst @@ -21,8 +21,8 @@ (Avoid deeper levels because they do not render well.) -Objects in neutron -================== +Objects +======= Object versioning is a key concept in achieving rolling upgrades. Since its initial implementation by the nova community, a versioned object model has been diff --git a/doc/source/contributor/internals/ovs_vhostuser.rst b/doc/source/contributor/internals/ovs_vhostuser.rst index e30d4a117df..d8c2a85fc32 100644 --- a/doc/source/contributor/internals/ovs_vhostuser.rst +++ b/doc/source/contributor/internals/ovs_vhostuser.rst @@ -20,7 +20,7 @@ ''''''' Heading 4 (Avoid deeper levels because they do not render well.) -Neutron Open vSwitch vhost-user support +Neutron Open vSwitch vhost-user Support ======================================= Neutron supports using Open vSwitch + DPDK vhost-user interfaces directly in diff --git a/doc/source/contributor/internals/policy.rst b/doc/source/contributor/internals/policy.rst index 011e5ef679c..3f8f164e03a 100644 --- a/doc/source/contributor/internals/policy.rst +++ b/doc/source/contributor/internals/policy.rst @@ -21,8 +21,8 @@ (Avoid deeper levels because they do not render well.) -Authorization Policy Enforcement -================================ +Policy Enforcement and Authorization +==================================== As most OpenStack projects, Neutron leverages oslo_policy [#]_. However, since Neutron loves to be special and complicate every developer's life, it also diff --git a/doc/source/contributor/internals/provisioning_blocks.rst b/doc/source/contributor/internals/provisioning_blocks.rst index 08ad0b2e0b0..a35bcdcb1a8 100644 --- a/doc/source/contributor/internals/provisioning_blocks.rst +++ b/doc/source/contributor/internals/provisioning_blocks.rst @@ -21,8 +21,8 @@ (Avoid deeper levels because they do not render well.) -Composite Object Status via Provisioning Blocks -=============================================== +Provisioning Blocks in relation to Composite Object Status +========================================================== We use the STATUS field on objects to indicate when a resource is ready by setting it to ACTIVE so external systems know when it's safe to use diff --git a/doc/source/contributor/internals/rpc_api.rst b/doc/source/contributor/internals/rpc_api.rst index 80e20afe2f9..be6e0180743 100644 --- a/doc/source/contributor/internals/rpc_api.rst +++ b/doc/source/contributor/internals/rpc_api.rst @@ -21,8 +21,8 @@ (Avoid deeper levels because they do not render well.) -Neutron RPC API Layer -===================== +RPC API Layer +============= Neutron uses the oslo.messaging library to provide an internal communication channel between Neutron services. This communication is typically done via diff --git a/doc/source/contributor/internals/rpc_callbacks.rst b/doc/source/contributor/internals/rpc_callbacks.rst index 933be77a0d3..6a3b5e9fe81 100644 --- a/doc/source/contributor/internals/rpc_callbacks.rst +++ b/doc/source/contributor/internals/rpc_callbacks.rst @@ -23,8 +23,8 @@ .. _rpc_callbacks: -Neutron Messaging Callback System -================================= +RPC Messaging Callback System +============================= Neutron already has a `callback system `_ diff --git a/doc/source/contributor/internals/security_group_api.rst b/doc/source/contributor/internals/security_group_api.rst index 6e7d929a760..6c9d2c5dc65 100644 --- a/doc/source/contributor/internals/security_group_api.rst +++ b/doc/source/contributor/internals/security_group_api.rst @@ -21,8 +21,8 @@ (Avoid deeper levels because they do not render well.) -Guided Tour: The Neutron Security Group API -=========================================== +Security Group API +================== https://wiki.openstack.org/wiki/Neutron/SecurityGroups diff --git a/doc/source/contributor/internals/segments.rst b/doc/source/contributor/internals/segments.rst index 78b7b51a2af..a8439617136 100644 --- a/doc/source/contributor/internals/segments.rst +++ b/doc/source/contributor/internals/segments.rst @@ -12,7 +12,7 @@ under the License. -Segments extension +Segments Extension ================== Neutron has an extension that allows CRUD operations on the ``/segments`` diff --git a/doc/source/contributor/internals/services_and_agents.rst b/doc/source/contributor/internals/services_and_agents.rst index a56b3be0e28..81558cedf1e 100644 --- a/doc/source/contributor/internals/services_and_agents.rst +++ b/doc/source/contributor/internals/services_and_agents.rst @@ -21,7 +21,7 @@ (Avoid deeper levels because they do not render well.) -Services and agents +Services and Agents =================== A usual Neutron setup consists of multiple services and agents running on one diff --git a/doc/source/contributor/internals/sriov_nic_agent.rst b/doc/source/contributor/internals/sriov_nic_agent.rst index 76bada10c91..e8d35d9f307 100644 --- a/doc/source/contributor/internals/sriov_nic_agent.rst +++ b/doc/source/contributor/internals/sriov_nic_agent.rst @@ -21,8 +21,9 @@ (Avoid deeper levels because they do not render well.) -L2 Networking with SR-IOV enabled NICs -====================================== +SR-IOV Networking L2 Agent +========================== + SR-IOV (Single Root I/O Virtualization) is a specification that allows a PCIe device to appear to be multiple separate physical PCIe devices. SR-IOV works by introducing the idea of physical functions (PFs) and virtual functions (VFs). diff --git a/doc/source/contributor/internals/tag.rst b/doc/source/contributor/internals/tag.rst index e213f52b6f0..4797f3a544f 100644 --- a/doc/source/contributor/internals/tag.rst +++ b/doc/source/contributor/internals/tag.rst @@ -21,8 +21,8 @@ (Avoid deeper levels because they do not render well.) -Add Tags to Neutron Resources -============================= +Tags in Neutron Resources +========================= Tag service plugin allows users to set tags on their resources. Tagging resources can be used by external systems or any other clients of the Neutron diff --git a/doc/source/contributor/ovn_vagrant/index.rst b/doc/source/contributor/ovn_vagrant/index.rst index cd6831e02c5..c30664a14d2 100644 --- a/doc/source/contributor/ovn_vagrant/index.rst +++ b/doc/source/contributor/ovn_vagrant/index.rst @@ -1,12 +1,12 @@ .. -================================================ -Deploying a development environment with vagrant -================================================ +===================================================== +Deploying an OVN Development Environment with vagrant +===================================================== The vagrant directory contains a set of vagrant configurations which will -help you deploy Neutron with ovn driver for testing or development purposes. +help you deploy Neutron with the OVN driver for testing or development purposes. We provide a sparse multinode architecture with clear separation between services. In the future we will include all-in-one and multi-gateway diff --git a/doc/source/contributor/policies/bugs.rst b/doc/source/contributor/policies/bugs.rst index 1c4ed7717ee..c4ff8c2bb74 100644 --- a/doc/source/contributor/policies/bugs.rst +++ b/doc/source/contributor/policies/bugs.rst @@ -1,7 +1,7 @@ .. _neutron_bugs: -Neutron Bugs -============ +Bugs +==== Neutron (client, core, FwaaS, VPNaaS) maintains all of its bugs in the following Launchpad projects: diff --git a/doc/source/contributor/policies/code-reviews.rst b/doc/source/contributor/policies/code-reviews.rst index bb22ae31931..f07f62affa8 100644 --- a/doc/source/contributor/policies/code-reviews.rst +++ b/doc/source/contributor/policies/code-reviews.rst @@ -1,7 +1,7 @@ .. _code_review: -Neutron Code Reviews -==================== +Code Reviews +============ Code reviews are a critical component of all OpenStack projects. Neutron accepts patches from many diverse people with diverse backgrounds, employers, and experience levels. Code reviews provide a diff --git a/doc/source/contributor/policies/gate-failure-triage.rst b/doc/source/contributor/policies/gate-failure-triage.rst index e098ae1e199..e0942e10903 100644 --- a/doc/source/contributor/policies/gate-failure-triage.rst +++ b/doc/source/contributor/policies/gate-failure-triage.rst @@ -1,5 +1,6 @@ -Neutron Gate Failure Triage -=========================== + +Gate Failure Triage +=================== This page provides guidelines for spotting and assessing neutron gate failures. Some hints for triaging failures are also provided. diff --git a/doc/source/contributor/policies/index.rst b/doc/source/contributor/policies/index.rst index 95ba2b9ed1f..6f46bb067dc 100644 --- a/doc/source/contributor/policies/index.rst +++ b/doc/source/contributor/policies/index.rst @@ -26,9 +26,9 @@ items. blueprints bugs - contributor-onboarding - neutron-teams - gate-failure-triage code-reviews + contributor-onboarding + gate-failure-triage release-checklist + neutron-teams thirdparty-ci diff --git a/doc/source/contributor/policies/neutron-teams.rst b/doc/source/contributor/policies/neutron-teams.rst index b2b4f5c6465..14c91553c17 100644 --- a/doc/source/contributor/policies/neutron-teams.rst +++ b/doc/source/contributor/policies/neutron-teams.rst @@ -1,8 +1,8 @@ .. _neutron_teams: -====================== -Neutron Team Structure -====================== +============== +Team Structure +============== Neutron Core Reviewers ====================== diff --git a/doc/source/contributor/policies/thirdparty-ci.rst b/doc/source/contributor/policies/thirdparty-ci.rst index 22845dfa874..893670ff3a5 100644 --- a/doc/source/contributor/policies/thirdparty-ci.rst +++ b/doc/source/contributor/policies/thirdparty-ci.rst @@ -1,5 +1,6 @@ -Neutron Third-party CI -====================== + +Third-party CI +============== What Is Expected of Third Party CI System for Neutron ----------------------------------------------------- diff --git a/doc/source/contributor/testing/ci_scenario_jobs.rst b/doc/source/contributor/testing/ci_scenario_jobs.rst index 9c97c9306c8..33612a258a2 100644 --- a/doc/source/contributor/testing/ci_scenario_jobs.rst +++ b/doc/source/contributor/testing/ci_scenario_jobs.rst @@ -22,7 +22,7 @@ .. _ci_jobs: -Neutron jobs running in Zuul CI +Neutron Jobs Running in Zuul CI =============================== Tempest jobs running in Neutron CI diff --git a/doc/source/contributor/testing/index.rst b/doc/source/contributor/testing/index.rst index 0efe0b8b7da..6ad9887a924 100644 --- a/doc/source/contributor/testing/index.rst +++ b/doc/source/contributor/testing/index.rst @@ -32,10 +32,10 @@ Testing testing fullstack - coverage - template_model_sync_test - db_transient_failure_injection + ml2_ovs_devstack ci_scenario_jobs ml2_ovn_devstack - ml2_ovs_devstack tempest + template_model_sync_test + coverage + db_transient_failure_injection diff --git a/doc/source/contributor/testing/ml2_ovn_devstack.rst b/doc/source/contributor/testing/ml2_ovn_devstack.rst index 80f5b01b19c..5ac749ab6b8 100644 --- a/doc/source/contributor/testing/ml2_ovn_devstack.rst +++ b/doc/source/contributor/testing/ml2_ovn_devstack.rst @@ -1,8 +1,8 @@ .. _ml2_ovn_devstack: -========================= -Testing OVN with DevStack -========================= +================= +OVN with DevStack +================= This document describes how to test OpenStack with OVN using DevStack. We will start by describing how to test on a single host. diff --git a/doc/source/contributor/testing/ml2_ovs_devstack.rst b/doc/source/contributor/testing/ml2_ovs_devstack.rst index 1d8ccfe6fcb..ca1aee55a7e 100644 --- a/doc/source/contributor/testing/ml2_ovs_devstack.rst +++ b/doc/source/contributor/testing/ml2_ovs_devstack.rst @@ -1,8 +1,8 @@ .. _ml2_ovs_devstack: -============================= -Testing ML2 OVS with DevStack -============================= +===================== +ML2 OVS with DevStack +===================== This document describes how to test OpenStack Neutron with ML2 OpenvSwitch using DevStack. We will start by describing how to test on a single host. diff --git a/doc/source/contributor/testing/tempest.rst b/doc/source/contributor/testing/tempest.rst index 6e92013fa3a..6ef7fd8bae2 100644 --- a/doc/source/contributor/testing/tempest.rst +++ b/doc/source/contributor/testing/tempest.rst @@ -22,7 +22,7 @@ .. _tempest_testing: -Tempest testing +Tempest Testing =============== Tempest basics in Networking projects