Browse Source

[docs] Further edits in DVS User Guide 3.0.0

This patch:

- addresses comments from https://review.openstack.org/333346
- improves the wording in the existing guide.

Link for PDF build:
https://drive.google.com/a/mirantis.com/file/d/0B2pEhXPCoNIIV29oZXN6Ql9KU28/view
Change-Id: I2a92cf199cb05477b587d3a8623f210186845830
Olena Logvinova 2 years ago
parent
commit
2c0198fc40

+ 1
- 1
docs/user_guide/appendix.rst View File

@@ -1,7 +1,7 @@
1 1
 .. _links:
2 2
 
3 3
 Useful links
4
-============
4
+------------
5 5
 
6 6
 For more information about Fuel VMware DVS plugin described in this document,
7 7
 see:

+ 10
- 12
docs/user_guide/config.rst View File

@@ -1,14 +1,14 @@
1 1
 .. _configure_env:
2 2
 
3 3
 Configure an environment with VMware DVS plugin
4
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4
+-----------------------------------------------
5 5
 
6 6
 Configuring and deploying an environment with VMware DVS plugin involves
7 7
 creating an environment in Fuel and modifying the environment settings.
8 8
 
9 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 12
    environment <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/create-environment/start-create-env.html>`_
13 13
    instruction.
14 14
 
@@ -31,14 +31,14 @@ creating an environment in Fuel and modifying the environment settings.
31 31
    environment <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/create-environment/start-create-env.html>`_
32 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 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 38
    .. figure:: _static/nodes-controller.png
39 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 43
    .. figure:: _static/nodes-vmware.png
44 44
       :width: 90%
@@ -55,12 +55,12 @@ creating an environment in Fuel and modifying the environment settings.
55 55
       :guilabel:`Use the VMware DVS firewall driver`.
56 56
 
57 57
    .. figure:: _static/settings.png
58
-      :width: 100%
58
+      :width: 90%
59 59
 
60 60
    .. caution::
61
-      VMware DVS ML2 plugin does not support the Distributed Virtual Routers
62
-      (DVR) feature. Therefore, do not select :guilabel:`Neutron DVR` in
63
-      :menuselection:`Neutron L3 Configuration -> Neutron Advanced Configuration`.
61
+      The VMware DVS ML2 plugin does not support the Distributed Virtual
62
+      Routers (DVR) feature. Therefore, do not select :guilabel:`Neutron DVR`
63
+      in :menuselection:`Neutron L3 Configuration -> Neutron Advanced Configuration`.
64 64
 
65 65
 .. raw:: latex
66 66
 
@@ -71,9 +71,7 @@ creating an environment in Fuel and modifying the environment settings.
71 71
    .. figure:: _static/vmware.png
72 72
       :width: 90%
73 73
 
74
-#. Make additional configuration adjustments as described in the
75
-   `Configure your environment <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment.html>`_
76
-   section of Fuel User Guide.
74
+#. Make additional `configuration adjustments <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment.html>`_.
77 75
 
78 76
 #. Proceed to the `environment deployment <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment.html>`_.
79 77
 

+ 1
- 1
docs/user_guide/definitions.rst View File

@@ -1,7 +1,7 @@
1 1
 .. _definitions:
2 2
 
3 3
 Key terms
4
-~~~~~~~~~
4
+---------
5 5
 
6 6
 The table below lists the key terms, acronyms, and abbreviations that are used
7 7
 in this document.

+ 3
- 3
docs/user_guide/install.rst View File

@@ -1,5 +1,5 @@
1 1
 Install VMware DVS plugin
2
-~~~~~~~~~~~~~~~~~~~~~~~~~
2
+-------------------------
3 3
 
4 4
 Before 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 8
 #. All the nodes of your future environment are :guilabel:`DISCOVERED` on the
9 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 12
    clusters created.
13 13
 
14 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 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 27
 #. Install the plugin:
28 28
 

+ 5
- 5
docs/user_guide/intro.rst View File

@@ -1,5 +1,5 @@
1 1
 Introduction
2
-~~~~~~~~~~~~
2
+------------
3 3
 
4 4
 The purpose of this document is to describe how to install, configure,
5 5
 and 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.
10 10
 Therefore, you get the following advanced network features for your
11 11
 environment:
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 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 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

+ 1
- 1
docs/user_guide/license.rst View File

@@ -1,5 +1,5 @@
1 1
 Licenses
2
-~~~~~~~~
2
+--------
3 3
 
4 4
 ================= ============
5 5
 **Component**     **License**

+ 5
- 8
docs/user_guide/limitations.rst View File

@@ -1,15 +1,12 @@
1 1
 Limitations
2
-~~~~~~~~~~~
2
+-----------
3 3
 
4 4
 The 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 7
   networking option.
8 8
 * Only VLANs are supported for the tenant network separation.
9 9
 * Only vSphere versions 5.5 and 6.0 are supported.
10
-* There is no IPv6 support.
11
-* Each vSphere Cluster shoud be connected with individual (one and only one) VDS.
12
-
13
-.. raw:: latex
14
-
15
-   \pagebreak
10
+* IPv6 is not supported.
11
+* Neutron Distributed Virtual Routers (DVR) feature is not supported.
12
+* Each vSphere cluster should be connected to one (and only one) VDS.

+ 9
- 8
docs/user_guide/prerequisites.rst View File

@@ -1,16 +1,16 @@
1 1
 .. _prereqs:
2 2
 
3 3
 Prerequisites
4
-~~~~~~~~~~~~~
4
+-------------
5 5
 
6
-Before you install and start using VMware DVS plugin on Fuel, complete the
6
+Before you install and start using the VMware DVS plugin on Fuel, complete the
7 7
 following steps:
8 8
 
9 9
 #. Install and set up
10 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
13
-   `Mirantis OpenStack Planning Guide <https://docs.mirantis.com/openstack/fuel/fuel-8.0/mos-planning-guide.html#plan-the-vsphere-integration>`_.
12
+#. Plan the vSphere integration. For details, see
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 15
    .. seealso::
16 16
     * `VMware vSphere 5.5 official documentation <http://pubs.vmware.com/vsphere-55/index.jsp>`_
@@ -34,15 +34,16 @@ following steps:
34 34
           * dvPort group.Modify
35 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 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 41
    your environment. For details, see the VDS videos in the
42 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 48
    .. note::
48 49
     The VMware DVS plugin does not create new VDSes but uses the existing ones.

+ 2
- 6
docs/user_guide/release_notes.rst View File

@@ -1,7 +1,7 @@
1 1
 Release notes
2
-~~~~~~~~~~~~~
2
+-------------
3 3
 
4
-VMware DVS plugin 3.0.0 contains the following updates:
4
+The VMware DVS plugin 3.0.0 contains the following updates:
5 5
 
6 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 11
 * Improved the VMware DVS plugin overall performance.
12 12
 
13 13
 * Improved the VMware DVS plugin documentation.
14
-
15
-.. raw:: latex
16
-
17
-   \pagebreak

+ 1
- 5
docs/user_guide/requirements.rst View File

@@ -1,11 +1,7 @@
1 1
 Requirements
2
-~~~~~~~~~~~~
2
+------------
3 3
 
4 4
 The VMware DVS plugin 3.0.0 for Fuel has the following requirements:
5 5
 
6 6
 * Fuel 9.0 on Mitaka
7 7
 * vCenter 5.5/6.0
8
-
9
-.. raw:: latex
10
-
11
-   \pagebreak

+ 23
- 12
docs/user_guide/troubleshooting.rst View File

@@ -1,13 +1,20 @@
1 1
 Troubleshooting
2
-~~~~~~~~~~~~~~~
2
+---------------
3 3
 
4
-VMware DVS driver consists of two parts: the mechanism driver of Neutron and
5
-the VMware DVS agent. Therefore, two main sources of information for
6
-troubleshooting are ``/var/log/neutron/server.log`` and
7
-``/var/log/neutron/vmware-dvs-agent-....log``.
4
+This section contains a guidance on how to ensure that the VMware DVS plugin
5
+is up and running on your deployed environment.
6
+
7
+**To find logs**
8
+
9
+The VMware DVS driver consists of two parts: the mechanism driver of Neutron
10
+and the VMware DVS agent. Therefore, two main sources of information for
11
+troubleshooting 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
- 
11 18
 To deliver a stable performance of the VMware DVS plugin, verify that the
12 19
 Neutron configuration files contain the following values:
13 20
 
@@ -45,11 +52,15 @@ Neutron configuration files contain the following values:
45 52
    vsphere_hostname=<vsphere_ip>
46 53
    vsphere_password=<vsphere_password>
47 54
 
48
-Verify that all neutron-dvs-agent services are launched on corresponding nodes:
55
+**To verify neutron-dvs-agent services**
56
+
57
+All neutron-dvs-agent services should run on the corresponding nodes:
49 58
 
50
-* On controllers: under corosync
51
-* On compute-vmware: using the init script
59
+* On controllers: ``p_neutron_plugin_vmware_dvs_agent_${host}`` in Corosync
60
+* On compute-vmware: ``neutron-plugin-vmware-dvs-agent-${host}`` in the init
61
+  script
52 62
 
53
-Verify the connectivity between controller nodes and vCenter:
63
+**To verify connectivity**
54 64
 
55
-.. TODO: add CLI command
65
+Check the connectivity between controller nodes and vCenter using the
66
+:command:`ping` command.

+ 7
- 5
docs/user_guide/using_neutron.rst View File

@@ -2,9 +2,9 @@ Using advanced Neutron possibilities with VMware DVS plugin
2 2
 -----------------------------------------------------------
3 3
 
4 4
 Once you deploy an OpenStack environment with VMware DVS plugin, you can
5
-start using Neutron for networking. When neutron creates a new network it
6
-doesn't affect any VDS until a port in that network would attached to VM, that
7
-launched on a corresponding Cluster.
5
+start using Neutron for networking. When Neutron creates a new network, it
6
+does not affect any VDS until a port in that network is attached to a VM
7
+launched on a corresponding environment.
8 8
 
9 9
 **DVS security groups**
10 10
 
@@ -44,12 +44,13 @@ Example of a common egress TCP rule:
44 44
 
45 45
 * TCP egress to any ports 0.0.0.0/0 CIDR
46 46
 
47
-It works in the following way:
47
+It works as follows:
48 48
 
49 49
 * TCP egress from any IP ports 32768-65535 to any IP any port
50 50
 * TCP ingress from any IP any port to any IP ports 32768-65535
51 51
 
52
-Once applied, the private ports of your VM like HTTP or SSH will be closed.
52
+Once applied, the private ports of your VM, such as HTTP or SSH, will be
53
+closed.
53 54
 
54 55
 The VMWare DVS plugin supports only symmetric ICMP interaction. If your host
55 56
 can ping a destination host, it means that the destination host can ping your
@@ -58,3 +59,4 @@ host by reverse rules.
58 59
 .. raw:: latex
59 60
 
60 61
    \pagebreak
62
+

+ 21
- 4
docs/user_guide/verification.rst View File

@@ -1,5 +1,22 @@
1
-Verification
2
-++++++++++++
1
+Verify a deployed environment with VMware DVS plugin
2
+----------------------------------------------------
3 3
 
4
-After deployment of an environment with VMware DVS plugin all corresponding
5
-OSTF tests should pass.
4
+After you deploy an environment with VMware DVS plugin, complete the
5
+following 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>`_.

Loading…
Cancel
Save