Skip to content

Commit 76478d9

Browse files
Radhika PCchipchilders
authored andcommitted
partial-fix-for-376
Signed-off-by: Radhika PC <radhika.puthiyetath@citrix.com>
1 parent 947d8cc commit 76478d9

5 files changed

Lines changed: 123 additions & 89 deletions

docs/en-US/about-hosts.xml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@
2828
<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>
2929
<para>Hosts in a &PRODUCT; deployment:</para>
3030
<itemizedlist>
31-
<listitem><para>Provde the CPU, memory, storage, and networking resources needed to host the virtual machines</para></listitem>
31+
<listitem><para>Provide the CPU, memory, storage, and networking resources needed to host the virtual
32+
machines</para></listitem>
3233
<listitem><para>Interconnect using a high bandwidth TCP/IP network and connect to the Internet</para></listitem>
3334
<listitem><para>May reside in multiple data centers across different geographic locations</para></listitem>
3435
<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>

docs/en-US/management-server-install-client.xml

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,32 @@
2121
specific language governing permissions and limitations
2222
under the License.
2323
-->
24-
2524
<section id="management-server-install">
26-
<title>Install the Management Server on the First Host</title>
27-
<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.
28-
</para>
29-
<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>
30-
<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>
31-
<section id="management-server-install-rhel">
32-
<title>Install on CentOS/RHEL</title>
33-
<para>We start by installing the required packages:</para>
34-
<programlisting language="Bash">yum install cloud-client</programlisting>
35-
</section>
36-
<section id="management-server-install-ubuntu">
37-
<title>Install on Ubuntu</title>
38-
<programlisting language="Bash">apt-get install cloud-client</programlisting>
39-
</section>
25+
<title>Install the Management Server on the First Host</title>
26+
<para>The first step in installation, whether you are installing the Management Server on one host
27+
or many, is to install the software on a single node. </para>
28+
<note>
29+
<para>If you are planning to install the Management Server on multiple nodes for high
30+
availability, do not proceed to the additional nodes yet. That step will come later.</para>
31+
</note>
32+
<para>The &PRODUCT; Management server can be installed using either RPM or DEB packages. These
33+
packages will depend on everything you need to run the Management server.</para>
34+
<section id="vhd-util">
35+
<title>Downloading vhd-util</title>
36+
<para>Before setting up the Management Server, download vhd-util from <ulink
37+
url="http://download.cloud.com.s3.amazonaws.com/tools/vhd-util">vhd-util</ulink></para>
38+
<para>If the Management Server is RHEL or CentOS, copy vhd-util to
39+
/usr/lib64/cloud/common/scripts/vm/hypervisor/xenserver.</para>
40+
<para>If the Management Server is Ubuntu, copy vhd-util to
41+
/usr/lib/cloud/common/scripts/vm/hypervisor/xenserver/vhd-util.</para>
42+
</section>
43+
<section id="management-server-install-rhel">
44+
<title>Install on CentOS/RHEL</title>
45+
<para>We start by installing the required packages:</para>
46+
<programlisting language="Bash">yum install cloud-client</programlisting>
47+
</section>
48+
<section id="management-server-install-ubuntu">
49+
<title>Install on Ubuntu</title>
50+
<programlisting language="Bash">apt-get install cloud-client</programlisting>
51+
</section>
4052
</section>

docs/en-US/management-server-install-multi-node.xml

Lines changed: 42 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -21,47 +21,49 @@
2121
specific language governing permissions and limitations
2222
under the License.
2323
-->
24-
2524
<section id="install-management-server-multi-nodes">
26-
<title>Prepare and Start Additional Management Servers</title>
27-
<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.
28-
</para>
29-
<orderedlist>
30-
<listitem>
31-
<para>
32-
Perform the steps in <xref linkend="prepare-os"/> and
33-
<xref linkend="sect-source-buildrpm" /> or
34-
<xref linkend="sect-source-builddebs" /> as appropriate.
35-
</para>
36-
</listitem>
37-
<listitem>
38-
<para>
39-
Ensure that necessary services are started and set to start
40-
on boot.
41-
<programlisting>
42-
<prompt>#</prompt> <command>service</command> rpcbind start
25+
<title>Prepare and Start Additional Management Servers</title>
26+
<para>For your second and subsequent Management Servers, you will install the Management Server
27+
software, connect it to the database, and set up the OS for the Management Server. </para>
28+
<orderedlist>
29+
<listitem>
30+
<para> Perform the steps in <xref linkend="prepare-os"/> and <xref
31+
linkend="sect-source-buildrpm"/> or <xref linkend="sect-source-builddebs"/> as
32+
appropriate. </para>
33+
</listitem>
34+
<listitem>
35+
<para>Download vhd-util from <ulink
36+
url="http://download.cloud.com.s3.amazonaws.com/tools/vhd-util">vhd-util</ulink></para>
37+
<para>If the Management Server is RHEL or CentOS, copy vhd-util to
38+
/usr/lib64/cloud/common/scripts/vm/hypervisor/xenserver.</para>
39+
<para>If the Management Server is Ubuntu, copy vhd-util to
40+
/usr/lib/cloud/common/scripts/vm/hypervisor/xenserver/vhd-util.</para>
41+
</listitem>
42+
<listitem>
43+
<para> Ensure that necessary services are started and set to start on boot.
44+
<programlisting><prompt>#</prompt> <command>service</command> rpcbind start
4345
<prompt>#</prompt> <command>service</command> nfs start
4446
<prompt>#</prompt> <command>chkconfig</command> nfs on
45-
<prompt>#</prompt> <command>chkconfig</command> rpcbind on
46-
</programlisting>
47-
</para>
48-
</listitem>
49-
<listitem>
50-
<para>
51-
Configure the database client. Note the absence of the
52-
--deploy-as argument in this case.
53-
(For more details about the arguments to this command, see
54-
<xref linkend="management-server-install-db-external"/>.)
55-
</para>
56-
<programlisting>
57-
<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>
58-
</programlisting>
59-
</listitem>
60-
<listitem><para>Configure the OS and start the Management Server:</para>
61-
<programlisting><prompt>#</prompt> <command>cloud-setup-management</command></programlisting>
62-
<para>The Management Server on this node should now be running.</para>
63-
</listitem>
64-
<listitem><para>Repeat these steps on each additional Management Server. </para></listitem>
65-
<listitem><para>Be sure to configure a load balancer for the Management Servers. See Management Server Load Balancing.</para></listitem>
66-
</orderedlist>
47+
<prompt>#</prompt> <command>chkconfig</command> rpcbind on </programlisting>
48+
</para>
49+
</listitem>
50+
<listitem>
51+
<para> Configure the database client. Note the absence of the --deploy-as argument in this
52+
case. (For more details about the arguments to this command, see <xref
53+
linkend="management-server-install-db-external"/>.) </para>
54+
<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>
55+
</listitem>
56+
<listitem>
57+
<para>Configure the OS and start the Management Server:</para>
58+
<programlisting><prompt>#</prompt> <command>cloud-setup-management</command></programlisting>
59+
<para>The Management Server on this node should now be running.</para>
60+
</listitem>
61+
<listitem>
62+
<para>Repeat these steps on each additional Management Server. </para>
63+
</listitem>
64+
<listitem>
65+
<para>Be sure to configure a load balancer for the Management Servers. See Management Server
66+
Load Balancing.</para>
67+
</listitem>
68+
</orderedlist>
6769
</section>

docs/en-US/management-server-install-overview.xml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,12 @@
3535
The procedure for installing the Management Server is:
3636
</para>
3737
<orderedlist>
38-
<listitem><para>Prepare the Operating System</para></listitem>
38+
<listitem>
39+
<para>Prepare the Operating System</para>
40+
</listitem>
41+
<listitem>
42+
<para>Download and install vhd-util.</para>
43+
</listitem>
3944
<listitem><para>Install the First Management Server</para></listitem>
4045
<listitem><para>Install and Configure the MySQL database</para></listitem>
4146
<listitem><para>Prepare NFS Shares</para></listitem>

docs/en-US/prepare-system-vm-template.xml

Lines changed: 46 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -21,37 +21,51 @@
2121
specific language governing permissions and limitations
2222
under the License.
2323
-->
24-
2524
<section id="prepare-system-vm-template">
26-
<title>Prepare the System VM Template</title>
27-
<para>Secondary storage must be seeded with a template that is used for &PRODUCT; system VMs.</para>
28-
<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>
29-
<orderedlist>
30-
<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>
31-
<para>If your secondary storage mount point is not named /mnt/secondary, substitute your own mount point name.</para>
32-
<para>If you set the &PRODUCT; database encryption type to "web" when you set up the database, you must now add the parameter -s &lt;management-server-secret-key&gt;. See About Password and Key Encryption.</para>
33-
<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>
34-
<itemizedlist>
35-
<listitem><para>For XenServer:</para>
36-
<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 &lt;optional-management-server-secret-key&gt; -F</programlisting>
37-
</listitem>
38-
<listitem><para>For vSphere:</para>
39-
<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 &lt;optional-management-server-secret-key&gt; -F</programlisting>
40-
</listitem>
41-
<listitem><para>For KVM:</para>
42-
<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 &lt;optional-management-server-secret-key&gt; -F</programlisting>
43-
</listitem>
44-
</itemizedlist>
45-
</listitem>
46-
<listitem><para>If you are using a separate NFS server, perform this step. If you are using the Management
47-
Server as the NFS server, you MUST NOT perform this step.</para>
48-
<para>When the script has finished, unmount secondary storage and remove the created directory.</para>
49-
<programlisting>
50-
# umount /mnt/secondary
51-
# rmdir /mnt/secondary
52-
</programlisting>
53-
</listitem>
54-
<listitem><para>Repeat these steps for each secondary storage server.</para>
55-
</listitem>
56-
</orderedlist>
25+
<title>Prepare the System VM Template</title>
26+
<para>Secondary storage must be seeded with a template that is used for &PRODUCT; system
27+
VMs.</para>
28+
<note>
29+
<para>When copying and pasting a command, be sure the command has pasted as a single line before
30+
executing. Some document viewers may introduce unwanted line breaks in copied text.</para>
31+
</note>
32+
<orderedlist>
33+
<listitem>
34+
<para>On the Management Server, run one or more of the following cloud-install-sys-tmplt
35+
commands to retrieve and decompress the system VM template. Run the command for each
36+
hypervisor type that you expect end users to run in this Zone.</para>
37+
<para>If your secondary storage mount point is not named /mnt/secondary, substitute your own
38+
mount point name.</para>
39+
<para>If you set the &PRODUCT; database encryption type to "web" when you set up the database,
40+
you must now add the parameter -s &lt;management-server-secret-key&gt;. See About Password
41+
and Key Encryption.</para>
42+
<para>This process will require approximately 5 GB of free space on the local file system and
43+
up to 30 minutes each time it runs.</para>
44+
<itemizedlist>
45+
<listitem>
46+
<para>For XenServer:</para>
47+
<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 &lt;optional-management-server-secret-key&gt; -F</programlisting>
48+
</listitem>
49+
<listitem>
50+
<para>For vSphere:</para>
51+
<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 &lt;optional-management-server-secret-key&gt; -F</programlisting>
52+
</listitem>
53+
<listitem>
54+
<para>For KVM:</para>
55+
<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 &lt;optional-management-server-secret-key&gt; -F</programlisting>
56+
</listitem>
57+
</itemizedlist>
58+
</listitem>
59+
<listitem>
60+
<para>If you are using a separate NFS server, perform this step. If you are using the
61+
Management Server as the NFS server, you MUST NOT perform this step.</para>
62+
<para>When the script has finished, unmount secondary storage and remove the created
63+
directory.</para>
64+
<programlisting># umount /mnt/secondary
65+
# rmdir /mnt/secondary</programlisting>
66+
</listitem>
67+
<listitem>
68+
<para>Repeat these steps for each secondary storage server.</para>
69+
</listitem>
70+
</orderedlist>
5771
</section>

0 commit comments

Comments
 (0)