Browse Source

Plugin Guide Fixes

Change-Id: Id43f082df4f64cae54aa2294f8b20c9a8f7bd90b
Signed-off-by: Javeria Khan <javeriak@plumgrid.com>
Javeria Khan 3 years ago
parent
commit
6480a3591b

+ 3
- 3
doc/plugin_guide/source/index.rst View File

@@ -11,6 +11,6 @@ Guide to PLUMgrid Plugin ver. 1.0-1.0.1-1 for Fuel 7.0
11 11
    :maxdepth: 2
12 12
    :numbered:
13 13
 
14
-    intro
15
-    requirements
16
-    install_guide
14
+   intro
15
+   requirements
16
+   install_guide

+ 16
- 11
doc/plugin_guide/source/install_guide.rst View File

@@ -8,7 +8,7 @@ This document assumes that you have `installed Fuel <https://docs.mirantis.com/o
8 8
 and setup the target hosts with appropriate networking for the pxe, management, public and plumgrid-fabric networks. The nodes
9 9
 must be discovered and functional prior to doing the following steps.
10 10
 
11
-Obtain a PLUMgrid ONS license and access to packages or LCM image at info@plumgrid.com
11
+Obtain a PLUMgrid ONS license and access to packages or LCM image by emailing Support at info@plumgrid.com.
12 12
 
13 13
 Installing Fuel PLUMgrid Plugin
14 14
 -------------------------------
@@ -25,7 +25,7 @@ Installing Fuel PLUMgrid Plugin
25 25
       cd /tmp
26 26
       fuel plugins --install plumgrid-<x.x.x>.rpm
27 27
 
28
-   You should get the following output
28
+   You should get the following output:
29 29
    ::
30 30
 
31 31
       Plugin <plugin-name-version>.rpm was successfully installed
@@ -38,8 +38,8 @@ Installing Fuel PLUMgrid Plugin
38 38
 #. The plugin is now ready for use and can be enabled on the Settings tab, PLUMgrid Plugin section
39 39
    of the Fuel web UI, as explained next.
40 40
 
41
-Configuring PLUmgrid Plugin
42
----------------------------
41
+Configuring a New Environment
42
+-----------------------------
43 43
 
44 44
 #. In Fuel UI `create environment <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_.
45 45
 
@@ -58,8 +58,10 @@ Configuring PLUmgrid Plugin
58 58
     .. image:: images/networking_setup.png
59 59
        :width: 80%
60 60
 
61
+Configuring PLUMgrid Plugin
62
+---------------------------
61 63
 
62
-#. After creating the enviroment, navigate to Settings → Fuel PLUMgrid plugin. Check the Fuel PLUMgrid Pluginbox and fill in the appropiate values for the your enviroment.
64
+#. After creating the enviroment, navigate to Settings → Fuel PLUMgrid plugin. Check the Fuel PLUMgrid Pluginbox and fill in the appropiate values for the enviroment.
63 65
 
64 66
    .. image:: images/plumgrid_ui_setup.png
65 67
        :width: 80%
@@ -79,7 +81,10 @@ Configuring PLUmgrid Plugin
79 81
 
80 82
   * **Enter the license for PLUMgrid:** Enter the PLUMgrid license string provided by PLUMgrid support.
81 83
 
82
-  * **Enter the interface(s) to be used by GW:** Enter the interfaces that will be used for external connectivity by the PLUMgrid Gateway comma separated for more than one.
84
+  * **Enter the interface(s) to be used by GW:** Enter the interfaces that will be used for external connectivity by the PLUMgrid Gateway, comma separated for more than one.
85
+
86
+Deployment Settings
87
+-------------------
83 88
 
84 89
 #. Navigate to Repositories tab and click Add Extra Repo and provide the following PLUMgrid repositories:
85 90
    ::
@@ -90,13 +95,13 @@ Configuring PLUmgrid Plugin
90 95
    .. image:: images/plumgrid_repos.png
91 96
        :width: 80%
92 97
 
93
-#. Navigate to the Nodes tab to and click on Add nodes:
98
+#. Navigate to the Nodes tab and click on Add nodes:
94 99
 
95 100
    .. image:: images/add_nodes.png
96 101
        :width: 80%
97 102
 
98 103
 
99
-Assign the unallocated nodes their respective roles. Select the role i.e. Controller/Compute/PLUMgrid-Gateway and select the node which will assume that role. This process must be repeated for each node individually:
104
+   Assign the unallocated nodes their respective roles. Select the role i.e. Controller/Compute/PLUMgrid-Gateway and select the node which will assume that role. This process must be repeated for every node individually:
100 105
 
101 106
    .. image:: images/add_controllers.png
102 107
        :width: 80%
@@ -114,7 +119,7 @@ Assign the unallocated nodes their respective roles. Select the role i.e. Contro
114 119
 
115 120
 #. Press **Deploy changes** to `deploy the environment <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#deploy-changes>`_.
116 121
 
117
-#. After a succesful deployment. The PLUMgrid UI will be accessible for the VIP entered in the PLUMgrid Settings
122
+#. After a succesful deployment. The PLUMgrid UI will be accessible on the VIP entered in the PLUMgrid Settings.
118 123
    ::
119 124
       https://<PG-VIP>
120 125
 
@@ -128,6 +133,6 @@ Assign the unallocated nodes their respective roles. Select the role i.e. Contro
128 133
       neutron net-create net1
129 134
       neutron router-create router1
130 135
 
131
-The newly created network and router should be visible in Horizon.
136
+   The newly created network and router should be visible in Horizon and the PLUMgrid UI
132 137
 
133
-#. For further details on usability & features, contact PLUMgrid at info@plumgrid.com to obtain official documentation.
138
+#. For further details on usability & features, and to obtain official documentation, contact PLUMgrid at info@plumgrid.com.

+ 1
- 1
doc/plugin_guide/source/intro.rst View File

@@ -2,7 +2,7 @@ Introduction
2 2
 ============
3 3
 
4 4
 This document contains instructions for installing and configuring the PLUMgrid plugin for Fuel.
5
-In order to use the PLUMgrid ONS Virtual Network Infrastructure for a Mirantis OpenStack Cloud.
5
+In order to use the PLUMgrid ONS Virtual Network Infrastructure for a Mirantis OpenStack Cloud, follow the Installation Guide.
6 6
 
7 7
 Key terms, acronyms and abbreviations
8 8
 -------------------------------------

Loading…
Cancel
Save