You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by hu...@apache.org on 2012/10/03 18:48:30 UTC
[1/2] git commit: Extended the documentation
Updated Branches:
refs/heads/master 18a09c966 -> e125cd3bb
Extended the documentation
Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/e125cd3b
Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/e125cd3b
Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/e125cd3b
Branch: refs/heads/master
Commit: e125cd3bb470575776a1ce7720a23e75de574670
Parents: 11cdd6e
Author: Hugo Trippaers <ht...@schubergphilis.com>
Authored: Wed Oct 3 09:35:58 2012 -0700
Committer: Hugo Trippaers <ht...@schubergphilis.com>
Committed: Wed Oct 3 09:48:10 2012 -0700
----------------------------------------------------------------------
docs/en-US/cloudstack_plugin_niciranvp.xml | 2 +-
docs/en-US/plugin-niciranvp-devicemanagement.xml | 47 +++++++++++++++
docs/en-US/plugin-niciranvp-features.xml | 3 +
docs/en-US/plugin-niciranvp-preparations.xml | 36 ++++++++++++
docs/en-US/plugin-niciranvp-provider.xml | 42 ++++++++++++++
docs/en-US/plugin-niciranvp-revisions.xml | 45 +++++++++++++++
docs/en-US/plugin-niciranvp-tables.xml | 51 +++++++++++++++++
docs/en-US/plugin-niciranvp-troubleshooting.xml | 3 +-
docs/en-US/plugin-niciranvp-usage.xml | 3 +-
docs/en-US/plugin-niciranvp-uuidreferences.xml | 30 ++++++++++
10 files changed, 257 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e125cd3b/docs/en-US/cloudstack_plugin_niciranvp.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/cloudstack_plugin_niciranvp.xml b/docs/en-US/cloudstack_plugin_niciranvp.xml
index 55c7ad7..c535c7c 100644
--- a/docs/en-US/cloudstack_plugin_niciranvp.xml
+++ b/docs/en-US/cloudstack_plugin_niciranvp.xml
@@ -49,6 +49,6 @@
<xi:include href="plugin-niciranvp-about.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="plugin-niciranvp-usage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="plugin-niciranvp-troubleshooting.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="plugin-niciranvp-revisions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e125cd3b/docs/en-US/plugin-niciranvp-devicemanagement.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/plugin-niciranvp-devicemanagement.xml b/docs/en-US/plugin-niciranvp-devicemanagement.xml
new file mode 100644
index 0000000..2423ce3
--- /dev/null
+++ b/docs/en-US/plugin-niciranvp-devicemanagement.xml
@@ -0,0 +1,47 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod">
+%xinclude;
+]>
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0.
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="Device-management">
+ <title>Device-management</title>
+ <para>In CloudStack 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 Nicra NVP Controller.</para>
+ <para>The plugin introduces a set of new API calls to manage the devices, see below or refer to the API reference.</para>
+ <itemizedlist>
+ <listitem><para>addNiciraNvpDevice</para></listitem>
+ <listitem>
+ <itemizedlist>
+ <listitem><para>physicalnetworkid: the UUID of the physical network on which the device is configured</para></listitem>
+ <listitem><para>hostname: the IP address of the NVP controller</para></listitem>
+ <listitem><para>username: the username for access to the NVP API</para></listitem>
+ <listitem><para>password: the password for access to the NVP API</para></listitem>
+ <listitem><para>transportzoneuuid: the UUID of the transportzone</para></listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para>deleteNiciraNVPDevice</para></listitem>
+ <listitem>
+ <itemizedlist>
+ <listitem><para>nvpdeviceid: the UUID of the device</para></listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para>listNiciraNVPDevices</para></listitem>
+ </itemizedlist>
+
+</section>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e125cd3b/docs/en-US/plugin-niciranvp-features.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/plugin-niciranvp-features.xml b/docs/en-US/plugin-niciranvp-features.xml
index b96e2d5..cdcda9e 100644
--- a/docs/en-US/plugin-niciranvp-features.xml
+++ b/docs/en-US/plugin-niciranvp-features.xml
@@ -23,4 +23,7 @@
<section id="Features-of-the-Nicira-NVP-Plugin">
<title>Features of the Nicira NVP Plugin</title>
<para>In CloudStack release 4.0.x 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 tennant 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>
+ <para>The plugin has been tested with Nicira NVP versions 2.1.0, 2.2.0 and 2.2.1</para>
+ <note><para>In CloudStack 4.0.x only the XenServer hypervisor is supported for use in combination with Nicira NVP</para></note>
+ <note><para>In CloudStack 4.0.x the UI components for this plugin are not complete, configuration is done by sending commands to the API</para></note>
</section>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e125cd3b/docs/en-US/plugin-niciranvp-preparations.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/plugin-niciranvp-preparations.xml b/docs/en-US/plugin-niciranvp-preparations.xml
new file mode 100644
index 0000000..95a25bd
--- /dev/null
+++ b/docs/en-US/plugin-niciranvp-preparations.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod">
+%xinclude;
+]>
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0.
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="Prerequisites">
+ <title>Prerequisites</title>
+ <para>Before enabling the Nicira NVP plugin the NVP Controller needs to be configured. Please review the NVP User Guide on how to do that. </para>
+ <para>CloudStack needs to have at least one physical network with the isolation method set to "STT". This network should be enabled for the Guest traffic type.</para>
+ <note><para>The Guest traffic type should be configured with the traffic label that matches the name of the Integration Bridge on XenServer. See the Nicira NVP User Guide for more details on how to set this up in XenServer.</para></note>
+ <para>Make sure you have the following information ready:</para>
+ <itemizedlist>
+ <listitem><para>The IP address of the NVP Controller</para></listitem>
+ <listitem><para>The username to access the API</para></listitem>
+ <listitem><para>The password to access the API</para></listitem>
+ <listitem><para>The UUID of the Transport Zone that contains the hypervisors in this Zone</para></listitem>
+ <listitem><para>The UUID of the Physical Network that will used for the Guest networks</para></listitem>
+ </itemizedlist>
+</section>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e125cd3b/docs/en-US/plugin-niciranvp-provider.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/plugin-niciranvp-provider.xml b/docs/en-US/plugin-niciranvp-provider.xml
new file mode 100644
index 0000000..d81db99
--- /dev/null
+++ b/docs/en-US/plugin-niciranvp-provider.xml
@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod">
+%xinclude;
+]>
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0.
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="Enabling-the-service-provider">
+ <title>Enabling the service provider</title>
+ <para>To allow CloudStack to use the Nicira NVP Plugin the network service provider needs to be enabled on the physical network. The following sequence of API calls will enable the network service provider</para>
+ <itemizedlist>
+ <listitem><para>addNetworkServiceProvider</para></listitem>
+ <listitem>
+ <itemizedlist>
+ <listitem><para>name = "NiciraNVP"</para></listitem>
+ <listitem><para>physicalnetworkid = <the uuid of the physical network></para></listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para>updateNetworkServiceProvider</para></listitem>
+ <listitem>
+ <itemizedlist>
+ <listitem><para>id = <the provider uuid returned by the previous call></para></listitem>
+ <listitem><para>state = "Enabled"</para></listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+</section>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e125cd3b/docs/en-US/plugin-niciranvp-revisions.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/plugin-niciranvp-revisions.xml b/docs/en-US/plugin-niciranvp-revisions.xml
new file mode 100644
index 0000000..6e455ca
--- /dev/null
+++ b/docs/en-US/plugin-niciranvp-revisions.xml
@@ -0,0 +1,45 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<appendix id="appe-cloudstack-Revision_History">
+ <title>Revision History</title>
+ <simpara>
+ <revhistory>
+ <revision>
+ <revnumber>0-0</revnumber>
+ <date>Wed Oct 03 2012</date>
+ <author>
+ <firstname>Hugo</firstname>
+ <surname>Trippaers</surname>
+ <email>hugo@apache.org</email>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Documentation created for 4.0.x version of the NVP Plugin</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ </revhistory>
+ </simpara>
+</appendix>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e125cd3b/docs/en-US/plugin-niciranvp-tables.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/plugin-niciranvp-tables.xml b/docs/en-US/plugin-niciranvp-tables.xml
new file mode 100644
index 0000000..4f81655
--- /dev/null
+++ b/docs/en-US/plugin-niciranvp-tables.xml
@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod">
+%xinclude;
+]>
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0.
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="Database-tables">
+ <title>Database tables</title>
+ <para>The following tables are added to the cloud database for the Nicira NVP Plugin</para>
+ <itemizedlist>
+ <listitem><para>nicira_nvp_nic_map, contains a mapping from nic to logical switch port</para></listitem>
+ <listitem>
+ <itemizedlist>
+ <listitem><para>id</para></listitem>
+ <listitem><para>logicalswitch, uuid of the logical switch this port is connected to</para></listitem>
+ <listitem><para>logicalswitchport, uuid of the logical switch port for this nic</para></listitem>
+ <listitem><para>nic, the CloudStack uuid for this nic, reference to the nics table</para></listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+ <itemizedlist>
+ <listitem><para>external_nicira_nvp_devices, contains all configured devices</para></listitem>
+ <listitem>
+ <itemizedlist>
+ <listitem><para>id</para></listitem>
+ <listitem><para>uuid</para></listitem>
+ <listitem><para>physical_network_id, the physical network this device is configured on</para></listitem>
+ <listitem><para>provider_name, set to "NiciraNvp"</para></listitem>
+ <listitem><para>device_name, display name for this device</para></listitem>
+ <listitem><para>host_id, reference to the host table with the device configuration</para></listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+
+</section>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e125cd3b/docs/en-US/plugin-niciranvp-troubleshooting.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/plugin-niciranvp-troubleshooting.xml b/docs/en-US/plugin-niciranvp-troubleshooting.xml
index 6c78beb..0e86e5d 100644
--- a/docs/en-US/plugin-niciranvp-troubleshooting.xml
+++ b/docs/en-US/plugin-niciranvp-troubleshooting.xml
@@ -22,8 +22,7 @@
-->
<chapter id="Troubleshooting-the-Nicira-NVP-Plugin">
<title>Troubleshooting the Nicira NVP Plugin</title>
- <!--
+
<xi:include href="plugin-niciranvp-uuidreferences.xml"></xi:include>
<xi:include href="plugin-niciranvp-tables.xml"></xi:include>
- -->
</chapter>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e125cd3b/docs/en-US/plugin-niciranvp-usage.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/plugin-niciranvp-usage.xml b/docs/en-US/plugin-niciranvp-usage.xml
index 4164cee..041e10e 100644
--- a/docs/en-US/plugin-niciranvp-usage.xml
+++ b/docs/en-US/plugin-niciranvp-usage.xml
@@ -22,9 +22,8 @@
-->
<chapter id="Using-the-Nicira-NVP-Plugin">
<title>Using the Nicira NVP Plugin</title>
- <!--
+
<xi:include href="plugin-niciranvp-preparations.xml"></xi:include>
<xi:include href="plugin-niciranvp-provider.xml"></xi:include>
<xi:include href="plugin-niciranvp-devicemanagement.xml"></xi:include>
- -->
</chapter>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/e125cd3b/docs/en-US/plugin-niciranvp-uuidreferences.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/plugin-niciranvp-uuidreferences.xml b/docs/en-US/plugin-niciranvp-uuidreferences.xml
new file mode 100644
index 0000000..c912971
--- /dev/null
+++ b/docs/en-US/plugin-niciranvp-uuidreferences.xml
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod">
+%xinclude;
+]>
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0.
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<section id="UUID-references">
+ <title>UUID References</title>
+ <para>The plugin maintains several references in the CloudStack database to items created on the NVP Controller.</para>
+ <para>Every guest network this is created will have its broadcast type set to Lswitch and if the network is in state "Implemented", the broadcast URI will have the UUID of the Logical Switch that was created for this network on the NVP Controller.</para>
+ <para>The Nics that are connected to one of the Logical Switches will have their Logical Switch Port UUID listed in the nicira_nvp_nic_map table</para>
+ <note><para>All devices created on the NVP Controller will have a tag set to domain-account of the owner of the network, this string can be used to search for items in the NVP Controller.</para></note>
+
+</section>
\ No newline at end of file