Browse Source

Update Plugin Guide

Change-Id: I1cc252d33c43bcac584d0b793a5b30176002d3fc
Signed-off-by: Javeria Khan <javeriak@plumgrid.com>
Javeria Khan 3 years ago
parent
commit
15e7c8a078

+ 8
- 1
doc/plugin_guide/source/conf.py View File

@@ -61,7 +61,7 @@ author = u'Javeria Khan'
61 61
 # The short X.Y version.
62 62
 version = u'1.0'
63 63
 # The full version, including alpha/beta/rc tags.
64
-release = u'1.0.1'
64
+release = u'1.0-1.0.1-1'
65 65
 
66 66
 # The language for content autogenerated by Sphinx. Refer to documentation
67 67
 # for a list of supported languages.
@@ -250,6 +250,10 @@ latex_documents = [
250 250
 # If false, no module index is generated.
251 251
 #latex_domain_indices = True
252 252
 
253
+# make latex stop printing blank pages between sections
254
+# http://stackoverflow.com/questions/5422997/sphinx-docs-remove-blank-pages-from-generated-pdfs
255
+latex_elements = { 'classoptions': ',openany,oneside', 'babel' : '\\usepackage[english]{babel}' }
256
+
253 257
 
254 258
 # -- Options for manual page output ---------------------------------------
255 259
 
@@ -287,6 +291,9 @@ texinfo_documents = [
287 291
 # If true, do not generate a @detailmenu in the "Top" node's menu.
288 292
 #texinfo_no_detailmenu = False
289 293
 
294
+# Insert footnotes where they are defined instead of
295
+# at the end.
296
+pdf_inline_footnotes = True
290 297
 
291 298
 # Example configuration for intersphinx: refer to the Python standard library.
292 299
 intersphinx_mapping = {'https://docs.python.org/': None}

+ 1
- 0
doc/plugin_guide/source/index.rst View File

@@ -14,3 +14,4 @@ Guide to PLUMgrid Plugin ver. 1.0-1.0.1-1 for Fuel 7.0
14 14
    intro
15 15
    requirements
16 16
    install_guide
17
+   troubleshooting

+ 19
- 19
doc/plugin_guide/source/install_guide.rst View File

@@ -6,9 +6,9 @@ Prerequisites
6 6
 
7 7
 This document assumes that you have `installed Fuel <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html>`_
8 8
 and setup the target hosts with appropriate networking for the pxe, management, public and plumgrid-fabric networks. The nodes
9
-must be discovered and functional prior to doing the following steps.
9
+must be discovered and functional prior to performing the following steps.
10 10
 
11
-Obtain a PLUMgrid ONS license and access to packages or LCM image by emailing Support at info@plumgrid.com.
11
+Obtain a PLUMgrid ONS license and access to packages or LCM image by emailing PLUMgrid Support at info@plumgrid.com.
12 12
 
13 13
 Installing Fuel PLUMgrid Plugin
14 14
 -------------------------------
@@ -17,9 +17,9 @@ Installing Fuel PLUMgrid Plugin
17 17
 #. Copy this file to the Fuel Master node with secure copy (scp):
18 18
    ::
19 19
 
20
-      scp plumgrid-<x.x.x>.rpm root@:<the_Fuel_Master_node_IP address>:/tmp
20
+      scp plumgrid-<x.x.x>.rpm root@<Fuel_Master_node_IP address>:/tmp
21 21
 
22
-#. On the Fuel Master node, Install the PLUMgrid plugin with:
22
+#. On the Fuel Master node, install the PLUMgrid plugin with:
23 23
    ::
24 24
 
25 25
       cd /tmp
@@ -35,19 +35,19 @@ Installing Fuel PLUMgrid Plugin
35 35
 
36 36
       fuel plugins --list
37 37
 
38
-#. The plugin is now ready for use and can be enabled on the Settings tab, PLUMgrid Plugin section
39
-   of the Fuel web UI, as explained next.
38
+#. The plugin is now ready for use and can be enabled in the Settings → PLUMgrid Plugin section of an OpenStack environment on the Fuel UI as explained next.
39
+   This part is visible after a new environment is created.
40 40
 
41 41
 Configuring a New Environment
42 42
 -----------------------------
43 43
 
44
-#. In Fuel UI `create environment <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_.
44
+#. In Fuel UI `create a new environment <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_.
45 45
 
46 46
     .. image:: images/create_env.png
47 47
        :width: 80%
48 48
 
49 49
 
50
-#. Select the appropiate KVM or QEMU hypervisor type for your environment.
50
+#. Select the appropriate KVM or QEMU hypervisor type for your environment.
51 51
 
52 52
     .. image:: images/compute.png
53 53
        :width: 80%
@@ -61,7 +61,7 @@ Configuring a New Environment
61 61
 Configuring PLUMgrid Plugin
62 62
 ---------------------------
63 63
 
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.
64
+#. After creating the enviroment, navigate to Settings → Fuel PLUMgrid plugin. Check the Fuel PLUMgrid Pluginbox and fill in the appropriate values for the enviroment.
65 65
 
66 66
    .. image:: images/plumgrid_ui_setup.png
67 67
        :width: 80%
@@ -71,17 +71,17 @@ Configuring PLUMgrid Plugin
71 71
 
72 72
   * **Enter the password for PLUMgrid:** default is *plumgrid*
73 73
 
74
-  * **PLUMgrid VIP on the management network to access the PLUMgrid console:**  The IP address for PLUMgrid console, make sure to select an unassigned IP on the management network.
74
+  * **PLUMgrid VIP on the management network to access the PLUMgrid console:**  The IP address for PLUMgrid console. Make sure to select an unassigned IP on the management network.
75 75
 
76
-  * **Enter the PLUMgrid Fabric Network:** Enter the network that will be used by PLUMgrid Fabric.
76
+  * **Enter the PLUMgrid Fabric Network:** Enter the network that will be used by PLUMgrid Fabric (without subnet mask).
77 77
 
78
-  * **Repository for PLUMgrid packages:** Enter IP address of a repo hosting PLUMgrid packages such as LCM.
78
+  * **Repository for PLUMgrid packages:** Enter IP address of a repo hosting PLUMgrid packages, for example the LCM.
79 79
 
80 80
   * **Enter the zone name for PLUMgrid LCM:** If using an LCM enter the zone name specified during its configuration.
81 81
 
82
-  * **Enter the license for PLUMgrid:** Enter the PLUMgrid license string provided by PLUMgrid support.
82
+  * **Enter the license for PLUMgrid:** Enter the PLUMgrid license string provided by PLUMgrid Support.
83 83
 
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.
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 85
 
86 86
 Deployment Settings
87 87
 -------------------
@@ -106,20 +106,20 @@ Deployment Settings
106 106
    .. image:: images/add_controllers.png
107 107
        :width: 80%
108 108
 
109
-#. As described in the Requirements section, configure interfaces on nodes as shown in figure below:
109
+#. As described in the Requirements section, configure interfaces on nodes as shown in figure below by clicking on the gear icon:
110 110
 
111 111
    .. image:: images/network_config.png
112 112
        :width: 80%
113 113
 
114
-#. Navigate to Networks tab and set the appropiate Network Settings for the Public, Storage and Management Networks. Click Verify Networks to verify correct configuration.
114
+#. Navigate to Networks tab and set the appropriate Network Settings for the Public, Storage and Management Networks. Click Verify Networks to verify correct configuration.
115 115
 
116 116
    .. image:: images/verify_network.png
117 117
        :width: 80%
118 118
 
119 119
 
120
-#. Press **Deploy changes** to `deploy the environment <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#deploy-changes>`_.
120
+#. Press **Deploy changes** in the Dashboard tab to `deploy the environment <https://docs.mirantis.com/openstack/fuel/fuel-7.0/user-guide.html#deploy-changes>`_.
121 121
 
122
-#. After a succesful deployment. The PLUMgrid UI will be accessible on 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.
123 123
    ::
124 124
       https://<PG-VIP>
125 125
 
@@ -133,6 +133,6 @@ Deployment Settings
133 133
       neutron net-create net1
134 134
       neutron router-create router1
135 135
 
136
-   The newly created network and router should be visible in Horizon and the PLUMgrid UI
136
+   The newly created network and router should be visible in Horizon and the PLUMgrid UI.
137 137
 
138 138
 #. For further details on usability & features, and to obtain official documentation, contact PLUMgrid at info@plumgrid.com.

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

@@ -18,9 +18,9 @@ Given below are some commonly used terms across this document:
18 18
 +--------------------+-------------------------------------------------------------------+
19 19
 | Virtual Domain     | A Virtual Domain is a logical data center. It can be created on   |
20 20
 |                    | demand to provide all the networking services (e.g. Routers,      |
21
-|                    | Switches, IPAM, DHCP, NAT, etc.) necessary to build a vitrual     |
22
-|                    | network for a tenant in OpenStack. Typically, each OpenStack      |
23
-|                    | tenant will map to a unique Virtual Domain in the PLUMgrid.       |
21
+|                    | Switches, IPAM, DHCP, NAT, etc.) necessary to build a virtual     |
22
+|                    | network for a project in OpenStack. Typically, each OpenStack     |
23
+|                    | project will map to a unique Virtual Domain in the PLUMgrid.      |
24 24
 +--------------------+-------------------------------------------------------------------+
25 25
 | Zone               | Represents the physical deployment of PLUMgrid ONS. A Zone is     |
26 26
 |                    | primarily a collection of Edges & Gateways that are dependent on  |
@@ -65,7 +65,7 @@ suite lets users create private Virtual Domains to provide isolation, security,
65 65
 
66 66
 PLUMgrid ONS features:
67 67
 
68
-*   Performance: Up to 40 Gbps per server; hardwarde Offload; terbytes of aggregate performance.
68
+*   Performance: Up to 40 Gbps per server; hardware offload; terabytes of aggregate performance.
69 69
 
70 70
 *   Scalable: across virtual domains, workloads and multiple racks, geographies.
71 71
 
@@ -73,7 +73,7 @@ PLUMgrid ONS features:
73 73
 
74 74
 *   Secure: end-to-end encryption within Virtual Domains and isolation across tenants.
75 75
 
76
-*   Operational tools: includes a comprehensive suite of powerful networking monitoring and troubleshooting tools.
76
+*   Operational tools: includes a comprehensive suite of powerful networking, monitoring and troubleshooting tools.
77 77
 
78 78
 Licensing information
79 79
 ---------------------

+ 5
- 6
doc/plugin_guide/source/requirements.rst View File

@@ -1,8 +1,7 @@
1 1
 Requirements
2 2
 ============
3 3
 
4
-In addition to the requirements set by a Mirantis 7.0 Installation. The PLUMgrid plugin also has the following requirements
5
-for software and hardware:
4
+In addition to the requirements set by a Mirantis 7.0 Installation. The PLUMgrid plugin also has the following software and hardware requirements:
6 5
 
7 6
 Network Requirements
8 7
 --------------------
@@ -11,14 +10,14 @@ Nodes within the PLUMgrid Zone are connected using the following two networks:
11 10
 
12 11
 #. **Management:** This network is mapped onto the Management network (br-mgmt) deployed within a Mirantis OpenStack Environment.
13 12
 
14
-#. **Fabric:** This network is mapped directly onto the untagged interface deployed within the Mirantis OpenStack Environment. The fabric network **cannot be bridged or tagged**, it is automatically created by the Fuel PLUMgrid plugin on the interface being used by br-mgmt. The network cidr is specified through the Fuel UI, as explained later. MTU for the entire fabric network is set to 1580 (this is the minimum value for PLUMgrid to work correctly, it will also function for higher values).
13
+#. **Fabric:** This network is mapped directly onto the untagged interface deployed within the Mirantis OpenStack Environment. The fabric network **cannot be bridged or tagged**, it is automatically created by the Fuel PLUMgrid plugin on the interface being used by br-mgmt. The network cidr is specified through the Fuel UI, as explained later. MTU for the fabric network is set to 1580 (this is the minimum value for PLUMgrid to work correctly, it will also function for higher values).
15 14
 
16 15
 Node Interface Requirements
17 16
 +++++++++++++++++++++++++++
18 17
 
19
-Physical servers with two network interfaces are used as Controllers, Computes and Gateways. A PLUMgrid-Gateway node must also have an additional 1-2 interfaces for external connectivity (these are specified in the PLUMgrid Settings given in the install section). The interfaces configuration is the following:
18
+Physical servers with two network interfaces are used as Controllers, Computes and A PLUMgrid-Gateways. A PLUMgrid-Gateway node must also have an additional 1-2 interfaces for external connectivity (these are specified in the PLUMgrid Settings given in the install section). The interfaces configuration is the following:
20 19
 
21
-* First interface is used for PXE network
20
+* First interface is used for PXE network.
22 21
 * Second interface is used for Public, Management and Storage networks using tagged VLANs. The PLUMgrid fabric network is also created here automatically.
23 22
 
24 23
   .. image:: images/network_config.png
@@ -28,7 +27,7 @@ Physical servers with two network interfaces are used as Controllers, Computes a
28 27
 PLUMgrid Repository
29 28
 -------------------
30 29
 
31
-Access to a url hosting PLUMgrid packages is required before deployment. A common way to obtain this is to use a LCM image and create the LCM VM, which will host the needed packages. This VM then becomes the source repo for installing and upgrading PLUMgrid. The VM can typically be created on the Infrastructure Server hosting the Fuel VM. It needs to be provided with management and fabric connectivity. Contact PLUMgrid to obtain an LCM image with pre-baked PLUMgrid packages and a license [info@plumgrid.com]
30
+Access to a url hosting PLUMgrid packages is required before deployment. A common way to obtain this is to use a LCM image to create the LCM VM, which will host the required packages. This VM then becomes the source repo for installing and upgrading PLUMgrid. The VM can typically be created on the Infrastructure Server hosting the Fuel VM. It needs to be provided with management and fabric connectivity. Contact PLUMgrid to obtain an LCM image with pre-baked PLUMgrid packages and a license [info@plumgrid.com].
32 31
 
33 32
 Node Requirements
34 33
 -----------------

+ 21
- 0
doc/plugin_guide/source/troubleshooting.rst View File

@@ -0,0 +1,21 @@
1
+Troubleshootig
2
+==============
3
+
4
+
5
+#. When PLUMgrid tasks fail during deployment.
6
+
7
+   **Solution**
8
+
9
+   Determine what node it failed on from the Fuel Astute Logs. Login to that node (SSH through the Fuel Master node),
10
+   and check the logs under /var/log/plumgrid .
11
+
12
+#. A node is not visible in the PLUMgrid UI, Zone View > Zone Inventory.
13
+
14
+   **Solution**
15
+
16
+   Login to that node (SSH through the Fuel Master node) and check PLUMgrid services. Start if stopped:
17
+   ::
18
+
19
+      service plumgrid status
20
+      service plumgrid start
21
+

Loading…
Cancel
Save