summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2016-07-05 15:45:31 +0000
committerGerrit Code Review <review@openstack.org>2016-07-05 15:45:31 +0000
commiteb508ead76584b4c8c576c8de38b5d4d717fdc95 (patch)
tree56963f9862d1c40d21ef979c5771743ef4e84429
parent7ad3634e9bb3cc13429f7c91e9b3285ef68e02e1 (diff)
parent2c0198fc4089d51fed5358e9d635b5b30f3d7373 (diff)
Merge "[docs] Further edits in DVS User Guide 3.0.0"
-rw-r--r--docs/user_guide/appendix.rst2
-rw-r--r--docs/user_guide/config.rst22
-rw-r--r--docs/user_guide/definitions.rst2
-rw-r--r--docs/user_guide/install.rst6
-rw-r--r--docs/user_guide/intro.rst10
-rw-r--r--docs/user_guide/license.rst2
-rw-r--r--docs/user_guide/limitations.rst13
-rw-r--r--docs/user_guide/prerequisites.rst17
-rw-r--r--docs/user_guide/release_notes.rst8
-rw-r--r--docs/user_guide/requirements.rst6
-rw-r--r--docs/user_guide/troubleshooting.rst35
-rw-r--r--docs/user_guide/using_neutron.rst12
-rw-r--r--docs/user_guide/verification.rst25
13 files changed, 89 insertions, 71 deletions
diff --git a/docs/user_guide/appendix.rst b/docs/user_guide/appendix.rst
index 218577b..563e71c 100644
--- a/docs/user_guide/appendix.rst
+++ b/docs/user_guide/appendix.rst
@@ -1,7 +1,7 @@
1.. _links: 1.. _links:
2 2
3Useful links 3Useful links
4============ 4------------
5 5
6For more information about Fuel VMware DVS plugin described in this document, 6For more information about Fuel VMware DVS plugin described in this document,
7see: 7see:
diff --git a/docs/user_guide/config.rst b/docs/user_guide/config.rst
index f422428..fef528a 100644
--- a/docs/user_guide/config.rst
+++ b/docs/user_guide/config.rst
@@ -1,14 +1,14 @@
1.. _configure_env: 1.. _configure_env:
2 2
3Configure an environment with VMware DVS plugin 3Configure an environment with VMware DVS plugin
4~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 4-----------------------------------------------
5 5
6Configuring and deploying an environment with VMware DVS plugin involves 6Configuring and deploying an environment with VMware DVS plugin involves
7creating an environment in Fuel and modifying the environment settings. 7creating an environment in Fuel and modifying the environment settings.
8 8
9**To configure an OpenStack environment with VMware DVS plugin:** 9**To configure an OpenStack environment with VMware DVS plugin:**
10 10
11#. Using Fuel Web UI, follow steps 1-5 of the `Create a new OpenStack 11#. Using the Fuel web UI, follow steps 1 to 5 of the `Create a new OpenStack
12 environment <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/create-environment/start-create-env.html>`_ 12 environment <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/create-environment/start-create-env.html>`_
13 instruction. 13 instruction.
14 14
@@ -31,14 +31,14 @@ creating an environment in Fuel and modifying the environment settings.
31 environment <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/create-environment/start-create-env.html>`_ 31 environment <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/create-environment/start-create-env.html>`_
32 instruction. 32 instruction.
33 33
34#. In the :guilabel:`Nodes` tab of the Fuel Web UI, `add 34#. In the :guilabel:`Nodes` tab of the Fuel web UI, `add
35 <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment/add-nodes.html>`_ 35 <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment/add-nodes.html>`_
36 at least 1 :guilabel:`Controller` node to the environment: 36 at least one :guilabel:`Controller` node to the environment:
37 37
38 .. figure:: _static/nodes-controller.png 38 .. figure:: _static/nodes-controller.png
39 :width: 90% 39 :width: 90%
40 40
41 (Optional) You can also add 1 dedicated :guilabel:`Compute VMware` node: 41 (Optional) You can also add one dedicated :guilabel:`Compute VMware` node:
42 42
43 .. figure:: _static/nodes-vmware.png 43 .. figure:: _static/nodes-vmware.png
44 :width: 90% 44 :width: 90%
@@ -55,12 +55,12 @@ creating an environment in Fuel and modifying the environment settings.
55 :guilabel:`Use the VMware DVS firewall driver`. 55 :guilabel:`Use the VMware DVS firewall driver`.
56 56
57 .. figure:: _static/settings.png 57 .. figure:: _static/settings.png
58 :width: 100% 58 :width: 90%
59 59
60 .. caution:: 60 .. caution::
61 VMware DVS ML2 plugin does not support the Distributed Virtual Routers 61 The VMware DVS ML2 plugin does not support the Distributed Virtual
62 (DVR) feature. Therefore, do not select :guilabel:`Neutron DVR` in 62 Routers (DVR) feature. Therefore, do not select :guilabel:`Neutron DVR`
63 :menuselection:`Neutron L3 Configuration -> Neutron Advanced Configuration`. 63 in :menuselection:`Neutron L3 Configuration -> Neutron Advanced Configuration`.
64 64
65.. raw:: latex 65.. raw:: latex
66 66
@@ -71,9 +71,7 @@ creating an environment in Fuel and modifying the environment settings.
71 .. figure:: _static/vmware.png 71 .. figure:: _static/vmware.png
72 :width: 90% 72 :width: 90%
73 73
74#. Make additional configuration adjustments as described in the 74#. Make additional `configuration adjustments <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment.html>`_.
75 `Configure your environment <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment.html>`_
76 section of Fuel User Guide.
77 75
78#. Proceed to the `environment deployment <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment.html>`_. 76#. Proceed to the `environment deployment <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment.html>`_.
79 77
diff --git a/docs/user_guide/definitions.rst b/docs/user_guide/definitions.rst
index 0528f92..f1d884e 100644
--- a/docs/user_guide/definitions.rst
+++ b/docs/user_guide/definitions.rst
@@ -1,7 +1,7 @@
1.. _definitions: 1.. _definitions:
2 2
3Key terms 3Key terms
4~~~~~~~~~ 4---------
5 5
6The table below lists the key terms, acronyms, and abbreviations that are used 6The table below lists the key terms, acronyms, and abbreviations that are used
7in this document. 7in this document.
diff --git a/docs/user_guide/install.rst b/docs/user_guide/install.rst
index 04133d3..f4a5c3d 100644
--- a/docs/user_guide/install.rst
+++ b/docs/user_guide/install.rst
@@ -1,5 +1,5 @@
1Install VMware DVS plugin 1Install VMware DVS plugin
2~~~~~~~~~~~~~~~~~~~~~~~~~ 2-------------------------
3 3
4Before you proceed with the VMware DVS plugin installation, verify that: 4Before you proceed with the VMware DVS plugin installation, verify that:
5 5
@@ -8,7 +8,7 @@ Before you proceed with the VMware DVS plugin installation, verify that:
8#. All the nodes of your future environment are :guilabel:`DISCOVERED` on the 8#. All the nodes of your future environment are :guilabel:`DISCOVERED` on the
9 Fuel Master node. 9 Fuel Master node.
10 10
11#. You have a connectivity to correctly configured vCenter with VDSes and 11#. You have connectivity to correctly configured vCenter with VDSes and
12 clusters created. 12 clusters created.
13 13
14**To install the VMware DVS plugin:** 14**To install the VMware DVS plugin:**
@@ -22,7 +22,7 @@ Before you proceed with the VMware DVS plugin installation, verify that:
22 22
23 $ scp fuel-plugin-vmware-dvs-3.0-3.0.0-1.noarch.rpm <Fuel Master node ip>:/tmp 23 $ scp fuel-plugin-vmware-dvs-3.0-3.0.0-1.noarch.rpm <Fuel Master node ip>:/tmp
24 24
25#. Log into the Fuel Master node CLI as root. 25#. Log in to the Fuel Master node CLI as root.
26 26
27#. Install the plugin: 27#. Install the plugin:
28 28
diff --git a/docs/user_guide/intro.rst b/docs/user_guide/intro.rst
index b314fd7..2404889 100644
--- a/docs/user_guide/intro.rst
+++ b/docs/user_guide/intro.rst
@@ -1,5 +1,5 @@
1Introduction 1Introduction
2~~~~~~~~~~~~ 2------------
3 3
4The purpose of this document is to describe how to install, configure, 4The purpose of this document is to describe how to install, configure,
5and use the VMware DVS plugin 3.0.0 for Fuel 9.0. 5and use the VMware DVS plugin 3.0.0 for Fuel 9.0.
@@ -10,12 +10,12 @@ Neutron ML2 plugin allows using Neutron for networking in such environments.
10Therefore, you get the following advanced network features for your 10Therefore, you get the following advanced network features for your
11environment: 11environment:
12 12
13- Create multi-tier networks (for example: web tier, database tier, 13- Create multi-tier networks (for example, web tier, database tier,
14 application tier) 14 application tier)
15 15
16- Control over IP addressing and security groups' rules. 16- Control over IP addressing and security groups' rules
17 17
18- Add and configure custom services (for example: firewall, 18- Add and configure custom services (for example, firewall,
19 intrusion-prevention system) 19 intrusion-prevention system)
20 20
21- VPN/Bridge to a remote physical hosting or customer premises. 21- Use VPN/bridge to a remote physical hosting or customer premises
diff --git a/docs/user_guide/license.rst b/docs/user_guide/license.rst
index 26be275..a01aa3e 100644
--- a/docs/user_guide/license.rst
+++ b/docs/user_guide/license.rst
@@ -1,5 +1,5 @@
1Licenses 1Licenses
2~~~~~~~~ 2--------
3 3
4================= ============ 4================= ============
5**Component** **License** 5**Component** **License**
diff --git a/docs/user_guide/limitations.rst b/docs/user_guide/limitations.rst
index 1f64e3b..67d85d4 100644
--- a/docs/user_guide/limitations.rst
+++ b/docs/user_guide/limitations.rst
@@ -1,15 +1,12 @@
1Limitations 1Limitations
2~~~~~~~~~~~ 2-----------
3 3
4The VMware DVS plugin 3.0.0 for Fuel has the following limitations: 4The VMware DVS plugin 3.0.0 for Fuel has the following limitations:
5 5
6* The plugin is enabled only in environments with Neutron as the 6* The plugin is enabled only on environments with Neutron as the
7 networking option. 7 networking option.
8* Only VLANs are supported for the tenant network separation. 8* Only VLANs are supported for the tenant network separation.
9* Only vSphere versions 5.5 and 6.0 are supported. 9* Only vSphere versions 5.5 and 6.0 are supported.
10* There is no IPv6 support. 10* IPv6 is not supported.
11* Each vSphere Cluster shoud be connected with individual (one and only one) VDS. 11* Neutron Distributed Virtual Routers (DVR) feature is not supported.
12 12* Each vSphere cluster should be connected to one (and only one) VDS.
13.. raw:: latex
14
15 \pagebreak
diff --git a/docs/user_guide/prerequisites.rst b/docs/user_guide/prerequisites.rst
index 7e2b466..fcf2f45 100644
--- a/docs/user_guide/prerequisites.rst
+++ b/docs/user_guide/prerequisites.rst
@@ -1,16 +1,16 @@
1.. _prereqs: 1.. _prereqs:
2 2
3Prerequisites 3Prerequisites
4~~~~~~~~~~~~~ 4-------------
5 5
6Before you install and start using VMware DVS plugin on Fuel, complete the 6Before you install and start using the VMware DVS plugin on Fuel, complete the
7following steps: 7following steps:
8 8
9#. Install and set up 9#. Install and set up
10 `Fuel 9.0 <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html>`__. 10 `Fuel 9.0 <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html>`__.
11 11
12#. Read the *Plan the vSphere integration* section in 12#. Plan the vSphere integration. For details, see
13 `Mirantis OpenStack Planning Guide <https://docs.mirantis.com/openstack/fuel/fuel-8.0/mos-planning-guide.html#plan-the-vsphere-integration>`_. 13 `Mirantis OpenStack Planning Guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/mos-planning-guide.html#plan-the-vsphere-integration>`_.
14 14
15 .. seealso:: 15 .. seealso::
16 * `VMware vSphere 5.5 official documentation <http://pubs.vmware.com/vsphere-55/index.jsp>`_ 16 * `VMware vSphere 5.5 official documentation <http://pubs.vmware.com/vsphere-55/index.jsp>`_
@@ -34,15 +34,16 @@ following steps:
34 * dvPort group.Modify 34 * dvPort group.Modify
35 * dvPort group.Policy operation 35 * dvPort group.Policy operation
36 36
37 It allows the VMware DVS plugin to use manipulation resources of VMware 37 This allows the VMware DVS plugin to use manipulation resources of VMware
38 vSphere Distributed Switch (VDS). 38 vSphere Distributed Switch (VDS).
39 39
40#. Create and properly configure VDSes on vCenter that will be used in 40#. Create and properly configure VDSes on vCenter that will be used for
41 your environment. For details, see the VDS videos in the 41 your environment. For details, see the VDS videos in the
42 :menuselection:`Technical Details -> Resources` section on the 42 :menuselection:`Technical Details -> Resources` section on the
43 `VMware Distributed Switch page <https://www.vmware.com/products/vsphere/features/distributed-switch>`__. 43 `VMware Distributed Switch <https://www.vmware.com/products/vsphere/features/distributed-switch>`__
44 page.
44 45
45#. Connect the VMware DVS plugin to the precreated and configured VDSes. 46#. Connect the VMware DVS plugin to the pre-created and configured VDSes.
46 47
47 .. note:: 48 .. note::
48 The VMware DVS plugin does not create new VDSes but uses the existing ones. 49 The VMware DVS plugin does not create new VDSes but uses the existing ones.
diff --git a/docs/user_guide/release_notes.rst b/docs/user_guide/release_notes.rst
index 4e54018..ab549ee 100644
--- a/docs/user_guide/release_notes.rst
+++ b/docs/user_guide/release_notes.rst
@@ -1,7 +1,7 @@
1Release notes 1Release notes
2~~~~~~~~~~~~~ 2-------------
3 3
4VMware DVS plugin 3.0.0 contains the following updates: 4The VMware DVS plugin 3.0.0 contains the following updates:
5 5
6* Added a new consistent engine for remote security groups. 6* Added a new consistent engine for remote security groups.
7 7
@@ -11,7 +11,3 @@ VMware DVS plugin 3.0.0 contains the following updates:
11* Improved the VMware DVS plugin overall performance. 11* Improved the VMware DVS plugin overall performance.
12 12
13* Improved the VMware DVS plugin documentation. 13* Improved the VMware DVS plugin documentation.
14
15.. raw:: latex
16
17 \pagebreak
diff --git a/docs/user_guide/requirements.rst b/docs/user_guide/requirements.rst
index 06e4e81..82829ff 100644
--- a/docs/user_guide/requirements.rst
+++ b/docs/user_guide/requirements.rst
@@ -1,11 +1,7 @@
1Requirements 1Requirements
2~~~~~~~~~~~~ 2------------
3 3
4The VMware DVS plugin 3.0.0 for Fuel has the following requirements: 4The VMware DVS plugin 3.0.0 for Fuel has the following requirements:
5 5
6* Fuel 9.0 on Mitaka 6* Fuel 9.0 on Mitaka
7* vCenter 5.5/6.0 7* vCenter 5.5/6.0
8
9.. raw:: latex
10
11 \pagebreak
diff --git a/docs/user_guide/troubleshooting.rst b/docs/user_guide/troubleshooting.rst
index 0e01a0f..edfc269 100644
--- a/docs/user_guide/troubleshooting.rst
+++ b/docs/user_guide/troubleshooting.rst
@@ -1,13 +1,20 @@
1Troubleshooting 1Troubleshooting
2~~~~~~~~~~~~~~~ 2---------------
3 3
4VMware DVS driver consists of two parts: the mechanism driver of Neutron and 4This section contains a guidance on how to ensure that the VMware DVS plugin
5the VMware DVS agent. Therefore, two main sources of information for 5is up and running on your deployed environment.
6troubleshooting are ``/var/log/neutron/server.log`` and 6
7``/var/log/neutron/vmware-dvs-agent-....log``. 7**To find logs**
8
9The VMware DVS driver consists of two parts: the mechanism driver of Neutron
10and the VMware DVS agent. Therefore, two main sources of information for
11troubleshooting are:
12
13* ``/var/log/neutron/server.log``
14* ``/var/log/neutron/vmware-dvs-agent-....log``
15
16**To verify Neutron configuration files**
8 17
9**To verify Neutron configuration files:**
10
11To deliver a stable performance of the VMware DVS plugin, verify that the 18To deliver a stable performance of the VMware DVS plugin, verify that the
12Neutron configuration files contain the following values: 19Neutron configuration files contain the following values:
13 20
@@ -45,11 +52,15 @@ Neutron configuration files contain the following values:
45 vsphere_hostname=<vsphere_ip> 52 vsphere_hostname=<vsphere_ip>
46 vsphere_password=<vsphere_password> 53 vsphere_password=<vsphere_password>
47 54
48Verify that all neutron-dvs-agent services are launched on corresponding nodes: 55**To verify neutron-dvs-agent services**
56
57All neutron-dvs-agent services should run on the corresponding nodes:
49 58
50* On controllers: under corosync 59* On controllers: ``p_neutron_plugin_vmware_dvs_agent_${host}`` in Corosync
51* On compute-vmware: using the init script 60* On compute-vmware: ``neutron-plugin-vmware-dvs-agent-${host}`` in the init
61 script
52 62
53Verify the connectivity between controller nodes and vCenter: 63**To verify connectivity**
54 64
55.. TODO: add CLI command 65Check the connectivity between controller nodes and vCenter using the
66:command:`ping` command.
diff --git a/docs/user_guide/using_neutron.rst b/docs/user_guide/using_neutron.rst
index 568b236..2fc6d42 100644
--- a/docs/user_guide/using_neutron.rst
+++ b/docs/user_guide/using_neutron.rst
@@ -2,9 +2,9 @@ Using advanced Neutron possibilities with VMware DVS plugin
2----------------------------------------------------------- 2-----------------------------------------------------------
3 3
4Once you deploy an OpenStack environment with VMware DVS plugin, you can 4Once you deploy an OpenStack environment with VMware DVS plugin, you can
5start using Neutron for networking. When neutron creates a new network it 5start using Neutron for networking. When Neutron creates a new network, it
6doesn't affect any VDS until a port in that network would attached to VM, that 6does not affect any VDS until a port in that network is attached to a VM
7launched on a corresponding Cluster. 7launched on a corresponding environment.
8 8
9**DVS security groups** 9**DVS security groups**
10 10
@@ -44,12 +44,13 @@ Example of a common egress TCP rule:
44 44
45* TCP egress to any ports 0.0.0.0/0 CIDR 45* TCP egress to any ports 0.0.0.0/0 CIDR
46 46
47It works in the following way: 47It works as follows:
48 48
49* TCP egress from any IP ports 32768-65535 to any IP any port 49* TCP egress from any IP ports 32768-65535 to any IP any port
50* TCP ingress from any IP any port to any IP ports 32768-65535 50* TCP ingress from any IP any port to any IP ports 32768-65535
51 51
52Once applied, the private ports of your VM like HTTP or SSH will be closed. 52Once applied, the private ports of your VM, such as HTTP or SSH, will be
53closed.
53 54
54The VMWare DVS plugin supports only symmetric ICMP interaction. If your host 55The VMWare DVS plugin supports only symmetric ICMP interaction. If your host
55can ping a destination host, it means that the destination host can ping your 56can ping a destination host, it means that the destination host can ping your
@@ -58,3 +59,4 @@ host by reverse rules.
58.. raw:: latex 59.. raw:: latex
59 60
60 \pagebreak 61 \pagebreak
62
diff --git a/docs/user_guide/verification.rst b/docs/user_guide/verification.rst
index 5014924..afb9660 100644
--- a/docs/user_guide/verification.rst
+++ b/docs/user_guide/verification.rst
@@ -1,5 +1,22 @@
1Verification 1Verify a deployed environment with VMware DVS plugin
2++++++++++++ 2----------------------------------------------------
3 3
4After deployment of an environment with VMware DVS plugin all corresponding 4After you deploy an environment with VMware DVS plugin, complete the
5OSTF tests should pass. 5following verification steps:
6
7#. Log in to a controller node.
8#. Verify whether the DVS agent is available in the list of Neutron agents:
9
10 .. code-block:: console
11
12 $ neutron agent-list
13 +----+-----------+-----------+-----------------+------+---------------+-----------------+
14 |id |agent_type |host |availability_zone|alive |admin_state_up |binary |
15 +----+-----------+-----------+-----------------+----------------------+-----------------+
16 |... |DVS agent |vcenter-sn2| |:-) |True |neutron-dvs-agent|
17 +----+-----------+-----------+-----------------+------+---------------+-----------------+
18
19#. Log in to the Fuel web UI.
20#. Click the :guilabel:`Health Check` tab.
21#. Run necessary health tests. For details, see:
22 `Verify your OpenStack environment <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/verify-environment.html>`_.