openstack/openstack-ansible-os_neutron
Code Issues Proposed changes

Doc improvements

Browse Source 
Change-Id: I5c0408c90d21c2c0bbf9858b332ccae4cab8423b
This commit is contained in:
zhang.lei 2018-05-14 02:16:49 +00:00
parent 683362981a
commit 8f8f367662
5 changed files with 30 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/source/app-nuage.rst
View File

@ -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 ``/opt/nuage-openstack-ansible/etc/user_nuage_vars.yml`` to the
``/etc/openstack_deploy/`` folder. ``/etc/openstack_deploy/`` folder.
.. code-block:: shell-session .. code-block:: console
# cp /opt/nuage-openstack-ansible/etc/user_nuage_vars.yml \ # cp /opt/nuage-openstack-ansible/etc/user_nuage_vars.yml \
/etc/openstack_deploy/ /etc/openstack_deploy/
Next, modify the following parameters in that file as per your Nuage Next, modify the following parameters in that file as per your Nuage
VCS environment: VCS environment:
@ -138,11 +138,12 @@ Installation
VRS playbooks in ``/opt/nuage-openstack-ansible/nuage_playbook`` on VRS playbooks in ``/opt/nuage-openstack-ansible/nuage_playbook`` on
your deployment host: your deployment host:
.. code-block:: shell-session .. code-block:: console
# cd /opt/nuage-openstack-ansible/nuage_playbooks # cd /opt/nuage-openstack-ansible/nuage_playbooks
# openstack-ansible nuage_all.yml # openstack-ansible nuage_all.yml
.. note:: To obtain Nuage Networks VSP software packages, user .. note::
documentation, and licenses, contact
info@nuagenetworks.net. To obtain Nuage Networks VSP software packages, user
documentation, and licenses, contact ``info@nuagenetworks.net``.

10
doc/source/app-opendaylight.rst
View File

@ -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 secured by default. For further information on securing this interface, see
these manuals: these manuals:
TLS Support on OpenDaylight OpenFlow plugin: * `TLS Support on OpenDaylight OpenFlow plugin
<https://wiki.opendaylight.org/view/OpenDaylight_OpenFlow_Plugin:_TLS_Support>`__.
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
https://www.thinkmind.org/download.php?articleid=afin_2015_2_30_40047

8
doc/source/app-openvswitch.rst
View File

@ -14,10 +14,10 @@ Recommended reading
We recommend that you read the following documents before proceeding: We recommend that you read the following documents before proceeding:
* Neutron documentation on Open vSwitch OpenStack deployments: * Neutron documentation on Open vSwitch OpenStack deployments:
`<https://docs.openstack.org/liberty/networking-guide/scenario-classic-ovs.html>`_ `<https://docs.openstack.org/liberty/networking-guide/scenario-classic-ovs.html>`_
* Blog post on how OpenStack-Ansible works with Open vSwitch: * Blog post on how OpenStack-Ansible works with Open vSwitch:
`<https://medium.com/@travistruman/configuring-openstack-ansible-for-open-vswitch-b7e70e26009d>`_ `<https://medium.com/@travistruman/configuring-openstack-ansible-for-open-vswitch-b7e70e26009d>`_
Prerequisites Prerequisites
~~~~~~~~~~~~~ ~~~~~~~~~~~~~

24
doc/source/configure-network-services.rst
View File

@ -331,16 +331,16 @@ configuration to enable Neutron SR-IOV support.
#. Define SR-IOV capable physical host interface for a provider network #. Define SR-IOV capable physical host interface for a provider network
As part of every Openstack-Ansible installation, all provider networks As part of every Openstack-Ansible installation, all provider networks
known to Neutron need to be configured inside the known to Neutron need to be configured inside the
``/etc/openstack_deploy/openstack_user_config.yml`` file. ``/etc/openstack_deploy/openstack_user_config.yml`` file.
For each supported network type (e.g. vlan), the attribute For each supported network type (e.g. vlan), the attribute
``sriov_host_interfaces`` can be defined to map ML2 network names ``sriov_host_interfaces`` can be defined to map ML2 network names
(``net_name`` attribute) to one or many physical interfaces. (``net_name`` attribute) to one or many physical interfaces.
Additionally, the network will need to be assigned to the Additionally, the network will need to be assigned to the
``neutron_sriov_nic_agent`` container group. ``neutron_sriov_nic_agent`` container group.
Example configuration: Example configuration:
.. code-block:: yaml .. code-block:: yaml
@ -411,10 +411,10 @@ Example configuration:
and openvswitch (``ml2.ovs``) ML2 plugins. and openvswitch (``ml2.ovs``) ML2 plugins.
``ml2.lxb`` is the standard activated core ML2 plugin. ``ml2.lxb`` is the standard activated core ML2 plugin.
.. code-block:: yaml .. code-block:: yaml
neutron_plugin_types: neutron_plugin_types:
- ml2.sriov - ml2.sriov
#. Execute the Neutron install playbook in order to update the configuration: #. Execute the Neutron install playbook in order to update the configuration:

4
doc/source/index.rst
View File

@ -16,8 +16,8 @@ Neutron role for OpenStack-Ansible
This role installs the following Systemd services: This role installs the following Systemd services:
* neutron-server * neutron-server
* neutron-agents * neutron-agents
To clone or view the source code for this repository, visit the role repository To clone or view the source code for this repository, visit the role repository
for `os_neutron <https://github.com/openstack/openstack-ansible-os_neutron>`_. for `os_neutron <https://github.com/openstack/openstack-ansible-os_neutron>`_.