Skip to content

Commit 1201d62

Browse files
spark404spark404
committed
CLOUDSTACK-862 Updated documentation with the new features available in
the Nicira NVP plugin.
1 parent 623a26e commit 1201d62

21 files changed

Lines changed: 516 additions & 94 deletions

‎docs/en-US/CloudStack_Nicira_NVP_Guide.xml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@
4848
</bookinfo>
4949
<xi:include href="plugin-niciranvp-about.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
5050
<xi:include href="plugin-niciranvp-usage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
51+
<xi:include href="plugin-niciranvp-vpc.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
5152
<xi:include href="plugin-niciranvp-troubleshooting.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
5253
<xi:include href="plugin-niciranvp-revisions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
5354
</book>

‎docs/en-US/images/nvp-add-controller.png‎

35.1 KB
Loading

‎docs/en-US/images/nvp-enable-provider.png‎

31.4 KB
Loading

‎docs/en-US/images/nvp-network-offering.png‎

102 KB
Loading

‎docs/en-US/images/nvp-physical-network-stt.png‎

26.7 KB
Loading

‎docs/en-US/images/nvp-vpc-offering-edit.png‎

28.6 KB
Loading

‎docs/en-US/plugin-niciranvp-about.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
2+
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
33
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
44
%BOOK_ENTITIES;
55
<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod">

‎docs/en-US/plugin-niciranvp-devicemanagement.xml‎

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -21,27 +21,15 @@
2121
under the License.
2222
-->
2323
<section id="Device-management">
24-
<title>Device-management</title>
25-
<para>In &PRODUCT; 4.0.x each Nicira NVP setup is considered a "device" that can be added and removed from a physical network. To complete the configuration of the Nicira NVP plugin a device needs to be added to the physical network using the "addNiciraNVPDevice" API call. The plugin is now enabled on the physical network and any guest networks created on that network will be provisioned using the Nicira NVP Controller.</para>
26-
<para>The plugin introduces a set of new API calls to manage the devices, see below or refer to the API reference.</para>
27-
<itemizedlist>
28-
<listitem><para>addNiciraNvpDevice</para></listitem>
29-
<listitem>
30-
<itemizedlist>
31-
<listitem><para>physicalnetworkid: the UUID of the physical network on which the device is configured</para></listitem>
32-
<listitem><para>hostname: the IP address of the NVP controller</para></listitem>
33-
<listitem><para>username: the username for access to the NVP API</para></listitem>
34-
<listitem><para>password: the password for access to the NVP API</para></listitem>
35-
<listitem><para>transportzoneuuid: the UUID of the transportzone</para></listitem>
36-
</itemizedlist>
37-
</listitem>
38-
<listitem><para>deleteNiciraNVPDevice</para></listitem>
39-
<listitem>
40-
<itemizedlist>
41-
<listitem><para>nvpdeviceid: the UUID of the device</para></listitem>
42-
</itemizedlist>
43-
</listitem>
44-
<listitem><para>listNiciraNVPDevices</para></listitem>
45-
</itemizedlist>
24+
<title>Device Management</title>
25+
<para>In &PRODUCT; a Nicira NVP setup is considered a "device" that can be added and removed from a physical network. To complete the configuration of the Nicira NVP plugin a device needs to be added to the physical network. Press the "Add NVP Controller" button on the provider panel and enter the configuration details.</para>
26+
<mediaobject>
27+
<imageobject>
28+
<imagedata fileref="./images/nvp-add-controller.png" />
29+
</imageobject>
30+
<textobject>
31+
<phrase>nvp-physical-network-stt.png: a screenshot of the device configuration popup.</phrase>
32+
</textobject>
33+
</mediaobject>
4634

4735
</section>

‎docs/en-US/plugin-niciranvp-features.xml‎

Lines changed: 59 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,63 @@
2222
-->
2323
<section id="Features-of-the-Nicira-NVP-Plugin">
2424
<title>Features of the Nicira NVP Plugin</title>
25-
<para>In &PRODUCT; release 4.0.0-incubating this plugin supports the Connectivity service. This service is responsible for creating Layer 2 networks supporting the networks created by Guests. In other words when an tenant creates a new network, instead of the traditional VLAN a logical network will be created by sending the appropriate calls to the Nicira NVP Controller.</para>
26-
<para>The plugin has been tested with Nicira NVP versions 2.1.0, 2.2.0 and 2.2.1</para>
27-
<note><para>In &PRODUCT; 4.0.0-incubating only the XenServer hypervisor is supported for use in
28-
combination with Nicira NVP.</para>
29-
<para>In &PRODUCT; 4.1.0-incubating both KVM and XenServer hypervisors are
30-
supported.</para></note>
31-
<note><para>In &PRODUCT; 4.0.0-incubating the UI components for this plugin are not complete,
32-
configuration is done by sending commands to the API.</para></note>
25+
<para>The following table lists the CloudStack network services provided by the Nicira NVP Plugin.</para>
26+
<table>
27+
<title>Supported Services</title>
28+
<tgroup cols="3">
29+
<thead>
30+
<row>
31+
<entry>Network Service</entry>
32+
<entry>CloudStack version</entry>
33+
<entry>NVP version</entry>
34+
</row>
35+
</thead>
36+
<tbody>
37+
<row>
38+
<entry>Virtual Networking</entry>
39+
<entry>&gt;= 4.0</entry>
40+
<entry>&gt;= 2.2.1</entry>
41+
</row>
42+
<row>
43+
<entry>Source NAT</entry>
44+
<entry>&gt;= 4.1</entry>
45+
<entry>&gt;= 3.0.1</entry>
46+
</row>
47+
<row>
48+
<entry>Static NAT</entry>
49+
<entry>&gt;= 4.1</entry>
50+
<entry>&gt;= 3.0.1</entry>
51+
</row>
52+
<row>
53+
<entry>Port Forwarding</entry>
54+
<entry>&gt;= 4.1</entry>
55+
<entry>&gt;= 3.0.1</entry>
56+
</row>
57+
</tbody>
58+
</tgroup>
59+
</table>
60+
<note><para>The Virtual Networking service was originally called 'Connectivity' in CloudStack 4.0</para></note>
61+
<para>The following hypervisors are supported by the Nicira NVP Plugin.</para>
62+
<table>
63+
<title>Supported Hypervisors</title>
64+
<tgroup cols="2">
65+
<thead>
66+
<row>
67+
<entry>Hypervisor</entry>
68+
<entry>CloudStack version</entry>
69+
</row>
70+
</thead>
71+
<tbody>
72+
<row>
73+
<entry>XenServer</entry>
74+
<entry>&gt;= 4.0</entry>
75+
</row>
76+
<row>
77+
<entry>KVM</entry>
78+
<entry>&gt;= 4.1</entry>
79+
</row>
80+
</tbody>
81+
</tgroup>
82+
</table>
83+
<note><para>Please refer to the Nicira NVP configuration guide on how to prepare the hypervisors for Nicira NVP integration.</para></note>
3384
</section>

‎docs/en-US/plugin-niciranvp-introduction.xml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,8 @@
2222
-->
2323
<section id="Introduction-to-the-Nicira-NVP-Plugin">
2424
<title>Introduction to the Nicira NVP Plugin</title>
25-
<para>The Nicira NVP plugin allows CloudStack to use the Nicira solution for virtualized network as a provider for CloudStack networks and services.</para>
25+
<para>The Nicira NVP plugin adds Nicira NVP as one of the available SDN implementations in
26+
CloudStack. With the plugin an exisiting Nicira NVP setup can be used by CloudStack to
27+
implement isolated guest networks and to provide additional services like routing and
28+
NAT.</para>
2629
</section>

0 commit comments

Comments
 (0)