Browse Source

Change UserGuide and TestPlan for 3.1

Change-Id: I953e5ef0d4f2beb81aba9b1b2b96f3ccd6bc3338
Igor Gajsin 2 years ago
parent
commit
75df65724f

+ 2
- 2
docs/test_plan/conf.py View File

@@ -63,9 +63,9 @@ copyright = u'2016, Mirantis Inc.'  # noqa
63 63
 # built documents.
64 64
 #
65 65
 # The short X.Y.Z version.
66
-version = '3.0.0'
66
+version = '3.1.0'
67 67
 # The full version, including alpha/beta/rc tags.
68
-release = '3.0-3.0.0-1'
68
+release = '3.1-3.1.0-1'
69 69
 
70 70
 # The language for content autogenerated by Sphinx. Refer to documentation
71 71
 # for a list of supported languages.

+ 2
- 2
docs/test_plan/source/test_suite_system.rst View File

@@ -1384,7 +1384,7 @@ Steps
1384 1384
     4. Configure interfaces on nodes.
1385 1385
     5. Configure network settings.
1386 1386
     6. Enable and configure DVS plugin with multiple uplinks.
1387
-       In format "luster:VDS:TU1;TU2;TU3".
1387
+       In format "Cluster:VDS:TU1;TU2;TU3".
1388 1388
     7. Enable VMware vCenter/ESXi datastore for images (Glance).
1389 1389
     8. Configure VMware vCenter Settings. Add 2 vSphere clusters and configure
1390 1390
        Nova Compute instances on controllers and compute-vmware.
@@ -1521,4 +1521,4 @@ Expected result
1521 1521
 ###############
1522 1522
 
1523 1523
 After disabling two of three teaming uplinks instances are alive and functioning.
1524
-All OSTF tests passed.
1524
+All OSTF tests passed.

+ 3
- 3
docs/test_plan/source/vmware_dvs_test_plan.rst View File

@@ -1,5 +1,5 @@
1 1
 =============================================
2
-Test Plan for VMware DVS plugin version 3.0.0
2
+Test Plan for VMware DVS plugin version 3.1.0
3 3
 =============================================
4 4
 
5 5
 ************
@@ -69,7 +69,7 @@ Product compatibility matrix
69 69
      - Version
70 70
      - Comment
71 71
    * - MOS
72
-     - 9.0 with Mitaka
72
+     - 9.1 with Mitaka
73 73
      -
74 74
    * - Operating System
75 75
      - Ubuntu 14.04
@@ -94,7 +94,7 @@ Evaluation Mission and Test Motivation
94 94
 The main goal of the project is to build a MOS plugin that integrates
95 95
 the Neutron ML2 Driver For VMware vCenter DVS. This will allow to use Neutron
96 96
 for networking in VMware-related environments. The plugin must be compatible
97
-with the version 9.0 of Mirantis OpenStack and should be tested with the
97
+with the version 9.1 of Mirantis OpenStack and should be tested with the
98 98
 software/hardware described in `product compatibility matrix`_.
99 99
 
100 100
 See the VMware DVS Plugin specification for more details.

BIN
docs/user_guide/_static/settings.png View File


BIN
docs/user_guide/_static/vmware.png View File


+ 2
- 2
docs/user_guide/conf.py View File

@@ -64,9 +64,9 @@ copyright = u'2016, Mirantis Inc.'  # noqa
64 64
 # built documents.
65 65
 #
66 66
 # The short X.Y version.
67
-version = '3.0.0'
67
+version = '3.1.0'
68 68
 # The full version, including alpha/beta/rc tags.
69
-release = '3.0-3.0.0-1'
69
+release = '3.1-3.1.0-1'
70 70
 
71 71
 # The language for content autogenerated by Sphinx. Refer to documentation
72 72
 # for a list of supported languages.

+ 20
- 4
docs/user_guide/config.rst View File

@@ -21,7 +21,7 @@ creating an environment in Fuel and modifying the environment settings.
21 21
 
22 22
    \pagebreak
23 23
 
24
-3. In the :guilabel:`Networking Setup` menu, select
24
+#. In the :guilabel:`Networking Setup` menu, select
25 25
    :guilabel:`Neutron with VMware DVS`:
26 26
 
27 27
    .. figure:: _static/net.png
@@ -47,15 +47,31 @@ creating an environment in Fuel and modifying the environment settings.
47 47
 
48 48
    \pagebreak
49 49
 
50
-6. In the :guilabel:`Networks` tab, click :guilabel:`Other`:
50
+#. In the :guilabel:`Networks` tab, click :guilabel:`Other`:
51 51
 
52 52
    #. Select the :guilabel:`Neutron VMware DVS ML2 plugin` checkbox.
53
-   #. Specify the :guilabel:`Cluster to VDSwitch mapping`.
53
+   #. Specify the :guilabel:`Cluster to VDSwitch mapping`. Please notice that
54
+      in the 3.1 release it has new format:
55
+
56
+      #. New string is used as a delimiter between clusters.
57
+      #. There are 2 new columns: list of teaming uplinks and list of fallback
58
+         uplinks. Both are optional.
59
+      #. The semicolon is used as a delimiter between uplinks.
60
+      #. There is no limitation for amount of uplinks.
61
+      #. Thereby there are next options for a mapping-string:
62
+
63
+         #. ClusterName:VDSName:TeamingUplink1;TeamingUplink2:FallBackUplink1;FallBackUplink2
64
+         #. ClusterName:VDSName:TeamingUplink1;TeamingUplink2;...;TeamingUplinkN
65
+         #. ClusterName:VDSName
66
+
67
+      #. There is no option to set fallback uplinks without teaming uplinks.
68
+      #. All uplinks should be presented on real VDS.
54 69
    #. If you want to use security groups on your ports, select
55 70
       :guilabel:`Use the VMware DVS firewall driver`.
56 71
 
57 72
    .. figure:: _static/settings.png
58 73
       :width: 90%
74
+   See the `Teaming and Failover Policy <https://pubs.vmware.com/vsphere-55/index.jsp#com.vmware.vsphere.networking.doc/GUID-4D97C749-1FFD-403D-B2AE-0CD0F1C70E2B.html>`__ for more detail about uplinks usage on VDS.
59 75
 
60 76
    .. caution::
61 77
       The VMware DVS ML2 plugin does not support the Distributed Virtual
@@ -66,7 +82,7 @@ creating an environment in Fuel and modifying the environment settings.
66 82
 
67 83
    \pagebreak
68 84
 
69
-7. In the :guilabel:`VMware` tab, fill in the VMware configuration fields:
85
+#. In the :guilabel:`VMware` tab, fill in the VMware configuration fields:
70 86
 
71 87
    .. figure:: _static/vmware.png
72 88
       :width: 90%

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

@@ -20,7 +20,7 @@ Before you proceed with the VMware DVS plugin installation, verify that:
20 20
 
21 21
    .. code-block:: console
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.1-3.1.0-1.noarch.rpm <Fuel Master node ip>:/tmp
24 24
 
25 25
 #. Log in to the Fuel Master node CLI as root.
26 26
 
@@ -28,7 +28,7 @@ Before you proceed with the VMware DVS plugin installation, verify that:
28 28
 
29 29
    .. code-block:: console
30 30
 
31
-     # fuel plugins --install /tmp/fuel-plugin-vmware-dvs-3.0-3.0.0-1.noarch.rpm
31
+     # fuel plugins --install /tmp/fuel-plugin-vmware-dvs-3.1-3.1.0-1.noarch.rpm
32 32
 
33 33
 #. Verify that the plugin was installed successfully:
34 34
 
@@ -39,11 +39,11 @@ Before you proceed with the VMware DVS plugin installation, verify that:
39 39
      +------+--------------------------+-----------+--------------------+
40 40
      | id   | name                     | version   | package\_version   |
41 41
      +------+--------------------------+-----------+--------------------+
42
-     | 2    | fuel-plugin-vmware-dvs   | 3.0.0     | 4.0.0              |
42
+     | 2    | fuel-plugin-vmware-dvs   | 3.1.0     | 4.0.0              |
43 43
      +------+--------------------------+-----------+--------------------+
44 44
 
45 45
 #. Proceed to :ref:`configure_env`.
46 46
 
47 47
 .. raw:: latex
48 48
 
49
-   \pagebreak
49
+   \pagebreak

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

@@ -2,7 +2,7 @@ Introduction
2 2
 ------------
3 3
 
4 4
 The purpose of this document is to describe how to install, configure,
5
-and use the VMware DVS plugin 3.0.0 for Fuel 9.0.
5
+and use the VMware DVS plugin 3.1.0 for Fuel 9.1.
6 6
 
7 7
 Mirantis OpenStack supports using vCenter as a hypervisor on vCenter-only or
8 8
 heterogeneous environments that are mixed with KVM. The vmware_dvs driver for

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

@@ -1,7 +1,7 @@
1 1
 Limitations
2 2
 -----------
3 3
 
4
-The VMware DVS plugin 3.0.0 for Fuel has the following limitations:
4
+The VMware DVS plugin 3.1.0 for Fuel has the following limitations:
5 5
 
6 6
 * The plugin is enabled only on environments with Neutron as the
7 7
   networking option.

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

@@ -7,7 +7,7 @@ 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
-   `Fuel 9.0 <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html>`__.
10
+   `Fuel 9.1 <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-install-guide.html>`__.
11 11
 
12 12
 #. Plan the vSphere integration. For details, see
13 13
    `Mirantis OpenStack Planning Guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/mos-planning-guide.html#plan-the-vsphere-integration>`_.

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

@@ -1,13 +1,6 @@
1 1
 Release notes
2 2
 -------------
3 3
 
4
-The VMware DVS plugin 3.0.0 contains the following updates:
4
+The VMware DVS plugin 3.1.0 contains the following updates:
5 5
 
6
-* Added a new consistent engine for remote security groups.
7
-
8
-* Enhanced the VMware DVS plugin stability, especially when multiple tasks
9
-  run simultaneously.
10
-
11
-* Improved the VMware DVS plugin overall performance.
12
-
13
-* Improved the VMware DVS plugin documentation.
6
+* Added support of multiple uplinks on VDS.

+ 2
- 2
docs/user_guide/remove.rst View File

@@ -15,7 +15,7 @@ To uninstall VMware DVS plugin, follow the steps below:
15 15
 
16 16
    .. code-block:: console
17 17
 
18
-     # fuel plugins --remove fuel-plugin-vmware-dvs==3.0.0
18
+     # fuel plugins --remove fuel-plugin-vmware-dvs==3.1.0
19 19
 
20 20
 #. Verify whether the VMware DVS plugin was uninstalled successfully:
21 21
 
@@ -27,4 +27,4 @@ To uninstall VMware DVS plugin, follow the steps below:
27 27
 
28 28
 .. raw:: latex
29 29
 
30
-   \pagebreak
30
+   \pagebreak

+ 2
- 2
docs/user_guide/requirements.rst View File

@@ -1,7 +1,7 @@
1 1
 Requirements
2 2
 ------------
3 3
 
4
-The VMware DVS plugin 3.0.0 for Fuel has the following requirements:
4
+The VMware DVS plugin 3.1.0 for Fuel has the following requirements:
5 5
 
6
-* Fuel 9.0 on Mitaka
6
+* Fuel 9.1 on Mitaka
7 7
 * vCenter 5.5/6.0

Loading…
Cancel
Save