From 8f8f367662c848ada6e74231a56ea5903d2c70c6 Mon Sep 17 00:00:00 2001 From: "zhang.lei" Date: Mon, 14 May 2018 02:16:49 +0000 Subject: [PATCH] Doc improvements Change-Id: I5c0408c90d21c2c0bbf9858b332ccae4cab8423b --- doc/source/app-nuage.rst | 15 +++++++------- doc/source/app-opendaylight.rst | 10 ++++------ doc/source/app-openvswitch.rst | 8 ++++---- doc/source/configure-network-services.rst | 24 +++++++++++------------ doc/source/index.rst | 4 ++-- 5 files changed, 30 insertions(+), 31 deletions(-) diff --git a/doc/source/app-nuage.rst b/doc/source/app-nuage.rst index 09269eb5..9cbb5eec 100644 --- a/doc/source/app-nuage.rst +++ b/doc/source/app-nuage.rst @@ -49,10 +49,10 @@ On the deployment host, copy the Nuage user variables file from ``/opt/nuage-openstack-ansible/etc/user_nuage_vars.yml`` to the ``/etc/openstack_deploy/`` folder. - .. code-block:: shell-session +.. code-block:: console - # cp /opt/nuage-openstack-ansible/etc/user_nuage_vars.yml \ - /etc/openstack_deploy/ + # cp /opt/nuage-openstack-ansible/etc/user_nuage_vars.yml \ + /etc/openstack_deploy/ Next, modify the following parameters in that file as per your Nuage VCS environment: @@ -138,11 +138,12 @@ Installation VRS playbooks in ``/opt/nuage-openstack-ansible/nuage_playbook`` on your deployment host: - .. code-block:: shell-session + .. code-block:: console # cd /opt/nuage-openstack-ansible/nuage_playbooks # openstack-ansible nuage_all.yml - .. note:: To obtain Nuage Networks VSP software packages, user - documentation, and licenses, contact - info@nuagenetworks.net. + .. note:: + + To obtain Nuage Networks VSP software packages, user + documentation, and licenses, contact ``info@nuagenetworks.net``. diff --git a/doc/source/app-opendaylight.rst b/doc/source/app-opendaylight.rst index 9e5d77c4..4ea4eb81 100644 --- a/doc/source/app-opendaylight.rst +++ b/doc/source/app-opendaylight.rst @@ -149,10 +149,8 @@ Communications between the OpenDaylight SDN Controller and Open vSwitch are not secured by default. For further information on securing this interface, see these manuals: -TLS Support on OpenDaylight OpenFlow plugin: +* `TLS Support on OpenDaylight OpenFlow plugin + `__. - https://wiki.opendaylight.org/view/OpenDaylight_OpenFlow_Plugin:_TLS_Support - -Secure Communication Between OpenFlow Switches and Controllers - - https://www.thinkmind.org/download.php?articleid=afin_2015_2_30_40047 +* `Secure Communication Between OpenFlow Switches and Controllers + `__. diff --git a/doc/source/app-openvswitch.rst b/doc/source/app-openvswitch.rst index 497cd0ba..6aa3ccbe 100644 --- a/doc/source/app-openvswitch.rst +++ b/doc/source/app-openvswitch.rst @@ -14,10 +14,10 @@ Recommended reading We recommend that you read the following documents before proceeding: - * Neutron documentation on Open vSwitch OpenStack deployments: - ``_ - * Blog post on how OpenStack-Ansible works with Open vSwitch: - ``_ +* Neutron documentation on Open vSwitch OpenStack deployments: + ``_ +* Blog post on how OpenStack-Ansible works with Open vSwitch: + ``_ Prerequisites ~~~~~~~~~~~~~ diff --git a/doc/source/configure-network-services.rst b/doc/source/configure-network-services.rst index 79b9ac8e..d093d84c 100644 --- a/doc/source/configure-network-services.rst +++ b/doc/source/configure-network-services.rst @@ -331,16 +331,16 @@ configuration to enable Neutron SR-IOV support. #. Define SR-IOV capable physical host interface for a provider network - As part of every Openstack-Ansible installation, all provider networks - known to Neutron need to be configured inside the - ``/etc/openstack_deploy/openstack_user_config.yml`` file. - For each supported network type (e.g. vlan), the attribute - ``sriov_host_interfaces`` can be defined to map ML2 network names - (``net_name`` attribute) to one or many physical interfaces. - Additionally, the network will need to be assigned to the - ``neutron_sriov_nic_agent`` container group. + As part of every Openstack-Ansible installation, all provider networks + known to Neutron need to be configured inside the + ``/etc/openstack_deploy/openstack_user_config.yml`` file. + For each supported network type (e.g. vlan), the attribute + ``sriov_host_interfaces`` can be defined to map ML2 network names + (``net_name`` attribute) to one or many physical interfaces. + Additionally, the network will need to be assigned to the + ``neutron_sriov_nic_agent`` container group. -Example configuration: + Example configuration: .. code-block:: yaml @@ -411,10 +411,10 @@ Example configuration: and openvswitch (``ml2.ovs``) ML2 plugins. ``ml2.lxb`` is the standard activated core ML2 plugin. - .. code-block:: yaml + .. code-block:: yaml - neutron_plugin_types: - - ml2.sriov + neutron_plugin_types: + - ml2.sriov #. Execute the Neutron install playbook in order to update the configuration: diff --git a/doc/source/index.rst b/doc/source/index.rst index 494a4411..055da5d7 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -16,8 +16,8 @@ Neutron role for OpenStack-Ansible This role installs the following Systemd services: - * neutron-server - * neutron-agents +* neutron-server +* neutron-agents To clone or view the source code for this repository, visit the role repository for `os_neutron `_.