diff --git a/doc/networking-guide/setup.cfg b/doc/networking-guide/setup.cfg index ec18d2edec..8373fa10d4 100644 --- a/doc/networking-guide/setup.cfg +++ b/doc/networking-guide/setup.cfg @@ -3,7 +3,7 @@ name = openstacknetworkingguide summary = OpenStack Networking Guide author = OpenStack author-email = openstack-docs@lists.openstack.org -home-page = http://docs.openstack.org/ +home-page = https://docs.openstack.org/ classifier = Environment :: OpenStack Intended Audience :: Information Technology diff --git a/doc/networking-guide/source/config-auto-allocation.rst b/doc/networking-guide/source/config-auto-allocation.rst index 78ca029ceb..20a000578c 100644 --- a/doc/networking-guide/source/config-auto-allocation.rst +++ b/doc/networking-guide/source/config-auto-allocation.rst @@ -31,7 +31,7 @@ topology creation. To perform this task, proceed with the following steps: Setting up an external network is described in `OpenStack Administrator Guide - `_. + `_. Assuming the external network to be used for the auto-allocation feature is named ``public``, make it the default external network with the following command: diff --git a/doc/networking-guide/source/config-lbaas.rst b/doc/networking-guide/source/config-lbaas.rst index 26fbe07850..659f06a674 100644 --- a/doc/networking-guide/source/config-lbaas.rst +++ b/doc/networking-guide/source/config-lbaas.rst @@ -15,7 +15,7 @@ There are two reference implementations of LBaaS v2. The one is an agent based implementation with HAProxy. The agents handle the HAProxy configuration and manage the HAProxy daemon. Another LBaaS v2 implementation, `Octavia -`_, has a separate API and +`_, has a separate API and separate worker processes that build load balancers within virtual machines on hypervisors that are managed by the Compute service. You do not need an agent for Octavia. @@ -25,8 +25,8 @@ for Octavia. LBaaS v1 was removed in the Newton release. These links provide more details about how LBaaS v1 works and how to configure it: - * `Load-Balancer-as-a-Service (LBaaS) overview `__ - * `Basic Load-Balancer-as-a-Service operations `__ + * `Load-Balancer-as-a-Service (LBaaS) overview `__ + * `Basic Load-Balancer-as-a-Service operations `__ .. warning:: @@ -138,7 +138,7 @@ The `Hands on Lab - Install and Configure OpenStack Octavia session at the OpenStack Summit in Tokyo provides an overview of Octavia. The DevStack documentation offers a `simple method to deploy Octavia -`_ +`_ and test the service with redundant load balancer instances. If you already have Octavia installed and configured within your environment, you can configure the Network service to use Octavia: diff --git a/doc/networking-guide/source/config-ml2.rst b/doc/networking-guide/source/config-ml2.rst index 968abde0f2..6508daf99b 100644 --- a/doc/networking-guide/source/config-ml2.rst +++ b/doc/networking-guide/source/config-ml2.rst @@ -104,7 +104,7 @@ To enable type drivers in the ML2 plug-in. Edit the Update Link. See bug https://bugs.launchpad.net/openstack-manuals/+bug/1567792 For more details, see the -`Networking configuration options `__ +`Networking configuration options `__ of Configuration Reference. The following type drivers are available @@ -125,21 +125,21 @@ But only administrative (privileged) users can manage those networks because they interface with the physical network infrastructure. More information about provider networks see :doc:`intro-os-networking` or the `OpenStack Administrator Guide -`__. +`__. * Flat The administrator needs to configure a list of physical network names that can be used for provider networks. For more details, see the related section in the - `Configuration Reference `__. + `Configuration Reference `__. * VLAN The administrator needs to configure a list of physical network names that can be used for provider networks. For more details, see the related section in the - `Configuration Reference `__. + `Configuration Reference `__. * GRE @@ -168,7 +168,7 @@ within the allocation that an administrator or operator defines for them. More information about project and provider networks see :doc:`intro-os-networking` or the `OpenStack Administrator Guide -`__. +`__. Project network configurations are made in the ``/etc/neutron/plugins/ml2/ml2_conf.ini`` configuration file on the neutron @@ -179,21 +179,21 @@ server: The administrator needs to configure the range of VLAN IDs that can be used for project network allocation. For more details, see the related section in the - `Configuration Reference `__. + `Configuration Reference `__. * GRE The administrator needs to configure the range of tunnel IDs that can be used for project network allocation. For more details, see the related section in the - `Configuration Reference `__. + `Configuration Reference `__. * VXLAN The administrator needs to configure the range of VXLAN IDs that can be used for project network allocation. For more details, see the related section in the - `Configuration Reference `__. + `Configuration Reference `__. .. note:: Flat networks for project allocation are not supported. They only @@ -214,7 +214,7 @@ To enable mechanism drivers in the ML2 plug-in, edit the Update Link. See bug https://bugs.launchpad.net/openstack-manuals/+bug/1567792 For more details, see the -`Configuration Reference `__. +`Configuration Reference `__. * Linux bridge @@ -232,7 +232,7 @@ For more details, see the The administrator needs to define a list PCI hardware that shall be used by OpenStack. For more details, see the related section in the - `Configuration Reference `__. + `Configuration Reference `__. * MacVTap @@ -243,7 +243,7 @@ For more details, see the The administrator can configure some optional configuration options. For more details, see the related section in the - `Configuration Reference `__. + `Configuration Reference `__. * Specialized @@ -283,7 +283,7 @@ resources. It typically runs on each Network Node and on each Compute Node. you pass this configuration file as argument. For a detailed list of configuration options, see the related section in the - `Configuration Reference `__. + `Configuration Reference `__. * Linux bridge agent @@ -295,7 +295,7 @@ resources. It typically runs on each Network Node and on each Compute Node. you pass this configuration file as argument. For a detailed list of configuration options, see the related section in the - `Configuration Reference `__. + `Configuration Reference `__. * SRIOV Nic Switch agent @@ -308,7 +308,7 @@ resources. It typically runs on each Network Node and on each Compute Node. you pass this configuration file as argument. For a detailed list of configuration options, see the related section in the - `Configuration Reference `__. + `Configuration Reference `__. * MacVTap agent @@ -321,7 +321,7 @@ resources. It typically runs on each Network Node and on each Compute Node. you pass this configuration file as argument. For a detailed list of configuration options, see the related section in the - `Configuration Reference `__. + `Configuration Reference `__. L3 agent ^^^^^^^^ @@ -334,7 +334,7 @@ Configuration for the L3 agent is typically done in the you pass this configuration file as argument. For a detailed list of configuration options, see the related section in the -`Configuration Reference `__. +`Configuration Reference `__. DHCP agent ^^^^^^^^^^ @@ -348,7 +348,7 @@ Configuration for the DHCP agent is typically done in the you pass this configuration file as argument. For a detailed list of configuration options, see the related section in the -`Configuration Reference `__. +`Configuration Reference `__. Metadata agent ^^^^^^^^^^^^^^ @@ -361,7 +361,7 @@ Configuration for the Metadata agent is typically done in the you pass this configuration file as argument. For a detailed list of configuration options, see the related section in the -`Configuration Reference `__. +`Configuration Reference `__. L3 metering agent ^^^^^^^^^^^^^^^^^ @@ -374,7 +374,7 @@ Configuration for the L3 metering agent is typically done in the you pass this configuration file as argument. For a detailed list of configuration options, see the related section in the -`Configuration Reference `__. +`Configuration Reference `__. Security -------- @@ -384,7 +384,7 @@ L2 agents support some important security configurations. * Security Groups For more details, see the related section in the - `Configuration Reference `__. + `Configuration Reference `__. * Arp Spoofing Prevention diff --git a/doc/networking-guide/source/config-ovs-dpdk.rst b/doc/networking-guide/source/config-ovs-dpdk.rst index ed02b5d6e4..ec0e445e8d 100644 --- a/doc/networking-guide/source/config-ovs-dpdk.rst +++ b/doc/networking-guide/source/config-ovs-dpdk.rst @@ -54,7 +54,7 @@ pages. This can be done through flavors. For example: $ openstack flavor set m1.large --property hw:mem_page_size=large For more information about the syntax for ``hw:mem_page_size``, refer to the -`Flavors `__ guide. +`Flavors `__ guide. .. note:: diff --git a/doc/networking-guide/source/config-ovsfwdriver.rst b/doc/networking-guide/source/config-ovsfwdriver.rst index 1d1de5a948..377e86c832 100644 --- a/doc/networking-guide/source/config-ovsfwdriver.rst +++ b/doc/networking-guide/source/config-ovsfwdriver.rst @@ -42,5 +42,5 @@ Enable the native OVS firewall driver firewall_driver = openvswitch For more information, see the `developer documentation -`_ +`_ and the `video `_. diff --git a/doc/networking-guide/source/config-sfc.rst b/doc/networking-guide/source/config-sfc.rst index 3cba86a8d5..3b434236c6 100644 --- a/doc/networking-guide/source/config-sfc.rst +++ b/doc/networking-guide/source/config-sfc.rst @@ -65,7 +65,7 @@ path rendering. :alt: Port chain model See the `developer documentation -`_ for more information. +`_ for more information. Resources ~~~~~~~~~ @@ -220,7 +220,7 @@ HTTP (TCP) traffic flows from 192.168.1.11:1000 to 192.168.2.11:80. This command requires additional options to successfully launch an instance. See the - `CLI reference `_ + `CLI reference `_ for more information. Alternatively, you can launch each instance with one network interface and diff --git a/doc/networking-guide/source/config-sriov.rst b/doc/networking-guide/source/config-sriov.rst index 5eb78cf84d..0152e118bc 100644 --- a/doc/networking-guide/source/config-sriov.rst +++ b/doc/networking-guide/source/config-sriov.rst @@ -379,7 +379,7 @@ Once configuration is complete, you can launch instances with SR-IOV ports. There are two ways to attach VFs to an instance. You can create an SR-IOV port or use the ``pci_alias`` in the Compute service. For more information about using ``pci_alias``, refer to `nova-api configuration - `__. + `__. SR-IOV with InfiniBand ~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/networking-guide/source/config.rst b/doc/networking-guide/source/config.rst index 8bf3bc526c..5b3e14ea76 100644 --- a/doc/networking-guide/source/config.rst +++ b/doc/networking-guide/source/config.rst @@ -35,4 +35,4 @@ Configuration .. note:: For general configuration, see the `Configuration Reference - `_. + `_. diff --git a/doc/networking-guide/source/deploy-lb-provider.rst b/doc/networking-guide/source/deploy-lb-provider.rst index 20463be39d..ef34b29e65 100644 --- a/doc/networking-guide/source/deploy-lb-provider.rst +++ b/doc/networking-guide/source/deploy-lb-provider.rst @@ -83,7 +83,7 @@ Controller node * Disable service plug-ins because provider networks do not require any. However, this breaks portions of the dashboard that manage the Networking service. See the - `Newton Install Tutorials and Guides `__ + `Newton Install Tutorials and Guides `__ for more information. .. code-block:: ini diff --git a/doc/networking-guide/source/deploy-ovs-provider.rst b/doc/networking-guide/source/deploy-ovs-provider.rst index c423f35908..b871c11274 100644 --- a/doc/networking-guide/source/deploy-ovs-provider.rst +++ b/doc/networking-guide/source/deploy-ovs-provider.rst @@ -95,7 +95,7 @@ Controller node any. However, this breaks portions of the dashboard that manage the Networking service. See the `Newton Install Tutorials and Guides - `__ for more + `__ for more information. .. code-block:: ini diff --git a/doc/networking-guide/source/deploy.rst b/doc/networking-guide/source/deploy.rst index 7025c3af27..390d767ffc 100644 --- a/doc/networking-guide/source/deploy.rst +++ b/doc/networking-guide/source/deploy.rst @@ -38,7 +38,7 @@ total of five nodes. Each building block could also require additional infrastructure or changes to existing infrastructure such as networks. For basic configuration of prerequisites, see the -`Newton Install Tutorials and Guides `__. +`Newton Install Tutorials and Guides `__. .. note:: diff --git a/doc/networking-guide/source/fwaas-v1-scenario.rst b/doc/networking-guide/source/fwaas-v1-scenario.rst index 03cca91097..5cf4722048 100644 --- a/doc/networking-guide/source/fwaas-v1-scenario.rst +++ b/doc/networking-guide/source/fwaas-v1-scenario.rst @@ -115,7 +115,7 @@ Then, create a firewall that applies the policy. * To add a single rule, use the insert-rule operation. For more details, see `Networking command-line client - `_ + `_ in the OpenStack Command-Line Interface Reference. .. note:: diff --git a/doc/networking-guide/source/fwaas-v2-scenario.rst b/doc/networking-guide/source/fwaas-v2-scenario.rst index 1a72057b21..1f7291ba3e 100644 --- a/doc/networking-guide/source/fwaas-v2-scenario.rst +++ b/doc/networking-guide/source/fwaas-v2-scenario.rst @@ -113,7 +113,7 @@ Then, create a firewall that applies the policy. * To add a single rule, use the insert-rule operation. For more details, see `Networking command-line client - `_ + `_ in the OpenStack Command-Line Interface Reference. .. note:: diff --git a/doc/networking-guide/source/fwaas.rst b/doc/networking-guide/source/fwaas.rst index edc300f936..78a4f6d890 100644 --- a/doc/networking-guide/source/fwaas.rst +++ b/doc/networking-guide/source/fwaas.rst @@ -66,6 +66,6 @@ effect this. \*\* This feature is planned for Ocata. For further information, see `v1 configuration guide -`_ or +`_ or `v2 configuration guide -`_. +`_. diff --git a/doc/networking-guide/source/intro-basic-networking.rst b/doc/networking-guide/source/intro-basic-networking.rst index 3ca1e8fed2..aa16ce6dff 100644 --- a/doc/networking-guide/source/intro-basic-networking.rst +++ b/doc/networking-guide/source/intro-basic-networking.rst @@ -412,8 +412,8 @@ for many TCP-based services, as well as services that use other layer 4 protocols that employ ports. Registering a TCP port number is not required, but registering a port number is helpful to avoid collisions with other services. See `Appendix B. Firewalls and default ports -`_ -of the `OpenStack Configuration Reference `_ +`_ +of the `OpenStack Configuration Reference `_ for the default TCP ports used by various services involved in an OpenStack deployment. diff --git a/doc/networking-guide/source/shared/deploy-config-neutron-common.txt b/doc/networking-guide/source/shared/deploy-config-neutron-common.txt index 3cd74d87e8..9175f7b69d 100644 --- a/doc/networking-guide/source/shared/deploy-config-neutron-common.txt +++ b/doc/networking-guide/source/shared/deploy-config-neutron-common.txt @@ -16,8 +16,8 @@ [agent] # ... -See the `Installation Tutorials and Guides `_ and -`Configuration Reference `_ for your OpenStack +See the `Installation Tutorials and Guides `_ and +`Configuration Reference `_ for your OpenStack release to obtain the appropriate additional configuration for the ``[DEFAULT]``, ``[database]``, ``[keystone_authtoken]``, ``[nova]``, and ``[agent]`` sections.