You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by ah...@apache.org on 2012/10/05 01:16:09 UTC
[2/5] Merged over docs from master
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/add-secondary-storage.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/add-secondary-storage.xml b/docs/en-US/add-secondary-storage.xml
new file mode 100644
index 0000000..318a6ea
--- /dev/null
+++ b/docs/en-US/add-secondary-storage.xml
@@ -0,0 +1,48 @@
+<?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;
+]>
+<!-- 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="add-secondary-storage">
+ <title>Adding Secondary Storage</title>
+ <note>
+ <para>Be sure there is nothing stored on the server. Adding the server to CloudStack will
+ destroy any existing data.</para>
+ </note>
+ <para>When you create a new zone, the first secondary storage is added as part of that procedure.
+ You can add secondary storage servers at any time to add more servers to an existing
+ zone.</para>
+ <orderedlist>
+ <listitem>
+ <para>If you are going to use Swift for cloud-wide secondary storage, you must add the Swift
+ storage to &PRODUCT; before you add the local zone secondary storage servers.</para>
+ </listitem>
+ <listitem>
+ <para>To prepare for local zone secondary storage, you should have created and mounted an NFS
+ share during Management Server installation.</para>
+ </listitem>
+ <listitem>
+ <para>Make sure you prepared the system VM template during Management Server
+ installation.</para>
+ </listitem>
+ <listitem>
+ <para>4. Now that the secondary storage server for per-zone storage is prepared, add it to
+ &PRODUCT;. Secondary storage is added as part of the procedure for adding a new zone.</para>
+ </listitem>
+ </orderedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/add-security-group.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/add-security-group.xml b/docs/en-US/add-security-group.xml
index e4c8b3c..85a6ba0 100644
--- a/docs/en-US/add-security-group.xml
+++ b/docs/en-US/add-security-group.xml
@@ -3,37 +3,47 @@
<!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.
+ 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="add-security-group">
- <title>Adding a Security Group</title>
- <para>A user or administrator can change the network offering that is associated with an existing guest network.</para>
- <itemizedlist>
- <listitem><para>Log in to the &PRODUCT; UI as an administrator or end user. </para></listitem>
- <listitem><para>In the left navigation, choose Network</para></listitem>
- <listitem><para>In Select view, choose Security Groups.</para></listitem>
- <listitem><para>Click Add Security Group.</para></listitem>
- <listitem><para>Provide a name and description.</para></listitem>
- <listitem><para>Click OK.</para>
- <para>The new security group appears in the Security Groups Details tab.</para></listitem>
- <listitem><para>To make the security group useful, continue to Adding Ingress and Egress Rules to a Security Group.</para></listitem>
- </itemizedlist>
+ <title>Adding a Security Group</title>
+ <para>A user or administrator can define a new security group.</para>
+ <orderedlist>
+ <listitem>
+ <para>Log in to the &PRODUCT; UI as an administrator or end user. </para>
+ </listitem>
+ <listitem>
+ <para>In the left navigation, choose Network</para>
+ </listitem>
+ <listitem>
+ <para>In Select view, choose Security Groups.</para>
+ </listitem>
+ <listitem>
+ <para>Click Add Security Group.</para>
+ </listitem>
+ <listitem>
+ <para>Provide a name and description.</para>
+ </listitem>
+ <listitem>
+ <para>Click OK.</para>
+ <para>The new security group appears in the Security Groups Details tab.</para>
+ </listitem>
+ <listitem>
+ <para>To make the security group useful, continue to Adding Ingress and Egress Rules to a
+ Security Group.</para>
+ </listitem>
+ </orderedlist>
</section>
-
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/add-tier.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/add-tier.xml b/docs/en-US/add-tier.xml
new file mode 100644
index 0000000..6beaab2
--- /dev/null
+++ b/docs/en-US/add-tier.xml
@@ -0,0 +1,89 @@
+<?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;
+]>
+<!-- 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="add-tier">
+ <title>Adding Tiers</title>
+ <para>Tiers are distinct locations within a VPC that act as isolated networks, which do not have
+ access to other tiers by default. Tiers are set up on different VLANs that can communicate with
+ each other by using a virtual router. Tiers provide inexpensive, low latency network
+ connectivity to other tiers within the VPC.</para>
+ <orderedlist>
+ <listitem>
+ <para>Log in to the &PRODUCT; UI as an administrator or end user.</para>
+ </listitem>
+ <listitem>
+ <para>In the left navigation, choose Network.</para>
+ </listitem>
+ <listitem>
+ <para>In the Select view, select VPC.</para>
+ <para>All the VPC that you have created for the account is listed in the page.</para>
+ <note>
+ <para>The end users can see their own VPCs, while root and domain admin can see any VPC they
+ are authorized to see.</para>
+ </note>
+ </listitem>
+ <listitem>
+ <para>Click the Configure button of the VPC for which you want to set up tiers.</para>
+ <para>The Add new tier dialog is displayed, as follows:</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/add-tier.png"/>
+ </imageobject>
+ <textobject>
+ <phrase>add-tier.png: adding a tier to a vpc.</phrase>
+ </textobject>
+ </mediaobject>
+ <para>If you have already created tiers, the VPC diagram is displayed. Click Create Tier to
+ add a new tier.</para>
+ </listitem>
+ <listitem>
+ <para>Specify the following:</para>
+ <para>All the fields are mandatory.</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Name</emphasis>: A unique name for the tier you create.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Network Offering</emphasis>: The following default network
+ offerings are listed: DefaultIsolatedNetworkOfferingForVpcNetworksNoLB,
+ DefaultIsolatedNetworkOfferingForVpcNetworks</para>
+ <para>In a VPC, only one tier can be created by using LB-enabled network offering.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Gateway</emphasis>: The gateway for the tier you create.
+ Ensure that the gateway is within the Super CIDR range that you specified while creating
+ the VPC, and is not overlapped with the CIDR of any existing tier within the VPC.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Netmask</emphasis>: The netmask for the tier you create. </para>
+ <para>For example, if the VPC CIDR is 10.0.0.0/16 and the network tier CIDR is
+ 10.0.1.0/24, the gateway of the tier is 10.0.1.1, and the netmask of the tier is
+ 255.255.255.0.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>Click OK.</para>
+ </listitem>
+ <listitem>
+ <para>Continue with configuring access control list for the tier.</para>
+ </listitem>
+ </orderedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/add-vm-to-tier.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/add-vm-to-tier.xml b/docs/en-US/add-vm-to-tier.xml
new file mode 100644
index 0000000..e401eed
--- /dev/null
+++ b/docs/en-US/add-vm-to-tier.xml
@@ -0,0 +1,45 @@
+<?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;
+]>
+<!-- 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="add-vm-to-tier">
+ <title>Deploying VMs to the Tier</title>
+ <orderedlist>
+ <listitem>
+ <para>Log in to the &PRODUCT; UI as an administrator or end user.</para>
+ </listitem>
+ <listitem>
+ <para>In the left navigation, choose Network.</para>
+ </listitem>
+ <listitem>
+ <para>In the Select view, select VPC.</para>
+ <para>All the VPCs that you have created for the account is listed in the page.</para>
+ </listitem>
+ <listitem>
+ <para>Click the Configure button of the VPC to which you want to deploy the VMs.</para>
+ <para>The VPC page is displayed where all the tiers you created are listed.</para>
+ </listitem>
+ <listitem>
+ <para>Click the Add VM button of the tier for which you want to add a VM.</para>
+ <para>The Add Instance page is displayed.</para>
+ <para>Follow the on-screen instruction to add an instance. For information on adding an
+ instance, see Adding Instances section in the Installation Guide.</para>
+ </listitem>
+ </orderedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/add-vpc.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/add-vpc.xml b/docs/en-US/add-vpc.xml
new file mode 100644
index 0000000..8c088a0
--- /dev/null
+++ b/docs/en-US/add-vpc.xml
@@ -0,0 +1,75 @@
+<?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;
+]>
+<!-- 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="add-vpc">
+ <title>Adding a Virtual Private Cloud</title>
+ <para>When creating the VPC, you simply provide the zone and a set of IP addresses for the VPC
+ network address space. You specify this set of addresses in the form of a Classless Inter-Domain
+ Routing (CIDR) block.</para>
+ <orderedlist>
+ <listitem>
+ <para>Log in to the &PRODUCT; UI as an administrator or end user. </para>
+ </listitem>
+ <listitem>
+ <para>In the left navigation, choose Network.</para>
+ </listitem>
+ <listitem>
+ <para>In the Select view, select VPC.</para>
+ </listitem>
+ <listitem>
+ <para>Click Add VPC. The Add VPC page is displayed as follows:</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/add-vpc.png"/>
+ </imageobject>
+ <textobject>
+ <phrase>add-vpc.png: adding a vpc.</phrase>
+ </textobject>
+ </mediaobject>
+ <para>Provide the following information:</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Name</emphasis>: A short name for the VPC that you are
+ creating.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Description</emphasis>: A brief description of the VPC.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Zone</emphasis>: Choose the zone where you want the VPC to be
+ available.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Super CIDR for Guest Networks</emphasis>: Defines the CIDR
+ range for all the tiers (guest networks) within a VPC. When you create a tier, ensure
+ that its CIDR is within the Super CIDR value you enter. The CIDR must be RFC1918
+ compliant.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">DNS domain for Guest Networks</emphasis>: If you want to
+ assign a special domain name, specify the DNS suffix. This parameter is applied to all
+ the tiers within the VPC. That implies, all the tiers you create in the VPC belong to
+ the same DNS domain. If the parameter is not specified, a DNS domain name is generated
+ automatically. </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </orderedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/added-API-commands.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/added-API-commands.xml b/docs/en-US/added-API-commands.xml
index b63895e..237c524 100644
--- a/docs/en-US/added-API-commands.xml
+++ b/docs/en-US/added-API-commands.xml
@@ -3,165 +3,332 @@
<!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.
+ 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="added-API-commands">
- <title>Added API commands</title>
- <para>Added in 3.0.3:</para>
- <itemizedlist>
- <listitem><para>enableCiscoNexusVSM (Enables Nexus 1000v dvSwitch in &PRODUCT;.)</para></listitem>
- <listitem><para>disableCiscoNexusVSM (Disables Nexus 1000v dvSwitch in &PRODUCT;.)</para></listitem>
- <listitem><para>deleteCiscoNexusVSM (Deletes Nexus 1000v dvSwitch in &PRODUCT;.)</para></listitem>
- <listitem><para>listCiscoNexusVSMs (Lists the control VLAN ID, packet VLAN ID, and data VLAN ID, as well as the IP address of the Nexus 1000v dvSwitch.)</para></listitem>
- </itemizedlist>
- <para>Added in 3.0.2:</para>
- <itemizedlist>
- <listitem><para>changeServiceForSystemVm</para>
- <para>Changes the service offering for a system VM (console proxy or secondary storage). The system VM must be in a "Stopped" state for this command to take effect.</para>
- </listitem>
- </itemizedlist>
- <para>Added in 3.0.1:</para>
- <itemizedlist>
- <listitem><para>changeServiceForSystemVm</para>
- <para>Changes the service offering for a system VM (console proxy or secondary storage). The system VM must be in a "Stopped" state for this command to take effect.</para>
- </listitem>
- </itemizedlist>
- <para>Added in 3.0.0:</para>
- <informaltable frame="all">
- <tgroup cols="3" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" />
- <colspec colname="c2" />
- <colspec colname="c3" />
- <tbody>
- <row>
- <entry><para>assignVirtualMachine (Move a user VM to another user under same domain.)</para></entry>
- <entry><para>restoreVirtualMachine (Restore a VM to original template or specific snapshot)</para></entry>
- <entry><para>createLBStickinessPolicy (Creates a Load Balancer stickiness policy )</para></entry>
- </row>
- <row>
- <entry><para>deleteLBStickinessPolicy (Deletes a LB stickiness policy.)</para></entry>
- <entry><para>listLBStickinessPolicies (Lists LBStickiness policies.)</para></entry>
- <entry><para>ldapConfig (Configure the LDAP context for this site.)</para></entry>
- </row>
- <row>
- <entry><para>addSwift (Adds Swift.)</para></entry>
- <entry><para>listSwifts (List Swift.)</para></entry>
- <entry><para>migrateVolume (Migrate volume)</para></entry>
- </row>
- <row>
- <entry><para>updateStoragePool (Updates a storage pool.)</para></entry>
- <entry><para>authorizeSecurityGroupEgress (Authorizes a particular egress rule for this security group)</para></entry>
- <entry><para>revokeSecurityGroupEgress (Deletes a particular egress rule from this security group)</para></entry>
- </row>
- <row>
- <entry><para>createNetworkOffering (Creates a network offering.)</para></entry>
- <entry><para>deleteNetworkOffering (Deletes a network offering.)</para></entry>
- <entry><para>createProject (Creates a project)</para></entry>
- </row>
- <row>
- <entry><para>deleteProject (Deletes a project)</para></entry>
- <entry><para>updateProject (Updates a project)</para></entry>
- <entry><para>activateProject (Activates a project)</para></entry>
- </row>
- <row>
- <entry><para>suspendProject (Suspends a project)</para></entry>
- <entry><para>listProjects (Lists projects and provides detailed information for listed projects)</para></entry>
- <entry><para>addAccountToProject (Adds acoount to a project)</para></entry>
- </row>
- <row>
- <entry><para>deleteAccountFromProject (Deletes account from the project)</para></entry>
- <entry><para>listProjectAccounts (Lists project's accounts)</para></entry>
- <entry><para>listProjectInvitations (Lists an account's invitations to join projects)</para></entry>
- </row>
- <row>
- <entry><para>updateProjectInvitation (Accepts or declines project invitation)</para></entry>
- <entry><para>deleteProjectInvitation (Deletes a project invitation)</para></entry>
- <entry><para>updateHypervisorCapabilities (Updates a hypervisor capabilities.)</para></entry>
- </row>
- <row>
- <entry><para>listHypervisorCapabilities (Lists all hypervisor capabilities.)</para></entry>
- <entry><para>createPhysicalNetwork (Creates a physical network)</para></entry>
- <entry><para>deletePhysicalNetwork (Deletes a Physical Network.)</para></entry>
- </row>
- <row>
- <entry><para>listPhysicalNetworks (Lists physical networks)</para></entry>
- <entry><para>updatePhysicalNetwork (Updates a physical network)</para></entry>
- <entry><para>listSupportedNetworkServices (Lists all network services provided by &PRODUCT; or for the given Provider.)</para></entry>
- </row>
- <row>
- <entry><para>addNetworkServiceProvider (Adds a network serviceProvider to a physical network)</para></entry>
- <entry><para>deleteNetworkServiceProvider (Deletes a Network Service Provider.)</para></entry>
- <entry><para>listNetworkServiceProviders (Lists network serviceproviders for a given physical network.)</para></entry>
- </row>
- <row>
- <entry><para>updateNetworkServiceProvider (Updates a network serviceProvider of a physical network)</para></entry>
- <entry><para>addTrafficType (Adds traffic type to a physical network)</para></entry>
- <entry><para>deleteTrafficType (Deletes traffic type of a physical network)</para></entry>
- </row>
- <row>
- <entry><para>listTrafficTypes (Lists traffic types of a given physical network.)</para></entry>
- <entry><para>updateTrafficType (Updates traffic type of a physical network)</para></entry>
- <entry><para>listTrafficTypeImplementors (Lists implementors of implementor of a network traffic type or implementors of all network traffic types)</para></entry>
- </row>
- <row>
- <entry><para>createStorageNetworkIpRange (Creates a Storage network IP range.)</para></entry>
- <entry><para>deleteStorageNetworkIpRange (Deletes a storage network IP Range.)</para></entry>
- <entry><para>listStorageNetworkIpRange (List a storage network IP range.)</para></entry>
- </row>
- <row>
- <entry><para>updateStorageNetworkIpRange (Update a Storage network IP range, only allowed when no IPs in this range have been allocated.)</para></entry>
- <entry><para>listUsageTypes (List Usage Types)</para></entry>
- <entry><para>addF5LoadBalancer (Adds a F5 BigIP load balancer device)</para></entry>
- </row>
- <row>
- <entry><para>configureF5LoadBalancer (configures a F5 load balancer device)</para></entry>
- <entry><para>deleteF5LoadBalancer ( delete a F5 load balancer device)</para></entry>
- <entry><para>listF5LoadBalancers (lists F5 load balancer devices)</para></entry>
- </row>
- <row>
- <entry><para>listF5LoadBalancerNetworks (lists network that are using a F5 load balancer device)</para></entry>
- <entry><para>addSrxFirewall (Adds a SRX firewall device)</para></entry>
- <entry><para>deleteSrxFirewall ( delete a SRX firewall device)</para></entry>
- </row>
- <row>
- <entry><para>listSrxFirewalls (lists SRX firewall devices in a physical network)</para></entry>
- <entry><para>listSrxFirewallNetworks (lists network that are using SRX firewall device)</para></entry>
- <entry><para>addNetscalerLoadBalancer (Adds a netscaler load balancer device)</para></entry>
- </row>
- <row>
- <entry><para>deleteNetscalerLoadBalancer ( delete a netscaler load balancer device)</para></entry>
- <entry><para>configureNetscalerLoadBalancer (configures a netscaler load balancer device)</para></entry>
- <entry><para>listNetscalerLoadBalancers (lists netscaler load balancer devices)</para></entry>
- </row>
- <row>
- <entry><para>listNetscalerLoadBalancerNetworks (lists network that are using a netscaler load balancer device)</para></entry>
- <entry><para>createVirtualRouterElement (Create a virtual router element.)</para></entry>
- <entry><para>configureVirtualRouterElement (Configures a virtual router element.)</para></entry>
- </row>
- <row>
- <entry><para>listVirtualRouterElements (Lists all available virtual router elements.)</para></entry>
- <entry><para></para></entry>
- <entry><para></para></entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </section>
+<section id="added-API-commands">
+ <title>Added API commands</title>
+ <para>Added in 4.0</para>
+ <itemizedlist>
+ <listitem>
+ <para>createCounter (Adds metric counter)</para>
+ </listitem>
+ <listitem>
+ <para>deleteCounter (Deletes a counter)</para>
+ </listitem>
+ <listitem>
+ <para>listCounters (List the counters)</para>
+ </listitem>
+ <listitem>
+ <para>createCondition (Creates a condition)</para>
+ </listitem>
+ <listitem>
+ <para>deleteCondition (Removes a condition)</para>
+ </listitem>
+ <listitem>
+ <para>listConditions (List Conditions for the specific user)</para>
+ </listitem>
+ <listitem>
+ <para>createTags. Add tags to one or more resources. Example:
+ <programlisting>command=createTags
+&resourceIds=1,10,12
+&resourceType=userVm
+&tags[0].key=region
+&tags[0].value=canada
+&tags[1].key=city
+&tags[1].value=Toronto </programlisting></para>
+ </listitem>
+ <listitem>
+ <para>deleteTags. Remove tags from one or more resources. Example:
+ <programlisting>command=deleteTags
+&resourceIds=1,12
+&resourceType=Snapshot
+&tags[0].key=city </programlisting></para>
+ </listitem>
+ <listitem>
+ <para>listTags (Show currently defined resource tags)</para>
+ </listitem>
+ <listitem>
+ <para>createVPC (Creates a VPC)</para>
+ </listitem>
+ <listitem>
+ <para>listVPCs (Lists VPCs)</para>
+ </listitem>
+ <listitem>
+ <para>deleteVPC (Deletes a VPC)</para>
+ </listitem>
+ <listitem>
+ <para>updateVPC (Updates a VPC)</para>
+ </listitem>
+ <listitem>
+ <para>restartVPC (Restarts a VPC)</para>
+ </listitem>
+ <listitem>
+ <para>createVPCOffering (Creates VPC offering)</para>
+ </listitem>
+ <listitem>
+ <para>updateVPCOffering (Updates VPC offering)</para>
+ </listitem>
+ <listitem>
+ <para>deleteVPCOffering (Deletes VPC offering)</para>
+ </listitem>
+ <listitem>
+ <para>listVPCOfferings (Lists VPC offerings)</para>
+ </listitem>
+ <listitem>
+ <para>createPrivateGateway (Creates a private gateway)</para>
+ </listitem>
+ <listitem>
+ <para>listPrivateGateways (List private gateways)</para>
+ </listitem>
+ <listitem>
+ <para>deletePrivateGateway (Deletes a Private gateway)</para>
+ </listitem>
+ <listitem>
+ <para>createNetworkACL (Creates a ACL rule the given network (the network has to belong to
+ VPC))</para>
+ </listitem>
+ <listitem>
+ <para>deleteNetworkACL (Deletes a Network ACL)</para>
+ </listitem>
+ <listitem>
+ <para>listNetworkACLs (Lists all network ACLs)</para>
+ </listitem>
+ <listitem>
+ <para>createStaticRoute (Creates a static route)</para>
+ </listitem>
+ <listitem>
+ <para>deleteStaticRoute (Deletes a static route)</para>
+ </listitem>
+ <listitem>
+ <para>listStaticRoutes (Lists all static routes)</para>
+ </listitem>
+ <listitem>
+ <para>createVpnCustomerGateway (Creates site to site vpn customer gateway)</para>
+ </listitem>
+ <listitem>
+ <para>createVpnGateway (Creates site to site vpn local gateway)</para>
+ </listitem>
+ <listitem>
+ <para>createVpnConnection (Create site to site vpn connection)</para>
+ </listitem>
+ <listitem>
+ <para>deleteVpnCustomerGateway (Delete site to site vpn customer gateway)</para>
+ </listitem>
+ <listitem>
+ <para>deleteVpnGateway (Delete site to site vpn gateway)</para>
+ </listitem>
+ <listitem>
+ <para>deleteVpnConnection (Delete site to site vpn connection)</para>
+ </listitem>
+ <listitem>
+ <para>updateVpnCustomerGateway (Update site to site vpn customer gateway)</para>
+ </listitem>
+ <listitem>
+ <para>resetVpnConnection (Reset site to site vpn connection)</para>
+ </listitem>
+ <listitem>
+ <para>listVpnCustomerGateways (Lists site to site vpn customer gateways)</para>
+ </listitem>
+ <listitem>
+ <para>listVpnGateways (Lists site 2 site vpn gateways)</para>
+ </listitem>
+ <listitem>
+ <para>listVpnConnections (Lists site to site vpn connection gateways)</para>
+ </listitem>
+ </itemizedlist>
+ <para>Added in 3.0.3:</para>
+ <itemizedlist>
+ <listitem>
+ <para>enableCiscoNexusVSM (Enables Nexus 1000v dvSwitch in &PRODUCT;.)</para>
+ </listitem>
+ <listitem>
+ <para>disableCiscoNexusVSM (Disables Nexus 1000v dvSwitch in &PRODUCT;.)</para>
+ </listitem>
+ <listitem>
+ <para>deleteCiscoNexusVSM (Deletes Nexus 1000v dvSwitch in &PRODUCT;.)</para>
+ </listitem>
+ <listitem>
+ <para>listCiscoNexusVSMs (Lists the control VLAN ID, packet VLAN ID, and data VLAN ID, as well
+ as the IP address of the Nexus 1000v dvSwitch.)</para>
+ </listitem>
+ </itemizedlist>
+ <para>Added in 3.0.2:</para>
+ <itemizedlist>
+ <listitem>
+ <para>changeServiceForSystemVm</para>
+ <para>Changes the service offering for a system VM (console proxy or secondary storage). The
+ system VM must be in a "Stopped" state for this command to take effect.</para>
+ </listitem>
+ </itemizedlist>
+ <para>Added in 3.0.1:</para>
+ <itemizedlist>
+ <listitem>
+ <para>changeServiceForSystemVm</para>
+ <para>Changes the service offering for a system VM (console proxy or secondary storage). The
+ system VM must be in a "Stopped" state for this command to take effect.</para>
+ </listitem>
+ </itemizedlist>
+ <para>Added in 3.0.0:</para>
+ <informaltable frame="all">
+ <tgroup cols="3" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1"/>
+ <colspec colname="c2"/>
+ <colspec colname="c3"/>
+ <tbody>
+ <row>
+ <entry><para>assignVirtualMachine (Move a user VM to another user under same
+ domain.)</para></entry>
+ <entry><para>restoreVirtualMachine (Restore a VM to original template or specific
+ snapshot)</para></entry>
+ <entry><para>createLBStickinessPolicy (Creates a Load Balancer stickiness policy
+ )</para></entry>
+ </row>
+ <row>
+ <entry><para>deleteLBStickinessPolicy (Deletes a LB stickiness policy.)</para></entry>
+ <entry><para>listLBStickinessPolicies (Lists LBStickiness policies.)</para></entry>
+ <entry><para>ldapConfig (Configure the LDAP context for this site.)</para></entry>
+ </row>
+ <row>
+ <entry><para>addSwift (Adds Swift.)</para></entry>
+ <entry><para>listSwifts (List Swift.)</para></entry>
+ <entry><para>migrateVolume (Migrate volume)</para></entry>
+ </row>
+ <row>
+ <entry><para>updateStoragePool (Updates a storage pool.)</para></entry>
+ <entry><para>authorizeSecurityGroupEgress (Authorizes a particular egress rule for this
+ security group)</para></entry>
+ <entry><para>revokeSecurityGroupEgress (Deletes a particular egress rule from this
+ security group)</para></entry>
+ </row>
+ <row>
+ <entry><para>createNetworkOffering (Creates a network offering.)</para></entry>
+ <entry><para>deleteNetworkOffering (Deletes a network offering.)</para></entry>
+ <entry><para>createProject (Creates a project)</para></entry>
+ </row>
+ <row>
+ <entry><para>deleteProject (Deletes a project)</para></entry>
+ <entry><para>updateProject (Updates a project)</para></entry>
+ <entry><para>activateProject (Activates a project)</para></entry>
+ </row>
+ <row>
+ <entry><para>suspendProject (Suspends a project)</para></entry>
+ <entry><para>listProjects (Lists projects and provides detailed information for listed
+ projects)</para></entry>
+ <entry><para>addAccountToProject (Adds acoount to a project)</para></entry>
+ </row>
+ <row>
+ <entry><para>deleteAccountFromProject (Deletes account from the project)</para></entry>
+ <entry><para>listProjectAccounts (Lists project's accounts)</para></entry>
+ <entry><para>listProjectInvitations (Lists an account's invitations to join
+ projects)</para></entry>
+ </row>
+ <row>
+ <entry><para>updateProjectInvitation (Accepts or declines project
+ invitation)</para></entry>
+ <entry><para>deleteProjectInvitation (Deletes a project invitation)</para></entry>
+ <entry><para>updateHypervisorCapabilities (Updates a hypervisor
+ capabilities.)</para></entry>
+ </row>
+ <row>
+ <entry><para>listHypervisorCapabilities (Lists all hypervisor
+ capabilities.)</para></entry>
+ <entry><para>createPhysicalNetwork (Creates a physical network)</para></entry>
+ <entry><para>deletePhysicalNetwork (Deletes a Physical Network.)</para></entry>
+ </row>
+ <row>
+ <entry><para>listPhysicalNetworks (Lists physical networks)</para></entry>
+ <entry><para>updatePhysicalNetwork (Updates a physical network)</para></entry>
+ <entry><para>listSupportedNetworkServices (Lists all network services provided by
+ &PRODUCT; or for the given Provider.)</para></entry>
+ </row>
+ <row>
+ <entry><para>addNetworkServiceProvider (Adds a network serviceProvider to a physical
+ network)</para></entry>
+ <entry><para>deleteNetworkServiceProvider (Deletes a Network Service
+ Provider.)</para></entry>
+ <entry><para>listNetworkServiceProviders (Lists network serviceproviders for a given
+ physical network.)</para></entry>
+ </row>
+ <row>
+ <entry><para>updateNetworkServiceProvider (Updates a network serviceProvider of a physical
+ network)</para></entry>
+ <entry><para>addTrafficType (Adds traffic type to a physical network)</para></entry>
+ <entry><para>deleteTrafficType (Deletes traffic type of a physical network)</para></entry>
+ </row>
+ <row>
+ <entry><para>listTrafficTypes (Lists traffic types of a given physical
+ network.)</para></entry>
+ <entry><para>updateTrafficType (Updates traffic type of a physical network)</para></entry>
+ <entry><para>listTrafficTypeImplementors (Lists implementors of implementor of a network
+ traffic type or implementors of all network traffic types)</para></entry>
+ </row>
+ <row>
+ <entry><para>createStorageNetworkIpRange (Creates a Storage network IP
+ range.)</para></entry>
+ <entry><para>deleteStorageNetworkIpRange (Deletes a storage network IP
+ Range.)</para></entry>
+ <entry><para>listStorageNetworkIpRange (List a storage network IP range.)</para></entry>
+ </row>
+ <row>
+ <entry><para>updateStorageNetworkIpRange (Update a Storage network IP range, only allowed
+ when no IPs in this range have been allocated.)</para></entry>
+ <entry><para>listUsageTypes (List Usage Types)</para></entry>
+ <entry><para>addF5LoadBalancer (Adds a F5 BigIP load balancer device)</para></entry>
+ </row>
+ <row>
+ <entry><para>configureF5LoadBalancer (configures a F5 load balancer device)</para></entry>
+ <entry><para>deleteF5LoadBalancer ( delete a F5 load balancer device)</para></entry>
+ <entry><para>listF5LoadBalancers (lists F5 load balancer devices)</para></entry>
+ </row>
+ <row>
+ <entry><para>listF5LoadBalancerNetworks (lists network that are using a F5 load balancer
+ device)</para></entry>
+ <entry><para>addSrxFirewall (Adds a SRX firewall device)</para></entry>
+ <entry><para>deleteSrxFirewall ( delete a SRX firewall device)</para></entry>
+ </row>
+ <row>
+ <entry><para>listSrxFirewalls (lists SRX firewall devices in a physical
+ network)</para></entry>
+ <entry><para>listSrxFirewallNetworks (lists network that are using SRX firewall
+ device)</para></entry>
+ <entry><para>addNetscalerLoadBalancer (Adds a netscaler load balancer
+ device)</para></entry>
+ </row>
+ <row>
+ <entry><para>deleteNetscalerLoadBalancer ( delete a netscaler load balancer
+ device)</para></entry>
+ <entry><para>configureNetscalerLoadBalancer (configures a netscaler load balancer
+ device)</para></entry>
+ <entry><para>listNetscalerLoadBalancers (lists netscaler load balancer
+ devices)</para></entry>
+ </row>
+ <row>
+ <entry><para>listNetscalerLoadBalancerNetworks (lists network that are using a netscaler
+ load balancer device)</para></entry>
+ <entry><para>createVirtualRouterElement (Create a virtual router element.)</para></entry>
+ <entry><para>configureVirtualRouterElement (Configures a virtual router
+ element.)</para></entry>
+ </row>
+ <row>
+ <entry><para>listVirtualRouterElements (Lists all available virtual router
+ elements.)</para></entry>
+ <entry><para/></entry>
+ <entry><para/></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/advanced-zone-configuration.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/advanced-zone-configuration.xml b/docs/en-US/advanced-zone-configuration.xml
index 85909e3..84649db 100644
--- a/docs/en-US/advanced-zone-configuration.xml
+++ b/docs/en-US/advanced-zone-configuration.xml
@@ -1,182 +1,380 @@
<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!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;
]>
-
<!-- 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.
+ 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="advanced-zone-configuration">
- <title>Advanced Zone Configuration</title>
- <orderedlist>
- <listitem><para>After you select Advanced in the Add Zone wizard and click Next, you will be asked to enter the following details. Then click Next.</para>
- <itemizedlist>
- <listitem><para><emphasis role="bold">Name.</emphasis> A name for the zone.</para></listitem>
- <listitem><para><emphasis role="bold">DNS 1 and 2.</emphasis> These are DNS servers for use by guest VMs in the zone. These DNS servers will be accessed via the public network you will add later. The public IP addresses for the zone must have a route to the DNS server named here.</para></listitem>
- <listitem><para><emphasis role="bold">Internal DNS 1 and Internal DNS 2.</emphasis> These are DNS servers for use by system VMs in the zone(these are VMs used by &PRODUCT; itself, such as virtual routers, console proxies,and Secondary Storage VMs.) These DNS servers will be accessed via the management traffic network interface of the System VMs. The private IP address you provide for the pods must have a route to the internal DNS server named here.</para></listitem>
- <listitem><para><emphasis role="bold">Network Domain.</emphasis> (Optional) If you want to assign a special domain name to the guest VM network, specify the DNS suffix.</para></listitem>
- <listitem><para><emphasis role="bold">Guest CIDR.</emphasis> This is the CIDR that describes the IP addresses in use in the guest virtual networks in this zone. For example, 10.1.1.0/24. As a matter of good practice you should set different CIDRs for different zones. This will make it easier to set up VPNs between networks in different zones.</para></listitem>
- <listitem><para><emphasis role="bold">Hypervisor.</emphasis> (Introduced in version 3.0.1) Choose the hypervisor for the first cluster in the zone. You can add clusters with different hypervisors later, after you finish adding the zone.</para></listitem>
- <listitem><para><emphasis role="bold">Public.</emphasis> A public zone is available to all users. A zone that is not public will be assigned to a particular domain. Only users in that domain will be allowed to create guest VMs in this zone.</para></listitem>
- </itemizedlist>
- </listitem>
- <listitem><para>Choose which traffic types will be carried by the physical network.</para>
- <para>The traffic types are management, public, guest, and storage traffic. For more information about the types, roll over the icons to display their tool tips, or see <xref linkend="advanced-zone-network-traffic-types" />. This screen starts out with one network already configured. If you have multiple physical networks, you need to add more. Drag and drop traffic types onto a greyed-out network and it will become active. You can move the traffic icons from one network to another; for example, if the default traffic types shown for Network 1 do not match your actual setup, you can move them down. You can also change the network names if desired.</para>
- </listitem>
- <listitem><para>(Introduced in version 3.0.1) Assign a network traffic label to each traffic type on each physical network. These labels must match the labels you have already defined on the hypervisor host. To assign each label, click the Edit button under the traffic type icon within each physical network. A popup dialog appears where you can type the label, then click OK.</para>
- <para>These traffic labels will be defined only for the hypervisor selected for the first cluster. For all other hypervisors, the labels can be configured after the zone is created.</para>
- <para>(VMware only) If you have enabled Nexus dvSwitch in the environment, you must specify the corresponding Ethernet port profile names as network traffic label for each traffic type on the physical network. For more information on Nexus dvSwitch, see Configuring a vSphere Cluster with Nexus 1000v Virtual Switch.</para>
- </listitem>
- <listitem><para>Click Next.</para>
- </listitem>
- <listitem><para>Configure the IP range for public Internet traffic. Enter the following details, then click Add. If desired, you can repeat this step to add more public Internet IP ranges. When done, click Next.</para>
- <itemizedlist>
- <listitem><para><emphasis role="bold">Gateway.</emphasis> The gateway in use for these IP addresses.</para></listitem>
- <listitem><para><emphasis role="bold">Netmask.</emphasis> The netmask associated with this IP range.</para></listitem>
- <listitem><para><emphasis role="bold">VLAN.</emphasis> The VLAN that will be used for public traffic.</para></listitem>
- <listitem><para><emphasis role="bold">Start IP/End IP.</emphasis> A range of IP addresses that are assumed to be accessible from the Internet and will be allocated for access to guest networks.</para></listitem>
- </itemizedlist>
- </listitem>
- <listitem><para>In a new zone, &PRODUCT; adds the first pod for you. You can always add more pods later. For an overview of what a pod is, see <xref linkend="about-pods" />.</para>
- <para>To configure the first pod, enter the following, then click Next:</para>
- <itemizedlist>
- <listitem><para><emphasis role="bold">Pod Name.</emphasis> A name for the pod.</para></listitem>
- <listitem><para><emphasis role="bold">Reserved system gateway.</emphasis> The gateway for the hosts in that pod.</para></listitem>
- <listitem><para><emphasis role="bold">Reserved system netmask.</emphasis> The network prefix that defines the pod's subnet. Use CIDR notation.</para></listitem>
- <listitem><para><emphasis role="bold">Start/End Reserved System IP.</emphasis> The IP range in the management network that &PRODUCT; uses to manage various system VMs, such as Secondary Storage VMs, Console Proxy VMs, and DHCP. For more information, see <xref linkend="system-reserved-ip-addresses" />.</para></listitem>
- </itemizedlist>
- </listitem>
- <listitem><para>Specify a range of VLAN IDs to carry guest traffic for each physical network (see VLAN Allocation Example ), then click Next.</para>
- </listitem>
- <listitem><para>In a new pod, &PRODUCT; adds the first cluster for you. You can always add more clusters later. For an overview of what a cluster is, see <xref linkend="about-clusters" />.</para>
- <para>To configure the first cluster, enter the following, then click Next:</para>
- <itemizedlist>
- <listitem><para><emphasis role="bold">Hypervisor.</emphasis> (Version 3.0.0 only; in 3.0.1, this field is read only) Choose the type of hypervisor software that all hosts in this cluster will run. If you choose VMware, additional fields appear so you can give information about a vSphere cluster. For vSphere servers, we recommend creating the cluster of hosts in vCenter and then adding the entire cluster to &PRODUCT;. See Add Cluster: vSphere .</para></listitem>
- <listitem><para><emphasis role="bold">Cluster name.</emphasis> Enter a name for the cluster. This can be text of your choosing and is not used by &PRODUCT;.</para></listitem>
- </itemizedlist>
- </listitem>
- <listitem><para>In a new cluster, &PRODUCT; adds the first host for you. You can always add more hosts later. For an overview of what a host is, see <xref linkend="about-hosts" />.</para>
- <note><para>When you deploy &PRODUCT;, the hypervisor host must not have any VMs already running.</para></note>
- <para>Before you can configure the host, you need to install the hypervisor software on the host. You will need to know which version of the hypervisor software version is supported by &PRODUCT; and what additional configuration is required to ensure the host will work with &PRODUCT;. To find these installation details, see:</para>
- <itemizedlist>
- <listitem><para>Citrix XenServer Installation for &PRODUCT;</para></listitem>
- <listitem><para>VMware vSphere Installation and Configuration</para></listitem>
- <listitem><para>KVM Installation and Configuration</para></listitem>
- <listitem><para>Oracle VM (OVM) Installation and Configuration</para></listitem>
- </itemizedlist>
- <para>To configure the first host, enter the following, then click Next:</para>
- <itemizedlist>
- <listitem><para><emphasis role="bold">Host Name.</emphasis> The DNS name or IP address of the host.</para></listitem>
- <listitem><para><emphasis role="bold">Username.</emphasis> Usually root.</para></listitem>
- <listitem><para><emphasis role="bold">Password.</emphasis> This is the password for the user named above (from your XenServer or KVM install).</para></listitem>
- <listitem><para><emphasis role="bold">Host Tags.</emphasis> (Optional) Any labels that you use to categorize hosts for ease of maintenance. For example, you can set to the cloud's HA tag (set in the ha.tag global configuration parameter) if you want this host to be used only for VMs with the "high availability" feature enabled. For more information, see HA-Enabled Virtual Machines as well as HA for Hosts, both in the Administration Guide.</para></listitem>
- </itemizedlist>
- </listitem>
- <listitem><para>In a new cluster, &PRODUCT; adds the first primary storage server for you. You can always add more servers later. For an overview of what primary storage is, see <xref linkend="about-primary-storage" />.</para>
- <para>To configure the first primary storage server, enter the following, then click Next:</para>
- <itemizedlist>
- <listitem><para><emphasis role="bold">Name.</emphasis> The name of the storage device.</para></listitem>
- <listitem><para><emphasis role="bold">Protocol.</emphasis> For XenServer, choose either NFS, iSCSI, or PreSetup. For KVM, choose NFS or SharedMountPoint. For vSphere choose either VMFS (iSCSI or FiberChannel) or NFS. The remaining fields in the screen vary depending on what you choose here.</para>
- <informaltable frame="all">
- <tgroup cols="2" align="left" colsep="1" rowsep="1">
- <colspec colname="c1" />
- <colspec colname="c2" />
- <tbody>
- <row>
- <entry><para>NFS</para></entry>
- <entry>
- <itemizedlist>
- <listitem><para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of the storage device.</para></listitem>
- <listitem><para><emphasis role="bold">Path.</emphasis> The exported path from the server.</para></listitem>
- <listitem>
- <para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para>
- <para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
- </listitem>
- </itemizedlist>
- </entry>
- </row>
- <row>
- <entry><para>iSCSI</para></entry>
- <entry>
- <itemizedlist>
- <listitem><para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of the storage device.</para></listitem>
- <listitem><para><emphasis role="bold">Target IQN.</emphasis> The IQN of the target. For example, iqn.1986-03.com.sun:02:01ec9bb549-1271378984.</para></listitem>
- <listitem><para><emphasis role="bold">Lun.</emphasis> The LUN number. For example, 3.</para></listitem>
- <listitem>
- <para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para>
- <para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
- </listitem>
- </itemizedlist>
- </entry>
- </row>
- <row>
- <entry><para>preSetup</para></entry>
- <entry>
- <itemizedlist>
- <listitem><para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of the storage device.</para></listitem>
- <listitem><para><emphasis role="bold">SR Name-Label.</emphasis> Enter the name-label of the SR that has been set up outside &PRODUCT;.</para></listitem>
- <listitem>
- <para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para>
- <para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
- </listitem>
- </itemizedlist>
- </entry>
- </row>
- <row>
- <entry><para>SharedMountPoint</para></entry>
- <entry>
- <itemizedlist>
- <listitem><para><emphasis role="bold">Path.</emphasis> The path on each host that is where this primary storage is mounted. For example, "/mnt/primary".</para></listitem>
- <listitem>
- <para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para>
- <para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
- </listitem>
- </itemizedlist>
- </entry>
- </row>
- <row>
- <entry><para>VMFS</para></entry>
- <entry>
- <itemizedlist>
- <listitem><para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of the vCenter server.</para></listitem>
- <listitem><para><emphasis role="bold">Path.</emphasis> A combination of the datacenter name and the datastore name. The format is "/" datacenter name "/" datastore name. For example, "/cloud.dc.VM/cluster1datastore".</para></listitem>
- <listitem>
- <para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated list of tags for this storage device. It should be an equivalent set or superset of the tags on your disk offerings.</para>
- <para>The tag sets on primary storage across clusters in a Zone must be identical. For example, if cluster A provides primary storage that has tags T1 and T2, all other clusters in the Zone must also provide primary storage that has tags T1 and T2.</para>
- </listitem>
- </itemizedlist>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </informaltable>
- </listitem>
- </itemizedlist>
- </listitem>
- <listitem><para>In a new zone, &PRODUCT; adds the first secondary storage server for you. For an overview of what secondary storage is, see <xref linkend="about-secondary-storage" />.</para>
- <para>Before you can fill out this screen, you need to prepare the secondary storage by setting up NFS shares and installing the latest &PRODUCT; System VM template. See Adding Secondary Storage :</para>
- <itemizedlist>
- <listitem><para><emphasis role="bold">NFS Server.</emphasis> The IP address of the server.</para></listitem>
- <listitem><para><emphasis role="bold">Path.</emphasis> The exported path from the server.</para></listitem>
- </itemizedlist>
- </listitem>
- <listitem><para>Click Launch.</para>
- </listitem>
- </orderedlist>
+ <title>Advanced Zone Configuration</title>
+ <orderedlist>
+ <listitem>
+ <para>After you select Advanced in the Add Zone wizard and click Next, you will be asked to
+ enter the following details. Then click Next.</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Name.</emphasis> A name for the zone.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">DNS 1 and 2.</emphasis> These are DNS servers for use by guest
+ VMs in the zone. These DNS servers will be accessed via the public network you will add
+ later. The public IP addresses for the zone must have a route to the DNS server named
+ here.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Internal DNS 1 and Internal DNS 2.</emphasis> These are DNS
+ servers for use by system VMs in the zone(these are VMs used by &PRODUCT; itself, such
+ as virtual routers, console proxies,and Secondary Storage VMs.) These DNS servers will
+ be accessed via the management traffic network interface of the System VMs. The private
+ IP address you provide for the pods must have a route to the internal DNS server named
+ here.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Network Domain.</emphasis> (Optional) If you want to assign a
+ special domain name to the guest VM network, specify the DNS suffix.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Guest CIDR.</emphasis> This is the CIDR that describes the IP
+ addresses in use in the guest virtual networks in this zone. For example, 10.1.1.0/24.
+ As a matter of good practice you should set different CIDRs for different zones. This
+ will make it easier to set up VPNs between networks in different zones.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Hypervisor.</emphasis> (Introduced in version 3.0.1) Choose
+ the hypervisor for the first cluster in the zone. You can add clusters with different
+ hypervisors later, after you finish adding the zone.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Public.</emphasis> A public zone is available to all users. A
+ zone that is not public will be assigned to a particular domain. Only users in that
+ domain will be allowed to create guest VMs in this zone.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>Choose which traffic types will be carried by the physical network.</para>
+ <para>The traffic types are management, public, guest, and storage traffic. For more
+ information about the types, roll over the icons to display their tool tips, or see <xref
+ linkend="advanced-zone-network-traffic-types"/>. This screen starts out with one network
+ already configured. If you have multiple physical networks, you need to add more. Drag and
+ drop traffic types onto a greyed-out network and it will become active. You can move the
+ traffic icons from one network to another; for example, if the default traffic types shown
+ for Network 1 do not match your actual setup, you can move them down. You can also change
+ the network names if desired.</para>
+ </listitem>
+ <listitem>
+ <para>(Introduced in version 3.0.1) Assign a network traffic label to each traffic type on
+ each physical network. These labels must match the labels you have already defined on the
+ hypervisor host. To assign each label, click the Edit button under the traffic type icon
+ within each physical network. A popup dialog appears where you can type the label, then
+ click OK.</para>
+ <para>These traffic labels will be defined only for the hypervisor selected for the first
+ cluster. For all other hypervisors, the labels can be configured after the zone is
+ created.</para>
+ <para>(VMware only) If you have enabled Nexus dvSwitch in the environment, you must specify
+ the corresponding Ethernet port profile names as network traffic label for each traffic type
+ on the physical network. For more information on Nexus dvSwitch, see Configuring a vSphere
+ Cluster with Nexus 1000v Virtual Switch.</para>
+ </listitem>
+ <listitem>
+ <para>Click Next.</para>
+ </listitem>
+ <listitem>
+ <para>Configure the IP range for public Internet traffic. Enter the following details, then
+ click Add. If desired, you can repeat this step to add more public Internet IP ranges. When
+ done, click Next.</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Gateway.</emphasis> The gateway in use for these IP
+ addresses.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Netmask.</emphasis> The netmask associated with this IP
+ range.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">VLAN.</emphasis> The VLAN that will be used for public
+ traffic.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Start IP/End IP.</emphasis> A range of IP addresses that are
+ assumed to be accessible from the Internet and will be allocated for access to guest
+ networks.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>In a new zone, &PRODUCT; adds the first pod for you. You can always add more pods later.
+ For an overview of what a pod is, see <xref linkend="about-pods"/>.</para>
+ <para>To configure the first pod, enter the following, then click Next:</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Pod Name.</emphasis> A name for the pod.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Reserved system gateway.</emphasis> The gateway for the hosts
+ in that pod.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Reserved system netmask.</emphasis> The network prefix that
+ defines the pod's subnet. Use CIDR notation.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Start/End Reserved System IP.</emphasis> The IP range in the
+ management network that &PRODUCT; uses to manage various system VMs, such as Secondary
+ Storage VMs, Console Proxy VMs, and DHCP. For more information, see <xref
+ linkend="system-reserved-ip-addresses"/>.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>Specify a range of VLAN IDs to carry guest traffic for each physical network (see VLAN
+ Allocation Example ), then click Next.</para>
+ </listitem>
+ <listitem>
+ <para>In a new pod, &PRODUCT; adds the first cluster for you. You can always add more clusters
+ later. For an overview of what a cluster is, see <xref linkend="about-clusters"/>.</para>
+ <para>To configure the first cluster, enter the following, then click Next:</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Hypervisor.</emphasis> (Version 3.0.0 only; in 3.0.1, this
+ field is read only) Choose the type of hypervisor software that all hosts in this
+ cluster will run. If you choose VMware, additional fields appear so you can give
+ information about a vSphere cluster. For vSphere servers, we recommend creating the
+ cluster of hosts in vCenter and then adding the entire cluster to &PRODUCT;. See Add
+ Cluster: vSphere .</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Cluster name.</emphasis> Enter a name for the cluster. This
+ can be text of your choosing and is not used by &PRODUCT;.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>In a new cluster, &PRODUCT; adds the first host for you. You can always add more hosts
+ later. For an overview of what a host is, see <xref linkend="about-hosts"/>.</para>
+ <note>
+ <para>When you deploy &PRODUCT;, the hypervisor host must not have any VMs already
+ running.</para>
+ </note>
+ <para>Before you can configure the host, you need to install the hypervisor software on the
+ host. You will need to know which version of the hypervisor software version is supported by
+ &PRODUCT; and what additional configuration is required to ensure the host will work with
+ &PRODUCT;. To find these installation details, see:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Citrix XenServer Installation for &PRODUCT;</para>
+ </listitem>
+ <listitem>
+ <para>VMware vSphere Installation and Configuration</para>
+ </listitem>
+ <listitem>
+ <para>KVM Installation and Configuration</para>
+ </listitem>
+ <listitem>
+ <para>Oracle VM (OVM) Installation and Configuration</para>
+ </listitem>
+ </itemizedlist>
+ <para>To configure the first host, enter the following, then click Next:</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Host Name.</emphasis> The DNS name or IP address of the
+ host.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Username.</emphasis> Usually root.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Password.</emphasis> This is the password for the user named
+ above (from your XenServer or KVM install).</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Host Tags.</emphasis> (Optional) Any labels that you use to
+ categorize hosts for ease of maintenance. For example, you can set to the cloud's HA tag
+ (set in the ha.tag global configuration parameter) if you want this host to be used only
+ for VMs with the "high availability" feature enabled. For more information, see
+ HA-Enabled Virtual Machines as well as HA for Hosts, both in the Administration
+ Guide.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>In a new cluster, &PRODUCT; adds the first primary storage server for you. You can
+ always add more servers later. For an overview of what primary storage is, see <xref
+ linkend="about-primary-storage"/>.</para>
+ <para>To configure the first primary storage server, enter the following, then click
+ Next:</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Name.</emphasis> The name of the storage device.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Protocol.</emphasis> For XenServer, choose either NFS, iSCSI,
+ or PreSetup. For KVM, choose NFS or SharedMountPoint. For vSphere choose either VMFS
+ (iSCSI or FiberChannel) or NFS. The remaining fields in the screen vary depending on
+ what you choose here.</para>
+ <informaltable frame="all">
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <colspec colname="c1"/>
+ <colspec colname="c2"/>
+ <tbody>
+ <row>
+ <entry><para>NFS</para></entry>
+ <entry>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of
+ the storage device.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Path.</emphasis> The exported path from the
+ server.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated
+ list of tags for this storage device. It should be an equivalent set or
+ superset of the tags on your disk offerings.</para>
+ </listitem>
+ </itemizedlist>
+ <para>The tag sets on primary storage across clusters in a Zone must be
+ identical. For example, if cluster A provides primary storage that has tags T1
+ and T2, all other clusters in the Zone must also provide primary storage that
+ has tags T1 and T2.</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>iSCSI</para></entry>
+ <entry>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of
+ the storage device.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Target IQN.</emphasis> The IQN of the target.
+ For example, iqn.1986-03.com.sun:02:01ec9bb549-1271378984.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Lun.</emphasis> The LUN number. For example,
+ 3.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated
+ list of tags for this storage device. It should be an equivalent set or
+ superset of the tags on your disk offerings.</para>
+ </listitem>
+ </itemizedlist>
+ <para>The tag sets on primary storage across clusters in a Zone must be
+ identical. For example, if cluster A provides primary storage that has tags T1
+ and T2, all other clusters in the Zone must also provide primary storage that
+ has tags T1 and T2.</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>preSetup</para></entry>
+ <entry>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of
+ the storage device.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">SR Name-Label.</emphasis> Enter the name-label
+ of the SR that has been set up outside &PRODUCT;.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated
+ list of tags for this storage device. It should be an equivalent set or
+ superset of the tags on your disk offerings.</para>
+ </listitem>
+ </itemizedlist>
+ <para>The tag sets on primary storage across clusters in a Zone must be
+ identical. For example, if cluster A provides primary storage that has tags T1
+ and T2, all other clusters in the Zone must also provide primary storage that
+ has tags T1 and T2.</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>SharedMountPoint</para></entry>
+ <entry>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Path.</emphasis> The path on each host that is
+ where this primary storage is mounted. For example, "/mnt/primary".</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated
+ list of tags for this storage device. It should be an equivalent set or
+ superset of the tags on your disk offerings.</para>
+ </listitem>
+ </itemizedlist>
+ <para>The tag sets on primary storage across clusters in a Zone must be
+ identical. For example, if cluster A provides primary storage that has tags T1
+ and T2, all other clusters in the Zone must also provide primary storage that
+ has tags T1 and T2.</para>
+ </entry>
+ </row>
+ <row>
+ <entry><para>VMFS</para></entry>
+ <entry>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Server.</emphasis> The IP address or DNS name of
+ the vCenter server.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Path.</emphasis> A combination of the datacenter
+ name and the datastore name. The format is "/" datacenter name "/"
+ datastore name. For example, "/cloud.dc.VM/cluster1datastore".</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Tags (optional).</emphasis> The comma-separated
+ list of tags for this storage device. It should be an equivalent set or
+ superset of the tags on your disk offerings.</para>
+ </listitem>
+ </itemizedlist>
+ <para>The tag sets on primary storage across clusters in a Zone must be
+ identical. For example, if cluster A provides primary storage that has tags T1
+ and T2, all other clusters in the Zone must also provide primary storage that
+ has tags T1 and T2.</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>In a new zone, &PRODUCT; adds the first secondary storage server for you. For an
+ overview of what secondary storage is, see <xref linkend="about-secondary-storage"/>.</para>
+ <para>Before you can fill out this screen, you need to prepare the secondary storage by
+ setting up NFS shares and installing the latest &PRODUCT; System VM template. See Adding
+ Secondary Storage :</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">NFS Server.</emphasis> The IP address of the server.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Path.</emphasis> The exported path from the server.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>Click Launch.</para>
+ </listitem>
+ </orderedlist>
</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/advanced-zone-physical-network-configuration.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/advanced-zone-physical-network-configuration.xml b/docs/en-US/advanced-zone-physical-network-configuration.xml
index 4c44c7d..2c3d9b3 100644
--- a/docs/en-US/advanced-zone-physical-network-configuration.xml
+++ b/docs/en-US/advanced-zone-physical-network-configuration.xml
@@ -3,26 +3,27 @@
<!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.
+ 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="advanced-zone-physical-network-configuration">
- <title>Advanced Zone Physical Network Configuration</title>
- <para>Within a zone that uses advanced networking, you need to tell the Management Server how the physical network is set up to carry different kinds of traffic in isolation.</para>
- </section>
+ <title>Advanced Zone Physical Network Configuration</title>
+ <para>Within a zone that uses advanced networking, you need to tell the Management Server how the
+ physical network is set up to carry different kinds of traffic in isolation.</para>
+ <xi:include href="configure-guest-traffic-in-advanced-zone.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="configure-public-traffic-in-an-advanced-zone.xml"
+ xmlns:xi="http://www.w3.org/2001/XInclude"/>
+</section>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/bd384829/docs/en-US/api-overview.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/api-overview.xml b/docs/en-US/api-overview.xml
new file mode 100644
index 0000000..a541049
--- /dev/null
+++ b/docs/en-US/api-overview.xml
@@ -0,0 +1,38 @@
+<?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;
+]>
+<!-- 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="api-overview">
+ <title>&PRODUCT; API</title>
+ <para>The &PRODUCT; API is a low level API that has been used to implement the &PRODUCT; web UIs.
+ It is also a good basis for implementing other popular APIs such as EC2/S3 and emerging DMTF
+ standards.</para>
+ <para>Many &PRODUCT; API calls are asynchronous. These will return a Job ID immediately when
+ called. This Job ID can be used to query the status of the job later. Also, status calls on
+ impacted resources will provide some indication of their state.</para>
+ <para>The API has a REST-like query basis and returns results in XML or JSON.</para>
+ <para>See <ulink
+ url="http://docs.cloudstack.org/CloudStack_Documentation/Developer's_Guide%3A_CloudStack">the
+ Developer’s Guide</ulink> and <ulink
+ url="http://docs.cloudstack.org/CloudStack_Documentation/API_Reference%3A_CloudStack">the API
+ Reference</ulink>.</para>
+ <xi:include href="provisioning-auth-api.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="allocators.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="user-data-and-meta-data.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+</chapter>