Updated Branches: refs/heads/master 623a26e46 -> 1201d623a
CLOUDSTACK-862 Updated documentation with the new features available in the Nicira NVP plugin. Project: http://git-wip-us.apache.org/repos/asf/cloudstack/repo Commit: http://git-wip-us.apache.org/repos/asf/cloudstack/commit/1201d623 Tree: http://git-wip-us.apache.org/repos/asf/cloudstack/tree/1201d623 Diff: http://git-wip-us.apache.org/repos/asf/cloudstack/diff/1201d623 Branch: refs/heads/master Commit: 1201d623a7091517a1e26bc4b82c5daeea3c155f Parents: 623a26e Author: Hugo Trippaers <[email protected]> Authored: Thu May 23 16:58:12 2013 +0200 Committer: Hugo Trippaers <[email protected]> Committed: Thu May 23 22:48:40 2013 +0200 ---------------------------------------------------------------------- docs/en-US/CloudStack_Nicira_NVP_Guide.xml | 1 + docs/en-US/images/nvp-add-controller.png | Bin 0 -> 35928 bytes docs/en-US/images/nvp-enable-provider.png | Bin 0 -> 32158 bytes docs/en-US/images/nvp-network-offering.png | Bin 0 -> 104060 bytes docs/en-US/images/nvp-physical-network-stt.png | Bin 0 -> 27317 bytes docs/en-US/images/nvp-vpc-offering-edit.png | Bin 0 -> 29279 bytes docs/en-US/plugin-niciranvp-about.xml | 2 +- docs/en-US/plugin-niciranvp-devicemanagement.xml | 32 +--- docs/en-US/plugin-niciranvp-features.xml | 67 +++++++- docs/en-US/plugin-niciranvp-guide.xml | 31 ---- docs/en-US/plugin-niciranvp-introduction.xml | 5 +- docs/en-US/plugin-niciranvp-networkofferings.xml | 131 +++++++++++++++ docs/en-US/plugin-niciranvp-physicalnet.xml | 37 ++++ docs/en-US/plugin-niciranvp-preparations.xml | 11 +- docs/en-US/plugin-niciranvp-provider.xml | 28 ++-- docs/en-US/plugin-niciranvp-revisions.xml | 14 ++ docs/en-US/plugin-niciranvp-tables.xml | 105 +++++++++--- docs/en-US/plugin-niciranvp-usage.xml | 11 +- docs/en-US/plugin-niciranvp-vpc.xml | 30 ++++ docs/en-US/plugin-niciranvp-vpcfeatures.xml | 28 +++ docs/en-US/plugin-niciranvp-vpcnetworkoffering.xml | 81 +++++++++ docs/en-US/plugin-niciranvp-vpcoffering.xml | 38 ++++ 22 files changed, 537 insertions(+), 115 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/cloudstack/blob/1201d623/docs/en-US/CloudStack_Nicira_NVP_Guide.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/CloudStack_Nicira_NVP_Guide.xml b/docs/en-US/CloudStack_Nicira_NVP_Guide.xml index 7f156d5..5431fc1 100644 --- a/docs/en-US/CloudStack_Nicira_NVP_Guide.xml +++ b/docs/en-US/CloudStack_Nicira_NVP_Guide.xml @@ -48,6 +48,7 @@ </bookinfo> <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-vpc.xml" xmlns:xi="http://www.w3.org/2001/XInclude";></xi:include> <xi:include href="plugin-niciranvp-troubleshooting.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/cloudstack/blob/1201d623/docs/en-US/images/nvp-add-controller.png ---------------------------------------------------------------------- diff --git a/docs/en-US/images/nvp-add-controller.png b/docs/en-US/images/nvp-add-controller.png new file mode 100644 index 0000000..e02d31f Binary files /dev/null and b/docs/en-US/images/nvp-add-controller.png differ http://git-wip-us.apache.org/repos/asf/cloudstack/blob/1201d623/docs/en-US/images/nvp-enable-provider.png ---------------------------------------------------------------------- diff --git a/docs/en-US/images/nvp-enable-provider.png b/docs/en-US/images/nvp-enable-provider.png new file mode 100644 index 0000000..0f2d02d Binary files /dev/null and b/docs/en-US/images/nvp-enable-provider.png differ http://git-wip-us.apache.org/repos/asf/cloudstack/blob/1201d623/docs/en-US/images/nvp-network-offering.png ---------------------------------------------------------------------- diff --git a/docs/en-US/images/nvp-network-offering.png b/docs/en-US/images/nvp-network-offering.png new file mode 100644 index 0000000..c2d25c4 Binary files /dev/null and b/docs/en-US/images/nvp-network-offering.png differ http://git-wip-us.apache.org/repos/asf/cloudstack/blob/1201d623/docs/en-US/images/nvp-physical-network-stt.png ---------------------------------------------------------------------- diff --git a/docs/en-US/images/nvp-physical-network-stt.png b/docs/en-US/images/nvp-physical-network-stt.png new file mode 100644 index 0000000..2ce7853 Binary files /dev/null and b/docs/en-US/images/nvp-physical-network-stt.png differ http://git-wip-us.apache.org/repos/asf/cloudstack/blob/1201d623/docs/en-US/images/nvp-vpc-offering-edit.png ---------------------------------------------------------------------- diff --git a/docs/en-US/images/nvp-vpc-offering-edit.png b/docs/en-US/images/nvp-vpc-offering-edit.png new file mode 100644 index 0000000..ff235e2 Binary files /dev/null and b/docs/en-US/images/nvp-vpc-offering-edit.png differ http://git-wip-us.apache.org/repos/asf/cloudstack/blob/1201d623/docs/en-US/plugin-niciranvp-about.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/plugin-niciranvp-about.xml b/docs/en-US/plugin-niciranvp-about.xml index 8d2e20e..cfab83c 100644 --- a/docs/en-US/plugin-niciranvp-about.xml +++ b/docs/en-US/plugin-niciranvp-about.xml @@ -1,5 +1,5 @@ <?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"; [ +<!DOCTYPE chapter 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";> http://git-wip-us.apache.org/repos/asf/cloudstack/blob/1201d623/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 index 57b8eee..761c39f 100644 --- a/docs/en-US/plugin-niciranvp-devicemanagement.xml +++ b/docs/en-US/plugin-niciranvp-devicemanagement.xml @@ -21,27 +21,15 @@ under the License. --> <section id="Device-management"> - <title>Device-management</title> - <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> - <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> + <title>Device Management</title> + <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> + <mediaobject> + <imageobject> + <imagedata fileref="./images/nvp-add-controller.png" /> + </imageobject> + <textobject> + <phrase>nvp-physical-network-stt.png: a screenshot of the device configuration popup.</phrase> + </textobject> + </mediaobject> </section> http://git-wip-us.apache.org/repos/asf/cloudstack/blob/1201d623/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 c346bfb..e439f1b 100644 --- a/docs/en-US/plugin-niciranvp-features.xml +++ b/docs/en-US/plugin-niciranvp-features.xml @@ -22,12 +22,63 @@ --> <section id="Features-of-the-Nicira-NVP-Plugin"> <title>Features of the Nicira NVP Plugin</title> - <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> - <para>The plugin has been tested with Nicira NVP versions 2.1.0, 2.2.0 and 2.2.1</para> - <note><para>In &PRODUCT; 4.0.0-incubating only the XenServer hypervisor is supported for use in - combination with Nicira NVP.</para> - <para>In &PRODUCT; 4.1.0-incubating both KVM and XenServer hypervisors are - supported.</para></note> - <note><para>In &PRODUCT; 4.0.0-incubating the UI components for this plugin are not complete, - configuration is done by sending commands to the API.</para></note> + <para>The following table lists the CloudStack network services provided by the Nicira NVP Plugin.</para> + <table> + <title>Supported Services</title> + <tgroup cols="3"> + <thead> + <row> + <entry>Network Service</entry> + <entry>CloudStack version</entry> + <entry>NVP version</entry> + </row> + </thead> + <tbody> + <row> + <entry>Virtual Networking</entry> + <entry>>= 4.0</entry> + <entry>>= 2.2.1</entry> + </row> + <row> + <entry>Source NAT</entry> + <entry>>= 4.1</entry> + <entry>>= 3.0.1</entry> + </row> + <row> + <entry>Static NAT</entry> + <entry>>= 4.1</entry> + <entry>>= 3.0.1</entry> + </row> + <row> + <entry>Port Forwarding</entry> + <entry>>= 4.1</entry> + <entry>>= 3.0.1</entry> + </row> + </tbody> + </tgroup> + </table> + <note><para>The Virtual Networking service was originally called 'Connectivity' in CloudStack 4.0</para></note> + <para>The following hypervisors are supported by the Nicira NVP Plugin.</para> + <table> + <title>Supported Hypervisors</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Hypervisor</entry> + <entry>CloudStack version</entry> + </row> + </thead> + <tbody> + <row> + <entry>XenServer</entry> + <entry>>= 4.0</entry> + </row> + <row> + <entry>KVM</entry> + <entry>>= 4.1</entry> + </row> + </tbody> + </tgroup> + </table> + <note><para>Please refer to the Nicira NVP configuration guide on how to prepare the hypervisors for Nicira NVP integration.</para></note> </section> http://git-wip-us.apache.org/repos/asf/cloudstack/blob/1201d623/docs/en-US/plugin-niciranvp-guide.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/plugin-niciranvp-guide.xml b/docs/en-US/plugin-niciranvp-guide.xml deleted file mode 100644 index 89c9871..0000000 --- a/docs/en-US/plugin-niciranvp-guide.xml +++ /dev/null @@ -1,31 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE chapter 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. ---> -<chapter id="niciranvp-plugin-guide"> - <title>Plugin Guide for the Nicira NVP Plugin</title> - <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"; /> -</chapter> http://git-wip-us.apache.org/repos/asf/cloudstack/blob/1201d623/docs/en-US/plugin-niciranvp-introduction.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/plugin-niciranvp-introduction.xml b/docs/en-US/plugin-niciranvp-introduction.xml index 9c1d42d..a06f123 100644 --- a/docs/en-US/plugin-niciranvp-introduction.xml +++ b/docs/en-US/plugin-niciranvp-introduction.xml @@ -22,5 +22,8 @@ --> <section id="Introduction-to-the-Nicira-NVP-Plugin"> <title>Introduction to the Nicira NVP Plugin</title> - <para>The Nicira NVP plugin allows CloudStack to use the Nicira solution for virtualized network as a provider for CloudStack networks and services.</para> + <para>The Nicira NVP plugin adds Nicira NVP as one of the available SDN implementations in + CloudStack. With the plugin an exisiting Nicira NVP setup can be used by CloudStack to + implement isolated guest networks and to provide additional services like routing and + NAT.</para> </section> http://git-wip-us.apache.org/repos/asf/cloudstack/blob/1201d623/docs/en-US/plugin-niciranvp-networkofferings.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/plugin-niciranvp-networkofferings.xml b/docs/en-US/plugin-niciranvp-networkofferings.xml new file mode 100644 index 0000000..b30437e --- /dev/null +++ b/docs/en-US/plugin-niciranvp-networkofferings.xml @@ -0,0 +1,131 @@ +<?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="network-offerings"> + <title>Network Offerings</title> + <para>Using the Nicira NVP plugin requires a network offering with Virtual Networking enabled and configured to use the NiciraNvp element. Typical use cases combine services from the Virtual Router appliance and the Nicira NVP plugin.</para> + <table> + <title>Isolated network offering with regular services from the Virtual Router.</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Service</entry> + <entry>Provider</entry> + </row> + </thead> + <tbody> + <row> + <entry>VPN</entry> + <entry>VirtualRouter</entry> + </row> + <row> + <entry>DHCP</entry> + <entry>VirtualRouter</entry> + </row> + <row> + <entry>DNS</entry> + <entry>VirtualRouter</entry> + </row> + <row> + <entry>Firewall</entry> + <entry>VirtualRouter</entry> + </row> + <row> + <entry>Load Balancer</entry> + <entry>VirtualRouter</entry> + </row> + <row> + <entry>User Data</entry> + <entry>VirtualRouter</entry> + </row> + <row> + <entry>Source NAT</entry> + <entry>VirtualRouter</entry> + </row> + <row> + <entry>Static NAT</entry> + <entry>VirtualRouter</entry> + </row> + <row> + <entry>Post Forwarding</entry> + <entry>VirtualRouter</entry> + </row> + <row> + <entry>Virtual Networking</entry> + <entry>NiciraNVP</entry> + </row> + </tbody> + </tgroup> + </table> + <mediaobject> + <imageobject> + <imagedata fileref="./images/nvp-network-offering.png" /> + </imageobject> + <textobject> + <phrase>nvp-physical-network-stt.png: a screenshot of a network offering.</phrase> + </textobject> + </mediaobject> + <note><para>The tag in the network offering should be set to the name of the physical network with the NVP provider.</para></note> + <para>Isolated network with network services. The virtual router is still required to provide network services like dns and dhcp.</para> + <table> + <title>Isolated network offering with network services</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Service</entry> + <entry>Provider</entry> + </row> + </thead> + <tbody> + <row> + <entry>DHCP</entry> + <entry>VirtualRouter</entry> + </row> + <row> + <entry>DNS</entry> + <entry>VirtualRouter</entry> + </row> + <row> + <entry>User Data</entry> + <entry>VirtualRouter</entry> + </row> + <row> + <entry>Source NAT</entry> + <entry>NiciraNVP</entry> + </row> + <row> + <entry>Static NAT</entry> + <entry>NiciraNVP</entry> + </row> + <row> + <entry>Post Forwarding</entry> + <entry>NiciraNVP</entry> + </row> + <row> + <entry>Virtual Networking</entry> + <entry>NiciraNVP</entry> + </row> + </tbody> + </tgroup> + </table> + +</section> http://git-wip-us.apache.org/repos/asf/cloudstack/blob/1201d623/docs/en-US/plugin-niciranvp-physicalnet.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/plugin-niciranvp-physicalnet.xml b/docs/en-US/plugin-niciranvp-physicalnet.xml new file mode 100644 index 0000000..d320290 --- /dev/null +++ b/docs/en-US/plugin-niciranvp-physicalnet.xml @@ -0,0 +1,37 @@ +<?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="zone-configuration"> + <title>Zone Configuration</title> + <para>&PRODUCT; 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 the hypervisor. See the Nicira NVP User Guide for more details + on how to set this up in XenServer or KVM.</para></note> + <mediaobject> + <imageobject> + <imagedata fileref="./images/nvp-physical-network-stt.png" /> + </imageobject> + <textobject> + <phrase>nvp-physical-network-stt.png: a screenshot of a physical network with the STT isolation type</phrase> + </textobject> + </mediaobject> + </section> http://git-wip-us.apache.org/repos/asf/cloudstack/blob/1201d623/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 index 762c941..6072559 100644 --- a/docs/en-US/plugin-niciranvp-preparations.xml +++ b/docs/en-US/plugin-niciranvp-preparations.xml @@ -22,17 +22,16 @@ --> <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>&PRODUCT; 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 the hypervisor. See the Nicira NVP User Guide for more details - on how to set this up in XenServer or KVM.</para></note> + <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>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 be used for the Guest networks</para></listitem> + <listitem> + <para>The UUID of the Gateway Service used to provide router and NAT services.</para> + </listitem> </itemizedlist> + <note><para>The gateway service uuid is optional and is used for Layer 3 services only (SourceNat, StaticNat and PortForwarding)</para></note> </section> http://git-wip-us.apache.org/repos/asf/cloudstack/blob/1201d623/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 index 80fb227..8694478 100644 --- a/docs/en-US/plugin-niciranvp-provider.xml +++ b/docs/en-US/plugin-niciranvp-provider.xml @@ -22,21 +22,15 @@ --> <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> + <para>The Nicira NVP provider is disabled by default. Navigate to the "Network Service Providers" configuration of the physical network with the STT isolation type. Navigate to the Nicira NVP provider and press the "Enable Provider" button.</para> + <note><para>CloudStack 4.0 does not have the UI interface to configure the Nicira NVP plugin. Configuration needs to be done using the API directly.</para></note> + <mediaobject> + <imageobject> + <imagedata fileref="./images/nvp-enable-provider.png" /> + </imageobject> + <textobject> + <phrase>nvp-physical-network-stt.png: a screenshot of an enabled Nicira NVP provider</phrase> + </textobject> + </mediaobject> + </section> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cloudstack/blob/1201d623/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 index b8e6935..b58d333 100644 --- a/docs/en-US/plugin-niciranvp-revisions.xml +++ b/docs/en-US/plugin-niciranvp-revisions.xml @@ -40,6 +40,20 @@ </simplelist> </revdescription> </revision> + <revision> + <revnumber>1-0</revnumber> + <date>Wed May 22 2013</date> + <author> + <firstname>Hugo</firstname> + <surname>Trippaers</surname> + <email>[email protected]</email> + </author> + <revdescription> + <simplelist> + <member>Documentation updated for &PRODUCT; 4.1.0</member> + </simplelist> + </revdescription> + </revision> </revhistory> </simpara> </appendix> http://git-wip-us.apache.org/repos/asf/cloudstack/blob/1201d623/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 index 4f81655..615f349 100644 --- a/docs/en-US/plugin-niciranvp-tables.xml +++ b/docs/en-US/plugin-niciranvp-tables.xml @@ -23,29 +23,84 @@ <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> - + <table> + <title>nicira_nvp_nic_map</title> + <tgroup cols="2"> + <tbody> + <row> + <entry>id</entry> + <entry>auto incrementing id</entry> + </row> + <row> + <entry>logicalswitch</entry> + <entry>uuid of the logical switch this port is connected to</entry> + </row> + <row> + <entry>logicalswitchport</entry> + <entry>uuid of the logical switch port for this nic</entry> + </row> + <row> + <entry>nic</entry> + <entry>the &PRODUCT; uuid for this nic, reference to the nics table</entry> + </row> + </tbody> + </tgroup> + </table> + + <table> + <title>external_nicira_nvp_devices</title> + <tgroup cols="2"> + <tbody> + <row> + <entry>id</entry> + <entry>auto incrementing id</entry> + </row> + <row> + <entry>uuid</entry> + <entry>UUID identifying this device</entry> + </row> + <row> + <entry>physical_network_id</entry> + <entry>the physical network this device is configured on</entry> + </row> + <row> + <entry>provider_name</entry> + <entry>NiciraNVP</entry> + </row> + <row> + <entry>device_name</entry> + <entry>display name for this device</entry> + </row> + <row> + <entry>host_id</entry> + <entry>reference to the host table with the device configuration</entry> + </row> + </tbody> + </tgroup> + </table> + + <table> + <title>nicira_nvp_router_map</title> + <tgroup cols="2"> + <tbody> + <row> + <entry>id</entry> + <entry>auto incrementing id</entry> + </row> + <row> + <entry>logicalrouter_uuid</entry> + <entry>uuid of the logical router</entry> + </row> + <row> + <entry>network_id</entry> + <entry>id of the network this router is linked to</entry> + </row> + </tbody> + </tgroup> + </table> + + <note> + <para>nicira_nvp_router_map is only available in &PRODUCT; 4.1 and above</para> + </note> + </section> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cloudstack/blob/1201d623/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 76f9a0b..9f04c38 100644 --- a/docs/en-US/plugin-niciranvp-usage.xml +++ b/docs/en-US/plugin-niciranvp-usage.xml @@ -21,10 +21,13 @@ under the License. --> <chapter id="Using-the-Nicira-NVP-Plugin" > - <title>Using the Nicira NVP Plugin</title> + <title>Configuring the Nicira NVP Plugin</title> <xi:include href="plugin-niciranvp-preparations.xml" xmlns:xi="http://www.w3.org/2001/XInclude";></xi:include> - <xi:include href="plugin-niciranvp-ui.xml" xmlns:xi="http://www.w3.org/2001/XInclude";></xi:include> - <xi:include href="plugin-niciranvp-provider.xml" xmlns:xi="http://www.w3.org/2001/XInclude";></xi:include> - <xi:include href="plugin-niciranvp-devicemanagement.xml" xmlns:xi="http://www.w3.org/2001/XInclude";></xi:include> + <xi:include href="plugin-niciranvp-physicalnet.xml" xmlns:xi="http://www.w3.org/2001/XInclude";></xi:include> + <xi:include href="plugin-niciranvp-provider.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="plugin-niciranvp-devicemanagement.xml" + xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="plugin-niciranvp-networkofferings.xml" + xmlns:xi="http://www.w3.org/2001/XInclude"/> </chapter> http://git-wip-us.apache.org/repos/asf/cloudstack/blob/1201d623/docs/en-US/plugin-niciranvp-vpc.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/plugin-niciranvp-vpc.xml b/docs/en-US/plugin-niciranvp-vpc.xml new file mode 100644 index 0000000..a43c5fa --- /dev/null +++ b/docs/en-US/plugin-niciranvp-vpc.xml @@ -0,0 +1,30 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE chapter 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. +--> +<chapter id="Using-the-Nicira-NVP-Plugin-With_VPC" > + <title>Using the Nicira NVP plugin with VPC</title> + + <xi:include href="plugin-niciranvp-vpcfeatures.xml" xmlns:xi="http://www.w3.org/2001/XInclude";></xi:include> + <xi:include href="plugin-niciranvp-vpcoffering.xml" xmlns:xi="http://www.w3.org/2001/XInclude";></xi:include> + <xi:include href="plugin-niciranvp-vpcnetworkoffering.xml" xmlns:xi="http://www.w3.org/2001/XInclude";></xi:include> + +</chapter> http://git-wip-us.apache.org/repos/asf/cloudstack/blob/1201d623/docs/en-US/plugin-niciranvp-vpcfeatures.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/plugin-niciranvp-vpcfeatures.xml b/docs/en-US/plugin-niciranvp-vpcfeatures.xml new file mode 100644 index 0000000..a8d8194 --- /dev/null +++ b/docs/en-US/plugin-niciranvp-vpcfeatures.xml @@ -0,0 +1,28 @@ +<?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="vpc-features"> + <title>Supported VPC features</title> + <para>The Nicira NVP plugin supports &PRODUCT; VPC to a certain extent. Starting with &PRODUCT; version 4.1 VPCs can be deployed using NVP isolated networks.</para> + <para>It is not possible to use a Nicira NVP Logical Router for as a VPC Router</para> + <para>It is not possible to connect a private gateway using a Nicira NVP Logical Switch</para> +</section> http://git-wip-us.apache.org/repos/asf/cloudstack/blob/1201d623/docs/en-US/plugin-niciranvp-vpcnetworkoffering.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/plugin-niciranvp-vpcnetworkoffering.xml b/docs/en-US/plugin-niciranvp-vpcnetworkoffering.xml new file mode 100644 index 0000000..141006e --- /dev/null +++ b/docs/en-US/plugin-niciranvp-vpcnetworkoffering.xml @@ -0,0 +1,81 @@ +<?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="nvp-vpc-network-offering"> + <title>VPC Network Offerings</title> + <para>The VPC needs specific network offerings with the VPC flag enabled. Otherwise these network offerings are identical to regular network offerings. To allow VPC networks with a Nicira NVP isolated network the offerings need to support the Virtual Networking service with the NiciraNVP provider.</para> + <para>In a typical configuration two network offerings need to be created. One with the loadbalancing service enabled and one without loadbalancing.</para> + <table> + <title>VPC Network Offering with Loadbalancing</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Service</entry> + <entry>Provider</entry> + </row> + </thead> + <tbody> + <row> + <entry>VPN</entry> + <entry>VpcVirtualRouter</entry> + </row> + <row> + <entry>DHCP</entry> + <entry>VpcVirtualRouter</entry> + </row> + <row> + <entry>DNS</entry> + <entry>VpcVirtualRouter</entry> + </row> + <row> + <entry>Load Balancer</entry> + <entry>VpcVirtualRouter</entry> + </row> + <row> + <entry>User Data</entry> + <entry>VpcVirtualRouter</entry> + </row> + <row> + <entry>Source NAT</entry> + <entry>VpcVirtualRouter</entry> + </row> + <row> + <entry>Static NAT</entry> + <entry>VpcVirtualRouter</entry> + </row> + <row> + <entry>Post Forwarding</entry> + <entry>VpcVirtualRouter</entry> + </row> + <row> + <entry>NetworkACL</entry> + <entry>VpcVirtualRouter</entry> + </row> + <row> + <entry>Virtual Networking</entry> + <entry>NiciraNVP</entry> + </row> + </tbody> + </tgroup> + </table> + +</section> http://git-wip-us.apache.org/repos/asf/cloudstack/blob/1201d623/docs/en-US/plugin-niciranvp-vpcoffering.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/plugin-niciranvp-vpcoffering.xml b/docs/en-US/plugin-niciranvp-vpcoffering.xml new file mode 100644 index 0000000..292621e --- /dev/null +++ b/docs/en-US/plugin-niciranvp-vpcoffering.xml @@ -0,0 +1,38 @@ +<?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="nvp-vpc-offering"> + <title>VPC Offering with Nicira NVP</title> + <para>To allow a VPC to use the Nicira NVP plugin to provision networks, a new VPC offering needs to be created which allows the Virtual Networking service to be implemented by NiciraNVP.</para> + <para>This is not currently possible with the UI. The API does provide the proper calls to create a VPC offering with Virtual Networking enabled. However due to a limitation in the 4.1 API it is not possible to select the provider for this network service. To configure the VPC offering with the NiciraNVP provider edit the database table 'vpc_offering_service_map' and change the provider to NiciraNvp for the service 'Connectivity'</para> + <para>It is also possible to update the default VPC offering by adding a row to the + 'vpc_offering_service_map' with service 'Connectivity' and provider 'NiciraNvp'</para> + <mediaobject> + <imageobject> + <imagedata fileref="./images/nvp-vpc-offering-edit.png" /> + </imageobject> + <textobject> + <phrase>nvp-physical-network-stt.png: a screenshot of the mysql table.</phrase> + </textobject> + </mediaobject> + <note><para>When creating a new VPC offering please note that the UI does not allow you to select a VPC offering yet. The VPC needs to be created using the API with the offering UUID.</para></note> +</section>
