partial-fix-for-376 Signed-off-by: Radhika PC <radhika.puthiyet...@citrix.com>
Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/f814f659 Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/f814f659 Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/f814f659 Branch: refs/heads/4.0 Commit: f814f659e1026e318f7c9463c306ce46ae8d3228 Parents: ad91b3f Author: Radhika PC <radhika.puthiyet...@citrix.com> Authored: Fri Oct 19 13:29:03 2012 +0530 Committer: Chip Childers <chip.child...@gmail.com> Committed: Mon Oct 22 11:00:06 2012 -0400 ---------------------------------------------------------------------- docs/en-US/about-hosts.xml | 3 +- docs/en-US/management-server-install-client.xml | 42 +++++--- .../en-US/management-server-install-multi-node.xml | 82 ++++++++------- docs/en-US/management-server-install-overview.xml | 7 +- docs/en-US/prepare-system-vm-template.xml | 78 ++++++++------ 5 files changed, 123 insertions(+), 89 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/f814f659/docs/en-US/about-hosts.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/about-hosts.xml b/docs/en-US/about-hosts.xml index 956c695..49694b2 100644 --- a/docs/en-US/about-hosts.xml +++ b/docs/en-US/about-hosts.xml @@ -28,7 +28,8 @@ <para>The host is the smallest organizational unit within a &PRODUCT; deployment. Hosts are contained within clusters, clusters are contained within pods, and pods are contained within zones.</para> <para>Hosts in a &PRODUCT; deployment:</para> <itemizedlist> - <listitem><para>Provde the CPU, memory, storage, and networking resources needed to host the virtual machines</para></listitem> + <listitem><para>Provide the CPU, memory, storage, and networking resources needed to host the virtual + machines</para></listitem> <listitem><para>Interconnect using a high bandwidth TCP/IP network and connect to the Internet</para></listitem> <listitem><para>May reside in multiple data centers across different geographic locations</para></listitem> <listitem><para>May have different capacities (different CPU speeds, different amounts of RAM, etc.), although the hosts within a cluster must all be homogeneous</para></listitem> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/f814f659/docs/en-US/management-server-install-client.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/management-server-install-client.xml b/docs/en-US/management-server-install-client.xml index 93273ce..7d219ac 100644 --- a/docs/en-US/management-server-install-client.xml +++ b/docs/en-US/management-server-install-client.xml @@ -21,20 +21,32 @@ specific language governing permissions and limitations under the License. --> - <section id="management-server-install"> - <title>Install the Management Server on the First Host</title> - <para>The first step in installation, whether you are installing the Management Server on one host or many, is to install the software on a single node. - </para> - <note><para>If you are planning to install the Management Server on multiple nodes for high availability, do not proceed to the additional nodes yet. That step will come later.</para></note> - <para>The &PRODUCT; Management server can be installed using either RPM or DEB packages. These packages will depend on everything you need to run the Management server.</para> - <section id="management-server-install-rhel"> - <title>Install on CentOS/RHEL</title> - <para>We start by installing the required packages:</para> - <programlisting language="Bash">yum install cloud-client</programlisting> - </section> - <section id="management-server-install-ubuntu"> - <title>Install on Ubuntu</title> - <programlisting language="Bash">apt-get install cloud-client</programlisting> - </section> + <title>Install the Management Server on the First Host</title> + <para>The first step in installation, whether you are installing the Management Server on one host + or many, is to install the software on a single node. </para> + <note> + <para>If you are planning to install the Management Server on multiple nodes for high + availability, do not proceed to the additional nodes yet. That step will come later.</para> + </note> + <para>The &PRODUCT; Management server can be installed using either RPM or DEB packages. These + packages will depend on everything you need to run the Management server.</para> + <section id="vhd-util"> + <title>Downloading vhd-util</title> + <para>Before setting up the Management Server, download vhd-util from <ulink + url="http://download.cloud.com.s3.amazonaws.com/tools/vhd-util">vhd-util</ulink></para> + <para>If the Management Server is RHEL or CentOS, copy vhd-util to + /usr/lib64/cloud/common/scripts/vm/hypervisor/xenserver.</para> + <para>If the Management Server is Ubuntu, copy vhd-util to + /usr/lib/cloud/common/scripts/vm/hypervisor/xenserver/vhd-util.</para> + </section> + <section id="management-server-install-rhel"> + <title>Install on CentOS/RHEL</title> + <para>We start by installing the required packages:</para> + <programlisting language="Bash">yum install cloud-client</programlisting> + </section> + <section id="management-server-install-ubuntu"> + <title>Install on Ubuntu</title> + <programlisting language="Bash">apt-get install cloud-client</programlisting> + </section> </section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/f814f659/docs/en-US/management-server-install-multi-node.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/management-server-install-multi-node.xml b/docs/en-US/management-server-install-multi-node.xml index 8ac70ac..1764fa9 100644 --- a/docs/en-US/management-server-install-multi-node.xml +++ b/docs/en-US/management-server-install-multi-node.xml @@ -21,47 +21,49 @@ specific language governing permissions and limitations under the License. --> - <section id="install-management-server-multi-nodes"> - <title>Prepare and Start Additional Management Servers</title> - <para>For your second and subsequent Management Servers, you will install the Management Server software, connect it to the database, and set up the OS for the Management Server. - </para> - <orderedlist> - <listitem> - <para> - Perform the steps in <xref linkend="prepare-os"/> and - <xref linkend="sect-source-buildrpm" /> or - <xref linkend="sect-source-builddebs" /> as appropriate. - </para> - </listitem> - <listitem> - <para> - Ensure that necessary services are started and set to start - on boot. - <programlisting> -<prompt>#</prompt> <command>service</command> rpcbind start + <title>Prepare and Start Additional Management Servers</title> + <para>For your second and subsequent Management Servers, you will install the Management Server + software, connect it to the database, and set up the OS for the Management Server. </para> + <orderedlist> + <listitem> + <para> Perform the steps in <xref linkend="prepare-os"/> and <xref +linkend="sect-source-buildrpm"/> or <xref linkend="sect-source-builddebs"/> as + appropriate. </para> + </listitem> + <listitem> + <para>Download vhd-util from <ulink + url="http://download.cloud.com.s3.amazonaws.com/tools/vhd-util">vhd-util</ulink></para> + <para>If the Management Server is RHEL or CentOS, copy vhd-util to + /usr/lib64/cloud/common/scripts/vm/hypervisor/xenserver.</para> + <para>If the Management Server is Ubuntu, copy vhd-util to + /usr/lib/cloud/common/scripts/vm/hypervisor/xenserver/vhd-util.</para> + </listitem> + <listitem> + <para> Ensure that necessary services are started and set to start on boot. + <programlisting><prompt>#</prompt> <command>service</command> rpcbind start <prompt>#</prompt> <command>service</command> nfs start <prompt>#</prompt> <command>chkconfig</command> nfs on -<prompt>#</prompt> <command>chkconfig</command> rpcbind on - </programlisting> - </para> - </listitem> - <listitem> - <para> - Configure the database client. Note the absence of the - --deploy-as argument in this case. - (For more details about the arguments to this command, see - <xref linkend="management-server-install-db-external"/>.) - </para> - <programlisting> - <prompt>#</prompt> <command>cloud-setup-databases</command> cloud:<replaceable>dbpassword</replaceable>@<replaceable>dbhost</replaceable> -e <replaceable>encryption_type</replaceable> -m <replaceable>management_server_key</replaceable> -k <replaceable>database_key</replaceable> - </programlisting> - </listitem> - <listitem><para>Configure the OS and start the Management Server:</para> - <programlisting><prompt>#</prompt> <command>cloud-setup-management</command></programlisting> - <para>The Management Server on this node should now be running.</para> - </listitem> - <listitem><para>Repeat these steps on each additional Management Server. </para></listitem> - <listitem><para>Be sure to configure a load balancer for the Management Servers. See Management Server Load Balancing.</para></listitem> - </orderedlist> +<prompt>#</prompt> <command>chkconfig</command> rpcbind on </programlisting> + </para> + </listitem> + <listitem> + <para> Configure the database client. Note the absence of the --deploy-as argument in this + case. (For more details about the arguments to this command, see <xref + linkend="management-server-install-db-external"/>.) </para> + <programlisting><prompt>#</prompt> <command>cloud-setup-databases</command> cloud:<replaceable>dbpassword</replaceable>@<replaceable>dbhost</replaceable> -e <replaceable>encryption_type</replaceable> -m <replaceable>management_server_key</replaceable> -k <replaceable>database_key</replaceable> </programlisting> + </listitem> + <listitem> + <para>Configure the OS and start the Management Server:</para> + <programlisting><prompt>#</prompt> <command>cloud-setup-management</command></programlisting> + <para>The Management Server on this node should now be running.</para> + </listitem> + <listitem> + <para>Repeat these steps on each additional Management Server. </para> + </listitem> + <listitem> + <para>Be sure to configure a load balancer for the Management Servers. See Management Server + Load Balancing.</para> + </listitem> + </orderedlist> </section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/f814f659/docs/en-US/management-server-install-overview.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/management-server-install-overview.xml b/docs/en-US/management-server-install-overview.xml index 5bc6f1b..ba4c8f6 100644 --- a/docs/en-US/management-server-install-overview.xml +++ b/docs/en-US/management-server-install-overview.xml @@ -35,7 +35,12 @@ The procedure for installing the Management Server is: </para> <orderedlist> - <listitem><para>Prepare the Operating System</para></listitem> + <listitem> + <para>Prepare the Operating System</para> + </listitem> + <listitem> + <para>Download and install vhd-util.</para> + </listitem> <listitem><para>Install the First Management Server</para></listitem> <listitem><para>Install and Configure the MySQL database</para></listitem> <listitem><para>Prepare NFS Shares</para></listitem> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/f814f659/docs/en-US/prepare-system-vm-template.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/prepare-system-vm-template.xml b/docs/en-US/prepare-system-vm-template.xml index caca4e7..5ed78f7 100644 --- a/docs/en-US/prepare-system-vm-template.xml +++ b/docs/en-US/prepare-system-vm-template.xml @@ -21,37 +21,51 @@ 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.</para> - <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> - <orderedlist> - <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 your secondary storage mount point is not named /mnt/secondary, substitute your own mount point name.</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 About Password and Key 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/agent/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/agent/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/agent/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> - </itemizedlist> - </listitem> - <listitem><para>If you are using a separate NFS server, perform this step. If you are using the Management - Server as the NFS server, you MUST NOT perform this step.</para> - <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> + <title>Prepare the System VM Template</title> + <para>Secondary storage must be seeded with a template that is used for &PRODUCT; system + VMs.</para> + <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> + <orderedlist> + <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 your secondary storage mount point is not named /mnt/secondary, substitute your own + mount point name.</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 About Password + and Key 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> + </itemizedlist> + </listitem> + <listitem> + <para>If you are using a separate NFS server, perform this step. If you are using the + Management Server as the NFS server, you MUST NOT perform this step.</para> + <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>