You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by hu...@apache.org on 2012/10/06 00:32:45 UTC
[22/49] git commit: Doc : Installation Guide. Adds missing files and
images, fixes a few issues. CLOUDSTACK-253
Doc : Installation Guide. Adds missing files and images, fixes a few issues. CLOUDSTACK-253
Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/742d9bbb
Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/742d9bbb
Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/742d9bbb
Branch: refs/heads/maven-to-rpm
Commit: 742d9bbbeb226d72482eb09c735cf0c317b99826
Parents: 1ca2e18
Author: Jessica Tomechak <je...@gmail.com>
Authored: Thu Oct 4 19:04:19 2012 -0700
Committer: Hugo Trippaers <ht...@schubergphilis.com>
Committed: Sat Oct 6 00:30:27 2012 +0200
----------------------------------------------------------------------
docs/en-US/Installation_Guide.xml | 6 +-
docs/en-US/Revision_History_Install_Guide.xml | 55 +++++++++
docs/en-US/add-clusters-ovm.xml | 24 ++++
docs/en-US/choosing-a-deployment-architecture.xml | 29 +++++
docs/en-US/citrix-xenserver-installation.xml | 48 ++++----
docs/en-US/cluster-add.xml | 39 ++++---
docs/en-US/host-add-vsphere.xml | 28 +++++
docs/en-US/host-add-xenserver-kvm-ovm.xml | 88 +++++++++++++++
docs/en-US/hypervisor-installation.xml | 29 +++++
docs/en-US/hypervisor-kvm-install-flow.xml | 34 ++++++
docs/en-US/images/large-scale-redundant-setup.png | Bin 0 -> 109117 bytes
docs/en-US/images/multi-node-management-server.png | Bin 0 -> 26912 bytes
docs/en-US/images/multi-site-deployment.png | Bin 0 -> 68190 bytes
docs/en-US/images/nic-bonding-and-multipath-io.png | Bin 0 -> 42030 bytes
docs/en-US/images/separate-storage-network.png | Bin 0 -> 44556 bytes
docs/en-US/images/small-scale-deployment.png | Bin 0 -> 50772 bytes
docs/en-US/installation.xml | 1 +
docs/en-US/large_scale_redundant_setup.xml | 4 +-
docs/en-US/log-in.xml | 44 ++++----
docs/en-US/multi_node_management_server.xml | 4 +-
docs/en-US/multi_site_deployment.xml | 8 +-
docs/en-US/pod-add.xml | 51 ++++++---
docs/en-US/provisioning-steps.xml.orig | 42 +++++++
docs/en-US/provisioning.xml | 25 ----
docs/en-US/small_scale_deployment.xml | 4 +-
docs/en-US/using-sshkeys.xml | 51 +++++---
docs/publican-trial-install.cfg | 29 -----
27 files changed, 476 insertions(+), 167 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/Installation_Guide.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/Installation_Guide.xml b/docs/en-US/Installation_Guide.xml
index 99d77f1..773fffb 100644
--- a/docs/en-US/Installation_Guide.xml
+++ b/docs/en-US/Installation_Guide.xml
@@ -45,9 +45,11 @@
<xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</bookinfo>
<xi:include href="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="cloud-infrastructure-concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="ui.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="provisioning.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="provisioning-steps.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="hypervisor-installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="choosing-a-deployment-architecture.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Revision_History_Install_Guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</book>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/Revision_History_Install_Guide.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/Revision_History_Install_Guide.xml b/docs/en-US/Revision_History_Install_Guide.xml
new file mode 100644
index 0000000..ee8dd31
--- /dev/null
+++ b/docs/en-US/Revision_History_Install_Guide.xml
@@ -0,0 +1,55 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<appendix id="appe-cloudstack-Revision_History">
+ <title>Revision History</title>
+ <simpara>
+ <revhistory>
+ <revision>
+ <revnumber>1-0</revnumber>
+ <date>October 5 2012</date>
+ <author>
+ <firstname>Jessica</firstname>
+ <surname>Tomechak</surname>
+ <email/>
+ </author>
+ <author>
+ <firstname>Radhika</firstname>
+ <surname>PC</surname>
+ <email/>
+ </author>
+ <author>
+ <firstname>Wido</firstname>
+ <surname>den Hollander</surname>
+ <email/>
+ </author>
+ <revdescription>
+ <simplelist>
+ <member>Initial publication</member>
+ </simplelist>
+ </revdescription>
+ </revision>
+ </revhistory>
+ </simpara>
+</appendix>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/add-clusters-ovm.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/add-clusters-ovm.xml b/docs/en-US/add-clusters-ovm.xml
new file mode 100644
index 0000000..d375a74
--- /dev/null
+++ b/docs/en-US/add-clusters-ovm.xml
@@ -0,0 +1,24 @@
+<?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;
+]>
+<section id="add-clusters-ovm">
+ <title>Add Cluster: OVM</title>
+ <para>To add a Cluster of hosts that run Oracle VM (OVM):</para>
+ <orderedlist>
+ <listitem><para>Add a companion non-OVM cluster to the Pod. This cluster provides an environment where the CloudPlatform System VMs can run. You should have already installed a non-OVM hypervisor on at least one Host to prepare for this step. Depending on which hypervisor you used:</para>
+ <itemizedlist>
+ <listitem><para>For VMWare, follow the steps in Add Cluster: vSphere. When finished, return here and continue with the next step.</para></listitem>
+ <listitem><para>For KVM or XenServer, follow the steps in <xref linkend="add-clusters-kvm-xenserver"/>. When finished, return here and continue with the next step</para></listitem>
+ </itemizedlist>
+ </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 cluster.</para></listitem>
+ <listitem><para>Click the Compute tab. In the Pods node, click View All. Select the same pod you used in step 1.</para></listitem>
+ <listitem><para>Click View Clusters, then click Add Cluster.</para>
+ <para>The Add Cluster dialog is displayed.</para></listitem>
+ <listitem><para>In Hypervisor, choose OVM.</para></listitem>
+ <listitem><para>In Cluster, enter a name for the cluster.</para></listitem>
+ <listitem><para>Click Add.</para></listitem>
+ </orderedlist>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/choosing-a-deployment-architecture.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/choosing-a-deployment-architecture.xml b/docs/en-US/choosing-a-deployment-architecture.xml
new file mode 100644
index 0000000..0503d8c
--- /dev/null
+++ b/docs/en-US/choosing-a-deployment-architecture.xml
@@ -0,0 +1,29 @@
+<!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="choosing-a-deployment_architecture">
+ <title>Choosing a Deployment Architecture</title>
+ <para>The architecture used in a deployment will vary depending on the size and purpose of the deployment. This section contains examples of deployment architecture, including a small-scale deployment useful for test and trial deployments and a fully-redundant large-scale setup for production deployments.</para>
+ <xi:include href="small_scale_deployment.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="large_scale_redundant_setup.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="separate_storage_network.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="multi_node_management_server.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="multi_site_deployment.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</chapter>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/citrix-xenserver-installation.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/citrix-xenserver-installation.xml b/docs/en-US/citrix-xenserver-installation.xml
index 75ba73d..b8ab592 100644
--- a/docs/en-US/citrix-xenserver-installation.xml
+++ b/docs/en-US/citrix-xenserver-installation.xml
@@ -100,11 +100,11 @@
<orderedlist>
<listitem>
<para>Install NTP.</para>
- <programlisting language="Bash"># yum install ntp</programlisting>
+ <programlisting># yum install ntp</programlisting>
</listitem>
<listitem>
<para>Edit the NTP configuration file to point to your NTP server.</para>
- <programlisting language="Bash"># vi /etc/ntp.conf</programlisting>
+ <programlisting># vi /etc/ntp.conf</programlisting>
<para>Add one or more server lines in this file with the names of the NTP servers you want to use. For example:</para>
<programlisting>
server 0.xenserver.pool.ntp.org
@@ -115,11 +115,11 @@ server 3.xenserver.pool.ntp.org
</listitem>
<listitem>
<para>Restart the NTP client.</para>
- <programlisting language="Bash"># service ntpd restart</programlisting>
+ <programlisting># service ntpd restart</programlisting>
</listitem>
<listitem>
<para>Make sure NTP will start again upon reboot.</para>
- <programlisting language="Bash"># chkconfig ntpd on</programlisting>
+ <programlisting># chkconfig ntpd on</programlisting>
</listitem>
</orderedlist>
</section>
@@ -153,15 +153,15 @@ server 3.xenserver.pool.ntp.org
</listitem>
<listitem>
<para>Extract the file:</para>
- <programlisting language="Bash"># tar xf xenserver-cloud-supp.tgz</programlisting>
+ <programlisting># tar xf xenserver-cloud-supp.tgz</programlisting>
</listitem>
<listitem>
<para>Run the following script:</para>
- <programlisting language="Bash"># xe-install-supplemental-pack xenserver-cloud-supp.iso</programlisting>
+ <programlisting># xe-install-supplemental-pack xenserver-cloud-supp.iso</programlisting>
</listitem>
<listitem>
<para>If the XenServer host is part of a zone that uses basic networking, disable Open vSwitch (OVS):</para>
- <programlisting language="Bash"># xe-switch-network-backend bridge</programlisting>
+ <programlisting># xe-switch-network-backend bridge</programlisting>
<para>Restart the host machine when prompted.</para>
</listitem>
</orderedlist>
@@ -175,12 +175,12 @@ server 3.xenserver.pool.ntp.org
<listitem><para>Connect FiberChannel cable to all hosts in the cluster and to the FiberChannel storage host.</para></listitem>
<listitem>
<para>Rescan the SCSI bus. Either use the following command or use XenCenter to perform an HBA rescan.</para>
- <programlisting language="Bash"># scsi-rescan</programlisting>
+ <programlisting># scsi-rescan</programlisting>
</listitem>
<listitem><para>Repeat step 2 on every host.</para></listitem>
<listitem>
<para>Check to be sure you see the new SCSI disk.</para>
- <programlisting language="Bash"># ls /dev/disk/by-id/scsi-360a98000503365344e6f6177615a516b -l</programlisting>
+ <programlisting># ls /dev/disk/by-id/scsi-360a98000503365344e6f6177615a516b -l</programlisting>
<para>The output should look like this, although the specific file name will be different (scsi-<scsiID>):</para>
<programlisting>
lrwxrwxrwx 1 root root 9 Mar 16 13:47
@@ -190,9 +190,9 @@ lrwxrwxrwx 1 root root 9 Mar 16 13:47
<listitem><para>Repeat step 4 on every host.</para></listitem>
<listitem>
<para>On the storage server, run this command to get a unique ID for the new SR.</para>
- <programlisting language="Bash"># uuidgen</programlisting>
+ <programlisting># uuidgen</programlisting>
<para>The output should look like this, although the specific ID will be different:</para>
- <programlisting language="Bash">e6849e96-86c3-4f2c-8fcc-350cc711be3d</programlisting>
+ <programlisting>e6849e96-86c3-4f2c-8fcc-350cc711be3d</programlisting>
</listitem>
<listitem>
<para>Create the FiberChannel SR. In name-label, use the unique ID you just generated.</para>
@@ -202,11 +202,11 @@ device-config:SCSIid=360a98000503365344e6f6177615a516b
name-label="e6849e96-86c3-4f2c-8fcc-350cc711be3d"
</programlisting>
<para>This command returns a unique ID for the SR, like the following example (your ID will be different):</para>
- <programlisting language="Bash">7a143820-e893-6c6a-236e-472da6ee66bf</programlisting>
+ <programlisting>7a143820-e893-6c6a-236e-472da6ee66bf</programlisting>
</listitem>
<listitem>
<para>To create a human-readable description for the SR, use the following command. In uuid, use the SR ID returned by the previous command. In name-description, set whatever friendly text you prefer.</para>
- <programlisting language="Bash"># xe sr-param-set uuid=7a143820-e893-6c6a-236e-472da6ee66bf name-description="Fiber Channel storage repository"</programlisting>
+ <programlisting># xe sr-param-set uuid=7a143820-e893-6c6a-236e-472da6ee66bf name-description="Fiber Channel storage repository"</programlisting>
<para>Make note of the values you will need when you add this storage to &PRODUCT; later (see <xref linkend="primary-storage-add" />). In the Add Primary Storage dialog, in Protocol, you will choose PreSetup. In SR Name-Label, you will enter the name-label you set earlier (in this example, e6849e96-86c3-4f2c-8fcc-350cc711be3d).</para>
</listitem>
<listitem><para>(Optional) If you want to enable multipath I/O on a FiberChannel SAN, refer to the documentation provided by the SAN vendor.</para></listitem>
@@ -238,7 +238,7 @@ name-label="e6849e96-86c3-4f2c-8fcc-350cc711be3d"
<listitem><para>Run xe network-list and find the public network. This is usually attached to the NIC that is public. Once you find the network make note of its UUID. Call this <UUID-Public>.</para></listitem>
<listitem>
<para>Run the following command.</para>
- <programlisting language="Bash"># xe network-param-set name-label=cloud-public uuid=<UUID-Public></programlisting>
+ <programlisting># xe network-param-set name-label=cloud-public uuid=<UUID-Public></programlisting>
</listitem>
</orderedlist>
</section>
@@ -250,7 +250,7 @@ name-label="e6849e96-86c3-4f2c-8fcc-350cc711be3d"
<listitem><para>Run xe network-list and find one of the guest networks. Once you find the network make note of its UUID. Call this <UUID-Guest>.</para></listitem>
<listitem>
<para>Run the following command, substituting your own name-label and uuid values.</para>
- <programlisting language="Bash"># xe network-param-set name-label=<cloud-guestN> uuid=<UUID-Guest></programlisting>
+ <programlisting># xe network-param-set name-label=<cloud-guestN> uuid=<UUID-Guest></programlisting>
</listitem>
<listitem><para>Repeat these steps for each additional guest network, using a different name-label and uuid each time.</para></listitem>
</orderedlist>
@@ -350,7 +350,7 @@ master-password=[your password]</programlisting>
<listitem><para>Copy the script from the Management Server in /usr/lib64/cloud/agent/scripts/vm/hypervisor/xenserver/cloud-setup-bonding.sh to the master host and ensure it is executable.</para></listitem>
<listitem>
<para>Run the script:</para>
- <programlisting language="Bash"># ./cloud-setup-bonding.sh</programlisting>
+ <programlisting># ./cloud-setup-bonding.sh</programlisting>
</listitem>
</orderedlist>
<para>Now the bonds are set up and configured properly across the cluster.</para>
@@ -398,11 +398,11 @@ master-password=[your password]</programlisting>
</listitem>
<listitem>
<para>Log in to one of the hosts in the cluster, and run this command to clean up the VLAN:</para>
- <programlisting language="Bash"># . /opt/xensource/bin/cloud-clean-vlan.sh</programlisting>
+ <programlisting># . /opt/xensource/bin/cloud-clean-vlan.sh</programlisting>
</listitem>
<listitem>
<para>Still logged in to the host, run the upgrade preparation script:</para>
- <programlisting language="Bash"># /opt/xensource/bin/cloud-prepare-upgrade.sh</programlisting>
+ <programlisting># /opt/xensource/bin/cloud-prepare-upgrade.sh</programlisting>
<para>Troubleshooting: If you see the error "can't eject CD," log in to the VM and umount the CD, then run the script again.</para>
</listitem>
<listitem>
@@ -416,7 +416,7 @@ master-password=[your password]</programlisting>
You attempted an operation on a VM which requires PV drivers to be installed but the drivers were not detected.
vm: b6cf79c8-02ee-050b-922f-49583d9f1a14 (i-2-8-VM)</programlisting>
<para>To solve this issue, run the following:</para>
- <programlisting language="Bash"># /opt/xensource/bin/make_migratable.sh b6cf79c8-02ee-050b-922f-49583d9f1a14</programlisting>
+ <programlisting># /opt/xensource/bin/make_migratable.sh b6cf79c8-02ee-050b-922f-49583d9f1a14</programlisting>
</listitem>
<listitem><para>Reboot the host.</para></listitem>
<listitem><para>Upgrade to the newer version of XenServer. Use the steps in XenServer documentation.</para></listitem>
@@ -455,13 +455,13 @@ vm: b6cf79c8-02ee-050b-922f-49583d9f1a14 (i-2-8-VM)</programlisting>
</listitem>
<listitem>
<para>Run the following script:</para>
- <programlisting language="Bash"># /opt/xensource/bin/setupxenserver.sh</programlisting>
+ <programlisting># /opt/xensource/bin/setupxenserver.sh</programlisting>
<para>Troubleshooting: If you see the following error message, you can safely ignore it.</para>
- <programlisting language="Bash">mv: cannot stat `/etc/cron.daily/logrotate': No such file or directory</programlisting>
+ <programlisting>mv: cannot stat `/etc/cron.daily/logrotate': No such file or directory</programlisting>
</listitem>
<listitem>
<para>Plug in the storage repositories (physical block devices) to the XenServer host:</para>
- <programlisting language="Bash"># for pbd in `xe pbd-list currently-attached=false| grep ^uuid | awk '{print $NF}'`; do xe pbd-plug uuid=$pbd ; done</programlisting>
+ <programlisting># for pbd in `xe pbd-list currently-attached=false| grep ^uuid | awk '{print $NF}'`; do xe pbd-plug uuid=$pbd ; done</programlisting>
<para>Note: If you add a host to this XenServer pool, you need to migrate all VMs on this host to other hosts, and eject this host from XenServer pool.</para>
</listitem>
</orderedlist>
@@ -469,7 +469,7 @@ vm: b6cf79c8-02ee-050b-922f-49583d9f1a14 (i-2-8-VM)</programlisting>
<listitem><para>Repeat these steps to upgrade every host in the cluster to the same version of XenServer.</para></listitem>
<listitem>
<para>Run the following command on one host in the XenServer cluster to clean up the host tags:</para>
- <programlisting language="Bash"># for host in $(xe host-list | grep ^uuid | awk '{print $NF}') ; do xe host-param-clear uuid=$host param-name=tags; done;</programlisting>
+ <programlisting># for host in $(xe host-list | grep ^uuid | awk '{print $NF}') ; do xe host-param-clear uuid=$host param-name=tags; done;</programlisting>
<note><para>When copying and pasting a command, be sure the command has pasted as a single line before executing. Some document viewers may introduce unwanted line breaks in copied text.</para></note>
</listitem>
<listitem>
@@ -482,7 +482,7 @@ vm: b6cf79c8-02ee-050b-922f-49583d9f1a14 (i-2-8-VM)</programlisting>
</listitem>
<listitem>
<para>After all hosts are up, run the following on one host in the cluster:</para>
- <programlisting language="Bash"># /opt/xensource/bin/cloud-clean-vlan.sh</programlisting>
+ <programlisting># /opt/xensource/bin/cloud-clean-vlan.sh</programlisting>
</listitem>
</orderedlist>
</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/cluster-add.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/cluster-add.xml b/docs/en-US/cluster-add.xml
index 5210bd8..89f9bd2 100644
--- a/docs/en-US/cluster-add.xml
+++ b/docs/en-US/cluster-add.xml
@@ -1,28 +1,31 @@
<?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="cluster-add">
- <title>Adding a Cluster</title>
- <para>TODO</para>
+ <title>Adding a Cluster</title>
+ <para>You need to tell &PRODUCT; about the hosts that it will manage. Hosts exist inside clusters, so before you begin adding hosts to the cloud, you must add at least one cluster.</para>
+ <xi:include href="add-clusters-kvm-xenserver.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="add-clusters-ovm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="add-clusters-vsphere.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/host-add-vsphere.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/host-add-vsphere.xml b/docs/en-US/host-add-vsphere.xml
new file mode 100644
index 0000000..038d8a8
--- /dev/null
+++ b/docs/en-US/host-add-vsphere.xml
@@ -0,0 +1,28 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE bookinfo 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="host-add-vsphere">
+ <title>Adding a Host (vSphere)</title>
+ <para>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>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/host-add-xenserver-kvm-ovm.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/host-add-xenserver-kvm-ovm.xml b/docs/en-US/host-add-xenserver-kvm-ovm.xml
new file mode 100644
index 0000000..7101332
--- /dev/null
+++ b/docs/en-US/host-add-xenserver-kvm-ovm.xml
@@ -0,0 +1,88 @@
+<?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="host-add-xenserver-kvm-ovm">
+ <title>Adding a Host (XenServer, KVM, or OVM)</title>
+ <para>XenServer, KVM, and Oracle VM (OVM) hosts can be added to a cluster at any time.</para>
+ <section>
+ <title>Requirements for XenServer, KVM, and OVM Hosts</title>
+ <warning><para>Make sure the hypervisor host does not have any VMs already running before you add it to &PRODUCT;.</para></warning>
+ <para>Configuration requirements:</para>
+ <itemizedlist>
+ <listitem><para>Each cluster must contain only hosts with the identical hypervisor. </para></listitem>
+ <listitem><para>For XenServer, do not put more than 8 hosts in a cluster. </para></listitem>
+ <listitem><para>For KVM, do not put more than 16 hosts in a cluster.</para></listitem>
+ </itemizedlist>
+ <para>For hardware requirements, see the installation section for your hypervisor in the &PRODUCT; Installation Guide.</para>
+ <section>
+ <title>XenServer Host Additional Requirements</title>
+ <para>If network bonding is in use, the administrator must cable the new host identically to other hosts in the cluster. </para>
+ <para>For all additional hosts to be added to the cluster, run the following command. This will cause the host to join the master in a XenServer pool. </para>
+ <programlisting># xe pool-join master-address=[master IP] master-username=root master-password=[your password]</programlisting>
+ <note><para>When copying and pasting a command, be sure the command has pasted as a single line before executing. Some document viewers may introduce unwanted line breaks in copied text.</para></note>
+ <para>With all hosts added to the XenServer pool, run the cloud-setup-bond script. This script will complete the configuration and setup of the bonds on the new hosts in the cluster.</para>
+ <orderedlist>
+ <listitem><para>Copy the script from the Management Server in /usr/lib64/cloud/agent/scripts/vm/hypervisor/xenserver/cloud-setup-bonding.sh to the master host and ensure it is executable.</para></listitem>
+ <listitem><para>Run the script:</para>
+ <programlisting># ./cloud-setup-bonding.sh</programlisting>
+ </listitem>
+ </orderedlist>
+ </section>
+ <section>
+ <title>KVM Host Additional Requirements</title>
+ <itemizedlist>
+ <listitem><para>If shared mountpoint storage is in use, the administrator should ensure that the new host has all the same mountpoints (with storage mounted) as the other hosts in the cluster.</para></listitem>
+ <listitem><para>Make sure the new host has the same network configuration (guest, private, and public network) as other hosts in the cluster.</para></listitem>
+ </itemizedlist>
+ </section>
+ <section>
+ <title>OVM Host Additional Requirements</title>
+ <para>Before adding a used host in &PRODUCT;, as part of the cleanup procedure on the host, be sure to remove
+ /etc/ovs-agent/db/.
+ </para>
+ </section>
+ </section>
+ <section>
+ <title>Adding a XenServer, KVM, or OVM Host</title>
+ <itemizedlist>
+ <listitem><para>If you have not already done so, 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
+ the appropriate section for your hypervisor in the &PRODUCT; Installation Guide.</para></listitem>
+ <listitem><para>Log in to the &PRODUCT; UI as administrator.</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 host.</para></listitem>
+ <listitem><para>Click the Compute tab. In the Clusters node, click View All.</para></listitem>
+ <listitem><para>Click the cluster where you want to add the host.</para></listitem>
+ <listitem><para>Click View Hosts.</para></listitem>
+ <listitem><para>Click Add Host.</para></listitem>
+ <listitem><para>Provide the following information.</para>
+ <itemizedlist>
+ <listitem><para>Host Name. The DNS name or IP address of the host. </para></listitem>
+ <listitem><para>Username. Usually root.</para></listitem>
+ <listitem><para>Password. This is the password for the user named above (from your XenServer, KVM, or OVM install).</para></listitem>
+ <listitem><para>Host Tags (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.</para></listitem>
+ </itemizedlist>
+ <para>There may be a slight delay while the host is provisioned. It should automatically display in the UI. </para></listitem>
+ <listitem><para>Repeat for additional hosts. </para></listitem>
+ </itemizedlist>
+ </section>
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/hypervisor-installation.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/hypervisor-installation.xml b/docs/en-US/hypervisor-installation.xml
new file mode 100644
index 0000000..8bfc0c0
--- /dev/null
+++ b/docs/en-US/hypervisor-installation.xml
@@ -0,0 +1,29 @@
+<?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="hypervisor-installation">
+ <title>Hypervisor Installation</title>
+ <xi:include href="hypervisor-kvm-install-flow.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="citrix-xenserver-installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+</chapter>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/hypervisor-kvm-install-flow.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/hypervisor-kvm-install-flow.xml b/docs/en-US/hypervisor-kvm-install-flow.xml
new file mode 100644
index 0000000..e2544c1
--- /dev/null
+++ b/docs/en-US/hypervisor-kvm-install-flow.xml
@@ -0,0 +1,34 @@
+<?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.
+-->
+
+<section id="hypervisor-kvm-install-flow">
+ <title>KVM Hypervisor Host Installation</title>
+ <xi:include href="hypervisor-host-install-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="hypervisor-host-install-prepare-os.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="hypervisor-host-install-libvirt.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="hypervisor-host-install-security-policies.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="hypervisor-host-install-network.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="hypervisor-host-install-firewall.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="hypervisor-host-install-agent.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/images/NIC_bonding_and_multipath_IO.png
----------------------------------------------------------------------
diff --git a/docs/en-US/images/NIC_bonding_and_multipath_IO.png b/docs/en-US/images/NIC_bonding_and_multipath_IO.png
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/images/example_of_a_multi_site_deployment.png
----------------------------------------------------------------------
diff --git a/docs/en-US/images/example_of_a_multi_site_deployment.png b/docs/en-US/images/example_of_a_multi_site_deployment.png
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/images/large-scale-redundant-setup.png
----------------------------------------------------------------------
diff --git a/docs/en-US/images/large-scale-redundant-setup.png b/docs/en-US/images/large-scale-redundant-setup.png
new file mode 100644
index 0000000..5d2581a
Binary files /dev/null and b/docs/en-US/images/large-scale-redundant-setup.png differ
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/images/large_scale_redundant_setup.png
----------------------------------------------------------------------
diff --git a/docs/en-US/images/large_scale_redundant_setup.png b/docs/en-US/images/large_scale_redundant_setup.png
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/images/multi-node-management-server.png
----------------------------------------------------------------------
diff --git a/docs/en-US/images/multi-node-management-server.png b/docs/en-US/images/multi-node-management-server.png
new file mode 100644
index 0000000..5cf5ed5
Binary files /dev/null and b/docs/en-US/images/multi-node-management-server.png differ
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/images/multi-site-deployment.png
----------------------------------------------------------------------
diff --git a/docs/en-US/images/multi-site-deployment.png b/docs/en-US/images/multi-site-deployment.png
new file mode 100644
index 0000000..f3ae5bb
Binary files /dev/null and b/docs/en-US/images/multi-site-deployment.png differ
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/images/multi_node_management_server.png
----------------------------------------------------------------------
diff --git a/docs/en-US/images/multi_node_management_server.png b/docs/en-US/images/multi_node_management_server.png
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/images/nic-bonding-and-multipath-io.png
----------------------------------------------------------------------
diff --git a/docs/en-US/images/nic-bonding-and-multipath-io.png b/docs/en-US/images/nic-bonding-and-multipath-io.png
new file mode 100644
index 0000000..0fe60b6
Binary files /dev/null and b/docs/en-US/images/nic-bonding-and-multipath-io.png differ
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/images/separate-storage-network.png
----------------------------------------------------------------------
diff --git a/docs/en-US/images/separate-storage-network.png b/docs/en-US/images/separate-storage-network.png
new file mode 100644
index 0000000..24dbbef
Binary files /dev/null and b/docs/en-US/images/separate-storage-network.png differ
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/images/separate_storage_network.png
----------------------------------------------------------------------
diff --git a/docs/en-US/images/separate_storage_network.png b/docs/en-US/images/separate_storage_network.png
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/images/small-scale-deployment.png
----------------------------------------------------------------------
diff --git a/docs/en-US/images/small-scale-deployment.png b/docs/en-US/images/small-scale-deployment.png
new file mode 100644
index 0000000..1c88520
Binary files /dev/null and b/docs/en-US/images/small-scale-deployment.png differ
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/images/small_scale_deployment.png
----------------------------------------------------------------------
diff --git a/docs/en-US/images/small_scale_deployment.png b/docs/en-US/images/small_scale_deployment.png
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/installation.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/installation.xml b/docs/en-US/installation.xml
index 5fc550e..35f1c68 100644
--- a/docs/en-US/installation.xml
+++ b/docs/en-US/installation.xml
@@ -29,4 +29,5 @@
<xi:include href="minimum-system-requirements.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<xi:include href="configure-package-repository.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<xi:include href="management-server-install-flow.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+ <xi:include href="global-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</chapter>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/large_scale_redundant_setup.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/large_scale_redundant_setup.xml b/docs/en-US/large_scale_redundant_setup.xml
index 9eb3190..427a42d 100644
--- a/docs/en-US/large_scale_redundant_setup.xml
+++ b/docs/en-US/large_scale_redundant_setup.xml
@@ -22,7 +22,7 @@
<title>Large-Scale Redundant Setup</title>
<mediaobject>
<imageobject>
- <imagedata fileref="./images/large_scale_redundant_setup.png" />
+ <imagedata fileref="./images/large-scale-redundant-setup.png" />
</imageobject>
<textobject><phrase>Large-Scale Redundant Setup</phrase></textobject>
</mediaobject>
@@ -39,4 +39,4 @@
<listitem><para>Secondary storage servers are connected to the management network.</para></listitem>
<listitem><para>Each pod contains storage and computing servers. Each storage and computing server should have redundant NICs connected to separate layer-2 access switches.</para></listitem>
</itemizedlist>
-</section>
\ No newline at end of file
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/log-in.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/log-in.xml b/docs/en-US/log-in.xml
index e72d27b..84328ce 100644
--- a/docs/en-US/log-in.xml
+++ b/docs/en-US/log-in.xml
@@ -5,27 +5,26 @@
]>
<!-- 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="log-in">
- <title>Log In to the UI</title>
- <para>&PRODUCT; provides a web-based UI that can be used by both administrators and end users. The appropriate version of the UI is displayed depending on the credentials used to log in. The UI is available in popular browsers including IE7, IE8, IE9, Firefox 3.5+, Firefox 4, Safari 4, and Safari 5. The URL is: (substitute your own management server IP address)</para>
- <programlisting>http://<management-server-ip-address>:8080/client</programlisting>
+ <title>Log In to the UI</title>
+ <para>&PRODUCT; provides a web-based UI that can be used by both administrators and end users. The appropriate version of the UI is displayed depending on the credentials used to log in. The UI is available in popular browsers including IE7, IE8, IE9, Firefox 3.5+, Firefox 4, Safari 4, and Safari 5. The URL is: (substitute your own management server IP address)</para>
+ <programlisting>http://<management-server-ip-address>:8080/client</programlisting>
<para>On a fresh Management Server installation, a guided tour splash screen appears. On later visits, you’ll see a login screen where you specify the following to proceed to your Dashboard:</para>
<formalpara>
<title>Username</title>
@@ -42,7 +41,8 @@
<para>If you are a user in the sub-domains, enter the full path to the domain, excluding the root domain.</para>
<para>For example, suppose multiple levels are created under the root domain, such as Comp1/hr. The users in the Comp1 domain should enter Comp1 in the Domain field, whereas the users in the Comp1/sales domain should enter Comp1/sales.</para>
<para>For more guidance about the choices that appear when you log in to this UI, see Logging In as the Root Administrator.</para>
- <xi:include href="end-user-ui-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="root-admin-ui-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <xi:include href="log-in-root-admin.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="end-user-ui-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="root-admin-ui-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="log-in-root-admin.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="changing-root-password.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/multi_node_management_server.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/multi_node_management_server.xml b/docs/en-US/multi_node_management_server.xml
index 9dea949..1ff713d 100644
--- a/docs/en-US/multi_node_management_server.xml
+++ b/docs/en-US/multi_node_management_server.xml
@@ -23,7 +23,7 @@
<para>The &PRODUCT; Management Server is deployed on one or more front-end servers connected to a single MySQL database. Optionally a pair of hardware load balancers distributes requests from the web. A backup management server set may be deployed using MySQL replication at a remote site to add DR capabilities.</para>
<mediaobject>
<imageobject>
- <imagedata fileref="./images/multi_node_management_server.png" />
+ <imagedata fileref="./images/multi-node-management-server.png" />
</imageobject>
<textobject><phrase>Multi-Node Management Server</phrase></textobject>
</mediaobject>
@@ -33,4 +33,4 @@
<listitem><para>How many Management Servers will be deployed.</para></listitem>
<listitem><para>Whether MySQL replication will be deployed to enable disaster recovery.</para></listitem>
</itemizedlist>
-</section>
\ No newline at end of file
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/multi_site_deployment.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/multi_site_deployment.xml b/docs/en-US/multi_site_deployment.xml
index 2dce575..8ad94aa 100644
--- a/docs/en-US/multi_site_deployment.xml
+++ b/docs/en-US/multi_site_deployment.xml
@@ -23,14 +23,14 @@
<para>The &PRODUCT; platform scales well into multiple sites through the use of zones. The following diagram shows an example of a multi-site deployment.</para>
<mediaobject>
<imageobject>
- <imagedata fileref="./images/example_of_a_multi_site_deployment.png" />
+ <imagedata fileref="./images/multi-site-deployment.png" />
</imageobject>
<textobject><phrase>Example Of A Multi-Site Deployment</phrase></textobject>
</mediaobject>
<para>Data Center 1 houses the primary Management Server as well as zone 1. The MySQL database is replicated in real time to the secondary Management Server installation in Data Center 2.</para>
<mediaobject>
<imageobject>
- <imagedata fileref="./images/separate_storage_network.png" />
+ <imagedata fileref="./images/separate-storage-network.png" />
</imageobject>
<textobject><phrase>Separate Storage Network</phrase></textobject>
</mediaobject>
@@ -42,9 +42,9 @@
</itemizedlist>
<mediaobject>
<imageobject>
- <imagedata fileref="./images/NIC_bonding_and_multipath_IO.png" />
+ <imagedata fileref="./images/nic-bonding-and-multipath-io.png" />
</imageobject>
<textobject><phrase>NIC Bonding And Multipath I/O</phrase></textobject>
</mediaobject>
<para> This diagram illustrates the differences between NIC bonding and Multipath I/O (MPIO). NIC bonding configuration involves only one network. MPIO involves two separate networks.</para>
-</section>
\ No newline at end of file
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/pod-add.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/pod-add.xml b/docs/en-US/pod-add.xml
index 419e333..2a2b087 100644
--- a/docs/en-US/pod-add.xml
+++ b/docs/en-US/pod-add.xml
@@ -1,28 +1,43 @@
<?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" "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.
+ 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>TODO</para>
+ <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/incubator-cloudstack/blob/742d9bbb/docs/en-US/provisioning-steps.xml.orig
----------------------------------------------------------------------
diff --git a/docs/en-US/provisioning-steps.xml.orig b/docs/en-US/provisioning-steps.xml.orig
new file mode 100644
index 0000000..b532783
--- /dev/null
+++ b/docs/en-US/provisioning-steps.xml.orig
@@ -0,0 +1,42 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
+%BOOK_ENTITIES;
+]>
+
+<!-- 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 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="changing-root-password.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" />
+<<<<<<< HEAD
+ <xi:include href="citrix-xenserver-installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</section>
+=======
+</chapter>
+>>>>>>> Promote sections to chapters: Cloud Infrastructure Concepts and Provisioning Steps.
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/provisioning.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/provisioning.xml b/docs/en-US/provisioning.xml
deleted file mode 100644
index ec28451..0000000
--- a/docs/en-US/provisioning.xml
+++ /dev/null
@@ -1,25 +0,0 @@
-<?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">
- <title>Provisioning Your Cloud Infrastructure</title>
- <xi:include href="cloud-infrastructure-concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
- <xi:include href="provisioning-steps.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-</chapter>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/small_scale_deployment.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/small_scale_deployment.xml b/docs/en-US/small_scale_deployment.xml
index eb509a7..bba2b9a 100644
--- a/docs/en-US/small_scale_deployment.xml
+++ b/docs/en-US/small_scale_deployment.xml
@@ -23,7 +23,7 @@
<title>Small-Scale Deployment</title>
<mediaobject>
<imageobject>
- <imagedata fileref="./images/small_scale_deployment.png" />
+ <imagedata fileref="./images/small-scale-deployment.png" />
</imageobject>
<textobject><phrase>Small-Scale Deployment</phrase></textobject>
</mediaobject>
@@ -34,4 +34,4 @@
<listitem><para>A single NFS server functions as both the primary and secondary storage.</para></listitem>
<listitem><para>The Management Server is connected to the management network.</para></listitem>
</itemizedlist>
-</section>
\ No newline at end of file
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/en-US/using-sshkeys.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/using-sshkeys.xml b/docs/en-US/using-sshkeys.xml
index b51569d..1e98eb6 100644
--- a/docs/en-US/using-sshkeys.xml
+++ b/docs/en-US/using-sshkeys.xml
@@ -23,27 +23,35 @@
-->
<section id="using-sshkeys">
- <subtitle>Using the SSH Keys for Authentication on Cloud</subtitle>
- <para>In addition to the username and password authentication, CloudStack supports using SSH keys to log in to the cloud infrastructure for additional security for your cloud infrastructure. You can use the createSSHKeyPair API to generate the SSH keys.</para>
- <para>Because each cloud user has their own ssh key, one cloud user cannot log in to another cloud user's instances unless they share their ssh key files. Using a single SSH key pair, you can manage multiple instances.</para>
- <subtitle> Creating an Instance Template that Supports SSH Keys</subtitle>
+ <title>Using SSH Keys for Authentication</title>
+ <para>In addition to the username and password authentication, &PRODUCT; supports using SSH keys to log in to the cloud infrastructure for additional security. You can use the createSSHKeyPair API to generate the SSH keys.</para>
+ <para>Because each cloud user has their own SSH key, one cloud user cannot log in to another cloud user's instances unless they share their SSH key files. Using a single SSH key pair, you can manage multiple instances.</para>
+ <section id="create-ssh-template">
+ <title> Creating an Instance Template that Supports SSH Keys</title>
+ <para>Create a instance template that supports SSH Keys.</para>
<orderedlist>
- <listitem><para>Create a instance template that supports SSH Keys.</para>
- <orderedlist numeration="loweralpha"><listitem><para>Create a new instance by using the template provided by cloudstack.</para>
- <para>For more information on creating a new instance, see </para></listitem>
+ <listitem><para>Create a new instance by using the template provided by cloudstack.</para>
+ <para>For more information on creating a new instance, see </para>
+ </listitem>
<listitem><para>Download the cloudstack script from <ulink url="http://sourceforge.net/projects/cloudstack/files/SSH%20Key%20Gen%20Script/">The SSH Key Gen Script</ulink>to the instance you have created.</para>
- <programlisting>wget http://downloads.sourceforge.net/project/cloudstack/SSH%20Key%20Gen%20Script/cloud-set-guest-sshkey.in?r=http%3A%2F%2Fsourceforge.net%2Fprojects%2Fcloudstack%2Ffiles%2FSSH%2520Key%2520Gen%2520Script%2F&ts=1331225219&use_mirror=iweb</programlisting></listitem>
+ <programlisting>wget http://downloads.sourceforge.net/project/cloudstack/SSH%20Key%20Gen%20Script/cloud-set-guest-sshkey.in?r=http%3A%2F%2Fsourceforge.net%2Fprojects%2Fcloudstack%2Ffiles%2FSSH%2520Key%2520Gen%2520Script%2F&ts=1331225219&use_mirror=iweb</programlisting>
+ </listitem>
<listitem><para>Copy the file to /etc/init.d.</para>
- <programlisting>cp cloud-set-guest-sshkey.in /etc/init.d/</programlisting></listitem>
+ <programlisting>cp cloud-set-guest-sshkey.in /etc/init.d/</programlisting>
+ </listitem>
<listitem><para>Give the necessary permissions on the script:</para>
- <programlisting>chmod +x /etc/init.d/cloud-set-guest-sshkey.in</programlisting></listitem>
+ <programlisting>chmod +x /etc/init.d/cloud-set-guest-sshkey.in</programlisting>
+ </listitem>
<listitem><para>Run the script while starting up the operating system:</para>
- <programlisting>chkconfig --add cloud-set-guest-sshkey.in</programlisting></listitem>
- <listitem><para>Stop the instance.</para></listitem>
- </orderedlist></listitem>
- </orderedlist>
- <subtitle>Creating the SSH Keypair</subtitle>
- <para>You must make a call to the createSSHKeyPair api method. You can either use the cloudstack python api library or the curl commands to make the call to the cloudstack api.</para>
+ <programlisting>chkconfig --add cloud-set-guest-sshkey.in</programlisting>
+ </listitem>
+ <listitem><para>Stop the instance.</para>
+ </listitem>
+ </orderedlist>
+ </section>
+ <section id="create-ssh-keypair">
+ <title>Creating the SSH Keypair</title>
+ <para>You must make a call to the createSSHKeyPair api method. You can either use the &PRODUCT; Python API library or the curl commands to make the call to the cloudstack api.</para>
<para>For example, make a call from the cloudstack server to create a SSH keypair called "keypair-doc" for the admin account in the root domain:</para>
<note><para>Ensure that you adjust these values to meet your needs. If you are making the API call from a different server, your URL/PORT will be different, and you will need to use the API keys.</para></note>
<orderedlist>
@@ -78,15 +86,20 @@ KfEEuzcCUIxtJYTahJ1pvlFkQ8anpuxjSEDp8x/18bq3
-----END RSA PRIVATE KEY-----</programlisting></listitem>
<listitem><para>Save the file.</para></listitem>
</orderedlist>
- <subtitle>Creating an Instance</subtitle>
- <para>After you save the SSH keypair file, you must create an instance by using the template that you created at <xref linkend="create-template"/>. Ensure that you use the same SSH key name that you created at <xref linkend="gen-ssh-keypair"/>.</para>
+ </section>
+ <section id="creating-ssh-instance">
+ <title>Creating an Instance</title>
+ <para>After you save the SSH keypair file, you must create an instance by using the template that you created at <xref linkend="create-ssh-template"/>. Ensure that you use the same SSH key name that you created at <xref linkend="create-ssh-keypair"/>.</para>
<note><para>You cannot create the instance by using the GUI at this time and associate the instance with the newly created SSH keypair.</para></note>
<para>A sample curl command to create a new instance is:</para>
<programlisting>curl --globoff http://localhost:<port numbet>/?command=deployVirtualMachine\&zoneId=1\&serviceOfferingId=18727021-7556-4110-9322-d625b52e0813\&templateId=e899c18a-ce13-4bbf-98a9-625c5026e0b5\&securitygroupids=ff03f02f-9e3b-48f8-834d-91b822da40c5\&account=admin\&domainid=1\&keypair=keypair-doc</programlisting>
<para>Substitute the template, service offering and security group IDs (if you are using the security group feature) that are in your cloud environment.</para>
- <subtitle>Logging In Using the SSH Keypair</subtitle>
+ </section>
+ <section id="logging-in-ssh">
+ <title>Logging In Using the SSH Keypair</title>
<para>To test your SSH key generation is successful, check whether you can log in to the cloud setup.</para>
<para>For exaple, from a Linux OS, run:</para>
<programlisting>ssh -i ~/.ssh/keypair-doc <ip address></programlisting>
<para>The -i parameter tells the ssh client to use a ssh key found at ~/.ssh/keypair-doc.</para>
+ </section>
</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/742d9bbb/docs/publican-trial-install.cfg
----------------------------------------------------------------------
diff --git a/docs/publican-trial-install.cfg b/docs/publican-trial-install.cfg
deleted file mode 100644
index 3e657b8..0000000
--- a/docs/publican-trial-install.cfg
+++ /dev/null
@@ -1,29 +0,0 @@
-# Publican configuration file for CloudStack Trial Installation Guide
-# Config::Simple 4.58
-# Tue May 29 00:57:27 2012
-#
-# 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.
-
-xml_lang: en-US
-type: Book
-docname: cloudstack_trial_installation
-brand: cloudstack
-chunk_first: 1
-chunk_section_depth: 1
-
-
-