You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by ke...@apache.org on 2013/10/02 16:23:29 UTC
[28/51] [partial] Adding documents from 4.2
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/pod-add.xml
----------------------------------------------------------------------
diff --git a/en-US/pod-add.xml b/en-US/pod-add.xml
new file mode 100644
index 0000000..2a2b087
--- /dev/null
+++ b/en-US/pod-add.xml
@@ -0,0 +1,43 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/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="pod-add">
+ <title>Adding a Pod</title>
+ <para>When you created a new zone, &PRODUCT; adds the first pod for you. You can add more pods at any time using the procedure in this section.</para>
+ <orderedlist>
+ <listitem><para>Log in to the &PRODUCT; UI. See <xref linkend="log-in"/>.</para></listitem>
+ <listitem><para>In the left navigation, choose Infrastructure. In Zones, click View More, then click the zone to which you want to add a pod.</para></listitem>
+ <listitem><para>Click the Compute and Storage tab. In the Pods node of the diagram, click View All.</para></listitem>
+ <listitem><para>Click Add Pod.</para></listitem>
+ <listitem><para>Enter the following details in the dialog.</para>
+ <itemizedlist>
+ <listitem><para><emphasis role="bold">Name.</emphasis> The name of the pod.</para></listitem>
+ <listitem><para><emphasis role="bold">Gateway.</emphasis> The gateway for the hosts in that pod.</para></listitem>
+ <listitem><para><emphasis role="bold">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 System Reserved IP Addresses.</para></listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para>Click OK.</para></listitem>
+ </orderedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/port-forwarding.xml
----------------------------------------------------------------------
diff --git a/en-US/port-forwarding.xml b/en-US/port-forwarding.xml
new file mode 100644
index 0000000..1bbba45
--- /dev/null
+++ b/en-US/port-forwarding.xml
@@ -0,0 +1,51 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- 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="port-forwarding">
+ <title>Port Forwarding</title>
+ <para>A port forward service is a set of port forwarding rules that define a policy. A port forward service is then applied to one or more guest VMs. The guest VM then has its inbound network access managed according to the policy defined by the port forwarding service. You can optionally specify one or more CIDRs to filter the source IPs. This is useful when you want to allow only incoming requests from certain IP addresses to be forwarded.</para>
+ <para>A guest VM can be in any number of port forward services. Port forward services can be defined but have no members. If a guest VM is part of more than one network, port forwarding rules will function only if they are defined on the default network</para>
+ <para>You cannot use port forwarding to open ports for an elastic IP address. When elastic IP is used, outside access is instead controlled through the use of security groups. See Security Groups.</para>
+ <para>To set up port forwarding:</para>
+ <orderedlist>
+ <listitem><para>Log in to the &PRODUCT; UI as an administrator or end user.</para></listitem>
+ <listitem><para>If you have not already done so, add a public IP address range to a zone in &PRODUCT;. See Adding a Zone and Pod in the Installation Guide.</para></listitem>
+ <listitem><para>Add one or more VM instances to &PRODUCT;.</para></listitem>
+ <listitem><para>In the left navigation bar, click Network.</para></listitem>
+ <listitem><para>Click the name of the guest network where the VMs are running.</para>
+ </listitem>
+ <listitem><para>Choose an existing IP address or acquire a new IP address. See <xref linkend="acquire-new-ip-address"/>. Click the name of the IP address in the list.</para></listitem>
+ <listitem><para>Click the Configuration tab.</para></listitem>
+ <listitem><para>In the Port Forwarding node of the diagram, click View All.</para></listitem>
+ <listitem><para>Fill in the following:</para>
+ <itemizedlist>
+ <listitem><para><emphasis role="bold">Public Port</emphasis>. The port to which public traffic will be
+ addressed on the IP address you acquired in the previous step.</para></listitem>
+ <listitem><para><emphasis role="bold">Private Port</emphasis>. The port on which the instance is listening for
+ forwarded public traffic.</para></listitem>
+ <listitem><para><emphasis role="bold">Protocol</emphasis>. The communication protocol in use between the two
+ ports</para></listitem>
+ </itemizedlist></listitem>
+ <listitem><para>Click Add.</para></listitem>
+ </orderedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/portable-ip.xml
----------------------------------------------------------------------
diff --git a/en-US/portable-ip.xml b/en-US/portable-ip.xml
new file mode 100644
index 0000000..f9ae395
--- /dev/null
+++ b/en-US/portable-ip.xml
@@ -0,0 +1,145 @@
+<?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="portable-ip">
+ <title>Portable IPs</title>
+ <section id="about-pip">
+ <title>About Portable IP</title>
+ <para>Portable IPs in &PRODUCT; are region-level pool of IPs, which are elastic in nature, that
+ can be transferred across geographically separated zones. As an administrator, you can
+ provision a pool of portable public IPs at region level and are available for user
+ consumption. The users can acquire portable IPs if admin has provisioned portable IPs at the
+ region level they are part of. These IPs can be use for any service within an advanced zone.
+ You can also use portable IPs for EIP services in basic zones. </para>
+ <para>The salient features of Portable IP are as follows:<itemizedlist>
+ <listitem>
+ <para>IP is statically allocated </para>
+ </listitem>
+ <listitem>
+ <para>IP need not be associated with a network </para>
+ </listitem>
+ <listitem>
+ <para>IP association is transferable across networks </para>
+ </listitem>
+ <listitem>
+ <para>IP is transferable across both Basic and Advanced zones </para>
+ </listitem>
+ <listitem>
+ <para>IP is transferable across VPC, non-VPC isolated and shared networks </para>
+ </listitem>
+ <listitem>
+ <para>Portable IP transfer is available only for static NAT. </para>
+ </listitem>
+ </itemizedlist></para>
+ <formalpara>
+ <title>Guidelines</title>
+ <para>Before transferring to another network, ensure that no network rules (Firewall, Static
+ NAT, Port Forwarding, and so on) exist on that portable IP.</para>
+ </formalpara>
+ </section>
+ <section id="config-pip">
+ <title>Configuring Portable IPs</title>
+ <orderedlist>
+ <listitem>
+ <para>Log in to the &PRODUCT; UI as an administrator or end user.</para>
+ </listitem>
+ <listitem>
+ <para>In the left navigation, click Regions.</para>
+ </listitem>
+ <listitem>
+ <para>Choose the Regions that you want to work with.</para>
+ </listitem>
+ <listitem>
+ <para>Click View Portable IP.</para>
+ </listitem>
+ <listitem>
+ <para>Click Portable IP Range.</para>
+ <para>The Add Portable IP Range window is displayed.</para>
+ </listitem>
+ <listitem>
+ <para>Specify the following:</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Start IP/ End IP</emphasis>: A range of IP addresses that
+ are accessible from the Internet and will be allocated to guest VMs. Enter the first
+ and last IP addresses that define a range that &PRODUCT; can assign to guest
+ VMs.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Gateway</emphasis>: The gateway in use for the Portable IP
+ addresses you are configuring.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Netmask</emphasis>: The netmask associated with the Portable
+ IP range.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">VLAN</emphasis>: The VLAN that will be used for public
+ traffic.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>Click OK.</para>
+ </listitem>
+ </orderedlist>
+ </section>
+ <section id="acquire-pip">
+ <title>Acquiring a Portable IP</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>Click the name of the network where you want to work with.</para>
+ </listitem>
+ <listitem>
+ <para>Click View IP Addresses.</para>
+ </listitem>
+ <listitem>
+ <para>Click Acquire New IP.</para>
+ <para>The Acquire New IP window is displayed.</para>
+ </listitem>
+ <listitem>
+ <para>Specify whether you want cross-zone IP or not.</para>
+ </listitem>
+ <listitem>
+ <para>Click Yes in the confirmation dialog.</para>
+ <para>Within a few moments, the new IP address should appear with the state Allocated. You
+ can now use the IP address in port forwarding or static NAT rules.</para>
+ </listitem>
+ </orderedlist>
+ </section>
+ <section id="transfer-pip">
+ <title>Transferring Portable IP</title>
+ <para>An IP can be transferred from one network to another only if Static NAT is enabled.
+ However, when a portable IP is associated with a network, you can use it for any service in
+ the network. </para>
+ <para>To transfer a portable IP across the networks, execute the following API:</para>
+ <programlisting>http://localhost:8096/client/api?command=enableStaticNat&response=json&ipaddressid=a4bc37b2-4b4e-461d-9a62-b66414618e36&virtualmachineid=a242c476-ef37-441e-9c7b-b303e2a9cb4f&networkid=6e7cd8d1-d1ba-4c35-bdaf-333354cbd49810 </programlisting>
+ <para>Replace the UUID with appropriate UUID. For example, if you want to transfer a portable IP
+ to network X and VM Y in a network, execute the following:</para>
+ <programlisting>http://localhost:8096/client/api?command=enableStaticNat&response=json&ipaddressid=a4bc37b2-4b4e-461d-9a62-b66414618e36&virtualmachineid=Y&networkid=X
+ </programlisting>
+ </section>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/prepare-system-vm-template.xml
----------------------------------------------------------------------
diff --git a/en-US/prepare-system-vm-template.xml b/en-US/prepare-system-vm-template.xml
new file mode 100644
index 0000000..35cc7e9
--- /dev/null
+++ b/en-US/prepare-system-vm-template.xml
@@ -0,0 +1,79 @@
+<?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="prepare-system-vm-template">
+ <title>Prepare the System VM Template</title>
+ <para>Secondary storage must be seeded with a template that is used for &PRODUCT; system VMs.
+ Citrix provides you with the necessary binary package of the system VM.</para>
+ <note>
+ <para>When copying and pasting a command, ensure that the command has pasted as a single line
+ before executing. Some document viewers may introduce unwanted line breaks in copied
+ text.</para>
+ </note>
+ <orderedlist>
+ <listitem>
+ <para>If you are using a separate NFS server, mount the secondary storage on your Management
+ Server. Replace the example NFS server name and NFS share paths below with your own.</para>
+ <programlisting># mount -t nfs nfsservername:/nfs/share/secondary /mnt/secondary</programlisting>
+ <para>If your secondary storage mount point is not named /mnt/secondary, substitute your own
+ mount point name.</para>
+ </listitem>
+ <listitem>
+ <para>On the Management Server, run one or more of the following cloud-install-sys-tmplt
+ commands to retrieve and decompress the system VM template. Run the command for each
+ hypervisor type that you expect end users to run in this Zone.</para>
+ <para>If you set the &PRODUCT; database encryption type to "web" when you set up the database,
+ you must now add the parameter -s <management-server-secret-key>. See <xref
+ linkend="about-password-encryption"/>.</para>
+ <para>This process will require approximately 5 GB of free space on the local file system and
+ up to 30 minutes each time it runs.</para>
+ <itemizedlist>
+ <listitem>
+ <para>For XenServer:</para>
+ <programlisting># /usr/lib64/cloud/common/scripts/storage/secondary/cloud-install-sys-tmplt -m /mnt/secondary -u http://download.cloud.com/templates/acton/acton-systemvm-02062012.vhd.bz2 -h xenserver -s <optional-management-server-secret-key> -F</programlisting>
+ </listitem>
+ <listitem>
+ <para>For vSphere:</para>
+ <programlisting># /usr/lib64/cloud/common/scripts/storage/secondary/cloud-install-sys-tmplt -m /mnt/secondary -u http://download.cloud.com/templates/acton/acton-systemvm-02062012.ova -h vmware -s <optional-management-server-secret-key> -F</programlisting>
+ </listitem>
+ <listitem>
+ <para>For KVM:</para>
+ <programlisting># /usr/lib64/cloud/common/scripts/storage/secondary/cloud-install-sys-tmplt -m /mnt/secondary -u http://download.cloud.com/templates/acton/acton-systemvm-02062012.qcow2.bz2 -h kvm -s <optional-management-server-secret-key> -F</programlisting>
+ </listitem>
+ <listitem>
+ <para>For LXC:</para>
+ <programlisting># /usr/lib64/cloud/common/scripts/storage/secondary/cloud-install-sys-tmplt -m /mnt/secondary -u http://download.cloud.com/templates/acton/acton-systemvm-02062012.qcow2.bz2 -h lxc -s <optional-management-server-secret-key> -F</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>When the script has finished, unmount secondary storage and remove the created
+ directory.</para>
+ <programlisting># umount /mnt/secondary
+# rmdir /mnt/secondary</programlisting>
+ </listitem>
+ <listitem>
+ <para>Repeat these steps for each secondary storage server.</para>
+ </listitem>
+ </orderedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/primary-storage-add.xml
----------------------------------------------------------------------
diff --git a/en-US/primary-storage-add.xml b/en-US/primary-storage-add.xml
new file mode 100644
index 0000000..d18dece
--- /dev/null
+++ b/en-US/primary-storage-add.xml
@@ -0,0 +1,163 @@
+<?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="primary-storage-add">
+ <title>Add Primary Storage</title>
+ <section id="sys-require-primary-storage">
+ <title>System Requirements for Primary Storage</title>
+ <para>Hardware requirements:</para>
+ <itemizedlist>
+ <listitem><para>Any standards-compliant iSCSI or NFS server that is supported by the underlying hypervisor.</para></listitem>
+ <listitem><para>The storage server should be a machine with a large number of disks. The disks should ideally be managed by a hardware RAID controller.</para></listitem>
+ <listitem><para>Minimum required capacity depends on your needs.</para></listitem>
+ </itemizedlist>
+ <para>When setting up primary storage, follow these restrictions:</para>
+ <itemizedlist>
+ <listitem><para>Primary storage cannot be added until a host has been added to the cluster.</para></listitem>
+ <listitem><para>If you do not provision shared primary storage, you must set the global configuration parameter system.vm.local.storage.required to true, or else you will not be able to start VMs.</para></listitem>
+ </itemizedlist>
+ </section>
+ <section id="adding-primary-storage">
+ <title>Adding Primary Storage</title>
+ <para>When you create a new zone, the first primary storage is added as part of that procedure. You can add primary storage servers at any time, such as when adding a new cluster or adding more servers to an existing cluster.</para>
+ <warning><para>When using preallocated storage for primary storage, be sure there is nothing on the storage (ex. you have an empty SAN volume or an empty NFS share). Adding the storage to &PRODUCT; will destroy any existing data.</para></warning>
+ <note><para>Primary storage can also be added at the zone level through the &PRODUCT; API (adding zone-level primary storage is not yet supported through the &PRODUCT; UI).</para><para>Once primary storage has been added at the zone level, it can be managed through the &PRODUCT; UI.</para></note>
+ <orderedlist>
+ <listitem><para>Log in to the &PRODUCT; UI (see <xref linkend="log-in" />).</para></listitem>
+ <listitem><para>In the left navigation, choose Infrastructure. In Zones, click View More, then click the zone in which you want to add the primary storage.</para></listitem>
+ <listitem><para>Click the Compute tab.</para></listitem>
+ <listitem><para>In the Primary Storage node of the diagram, click View All.</para></listitem>
+ <listitem><para>Click Add Primary Storage.</para></listitem>
+ <listitem>
+ <para>Provide the following information in the dialog. The information required varies depending on your choice in Protocol.</para>
+ <itemizedlist>
+ <listitem><para><emphasis role="bold">Scope.</emphasis> Indicate whether the storage is available to all hosts in the zone or only to hosts in a single cluster.</para></listitem>
+ <listitem><para><emphasis role="bold">Pod.</emphasis> (Visible only if you choose Cluster in the Scope field.) The pod for the storage device.</para></listitem>
+ <listitem><para><emphasis role="bold">Cluster.</emphasis> (Visible only if you choose Cluster in the Scope field.) The cluster for the storage device.</para></listitem>
+ <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.</para></listitem>
+ <listitem><para><emphasis role="bold">Server (for NFS, iSCSI, or PreSetup).</emphasis> The IP address or DNS name of the storage device.</para></listitem>
+ <listitem><para><emphasis role="bold">Server (for VMFS).</emphasis> The IP address or DNS name of the vCenter server.</para></listitem>
+ <listitem><para><emphasis role="bold">Path (for NFS).</emphasis> In NFS this is the exported path from the server.</para></listitem>
+ <listitem><para><emphasis role="bold">Path (for VMFS).</emphasis> In vSphere this is 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">Path (for SharedMountPoint).</emphasis> With KVM this is the path on each host that is where this primary storage is mounted. For example, "/mnt/primary".</para></listitem>
+ <listitem><para><emphasis role="bold">SR Name-Label (for PreSetup).</emphasis> Enter the name-label of the SR that has been set up outside &PRODUCT;.</para></listitem>
+ <listitem><para><emphasis role="bold">Target IQN (for iSCSI).</emphasis> In iSCSI this is the IQN of the target. For example, iqn.1986-03.com.sun:02:01ec9bb549-1271378984.</para></listitem>
+ <listitem><para><emphasis role="bold">Lun # (for iSCSI).</emphasis> In iSCSI this is 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>
+ </listitem>
+ <listitem><para>Click OK.</para></listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>Configuring a Storage Plug-in</title>
+ <note>
+ <para>Primary storage that is based on a custom plug-in (ex. SolidFire) must be added through the &PRODUCT; API (described later in this section). There is no support at this time through the &PRODUCT; UI to add this type of primary storage (although most of its features are available through the &PRODUCT; UI).</para>
+ </note>
+ <note>
+ <para>At this time, a custom storage plug-in, such as the SolidFire storage plug-in, can only be leveraged for data disks (through Disk Offerings).</para>
+ </note>
+ <note>
+ <para>The SolidFire storage plug-in for &PRODUCT; is part of the standard &PRODUCT; install. There is no additional work required to add this component.</para>
+ </note>
+ <para>Adding primary storage that is based on the SolidFire plug-in enables &PRODUCT; to provide hard quality-of-service (QoS) guarantees.</para>
+ <para>When used with Disk Offerings, an administrator is able to build an environment in which a data disk that a user creates leads to the dynamic creation of a SolidFire volume, which has guaranteed performance. Such a SolidFire volume is associated with one (and only ever one) &PRODUCT; volume, so performance of the &PRODUCT; volume does not vary depending on how heavily other tenants are using the system.</para>
+ <para>The createStoragePool API has been augmented to support plugable storage providers. The following is a list of parameters to use when adding storage to &PRODUCT; that is based on the SolidFire plug-in:</para>
+ <itemizedlist>
+ <listitem>
+ <para>command=createStoragePool</para>
+ </listitem>
+ <listitem>
+ <para>scope=zone</para>
+ </listitem>
+ <listitem>
+ <para>zoneId=[your zone id]</para>
+ </listitem>
+ <listitem>
+ <para>name=[name for primary storage]</para>
+ </listitem>
+ <listitem>
+ <para>hypervisor=Any</para>
+ </listitem>
+ <listitem>
+ <para>provider=SolidFire</para>
+ </listitem>
+ <listitem>
+ <para>capacityIops=[whole number of IOPS from the SAN to give to &PRODUCT;]</para>
+ </listitem>
+ <listitem>
+ <para>capacityBytes=[whole number of bytes from the SAN to give to &PRODUCT;]</para>
+ </listitem>
+ </itemizedlist>
+ <para>The url parameter is somewhat unique in that its value can contain additional key/value pairs.</para>
+ <itemizedlist>
+ <para>url=[key/value pairs detailed below (values are URL encoded; for example, '=' is represented as '%3D')]</para>
+ <listitem>
+ <para>MVIP%3D[Management Virtual IP Address] (can be suffixed with :[port number])</para>
+ </listitem>
+ <listitem>
+ <para>SVIP%3D[Storage Virtual IP Address] (can be suffixed with :[port number])</para>
+ </listitem>
+ <listitem>
+ <para>clusterAdminUsername%3D[cluster admin's username]</para>
+ </listitem>
+ <listitem>
+ <para>clusterAdminPassword%3D[cluster admin's password]</para>
+ </listitem>
+ <listitem>
+ <para>clusterDefaultMinIops%3D[Min IOPS (whole number) to set for a volume; used if Min IOPS is not specified by administrator or user]</para>
+ </listitem>
+ <listitem>
+ <para>clusterDefaultMaxIops%3D[Max IOPS (whole number) to set for a volume; used if Max IOPS is not specified by administrator or user]</para>
+ </listitem>
+ <listitem>
+ <para>clusterDefaultBurstIopsPercentOfMaxIops%3D[Burst IOPS is determined by (Min IOPS * clusterDefaultBurstIopsPercentOfMaxIops parameter) (can be a decimal value)]
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>Example URL to add primary storage to &PRODUCT; based on the SolidFire plug-in (note that URL encoding is used with the value of the url key, so '%3A' equals ':','%3B' equals '&' and '%3D' equals '='):</para>
+ <para>
+ http://127.0.0.1:8080/client/api?command=createStoragePool
+ &scope=zone
+ &zoneId=cf4e6ddf-8ae7-4194-8270-d46733a52b55
+ &name=SolidFire_121258566
+ &url=MVIP%3D192.168.138.180%3A443
+ %3BSVIP%3D192.168.56.7
+ %3BclusterAdminUsername%3Dadmin
+ %3BclusterAdminPassword%3Dpassword
+ %3BclusterDefaultMinIops%3D200
+ %3BclusterDefaultMaxIops%3D300
+ %3BclusterDefaultBurstIopsPercentOfMaxIop%3D2.5
+ &provider=SolidFire
+ &tags=SolidFire_SAN_1
+ &capacityIops=4000000
+ &capacityBytes=2251799813685248
+ &hypervisor=Any
+ &response=json
+ &apiKey=VrrkiZQWFFgSdA6k3DYtoKLcrgQJjZXoSWzicHXt8rYd9Bl47p8L39p0p8vfDpiljtlcMLn_jatMSqCWv5Cs-Q&signature=wqf8KzcPpY2JmT1Sxk%2F%2BWbgX3l8%3D
+ </para>
+ </section>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/primary-storage-outage-and-data-loss.xml
----------------------------------------------------------------------
diff --git a/en-US/primary-storage-outage-and-data-loss.xml b/en-US/primary-storage-outage-and-data-loss.xml
new file mode 100644
index 0000000..e68d1d9
--- /dev/null
+++ b/en-US/primary-storage-outage-and-data-loss.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;
+]>
+
+<!-- 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="primary-storage-outage-and-data-loss">
+ <title>Primary Storage Outage and Data Loss</title>
+ <para>When a primary storage outage occurs the hypervisor immediately stops all VMs stored on that storage device. Guests that are marked for HA will be restarted as soon as practical when the primary storage comes back on line. With NFS, the hypervisor may allow the virtual machines to continue running depending on the nature of the issue. For example, an NFS hang will cause the guest VMs to be suspended until storage connectivity is restored.Primary storage is not designed to be backed up. Individual volumes in primary storage can be backed up using snapshots.</para>
+ </section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/primary-storage.xml
----------------------------------------------------------------------
diff --git a/en-US/primary-storage.xml b/en-US/primary-storage.xml
new file mode 100644
index 0000000..4ab37ef
--- /dev/null
+++ b/en-US/primary-storage.xml
@@ -0,0 +1,34 @@
+<?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="primary-storage">
+ <title>Primary Storage</title>
+ <para>This section gives concepts and technical details about &PRODUCT; primary storage. For information about how to install and configure primary storage through the &PRODUCT; UI, see the Installation Guide.</para>
+ <para><xref linkend="about-primary-storage"/></para>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="best-practices-primary-storage.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="runtime-behavior-of-primary-storage.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="hypervisor-support-for-primarystorage.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="storage-tags.xml"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="maintenance-mode-for-primary-storage.xml"/>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/private-public-template.xml
----------------------------------------------------------------------
diff --git a/en-US/private-public-template.xml b/en-US/private-public-template.xml
new file mode 100644
index 0000000..8556583
--- /dev/null
+++ b/en-US/private-public-template.xml
@@ -0,0 +1,30 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- 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="private-public-template">
+ <title>Private and Public Templates</title>
+ <para>When a user creates a template, it can be designated private or public.</para>
+ <para>Private templates are only available to the user who created them. By default, an uploaded template is private.</para>
+ <para>When a user marks a template as “public,” the template becomes available to all users in all accounts in the user's domain, as well as users in any other domains that have access to the Zone where the template is stored. This depends on whether the Zone, in turn, was defined as private or public. A private Zone is assigned to a single domain, and a public Zone is accessible to any domain. If a public template is created in a private Zone, it is available only to users in the domain assigned to that Zone. If a public template is created in a public Zone, it is available to all users in all domains.</para>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/projects-overview.xml
----------------------------------------------------------------------
diff --git a/en-US/projects-overview.xml b/en-US/projects-overview.xml
new file mode 100644
index 0000000..4f9a833
--- /dev/null
+++ b/en-US/projects-overview.xml
@@ -0,0 +1,31 @@
+<?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="projects-overview">
+ <title>Overview of Projects</title>
+ <para>Projects are used to organize people and resources. &PRODUCT; users within a single domain can group themselves into project teams so they can collaborate and share virtual resources such as VMs, snapshots, templates, data disks, and IP addresses. &PRODUCT; tracks resource usage per project as well as per user, so the usage can be billed to either a user account or a project. For example, a private cloud within a software company might have all members of the QA department assigned to one project, so the company can track the resources used in testing while the project members can more easily isolate their efforts from other users of the same cloud</para>
+ <para>You can configure &PRODUCT; to allow any user to create a new project, or you can restrict that ability to just &PRODUCT; administrators. Once you have created a project, you become that project’s administrator, and you can add others within your domain to the project. &PRODUCT; can be set up either so that you can add people directly to a project, or so that you have to send an invitation which the recipient must accept. Project members can view and manage all virtual resources created by anyone in the project (for example, share VMs). A user can be a member of any number of projects and can switch views in the &PRODUCT; UI to show only project-related information, such as project VMs, fellow project members, project-related alerts, and so on.</para>
+ <para>The project administrator can pass on the role to another project member. The project administrator can also add more members, remove members from the project, set new resource limits (as long as they are below the global defaults set by the &PRODUCT; administrator), and delete the project. When the administrator removes a member from the project, resources created by that user, such as VM instances, remain with the project. This brings us to the subject of resource ownership and which resources can be used by a project.</para>
+ <para>Resources created within a project are owned by the project, not by any particular &PRODUCT; account, and they can be used only within the project. A user who belongs to one or more projects can still create resources outside of those projects, and those resources belong to the user’s account; they will not be counted against the project’s usage or resource limits. You can create project-level networks to isolate traffic within the project and provide network services such as port forwarding, load balancing, VPN, and static NAT. A project can also make use of certain types of resources from outside the project, if those resources are shared. For example, a shared network or public template is available to any project in the domain. A project can get access to a private template if the template’s owner will grant permission. A project can use any service offering or disk offering available in its domain; however, you can not create private service and disk offerings a
t the project level..</para>
+</section>
+
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/projects.xml
----------------------------------------------------------------------
diff --git a/en-US/projects.xml b/en-US/projects.xml
new file mode 100644
index 0000000..39ce96b
--- /dev/null
+++ b/en-US/projects.xml
@@ -0,0 +1,35 @@
+<?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.
+-->
+
+<chapter id="projects">
+ <title>Using Projects to Organize Users and Resources</title>
+ <xi:include href="projects-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="configuring-projects.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="create-new-projects.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="add-members-to-projects.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="accept-membership-invite.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="suspend-project.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="use-project-view.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</chapter>
+
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/provisioning-auth-api.xml
----------------------------------------------------------------------
diff --git a/en-US/provisioning-auth-api.xml b/en-US/provisioning-auth-api.xml
new file mode 100644
index 0000000..0f28b1f
--- /dev/null
+++ b/en-US/provisioning-auth-api.xml
@@ -0,0 +1,29 @@
+<?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="provisioning-auth-api">
+ <title>Provisioning and Authentication API</title>
+ <para>&PRODUCT; expects that a customer will have their own user provisioning infrastructure. It provides APIs to integrate with these existing systems where the systems call out to &PRODUCT; to add/remove users..</para>
+ <para>&PRODUCT; supports pluggable authenticators. By default, &PRODUCT; assumes it is provisioned with the user’s password, and as a result authentication is done locally. However, external authentication is possible as well. For example, see Using an LDAP Server for User Authentication.</para>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/provisioning-steps-overview.xml
----------------------------------------------------------------------
diff --git a/en-US/provisioning-steps-overview.xml b/en-US/provisioning-steps-overview.xml
new file mode 100644
index 0000000..5fb6196
--- /dev/null
+++ b/en-US/provisioning-steps-overview.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="provisioning-steps-overview">
+ <title>Overview of Provisioning Steps</title>
+ <para>After the Management Server is installed and running, you can add the compute resources for it to manage. For an overview of how a &PRODUCT; cloud infrastructure is organized, see <xref linkend="cloud-infrastructure-overview" />.</para>
+ <para>To provision the cloud infrastructure, or to scale it up at any time, follow these procedures:</para>
+ <orderedlist>
+ <listitem><para>Define regions (optional). See <xref linkend="region-add"/>.</para></listitem>
+ <listitem><para>Add a zone to the region. See <xref linkend="zone-add" />.</para></listitem>
+ <listitem><para>Add more pods to the zone (optional). See <xref linkend="pod-add" />.</para></listitem>
+ <listitem><para>Add more clusters to the pod (optional). See <xref linkend="cluster-add" />.</para></listitem>
+ <listitem><para>Add more hosts to the cluster (optional). See <xref linkend="host-add" />.</para></listitem>
+ <listitem><para>Add primary storage to the cluster. See <xref linkend="primary-storage-add" />.</para></listitem>
+ <listitem><para>Add secondary storage to the zone. See <xref linkend="secondary-storage-add" />.</para></listitem>
+ <listitem><para>Initialize and test the new cloud. See <xref linkend="initialize-and-test" />.</para></listitem>
+ </orderedlist>
+ <para>When you have finished these steps, you will have a deployment with the following basic structure:</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/provisioning-overview.png" />
+ </imageobject>
+ <textobject><phrase>provisioning-overview.png: Conceptual overview of a basic deployment</phrase></textobject>
+ </mediaobject>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/provisioning-steps.xml
----------------------------------------------------------------------
diff --git a/en-US/provisioning-steps.xml b/en-US/provisioning-steps.xml
new file mode 100644
index 0000000..04ece13
--- /dev/null
+++ b/en-US/provisioning-steps.xml
@@ -0,0 +1,36 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- 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="provisioning-steps">
+ <title>Steps to Provisioning Your Cloud Infrastructure</title>
+ <para>This section tells how to add regions, zones, pods, clusters, hosts, storage, and networks to your cloud. If you are unfamiliar with these entities, please begin by looking through <xref linkend="cloud-infrastructure-concepts" />.</para>
+ <xi:include href="provisioning-steps-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="region-add.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="zone-add.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="pod-add.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="cluster-add.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="host-add.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="primary-storage-add.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="secondary-storage-add.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="initialize-and-test.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</chapter>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/pvlan.xml
----------------------------------------------------------------------
diff --git a/en-US/pvlan.xml b/en-US/pvlan.xml
new file mode 100644
index 0000000..38b2531
--- /dev/null
+++ b/en-US/pvlan.xml
@@ -0,0 +1,247 @@
+<?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="pvlan">
+ <title>Isolation in Advanced Zone Using Private VLAN</title>
+ <para>Isolation of guest traffic in shared networks can be achieved by using Private VLANs
+ (PVLAN). PVLANs provide Layer 2 isolation between ports within the same VLAN. In a PVLAN-enabled
+ shared network, a user VM cannot reach other user VM though they can reach the DHCP server and
+ gateway, this would in turn allow users to control traffic within a network and help them deploy
+ multiple applications without communication between application as well as prevent communication
+ with other users’ VMs.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Isolate VMs in a shared networks by using Private VLANs.</para>
+ </listitem>
+ <listitem>
+ <para>Supported on KVM, XenServer, and VMware hypervisors</para>
+ </listitem>
+ <listitem>
+ <para>PVLAN-enabled shared network can be a part of multiple networks of a guest VM.</para>
+ </listitem>
+ </itemizedlist>
+ <section id="about-pvlan">
+ <title>About Private VLAN</title>
+ <para>In an Ethernet switch, a VLAN is a broadcast domain where hosts can establish direct
+ communication with each another at Layer 2. Private VLAN is designed as an extension of VLAN
+ standard to add further segmentation of the logical broadcast domain. A regular VLAN is a
+ single broadcast domain, whereas a private VLAN partitions a larger VLAN broadcast domain into
+ smaller sub-domains. A sub-domain is represented by a pair of VLANs: a Primary VLAN and a
+ Secondary VLAN. The original VLAN that is being divided into smaller groups is called Primary,
+ which implies that all VLAN pairs in a private VLAN share the same Primary VLAN. All the
+ secondary VLANs exist only inside the Primary. Each Secondary VLAN has a specific VLAN ID
+ associated to it, which differentiates one sub-domain from another. </para>
+ <para>Three types of ports exist in a private VLAN domain, which essentially determine the
+ behaviour of the participating hosts. Each ports will have its own unique set of rules, which
+ regulate a connected host's ability to communicate with other connected host within the same
+ private VLAN domain. Configure each host that is part of a PVLAN pair can be by using one of
+ these three port designation:</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Promiscuous</emphasis>: A promiscuous port can communicate with
+ all the interfaces, including the community and isolated host ports that belong to the
+ secondary VLANs. In Promiscuous mode, hosts are connected to promiscuous ports and are
+ able to communicate directly with resources on both primary and secondary VLAN. Routers,
+ DHCP servers, and other trusted devices are typically attached to promiscuous
+ ports.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Isolated VLANs</emphasis>: The ports within an isolated VLAN
+ cannot communicate with each other at the layer-2 level. The hosts that are connected to
+ Isolated ports can directly communicate only with the Promiscuous resources. If your
+ customer device needs to have access only to a gateway router, attach it to an isolated
+ port.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Community VLANs</emphasis>: The ports within a community VLAN
+ can communicate with each other and with the promiscuous ports, but they cannot
+ communicate with the ports in other communities at the layer-2 level. In a Community mode,
+ direct communication is permitted only with the hosts in the same community and those that
+ are connected to the Primary PVLAN in promiscuous mode. If your customer has two devices
+ that need to be isolated from other customers' devices, but to be able to communicate
+ among themselves, deploy them in community ports.</para>
+ </listitem>
+ </itemizedlist>
+ <para>For further reading:</para>
+ <itemizedlist>
+ <listitem>
+ <para><ulink
+ url="http://www.cisco.com/en/US/docs/switches/lan/catalyst3750/software/release/12.2_25_see/configuration/guide/swpvlan.html#wp1038379"
+ >Understanding Private VLANs</ulink></para>
+ </listitem>
+ <listitem>
+ <para><ulink url="http://tools.ietf.org/html/rfc5517">Cisco Systems' Private VLANs: Scalable
+ Security in a Multi-Client Environment</ulink></para>
+ </listitem>
+ <listitem>
+ <para><ulink url="http://kb.vmware.com">Private VLAN (PVLAN) on vNetwork Distributed Switch
+ - Concept Overview (1010691)</ulink></para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="prereq-pvlan">
+ <title>Prerequisites</title>
+ <itemizedlist>
+ <listitem>
+ <para>Use a PVLAN supported switch.</para>
+ <para>See <ulink
+ url="http://www.cisco.com/en/US/products/hw/switches/ps708/products_tech_note09186a0080094830.shtml"
+ >Private VLAN Catalyst Switch Support Matrix</ulink>for more information.</para>
+ </listitem>
+ <listitem>
+ <para>All the layer 2 switches, which are PVLAN-aware, are connected to each other, and one
+ of them is connected to a router. All the ports connected to the host would be configured
+ in trunk mode. Open Management VLAN, Primary VLAN (public) and Secondary Isolated VLAN
+ ports. Configure the switch port connected to the router in PVLAN promiscuous trunk mode,
+ which would translate an isolated VLAN to primary VLAN for the PVLAN-unaware router. </para>
+ <para>Note that only Cisco Catalyst 4500 has the PVLAN promiscuous trunk mode to connect
+ both normal VLAN and PVLAN to a PVLAN-unaware switch. For the other Catalyst PVLAN support
+ switch, connect the switch to upper switch by using cables, one each for a PVLAN
+ pair.</para>
+ </listitem>
+ <listitem>
+ <para>Configure private VLAN on your physical switches out-of-band.</para>
+ </listitem>
+ <listitem>
+ <para>Before you use PVLAN on XenServer and KVM, enable Open vSwitch (OVS).</para>
+ <note>
+ <para>OVS on XenServer and KVM does not support PVLAN natively. Therefore, &PRODUCT;
+ managed to simulate PVLAN on OVS for XenServer and KVM by modifying the flow
+ table.</para>
+ </note>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="ability-pvlan">
+ <title>Creating a PVLAN-Enabled Guest Network</title>
+ <orderedlist>
+ <listitem>
+ <para>Log in to the &PRODUCT; UI as administrator.</para>
+ </listitem>
+ <listitem>
+ <para>In the left navigation, choose Infrastructure.</para>
+ </listitem>
+ <listitem>
+ <para>On Zones, click View More.</para>
+ </listitem>
+ <listitem>
+ <para>Click the zone to which you want to add a guest network.</para>
+ </listitem>
+ <listitem>
+ <para>Click the Physical Network tab.</para>
+ </listitem>
+ <listitem>
+ <para>Click the physical network you want to work with.</para>
+ </listitem>
+ <listitem>
+ <para>On the Guest node of the diagram, click Configure.</para>
+ </listitem>
+ <listitem>
+ <para>Click the Network tab.</para>
+ </listitem>
+ <listitem>
+ <para>Click Add guest network.</para>
+ <para>The Add guest network window is displayed.</para>
+ </listitem>
+ <listitem>
+ <para>Specify the following:</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Name</emphasis>: The name of the network. This will be
+ visible to the user.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Description</emphasis>: The short description of the network
+ that can be displayed to users.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">VLAN ID</emphasis>: The unique ID of the VLAN.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Secondary Isolated VLAN ID</emphasis>: The unique ID of the
+ Secondary Isolated VLAN. </para>
+ <para>For the description on Secondary Isolated VLAN, see <xref linkend="about-pvlan"
+ />.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Scope</emphasis>: The available scopes are Domain, Account,
+ Project, and All.</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Domain</emphasis>: Selecting Domain limits the scope of
+ this guest network to the domain you specify. The network will not be available
+ for other domains. If you select Subdomain Access, the guest network is available
+ to all the sub domains within the selected domain.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Account</emphasis>: The account for which the guest
+ network is being created for. You must specify the domain the account belongs
+ to.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Project</emphasis>: The project for which the guest
+ network is being created for. You must specify the domain the project belongs
+ to.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">All</emphasis>: The guest network is available for all
+ the domains, account, projects within the selected zone. </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Network Offering</emphasis>: If the administrator has
+ configured multiple network offerings, select the one you want to use for this
+ network.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Gateway</emphasis>: The gateway that the guests should
+ use.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Netmask</emphasis>: The netmask in use on the subnet the
+ guests will use.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">IP Range</emphasis>: A range of IP addresses that are
+ accessible from the Internet and are assigned to the guest VMs.</para>
+ <!--<para>If one NIC is used, these IPs should be in the same CIDR in the case of
+ IPv6.</para> -->
+ </listitem>
+ <!-- <listitem>
+ <para><emphasis role="bold">IPv6 CIDR</emphasis>: The network prefix that defines the
+ guest network subnet. This is the CIDR that describes the IPv6 addresses in use in the
+ guest networks in this zone. To allot IP addresses from within a particular address
+ block, enter a CIDR.</para>
+ </listitem> -->
+ <listitem>
+ <para><emphasis role="bold">Network Domain</emphasis>: A custom DNS suffix at the level
+ of a network. If you want to assign a special domain name to the guest VM network,
+ specify a DNS suffix.</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>Click OK to confirm.</para>
+ </listitem>
+ </orderedlist>
+ </section>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/query-filter.xml
----------------------------------------------------------------------
diff --git a/en-US/query-filter.xml b/en-US/query-filter.xml
new file mode 100644
index 0000000..1c0e493
--- /dev/null
+++ b/en-US/query-filter.xml
@@ -0,0 +1,60 @@
+<?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="query-filter">
+<title>Query Filter</title>
+<para>The query filter is used to find a mapped user in the external LDAP server. The query filter should uniquely map the &PRODUCT; user to LDAP user for a meaningful authentication. For more information about query filter syntax, consult the documentation for your LDAP server.</para>
+<para>The &PRODUCT; query filter wildcards are:</para>
+ <informaltable>
+ <tgroup cols="2" align="left" colsep="1" rowsep="1">
+ <thead>
+ <row>
+ <entry><para>Query Filter Wildcard</para></entry>
+ <entry><para>Description</para></entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><para>%u</para></entry>
+ <entry><para>User name</para></entry>
+ </row>
+ <row>
+ <entry><para>%e</para></entry>
+ <entry><para>Email address</para></entry>
+ </row>
+ <row>
+ <entry><para>%n</para></entry>
+ <entry><para>First and last name</para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+<para>The following examples assume you are using Active Directory, and refer to user attributes from the Active Directory schema.</para>
+<para>If the &PRODUCT; user name is the same as the LDAP user ID:</para>
+<programlisting>(uid=%u)</programlisting>
+<para>If the &PRODUCT; user name is the LDAP display name:</para>
+<programlisting>(displayName=%u)</programlisting>
+<para>To find a user by email address:</para>
+<programlisting>(mail=%e)</programlisting>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/re-install-hosts.xml
----------------------------------------------------------------------
diff --git a/en-US/re-install-hosts.xml b/en-US/re-install-hosts.xml
new file mode 100644
index 0000000..b8092ad
--- /dev/null
+++ b/en-US/re-install-hosts.xml
@@ -0,0 +1,26 @@
+<?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="re-install-hosts">
+ <title>Re-Installing Hosts</title>
+ <para>You can re-install a host after placing it in maintenance mode and then removing it. If a
+ host is down and cannot be placed in maintenance mode, it should still be removed before the
+ re-install.</para>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/region-add.xml
----------------------------------------------------------------------
diff --git a/en-US/region-add.xml b/en-US/region-add.xml
new file mode 100644
index 0000000..212047a
--- /dev/null
+++ b/en-US/region-add.xml
@@ -0,0 +1,151 @@
+<?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="region-add">
+ <title>Adding Regions (optional)</title>
+ <para>Grouping your cloud resources into geographic regions is an optional step when provisioning the cloud.
+ For an overview of regions, see <xref linkend="about-regions"/>.</para>
+ <section id="region-first">
+ <title>The First Region: The Default Region</title>
+ <para>If you do not take action to define regions, then all the zones in your cloud will be
+ automatically grouped into a single default region. This region is assigned the region
+ ID of 1. You can change the name or URL of the default region by displaying the region in
+ the &PRODUCT; UI and clicking the Edit button.</para>
+ </section>
+ <section id="region-add-2">
+ <title>Adding a Region</title>
+ <para>Use these steps to add a second region in addition to the default region.</para>
+ <orderedlist>
+ <listitem><para>Each region has its own &PRODUCT; instance. Therefore, the first step of creating a new region
+ is to install the Management Server software, on one or more nodes, in the
+ geographic area where you want to set up the new region. Use the steps in the
+ Installation guide. When you come to the step where you set up the database, use
+ the additional command-line flag <code>-r <region_id></code> to set a
+ region ID for the new region. The default region is automatically assigned a
+ region ID of 1, so your first additional region might be region 2.</para>
+ <programlisting>cloudstack-setup-databases cloud:<dbpassword>@localhost --deploy-as=root:<password> -e <encryption_type> -m <management_server_key> -k <database_key> -r <region_id></programlisting>
+ </listitem>
+ <listitem><para>By the end of the installation procedure, the Management Server should have been started. Be sure that the Management Server installation was successful and complete.</para></listitem>
+ <listitem><para>Now add the new region to region 1 in &PRODUCT;.</para>
+ <orderedlist numeration="loweralpha">
+ <listitem><para>Log in to &PRODUCT; in the first region as root administrator
+ (that is, log in to <region.1.IP.address>:8080/client).</para></listitem>
+ <listitem><para>In the left navigation bar, click Regions.</para></listitem>
+ <listitem><para>Click Add Region. In the dialog, fill in the following fields:</para>
+ <itemizedlist>
+ <listitem><para>ID. A unique identifying number. Use the same number
+ you set in the database during Management Server installation in the new region;
+ for example, 2.</para></listitem>
+ <listitem><para>Name. Give the new region a descriptive name.</para></listitem>
+ <listitem><para>Endpoint. The URL where you can log in to the Management Server in the new region.
+ This has the format <region.2.IP.address>:8080/client.</para></listitem>
+ </itemizedlist>
+ </listitem>
+ </orderedlist>
+ </listitem>
+ <listitem><para>Now perform the same procedure in reverse. Log in to region 2, and add region 1.</para></listitem>
+ <listitem><para>Copy the account, user, and domain tables from the region 1 database to the region 2 database.</para>
+ <para>In the following commands, it is assumed that you have set the root password on the
+ database, which is a &PRODUCT; recommended best practice. Substitute your own MySQL
+ root password.</para>
+ <orderedlist numeration="loweralpha">
+ <listitem><para>First, run this command to copy the contents of the database:</para>
+ <programlisting># mysqldump -u root -p<mysql_password> -h <region1_db_host> cloud account user domain > region1.sql</programlisting>
+ </listitem>
+ <listitem><para>Then run this command to put the data onto the region 2 database:</para>
+ <programlisting># mysql -u root -p<mysql_password> -h <region2_db_host> cloud < region1.sql</programlisting>
+ </listitem>
+ </orderedlist>
+ </listitem>
+ <listitem><para>Remove project accounts. Run these commands on the region 2 database:</para>
+ <programlisting>mysql> delete from account where type = 5;</programlisting>
+ </listitem>
+ <listitem><para>Set the default zone as null:</para>
+ <programlisting>mysql> update account set default_zone_id = null;</programlisting>
+ </listitem>
+ <listitem><para>Restart the Management Servers in region 2.</para></listitem>
+ </orderedlist>
+ </section>
+ <section id="region-add-n">
+ <title>Adding Third and Subsequent Regions</title>
+ <para>To add the third region, and subsequent additional regions, the steps are similar to those for adding the second region.
+ However, you must repeat certain steps additional times for each additional region:</para>
+ <orderedlist>
+ <listitem><para>Install &PRODUCT; in each additional region. Set the region ID for each region during the database setup step.</para>
+ <programlisting>cloudstack-setup-databases cloud:<dbpassword>@localhost --deploy-as=root:<password> -e <encryption_type> -m <management_server_key> -k <database_key> -r <region_id></programlisting></listitem>
+ <listitem><para>Once the Management Server is running, add your new region to all existing regions by
+ repeatedly using the Add Region button in the UI. For example, if you were adding
+ region 3:</para>
+ <orderedlist numeration="loweralpha">
+ <listitem><para>Log in to &PRODUCT; in the first region as root administrator
+ (that is, log in to <region.1.IP.address>:8080/client), and add a region with ID 3, the name of region 3, and the endpoint <region.3.IP.address>:8080/client.</para></listitem>
+ <listitem><para>Log in to &PRODUCT; in the second region as root administrator (that is, log in to <region.2.IP.address>:8080/client), and add a region with ID 3, the name of region 3, and the endpoint <region.3.IP.address>:8080/client.</para></listitem>
+ </orderedlist>
+ </listitem>
+ <listitem><para>Repeat the procedure in reverse to add all existing regions to the new region. For example,
+ for the third region, add the other two existing regions:</para>
+ <orderedlist numeration="loweralpha">
+ <listitem><para>Log in to &PRODUCT; in the third region as root administrator
+ (that is, log in to <region.3.IP.address>:8080/client).</para></listitem>
+ <listitem><para>Add a region with ID 1, the name of region 1, and the endpoint <region.1.IP.address>:8080/client.</para></listitem>
+ <listitem><para>Add a region with ID 2, the name of region 2, and the endpoint <region.2.IP.address>:8080/client.</para></listitem>
+ </orderedlist>
+ </listitem>
+ <listitem><para>Copy the account, user, and domain tables from any existing region's database to the new
+ region's database.</para>
+ <para>In the following commands, it is assumed that you have set the root password on the
+ database, which is a &PRODUCT; recommended best practice. Substitute your own MySQL
+ root password.</para>
+ <orderedlist numeration="loweralpha">
+ <listitem><para>First, run this command to copy the contents of the database:</para>
+ <programlisting># mysqldump -u root -p<mysql_password> -h <region1_db_host> cloud account user domain > region1.sql</programlisting>
+ </listitem>
+ <listitem><para>Then run this command to put the data onto the new region's database. For example, for region
+ 3:</para>
+ <programlisting># mysql -u root -p<mysql_password> -h <region3_db_host> cloud < region1.sql</programlisting>
+ </listitem>
+ </orderedlist>
+ </listitem>
+ <listitem><para>Remove project accounts. Run these commands on the region 3 database:</para>
+ <programlisting>mysql> delete from account where type = 5;</programlisting>
+ </listitem>
+ <listitem><para>Set the default zone as null:</para>
+ <programlisting>mysql> update account set default_zone_id = null;</programlisting>
+ </listitem>
+ <listitem><para>Restart the Management Servers in the new region.</para></listitem>
+ </orderedlist>
+ </section>
+ <section id="region-delete">
+ <title>Deleting a Region</title>
+ <para>Log in to each of the other regions, navigate to the one you want to delete, and click Remove Region.
+ For example, to remove the third region in a 3-region cloud:</para>
+ <orderedlist>
+ <listitem><para>Log in to <region.1.IP.address>:8080/client.</para></listitem>
+ <listitem><para>In the left navigation bar, click Regions.</para></listitem>
+ <listitem><para>Click the name of the region you want to delete.</para></listitem>
+ <listitem><para>Click the Remove Region button.</para></listitem>
+ <listitem><para>Repeat these steps for <region.2.IP.address>:8080/client.</para></listitem>
+ </orderedlist>
+ </section>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/release-ip-address.xml
----------------------------------------------------------------------
diff --git a/en-US/release-ip-address.xml b/en-US/release-ip-address.xml
new file mode 100644
index 0000000..9fdccd7
--- /dev/null
+++ b/en-US/release-ip-address.xml
@@ -0,0 +1,43 @@
+<?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="release-ip-address">
+ <title>Releasing an IP Address</title>
+ <para>When the last rule for an IP address is removed, you can release that IP address. The IP address still belongs to the VPC; however, it can be picked up for any guest network again.</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>Click the name of the network where you want to work with.</para></listitem>
+ <listitem><para>Click View IP Addresses.</para></listitem>
+ <listitem><para>Click the IP address you want to release.</para>
+ </listitem>
+ <listitem><para>Click the Release IP button. <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="./images/release-ip-icon.png"/>
+ </imageobject>
+ <textobject>
+ <phrase>ReleaseIPButton.png: button to release an IP</phrase>
+ </textobject>
+ </inlinemediaobject></para></listitem>
+ </orderedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/release-ip-for-vpc.xml
----------------------------------------------------------------------
diff --git a/en-US/release-ip-for-vpc.xml b/en-US/release-ip-for-vpc.xml
new file mode 100644
index 0000000..f827b67
--- /dev/null
+++ b/en-US/release-ip-for-vpc.xml
@@ -0,0 +1,95 @@
+<?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="release-ip-for-vpc">
+ <title>Releasing an IP Address Alloted to a VPC</title>
+ <para>The IP address is a limited resource. If you no longer need a particular IP, you can
+ disassociate it from its VPC and return it to the pool of available addresses. An IP address can
+ be released from its tier, only when all the networking ( port forwarding, load balancing, or
+ StaticNAT ) rules are removed for this IP address. The released IP address will still belongs to
+ the same 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 VPCs that you have created for the account is listed in the page.</para>
+ </listitem>
+ <listitem>
+ <para>Click the Configure button of the VPC whose IP you want to release.</para>
+ <para>The VPC page is displayed where all the tiers you created are listed in a
+ diagram.</para>
+ <para>The following options are displayed.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Internal LB</para>
+ </listitem>
+ <listitem>
+ <para>Public LB IP</para>
+ </listitem>
+ <listitem>
+ <para>Static NAT</para>
+ </listitem>
+ <listitem>
+ <para>Virtual Machines</para>
+ </listitem>
+ <listitem>
+ <para>CIDR</para>
+ </listitem>
+ </itemizedlist>
+ <para>The following router information is displayed:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Private Gateways</para>
+ </listitem>
+ <listitem>
+ <para>Public IP Addresses</para>
+ </listitem>
+ <listitem>
+ <para>Site-to-Site VPNs</para>
+ </listitem>
+ <listitem>
+ <para>Network ACL Lists</para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>Select Public IP Addresses.</para>
+ <para>The IP Addresses page is displayed.</para>
+ </listitem>
+ <listitem>
+ <para>Click the IP you want to release.</para>
+ </listitem>
+ <listitem>
+ <para>In the Details tab, click the Release IP button <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="./images/release-ip-icon.png"/>
+ </imageobject>
+ <textobject>
+ <phrase>release-ip-icon.png: button to release an IP.</phrase>
+ </textobject>
+ </inlinemediaobject></para>
+ </listitem>
+ </orderedlist>
+</section>