Merge "Update production architecture guide for formatting"

doc/production-architecture-guide.rst

@@ -20,7 +20,7 @@ A basic Kolla inventory consists of several types of nodes, known in Ansible as
 
 * Network - This is the network node. It will host Neutron agents along with
   haproxy / keepalived. These nodes will have a floating ip defined in
-  ``Kolla_internal_vip_address``.
+  ``kolla_internal_vip_address``.
 
 * Compute - These are servers for compute services. This is where guest VMs
   live.
@@ -37,35 +37,37 @@ Interface configuration
 
 In Kolla operators should configure following network interfaces:
 
-* network_interface - While it is not used on its own, this provides the
+* ``network_interface`` - While it is not used on its own, this provides the
   required default for other interfaces below.
 
-* api_interface - This interface is used for the management network. The
+* ``api_interface`` - This interface is used for the management network. The
   management network is the network OpenStack services uses to communicate to
   each other and the databases. There are known security risks here, so it's
   recommended to make this network internal, not accessible from outside.
-  Defaults to network_interface.
+  Defaults to ``network_interface``.
 
-* kolla_external_vip_interface - This interface is public-facing one. It's
+* ``kolla_external_vip_interface`` - This interface is public-facing one. It's
   used when you want HAProxy public endpoints to be exposed in different
   network than internal ones. It is mandatory to set this option when
-  ``kolla_enable_tls_external`` is set to yes. Defaults to network_interface.
+  ``kolla_enable_tls_external`` is set to yes. Defaults to
+  ``network_interface``.
 
-* storage_interface - This is the interface that is used by virtual machines to
-  communicate to Ceph. This can be heavily utilized so it's recommended to put
-  this network on 10Gig networking. Defaults to network_interface.
+* ``storage_interface`` - This is the interface that is used by virtual
+  machines to communicate to Ceph. This can be heavily utilized so it's
+  recommended to put this network on 10Gig networking. Defaults to 
+  ``network_interface``.
 
-* cluster_interface - This is another interface used by Ceph. It's used for
+* ``cluster_interface`` - This is another interface used by Ceph. It's used for
   data replication. It can be heavily utilized also and if it becomes a
   bottleneck it can affect data consistency and performance of whole cluster.
-  Defaults to network_interface.
+  Defaults to ``network_interface``.
 
-* tunnel_interface - This interface is used by Neutron for vm-to-vm traffic
-  over tunneled networks (like VxLan). Defaults to network_interface.
+* ``tunnel_interface`` - This interface is used by Neutron for vm-to-vm traffic
+  over tunneled networks (like VxLan). Defaults to ``network_interface``.
 
-* Neutron_external_interface - This interface is required by Neutron. Neutron
-  will put br-ex on it. It will be used for flat networking as well as tagged
-  vlan networks. Has to be set separately.
+* ``neutron_external_interface`` - This interface is required by Neutron.
+  Neutron will put br-ex on it. It will be used for flat networking as well as
+  tagged vlan networks. Has to be set separately.
 
 Docker configuration
 ====================