openstack/neutron
Code Issues Proposed changes

docs: Deindent code blocks

Browse Source 
We had a number of code blocks that were being incorrectly rendered
inside block quotes, which messed with formatting somewhat. Correct
them. This was done using the following script:

  sphinx-build -W -b xml doc/source doc/build/xml
  files=$(find doc/build/xml -name '*.xml' -print)
  for file in $files; do
      if xmllint -xpath "//block_quote/literal_block" "$file" &>/dev/null; then
          echo "$file"
      fi
  done

Note that this also highlighted a file using DOS line endings. This is
corrected.

Change-Id: If63f31bf13c76a185e2c6eebc9b85f9a1f3bbde8
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
This commit is contained in:
Stephen Finucane
2023-05-09 15:57:21 +01:00
parent 272a315109
commit d409296bde
10 changed files with 728 additions and 736 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/admin/config-bgp-floating-ip-over-l2-segmented-network.rst
View File

@@ -146,7 +146,6 @@ bridge_mappings directive:
[ovs]
bridge_mappings = physnet-rack1:br-ex
All of the physical networks created this way must be added in the
configuration of the neutron-server as well (ie: this is used by both
neutron-api and neutron-rpc-server). For example, with 3 racks,
@@ -160,7 +159,6 @@ here's how /etc/neutron/plugins/ml2/ml2_conf.ini should look like:
[ml2_type_vlan]
network_vlan_ranges = physnet-rack1,physnet-rack2,physnet-rack3
Once this is done, the provider network can be created, using physnet-rack1
as "physical network".

10
doc/source/admin/config-logging.rst
View File

@@ -57,7 +57,7 @@ To enable the logging service, follow the below steps.
#. On compute/network nodes, add configuration for logging service to
``[network_log]`` in ``/etc/neutron/plugins/ml2/openvswitch_agent.ini`` and in
``/etc/neutron/l3_agent.ini`` as shown bellow:
``/etc/neutron/l3_agent.ini`` as shown below:
.. code-block:: ini
@@ -259,7 +259,7 @@ The general characteristics of each event will be shown as the following:
* Security event record format:
* Logged data of an ``ACCEPT`` event would look like:
Logged data of an ``ACCEPT`` event would look like:
.. code-block:: console
@@ -274,7 +274,7 @@ The general characteristics of each event will be shown as the following:
TCPOptionNoOperation(kind=1,length=1), TCPOptionWindowScale(kind=3,length=3,shift_cnt=3)],
seq=3284890090,src_port=47825,urgent=0,window_size=14600)
* Logged data of a ``DROP`` event:
Logged data of a ``DROP`` event:
.. code-block:: console
@@ -298,7 +298,7 @@ The general characteristics of each event will be shown as the following:
* Security event record format:
* Logged data of an ``ACCEPT`` event would look like:
Logged data of an ``ACCEPT`` event would look like:
.. code-block:: console
@@ -310,7 +310,7 @@ The general characteristics of each event will be shown as the following:
\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00
\x00\x00\x00\x00\x00\x00\x00',id=29185,seq=0),type=8)
* Logged data of a ``DROP`` event:
Logged data of a ``DROP`` event:
.. code-block:: console

1
doc/source/admin/config-ovs-offload.rst
View File

@@ -176,7 +176,6 @@ network and has access to the private networks of all nodes.
03:00.4 Ethernet controller: Mellanox Technologies MT27800 Family [ConnectX-5 Virtual Function]
03:00.5 Ethernet controller: Mellanox Technologies MT27800 Family [ConnectX-5 Virtual Function]
.. code-block:: bash
# ip link show enp3s0f0

1
doc/source/admin/config-qos.rst
View File

@@ -268,7 +268,6 @@ On the network and compute nodes:
[agent]
extensions = fip_qos, gateway_ip_qos
#. As rate limit doesn't work on Open vSwitch's ``internal`` ports,
optionally, as a workaround, to make QoS bandwidth limit work on
router's gateway ports, set ``ovs_use_veth`` to ``True`` in ``DEFAULT``

4
doc/source/admin/ovn/troubleshooting.rst
View File

@@ -87,14 +87,12 @@ the OVN Southbound database the stale registers. For example:
hostname : u20ovn
name : "ce9a1471-79c1-4472-adfc-9e5ce86eba07"
* Delete the stale "Chassis" register:
.. code-block:: console
$ sudo ovn-sbctl destroy Chassis ce9a1471-79c1-4472-adfc-9e5ce86eba07
* List the "Chassis_Private" registers, filtering by name:
.. code-block:: console
@@ -103,14 +101,12 @@ the OVN Southbound database the stale registers. For example:
name : "a55c8d85-2071-4452-92cb-95d15c29bde7"
name : "ce9a1471-79c1-4472-adfc-9e5ce86eba07"
* Delete the stale "Chassis_Private" register:
.. code-block:: console
$ sudo ovn-sbctl destroy Chassis_Private ce9a1471-79c1-4472-adfc-9e5ce86eba07
If the host name is also updated during the system upgrade, the Neutron
agent list could present entries from different host names, but the older
ones will be down too. The procedure is the same.