You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by ch...@apache.org on 2012/10/22 17:20:28 UTC
[26/49] fix for 344
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/296cf96f/docs/en-US/management-server-install-systemvm.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/management-server-install-systemvm.xml b/docs/en-US/management-server-install-systemvm.xml
index c2c1212..6cd1ef7 100644
--- a/docs/en-US/management-server-install-systemvm.xml
+++ b/docs/en-US/management-server-install-systemvm.xml
@@ -1,5 +1,5 @@
<?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" [
+<!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;
]>
@@ -21,36 +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/burbank/burbank-systemvm-08012012.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>
+ <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>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>
+ <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/burbank/burbank-systemvm-08012012.ova -h vmware -s <optional-management-server-secret-key> -F</programlisting>
</listitem>
- <listitem><para>Repeat these steps for each secondary storage server.</para>
+ <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>
- </orderedlist>
+ </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>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/296cf96f/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 160cea4..caca4e7 100644
--- a/docs/en-US/prepare-system-vm-template.xml
+++ b/docs/en-US/prepare-system-vm-template.xml
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8' ?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/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;
]>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/296cf96f/docs/en-US/release-notes.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/release-notes.xml b/docs/en-US/release-notes.xml
index c54b384..fade0ec 100644
--- a/docs/en-US/release-notes.xml
+++ b/docs/en-US/release-notes.xml
@@ -21,28 +21,45 @@
<book>
<xi:include href="Book_Info_Release_Notes_4.0.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
<chapter id="submitting-feedback">
- <title>Submitting Feedback and Getting Help</title>
- <para>The Apache CloudStack project has mailing lists for users and developers. These are the official channels of communication for the project and are the best way to get answers about using and contributing to CloudStack. It's a good idea to subscribe to the cloudstack-users mailing list if you've deployed or are deploying CloudStack into production, and even for test deployments.</para>
- <para>The CloudStack developer's mailing list (cloudstack-dev) is for discussions about CloudStack development, and is the best list for discussing possible bugs in CloudStack. Anyone contributing to CloudStack should be on this mailing list.</para>
- <para>You can also report bugs in CloudStack using the <ulink url="https://issues.apache.org/jira/secure/CreateIssue!default.jspa">Apache Defect Tracking System</ulink></para>
- <para>To posts to the lists, you'll need to be subscribed. See the <ulink url="http://incubator.apache.org/cloudstack/mailing-lists.html">CloudStack Web site</ulink> for instructions.</para>
+ <title>Submitting Feedback and Getting Help</title>
+ <para>The Apache CloudStack project has mailing lists for users and developers. These are the
+ official channels of communication for the project and are the best way to get answers about
+ using and contributing to CloudStack. It's a good idea to subscribe to the cloudstack-users
+ mailing list if you've deployed or are deploying CloudStack into production, and even for test
+ deployments.</para>
+ <para>The CloudStack developer's mailing list (cloudstack-dev) is for discussions about
+ CloudStack development, and is the best list for discussing possible bugs in CloudStack.
+ Anyone contributing to CloudStack should be on this mailing list.</para>
+ <para>You can also report bugs in CloudStack using the <ulink
+ url="https://issues.apache.org/jira/secure/CreateIssue!default.jspa">Apache Defect Tracking
+ System</ulink></para>
+ <para>To posts to the lists, you'll need to be subscribed. See the <ulink
+ url="http://incubator.apache.org/cloudstack/mailing-lists.html">CloudStack Web site</ulink>
+ for instructions.</para>
</chapter>
<chapter id="upgrade-instructions">
<title>Upgrade Instructions</title>
<section id="upgrade-from-3.0.2-to-4.0">
<title>Upgrade from 3.0.2 to 4.0.0-incubating</title>
- <para>Perform the following to upgrade from version 3.0.2 to version 4.0.0-incubating. Note that some of the steps here are only required if you're using a specific hypervisor. The steps that are hypervisor-specific are called out with a note.</para>
+ <para>Perform the following to upgrade from version 3.0.2 to version 4.0.0-incubating. Note
+ that some of the steps here are only required if you're using a specific hypervisor. The
+ steps that are hypervisor-specific are called out with a note.</para>
<orderedlist>
<listitem>
- <para>Ensure that you query your IP address usage records and process them or make a backup. During the upgrade you will lose the old IP address usage records.</para>
+ <para>Ensure that you query your IP address usage records and process them or make a
+ backup. During the upgrade you will lose the old IP address usage records.</para>
<para>Starting in 3.0.2, the usage record format for IP addresses is the same as the rest
of the usage types. Instead of a single record with the assignment and release dates,
separate records are generated per aggregation period with start and end dates. After
upgrading, any existing IP address usage records in the old format will no longer be
available.</para>
- </listitem>
- <listitem>
- <note><para>The following upgrade instructions apply only if you're using VMware hosts. If you're not using VMware hosts, skip this step and move on to step 3: stopping all usage servers.</para></note>
+ </listitem>
+ <listitem>
+ <note>
+ <para>The following upgrade instructions apply only if you're using VMware hosts. If
+ you're not using VMware hosts, skip this step and move on to step 3: stopping all
+ usage servers.</para>
+ </note>
<para>In each zone that includes VMware hosts, you need to add a new system VM template. </para>
<orderedlist numeration="loweralpha">
<listitem>
@@ -121,10 +138,10 @@
</tgroup>
</informaltable>
</listitem>
- <listitem>
- <para>Watch the screen to be sure that the template downloads successfully and enters the
- READY state. Do not proceed until this is successful.</para>
- </listitem>
+ <listitem>
+ <para>Watch the screen to be sure that the template downloads successfully and enters
+ the READY state. Do not proceed until this is successful.</para>
+ </listitem>
</orderedlist>
</listitem>
<listitem>
@@ -136,127 +153,186 @@
<programlisting># service cloud-management stop</programlisting>
</listitem>
<listitem>
- <para>On the MySQL master, take a backup of the MySQL databases. We recommend performing this step even in test upgrades. If there is an issue, this will assist with debugging.</para>
- <para>In the following commands, it is assumed that you have set the root password on the database, which is a CloudStack recommended best practice. Substitute your own MySQL root password.</para>
+ <para>On the MySQL master, take a backup of the MySQL databases. We recommend performing
+ this step even in test upgrades. If there is an issue, this will assist with
+ debugging.</para>
+ <para>In the following commands, it is assumed that you have set the root password on the
+ database, which is a CloudStack recommended best practice. Substitute your own MySQL
+ root password.</para>
<programlisting><prompt>#</prompt> <command>mysqldump</command> -u root -p<replaceable>mysql_password</replaceable> cloud > <filename>cloud-backup.dmp</filename>
<prompt>#</prompt> <command>mysqldump</command> -u root -p<replaceable>mysql_password</replaceable> cloud_usage > <filename>cloud-usage-backup.dmp</filename></programlisting>
</listitem>
<listitem>
- <para>Either build RPM/DEB packages as detailed in the Installation Guide, or use one of the community provided yum/apt repositories to gain access to the &PRODUCT; binaries.</para>
+ <para>Either build RPM/DEB packages as detailed in the Installation Guide, or use one of
+ the community provided yum/apt repositories to gain access to the &PRODUCT;
+ binaries.</para>
</listitem>
<listitem>
- <para>After you have configured an appropriate yum or apt repository, you may execute the one of the following commands as appropriate for your environment in order to upgrade &PRODUCT;:
- <programlisting><prompt>#</prompt> <command>yum</command> update cloud-*</programlisting>
- <programlisting><prompt>#</prompt> <command>apt-get</command> update
+ <para>After you have configured an appropriate yum or apt repository, you may execute the
+ one of the following commands as appropriate for your environment in order to upgrade
+ &PRODUCT;: <programlisting><prompt>#</prompt> <command>yum</command> update cloud-*</programlisting>
+ <programlisting><prompt>#</prompt> <command>apt-get</command> update
<prompt>#</prompt> <command>apt-get</command> upgrade cloud-*</programlisting>
- </para>
+ </para>
<note>
- <para>If the upgrade output includes a message similar to the following, then some custom content was found in your old components.xml, and you need to merge the two files:</para>
+ <para>If the upgrade output includes a message similar to the following, then some
+ custom content was found in your old components.xml, and you need to merge the two
+ files:</para>
<programlisting>warning: /etc/cloud/management/components.xml created as /etc/cloud/management/components.xml.rpmnew </programlisting>
<para>Instructions follow in the next step.</para>
</note>
</listitem>
<listitem>
- <para>If you have made changes to your copy of <filename>/etc/cloud/management/components.xml</filename> the changes will be preserved in the upgrade. However, you need to do the following steps to place these changes in a new version of the file which is compatible with version 4.0.0-incubating.</para>
+ <para>If you have made changes to your copy of
+ <filename>/etc/cloud/management/components.xml</filename> the changes will be
+ preserved in the upgrade. However, you need to do the following steps to place these
+ changes in a new version of the file which is compatible with version
+ 4.0.0-incubating.</para>
<orderedlist numeration="loweralpha">
<listitem>
- <para>Make a backup copy of <filename>/etc/cloud/management/components.xml</filename>. For example:</para>
+ <para>Make a backup copy of <filename>/etc/cloud/management/components.xml</filename>.
+ For example:</para>
<programlisting># mv /etc/cloud/management/components.xml /etc/cloud/management/components.xml-backup</programlisting>
</listitem>
<listitem>
- <para>Copy <filename>/etc/cloud/management/components.xml.rpmnew</filename> to create a new <filename>/etc/cloud/management/components.xml</filename>:</para>
+ <para>Copy <filename>/etc/cloud/management/components.xml.rpmnew</filename> to create
+ a new <filename>/etc/cloud/management/components.xml</filename>:</para>
<programlisting># cp -ap /etc/cloud/management/components.xml.rpmnew /etc/cloud/management/components.xml</programlisting>
</listitem>
<listitem>
- <para>Merge your changes from the backup file into the new <filename>components.xml</filename>.</para>
+ <para>Merge your changes from the backup file into the new
+ <filename>components.xml</filename>.</para>
<programlisting># vi /etc/cloud/management/components.xml</programlisting>
</listitem>
- </orderedlist>
- <note><para>If you have more than one management server node, repeat the upgrade steps on each node.</para></note>
+ </orderedlist>
+ <note>
+ <para>If you have more than one management server node, repeat the upgrade steps on each
+ node.</para>
+ </note>
</listitem>
<listitem>
- <para>Start the first Management Server. Do not start any other Management Server nodes yet.</para>
+ <para>Start the first Management Server. Do not start any other Management Server nodes
+ yet.</para>
<programlisting># service cloud-management start</programlisting>
- <para>Wait until the databases are upgraded. Ensure that the database upgrade is complete. After confirmation, start the other Management Servers one at a time by running the same command on each node.</para>
+ <para>Wait until the databases are upgraded. Ensure that the database upgrade is complete.
+ After confirmation, start the other Management Servers one at a time by running the same
+ command on each node.</para>
<note>
- <para>Failing to restart the Management Server indicates a problem in the upgrade. Having the Management Server restarted without any issues indicates that the upgrade is successfully completed.</para>
+ <para>Failing to restart the Management Server indicates a problem in the upgrade.
+ Having the Management Server restarted without any issues indicates that the upgrade
+ is successfully completed.</para>
</note>
</listitem>
<listitem>
- <para>Start all Usage Servers (if they were running on your previous version). Perform this on each Usage Server host.</para>
+ <para>Start all Usage Servers (if they were running on your previous version). Perform
+ this on each Usage Server host.</para>
<para><command># service cloud-usage start</command></para>
</listitem>
<listitem>
- <note><para>Additional steps are required for each KVM host. These steps will not affect running guests in the cloud. These steps are required only for clouds using KVM as hosts and only on the KVM hosts.</para></note>
+ <note>
+ <para>Additional steps are required for each KVM host. These steps will not affect
+ running guests in the cloud. These steps are required only for clouds using KVM as
+ hosts and only on the KVM hosts.</para>
+ </note>
<orderedlist numeration="loweralpha">
<listitem>
- <para>Configure a yum or apt respository containing the &PRODUCT; packages as outlined in the Installation Guide.</para>
+ <para>Configure a yum or apt respository containing the &PRODUCT; packages as outlined
+ in the Installation Guide.</para>
</listitem>
<listitem>
<para>Stop the running agent.</para>
<para><command># service cloud-agent stop</command></para>
</listitem>
<listitem>
- <para>Update the agent software with one of the following command sets as appropriate for your environment.</para>
- <para><command># yum update cloud-*</command></para>
- <para><command># apt-get update</command></para>
- <para><command># apt-get upgrade cloud-*</command></para>
+ <para>Update the agent software with one of the following command sets as appropriate
+ for your environment.</para>
+ <para><command># yum update cloud-*</command></para>
+ <para><command># apt-get update</command></para>
+ <para><command># apt-get upgrade cloud-*</command></para>
</listitem>
<listitem>
<para>Start the agent.</para>
<programlisting># service cloud-agent start</programlisting>
</listitem>
<listitem>
- <para>Edit <filename>/etc/cloud/agent/agent.properties</filename> to change the resource parameter from "com.cloud.agent.resource.computing.LibvirtComputingResource" to "com.cloud.hypervisor.kvm.resource.LibvirtComputingResource".</para>
+ <para>Edit <filename>/etc/cloud/agent/agent.properties</filename> to change the
+ resource parameter from
+ "com.cloud.agent.resource.computing.LibvirtComputingResource" to
+ "com.cloud.hypervisor.kvm.resource.LibvirtComputingResource".</para>
</listitem>
<listitem>
<para>Start the cloud agent and cloud management services.</para>
</listitem>
<listitem>
- <para>When the Management Server is up and running, log in to the CloudStack UI and restart the virtual router for proper functioning of all the features.</para>
+ <para>When the Management Server is up and running, log in to the CloudStack UI and
+ restart the virtual router for proper functioning of all the features.</para>
</listitem>
</orderedlist>
</listitem>
<listitem>
- <para>Log in to the CloudStack UI as administrator, and check the status of the hosts. All hosts should come to Up state (except those that you know to be offline). You may need to wait 20 or 30 minutes, depending on the number of hosts.</para>
+ <para>Log in to the CloudStack UI as administrator, and check the status of the hosts. All
+ hosts should come to Up state (except those that you know to be offline). You may need
+ to wait 20 or 30 minutes, depending on the number of hosts.</para>
<note>
- <para>Troubleshooting: If login fails, clear your browser cache and reload the page.</para>
+ <para>Troubleshooting: If login fails, clear your browser cache and reload the
+ page.</para>
</note>
<para/>
- <para>Do not proceed to the next step until the hosts show in Up state.</para>
+ <para>Do not proceed to the next step until the hosts show in Up state.</para>
</listitem>
<listitem>
<para>If you are upgrading from 3.0.2, perform the following:</para>
<orderedlist numeration="loweralpha">
<listitem>
- <para>Ensure that the admin port is set to 8096 by using the "integration.api.port" global parameter.</para>
- <para>This port is used by the cloud-sysvmadm script at the end of the upgrade procedure. For information about how to set this parameter, see "Setting Global Configuration Parameters" in the Installation Guide.</para>
+ <para>Ensure that the admin port is set to 8096 by using the "integration.api.port"
+ global parameter.</para>
+ <para>This port is used by the cloud-sysvmadm script at the end of the upgrade
+ procedure. For information about how to set this parameter, see "Setting Global
+ Configuration Parameters" in the Installation Guide.</para>
</listitem>
<listitem>
<para>Restart the Management Server.</para>
<note>
- <para>If you don't want the admin port to remain open, you can set it to null after the upgrade is done and restart the management server.</para>
+ <para>If you don't want the admin port to remain open, you can set it to null after
+ the upgrade is done and restart the management server.</para>
</note>
</listitem>
</orderedlist>
</listitem>
<listitem>
- <para>Run the <command>cloud-sysvmadm</command> script to stop, then start, all Secondary Storage VMs, Console Proxy VMs, and virtual routers. Run the script once on each management server. Substitute your own IP address of the MySQL instance, the MySQL user to connect as, and the password to use for that user. In addition to those parameters, provide the <command>-c</command> and <command>-r</command> arguments. For example:</para>
- <para><command># nohup cloud-sysvmadm -d 192.168.1.5 -u cloud -p password -c -r > sysvm.log 2>&1 &</command></para>
- <para><command># tail -f sysvm.log</command></para>
- <para>This might take up to an hour or more to run, depending on the number of accounts in the system.</para>
+ <para>Run the <command>cloud-sysvmadm</command> script to stop, then start, all Secondary
+ Storage VMs, Console Proxy VMs, and virtual routers. Run the script once on each
+ management server. Substitute your own IP address of the MySQL instance, the MySQL user
+ to connect as, and the password to use for that user. In addition to those parameters,
+ provide the <command>-c</command> and <command>-r</command> arguments. For
+ example:</para>
+ <para><command># nohup cloud-sysvmadm -d 192.168.1.5 -u cloud -p password -c -r >
+ sysvm.log 2>&1 &</command></para>
+ <para><command># tail -f sysvm.log</command></para>
+ <para>This might take up to an hour or more to run, depending on the number of accounts in
+ the system.</para>
</listitem>
<listitem>
- <para>If needed, upgrade all Citrix XenServer hypervisor hosts in your cloud to a version supported by CloudStack 4.0.0-incubating. The supported versions are XenServer 5.6 SP2 and 6.0.2. Instructions for upgrade can be found in the CloudStack 4.0.0-incubating Installation Guide.</para>
+ <para>If needed, upgrade all Citrix XenServer hypervisor hosts in your cloud to a version
+ supported by CloudStack 4.0.0-incubating. The supported versions are XenServer 5.6 SP2
+ and 6.0.2. Instructions for upgrade can be found in the CloudStack 4.0.0-incubating
+ Installation Guide.</para>
</listitem>
<listitem>
- <para>Now apply the XenServer hotfix XS602E003 (and any other needed hotfixes) to XenServer v6.0.2 hypervisor hosts.</para>
+ <para>Now apply the XenServer hotfix XS602E003 (and any other needed hotfixes) to
+ XenServer v6.0.2 hypervisor hosts.</para>
<orderedlist numeration="loweralpha">
<listitem>
<para>Disconnect the XenServer cluster from CloudStack.</para>
- <para>In the left navigation bar of the CloudStack UI, select Infrastructure. Under Clusters, click View All. Select the XenServer cluster and click Actions - Unmanage.</para>
- <para>This may fail if there are hosts not in one of the states Up, Down, Disconnected, or Alert. You may need to fix that before unmanaging this cluster.</para>
- <para>Wait until the status of the cluster has reached Unmanaged. Use the CloudStack UI to check on the status. When the cluster is in the unmanaged state, there is no connection to the hosts in the cluster.</para>
+ <para>In the left navigation bar of the CloudStack UI, select Infrastructure. Under
+ Clusters, click View All. Select the XenServer cluster and click Actions -
+ Unmanage.</para>
+ <para>This may fail if there are hosts not in one of the states Up, Down,
+ Disconnected, or Alert. You may need to fix that before unmanaging this
+ cluster.</para>
+ <para>Wait until the status of the cluster has reached Unmanaged. Use the CloudStack
+ UI to check on the status. When the cluster is in the unmanaged state, there is no
+ connection to the hosts in the cluster.</para>
</listitem>
<listitem>
<para>To clean up the VLAN, log in to one XenServer host and run:</para>
@@ -265,34 +341,51 @@
<listitem>
<para>Now prepare the upgrade by running the following on one XenServer host:</para>
<para><command>/opt/xensource/bin/cloud-prepare-upgrade.sh</command></para>
- <para>If you see a message like "can't eject CD", log in to the VM and unmount the CD, then run this script again.</para>
+ <para>If you see a message like "can't eject CD", log in to the VM and unmount the CD,
+ then run this script again.</para>
</listitem>
<listitem>
- <para>Upload the hotfix to the XenServer hosts. Always start with the Xen pool master, then the slaves. Using your favorite file copy utility (e.g. WinSCP), copy the hotfixes to the host. Place them in a temporary folder such as /tmp. </para>
+ <para>Upload the hotfix to the XenServer hosts. Always start with the Xen pool master,
+ then the slaves. Using your favorite file copy utility (e.g. WinSCP), copy the
+ hotfixes to the host. Place them in a temporary folder such as /tmp. </para>
<para>On the Xen pool master, upload the hotfix with this command:</para>
<para><command>xe patch-upload file-name=XS602E003.xsupdate</command></para>
- <para>Make a note of the output from this command, which is a UUID for the hotfix file. You'll need it in another step later.</para>
+ <para>Make a note of the output from this command, which is a UUID for the hotfix
+ file. You'll need it in another step later.</para>
<note>
- <para>(Optional) If you are applying other hotfixes as well, you can repeat the commands in this section with the appropriate hotfix number. For example, XS602E004.xsupdate.</para>
+ <para>(Optional) If you are applying other hotfixes as well, you can repeat the
+ commands in this section with the appropriate hotfix number. For example,
+ XS602E004.xsupdate.</para>
</note>
</listitem>
<listitem>
- <para>Manually live migrate all VMs on this host to another host. First, get a list of the VMs on this host:</para>
+ <para>Manually live migrate all VMs on this host to another host. First, get a list of
+ the VMs on this host:</para>
<para><command># xe vm-list</command></para>
- <para>Then use this command to migrate each VM. Replace the example host name and VM name with your own:</para>
- <para><command># xe vm-migrate live=true host=<replaceable>host-name</replaceable> vm=<replaceable>VM-name</replaceable></command></para>
- <note><title>Troubleshooting</title>
- <para>If you see a message like "You attempted an operation on a VM which requires PV drivers to be installed but the drivers were not detected," run:</para>
- <para><command>/opt/xensource/bin/make_migratable.sh b6cf79c8-02ee-050b-922f-49583d9f1a14</command>.</para></note>
+ <para>Then use this command to migrate each VM. Replace the example host name and VM
+ name with your own:</para>
+ <para><command># xe vm-migrate live=true host=<replaceable>host-name</replaceable>
+ vm=<replaceable>VM-name</replaceable></command></para>
+ <note>
+ <title>Troubleshooting</title>
+ <para>If you see a message like "You attempted an operation on a VM which requires
+ PV drivers to be installed but the drivers were not detected," run:</para>
+ <para><command>/opt/xensource/bin/make_migratable.sh
+ b6cf79c8-02ee-050b-922f-49583d9f1a14</command>.</para>
+ </note>
</listitem>
<listitem>
<para>Apply the hotfix. First, get the UUID of this host:</para>
<programlisting># xe host-list</programlisting>
- <para>Then use the following command to apply the hotfix. Replace the example host UUID with the current host ID, and replace the hotfix UUID with the output from the patch-upload command you ran on this machine earlier. You can also get the hotfix UUID by running xe patch-list. </para>
+ <para>Then use the following command to apply the hotfix. Replace the example host
+ UUID with the current host ID, and replace the hotfix UUID with the output from the
+ patch-upload command you ran on this machine earlier. You can also get the hotfix
+ UUID by running xe patch-list. </para>
<programlisting><command>xe</command> patch-apply host-uuid=<replaceable>host-uuid</replaceable> uuid=<replaceable>hotfix-uuid</replaceable></programlisting>
</listitem>
<listitem>
- <para>Copy the following files from the CloudStack Management Server to the host.</para>
+ <para>Copy the following files from the CloudStack Management Server to the
+ host.</para>
<informaltable>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*" colname="1" colnum="1"/>
@@ -305,15 +398,15 @@
</thead>
<tbody>
<row>
- <entry><para>/usr/lib64/cloud/agent/scripts/vm/hypervisor/xenserver/xenserver60/NFSSR.py</para></entry>
+ <entry><para>/usr/lib64/cloud/common/scripts/vm/hypervisor/xenserver/xenserver60/NFSSR.py</para></entry>
<entry><para>/opt/xensource/sm/NFSSR.py</para></entry>
</row>
<row>
- <entry><para>/usr/lib64/cloud/agent/scripts/vm/hypervisor/xenserver/setupxenserver.sh</para></entry>
+ <entry><para>/usr/lib64/cloud/common/scripts/vm/hypervisor/xenserver/setupxenserver.sh</para></entry>
<entry><para>/opt/xensource/bin/setupxenserver.sh</para></entry>
</row>
<row>
- <entry><para>/usr/lib64/cloud/agent/scripts/vm/hypervisor/xenserver/make_migratable.sh</para></entry>
+ <entry><para>/usr/lib64/cloud/common/scripts/vm/hypervisor/xenserver/make_migratable.sh</para></entry>
<entry><para>/opt/xensource/bin/make_migratable.sh</para></entry>
</row>
</tbody>
@@ -325,11 +418,14 @@
Support Pack.</para>
<itemizedlist>
<listitem>
- <para>Download the CSP software onto the XenServer host from one of the following links:</para>
+ <para>Download the CSP software onto the XenServer host from one of the following
+ links:</para>
<para>For hotfix XS602E005: <ulink
url="http://coltrane.eng.hq.xensource.com/release/XenServer-6.x/XS-6.0.2/hotfixes/XS602E005/56710/xe-phase-2/xenserver-cloud-supp.tgz"
>http://coltrane.eng.hq.xensource.com/release/XenServer-6.x/XS-6.0.2/hotfixes/XS602E005/56710/xe-phase-2/xenserver-cloud-supp.tgz</ulink></para>
- <para>For hotfix XS602E007: <ulink url="http://coltrane.eng.hq.xensource.com/release/XenServer-6.x/XS-6.0.2/hotfixes/XS602E007/57824/xe-phase-2/xenserver-cloud-supp.tgz">http://coltrane.eng.hq.xensource.com/release/XenServer-6.x/XS-6.0.2/hotfixes/XS602E007/57824/xe-phase-2/xenserver-cloud-supp.tgz</ulink></para>
+ <para>For hotfix XS602E007: <ulink
+ url="http://coltrane.eng.hq.xensource.com/release/XenServer-6.x/XS-6.0.2/hotfixes/XS602E007/57824/xe-phase-2/xenserver-cloud-supp.tgz"
+ >http://coltrane.eng.hq.xensource.com/release/XenServer-6.x/XS-6.0.2/hotfixes/XS602E007/57824/xe-phase-2/xenserver-cloud-supp.tgz</ulink></para>
</listitem>
<listitem>
<para>Extract the file:</para>
@@ -353,7 +449,8 @@
<para>Run the following:</para>
<programlisting>/opt/xensource/bin/setupxenserver.sh</programlisting>
<note>
- <para>If the message "mv: cannot stat `/etc/cron.daily/logrotate': No such file or directory" appears, you can safely ignore it.</para>
+ <para>If the message "mv: cannot stat `/etc/cron.daily/logrotate': No such file or
+ directory" appears, you can safely ignore it.</para>
</note>
</listitem>
<listitem>
@@ -361,26 +458,39 @@
<programlisting>for pbd in `xe pbd-list currently-attached=false| grep ^uuid | awk '{print $NF}'`; do xe pbd-plug uuid=$pbd ; </programlisting>
</listitem>
<listitem>
- <para>On each slave host in the Xen pool, repeat these steps, starting from "manually live migrate VMs."</para>
+ <para>On each slave host in the Xen pool, repeat these steps, starting from "manually
+ live migrate VMs."</para>
</listitem>
</orderedlist>
</listitem>
</orderedlist>
- <note><title>Troubleshooting Tip</title>
- <para>If passwords which you know to be valid appear not to work after upgrade, or other UI issues are seen, try clearing your browser cache and reloading the UI page.</para>
+ <note>
+ <title>Troubleshooting Tip</title>
+ <para>If passwords which you know to be valid appear not to work after upgrade, or other UI
+ issues are seen, try clearing your browser cache and reloading the UI page.</para>
</note>
</section>
<section id="upgrade-from-2.2.x-to-4.0">
<title>Upgrade from 2.2.14 to 4.0</title>
<orderedlist>
<listitem>
- <para>Ensure that you query your IPaddress usage records and process them; for example, issue invoices for any usage that you have not yet billed users for.</para>
- <para>Starting in 3.0.2, the usage record format for IP addresses is the same as the rest of the usage types. Instead of a single record with the assignment and release dates, separate records are generated per aggregation period with start and end dates. After upgrading to 4.0.0-incubating, any existing IP address usage records in the old format will no longer be available.</para>
- </listitem>
- <listitem>
- <para>If you are using version 2.2.0 - 2.2.13, first upgrade to 2.2.14 by using the instructions in the 2.2.14 Release Notes.</para>
- <warning><title>KVM Hosts</title>
- <para>If KVM hypervisor is used in your cloud, be sure you completed the step to insert a valid username and password into the host_details table on each KVM node as described in the 2.2.14 Release Notes. This step is critical, as the database will be encrypted after the upgrade to 4.0.0-incubating.</para>
+ <para>Ensure that you query your IPaddress usage records and process them; for example,
+ issue invoices for any usage that you have not yet billed users for.</para>
+ <para>Starting in 3.0.2, the usage record format for IP addresses is the same as the rest
+ of the usage types. Instead of a single record with the assignment and release dates,
+ separate records are generated per aggregation period with start and end dates. After
+ upgrading to 4.0.0-incubating, any existing IP address usage records in the old format
+ will no longer be available.</para>
+ </listitem>
+ <listitem>
+ <para>If you are using version 2.2.0 - 2.2.13, first upgrade to 2.2.14 by using the
+ instructions in the 2.2.14 Release Notes.</para>
+ <warning>
+ <title>KVM Hosts</title>
+ <para>If KVM hypervisor is used in your cloud, be sure you completed the step to insert
+ a valid username and password into the host_details table on each KVM node as
+ described in the 2.2.14 Release Notes. This step is critical, as the database will be
+ encrypted after the upgrade to 4.0.0-incubating.</para>
</warning>
</listitem>
<listitem>
@@ -498,20 +608,17 @@
</programlisting>
</listitem>
<listitem>
- <para>
- Either build RPM/DEB packages as detailed in the Installation Guide, or use one of
- the community provided yum/apt repositories to gain access to the &PRODUCT; binaries.
+ <para> Either build RPM/DEB packages as detailed in the Installation Guide, or use one of
+ the community provided yum/apt repositories to gain access to the &PRODUCT; binaries.
</para>
</listitem>
<listitem>
- <para>
- After you have configured an appropriate yum or apt repository, you
- may execute the one of the following commands as appropriate for your
- environment in order to upgrade &PRODUCT;:
- <programlisting><prompt>#</prompt> <command>yum</command> update cloud-*</programlisting>
- <programlisting><prompt>#</prompt> <command>apt-get</command> update
+ <para> After you have configured an appropriate yum or apt repository, you may execute the
+ one of the following commands as appropriate for your environment in order to upgrade
+ &PRODUCT;: <programlisting><prompt>#</prompt> <command>yum</command> update cloud-*</programlisting>
+ <programlisting><prompt>#</prompt> <command>apt-get</command> update
<prompt>#</prompt> <command>apt-get</command> upgrade cloud-*</programlisting>
- </para>
+ </para>
</listitem>
<listitem>
<para>If you have made changes to your existing copy of the file components.xml in your
@@ -526,13 +633,14 @@
<programlisting>warning: /etc/cloud/management/components.xml created as /etc/cloud/management/components.xml.rpmnew </programlisting>
<orderedlist numeration="loweralpha">
<listitem>
- <para>Make a backup copy of your <filename>/etc/cloud/management/components.xml</filename> file. For
+ <para>Make a backup copy of your
+ <filename>/etc/cloud/management/components.xml</filename> file. For
example:</para>
<programlisting><prompt>#</prompt> <command>mv</command> <filename>/etc/cloud/management/components.xml</filename> <filename>/etc/cloud/management/components.xml-backup</filename></programlisting>
</listitem>
<listitem>
- <para>Copy <filename>/etc/cloud/management/components.xml.rpmnew</filename> to create a new
- <filename>/etc/cloud/management/components.xml</filename>:</para>
+ <para>Copy <filename>/etc/cloud/management/components.xml.rpmnew</filename> to create
+ a new <filename>/etc/cloud/management/components.xml</filename>:</para>
<programlisting><prompt>#</prompt> <command>cp</command> -ap <filename>/etc/cloud/management/components.xml.rpmnew</filename> <filename>/etc/cloud/management/components.xml</filename></programlisting>
</listitem>
<listitem>
@@ -544,19 +652,19 @@
</listitem>
<listitem>
<para>If you have made changes to your existing copy of the
- <filename>/etc/cloud/management/db.properties</filename> file in your previous-version CloudStack
- installation, the changes will be preserved in the upgrade. However, you need to do the
- following steps to place these changes in a new version of the file which is compatible
- with version 4.0.</para>
+ <filename>/etc/cloud/management/db.properties</filename> file in your previous-version
+ CloudStack installation, the changes will be preserved in the upgrade. However, you need
+ to do the following steps to place these changes in a new version of the file which is
+ compatible with version 4.0.0-incubating.</para>
<orderedlist>
<listitem>
- <para>Make a backup copy of your file <filename>/etc/cloud/management/db.properties</filename>. For
- example:</para>
+ <para>Make a backup copy of your file
+ <filename>/etc/cloud/management/db.properties</filename>. For example:</para>
<programlisting><prompt>#</prompt> <command>mv</command> <filename>/etc/cloud/management/db.properties</filename> <filename>/etc/cloud/management/db.properties-backup</filename></programlisting>
</listitem>
<listitem>
- <para>Copy <filename>/etc/cloud/management/db.properties.rpmnew</filename> to create a new
- <filename>/etc/cloud/management/db.properties</filename>:</para>
+ <para>Copy <filename>/etc/cloud/management/db.properties.rpmnew</filename> to create a
+ new <filename>/etc/cloud/management/db.properties</filename>:</para>
<programlisting><prompt>#</prompt> <command>cp</command> -ap <filename>/etc/cloud/management/db.properties.rpmnew</filename> <filename>etc/cloud/management/db.properties</filename></programlisting>
</listitem>
<listitem>
@@ -612,17 +720,16 @@
as hosts and only on the KVM hosts.</para>
<orderedlist numeration="loweralpha">
<listitem>
- <para>
- Configure your CloudStack package repositories as outlined
- in the Installation Guide
- </para>
+ <para> Configure your CloudStack package repositories as outlined in the Installation
+ Guide </para>
</listitem>
<listitem>
<para>Stop the running agent.</para>
<programlisting># service cloud-agent stop</programlisting>
</listitem>
<listitem>
- <para>Update the agent software with one of the following command sets as appropriate.</para>
+ <para>Update the agent software with one of the following command sets as
+ appropriate.</para>
<programlisting><prompt>#</prompt> <command>yum</command> update cloud-*</programlisting>
<programlisting>
<prompt>#</prompt> <command>apt-get</command> update
@@ -634,11 +741,9 @@
<programlisting># service cloud-agent start</programlisting>
</listitem>
<listitem>
- <para>
- Copy the contents of the <filename>agent.properties</filename>
- file to the new <filename>agent.properties</filename> file
- by using the following command</para>
- <programlisting><command>sed</command> -i 's/com.cloud.agent.resource.computing.LibvirtComputingResource/com.cloud.hypervisor.kvm.resource.LibvirtComputingResource/g' <filename>/etc/cloud/agent/agent.properties</filename></programlisting>
+ <para> Copy the contents of the <filename>agent.properties</filename> file to the new
+ <filename>agent.properties</filename> file by using the following command</para>
+ <programlisting><command>sed</command> -i 's/com.cloud.agent.resource.computing.LibvirtComputingResource/com.cloud.hypervisor.kvm.resource.LibvirtComputingResource/g' <filename>/etc/cloud/agent/agent.properties</filename></programlisting>
</listitem>
<listitem>
<para>Start the cloud agent and cloud management services.</para>
@@ -717,8 +822,9 @@ Done restarting router(s).
</listitem>
<listitem>
<para>If needed, upgrade all Citrix XenServer hypervisor hosts in your cloud to a version
- supported by CloudStack 4.0. The supported versions are XenServer 5.6 SP2 and 6.0.2.
- Instructions for upgrade can be found in the CloudStack 4.0 Installation Guide.</para>
+ supported by CloudStack 4.0.0-incubating. The supported versions are XenServer 5.6 SP2
+ and 6.0.2. Instructions for upgrade can be found in the CloudStack 4.0.0-incubating
+ Installation Guide.</para>
</listitem>
<listitem>
<para>Apply the XenServer hotfix XS602E003 (and any other needed hotfixes) to XenServer
@@ -767,17 +873,27 @@ Done restarting router(s).
<para>Then use this command to migrate each VM. Replace the example host name and VM
name with your own:</para>
<programlisting><prompt>#</prompt> <command>xe</command> vm-migrate live=true host=<replaceable>host-name</replaceable> vm=<replaceable>VM-name</replaceable></programlisting>
- <note><title>Troubleshooting</title><para>If you see a message like "You attempted an operation on a VM which requires PV drivers to be installed but the drivers were not detected," run:</para>
- <para><command>/opt/xensource/bin/make_migratable.sh b6cf79c8-02ee-050b-922f-49583d9f1a14</command>.</para></note>
+ <note>
+ <title>Troubleshooting</title>
+ <para>If you see a message like "You attempted an operation on a VM which requires
+ PV drivers to be installed but the drivers were not detected," run:</para>
+ <para><command>/opt/xensource/bin/make_migratable.sh
+ b6cf79c8-02ee-050b-922f-49583d9f1a14</command>.</para>
+ </note>
</listitem>
<listitem>
<para>Apply the hotfix. First, get the UUID of this host:</para>
<para><command># xe host-list</command></para>
- <para>Then use the following command to apply the hotfix. Replace the example host UUID with the current host ID, and replace the hotfix UUID with the output from the patch-upload command you ran on this machine earlier. You can also get the hotfix UUID by running xe patch-list. </para>
- <para><command>xe patch-apply host-uuid=<replaceable>host-uuid</replaceable> uuid=<replaceable>hotfix-uuid</replaceable></command></para>
+ <para>Then use the following command to apply the hotfix. Replace the example host
+ UUID with the current host ID, and replace the hotfix UUID with the output from the
+ patch-upload command you ran on this machine earlier. You can also get the hotfix
+ UUID by running xe patch-list. </para>
+ <para><command>xe patch-apply host-uuid=<replaceable>host-uuid</replaceable>
+ uuid=<replaceable>hotfix-uuid</replaceable></command></para>
</listitem>
<listitem>
- <para>Copy the following files from the CloudStack Management Server to the host.</para>
+ <para>Copy the following files from the CloudStack Management Server to the
+ host.</para>
<informaltable>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*" colname="1" colnum="1"/>
@@ -790,28 +906,34 @@ Done restarting router(s).
</thead>
<tbody>
<row>
- <entry><para><filename>/usr/lib64/cloud/agent/scripts/vm/hypervisor/xenserver/xenserver60/NFSSR.py</filename></para></entry>
- <entry><para><filename>/opt/xensource/sm/NFSSR.py</filename></para></entry>
+ <entry><para><filename>/usr/lib64/cloud/common/scripts/vm/hypervisor/xenserver/xenserver60/NFSSR.py</filename></para></entry>
+ <entry><para><filename>/opt/xensource/sm/NFSSR.py</filename></para></entry>
</row>
<row>
- <entry><para><filename>/usr/lib64/cloud/agent/scripts/vm/hypervisor/xenserver/setupxenserver.sh</filename></para></entry>
- <entry><para><filename>/opt/xensource/bin/setupxenserver.sh</filename></para></entry>
+ <entry><para><filename>/usr/lib64/cloud/common/scripts/vm/hypervisor/xenserver/setupxenserver.sh</filename></para></entry>
+ <entry><para><filename>/opt/xensource/bin/setupxenserver.sh</filename></para></entry>
</row>
<row>
- <entry><para><filename>/usr/lib64/cloud/agent/scripts/vm/hypervisor/xenserver/make_migratable.sh</filename></para></entry>
- <entry><para><filename>/opt/xensource/bin/make_migratable.sh</filename></para></entry>
+ <entry><para><filename>/usr/lib64/cloud/common/scripts/vm/hypervisor/xenserver/make_migratable.sh</filename></para></entry>
+ <entry><para><filename>/opt/xensource/bin/make_migratable.sh</filename></para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</listitem>
<listitem>
- <para>(Only for hotfixes XS602E005 and XS602E007) You need to apply a new Cloud Support Pack.</para>
+ <para>(Only for hotfixes XS602E005 and XS602E007) You need to apply a new Cloud
+ Support Pack.</para>
<itemizedlist>
<listitem>
- <para>Download the CSP software onto the XenServer host from one of the following links:</para>
- <para>For hotfix XS602E005: <ulink url="http://coltrane.eng.hq.xensource.com/release/XenServer-6.x/XS-6.0.2/hotfixes/XS602E005/56710/xe-phase-2/xenserver-cloud-supp.tgz">http://coltrane.eng.hq.xensource.com/release/XenServer-6.x/XS-6.0.2/hotfixes/XS602E005/56710/xe-phase-2/xenserver-cloud-supp.tgz</ulink></para>
- <para>For hotfix XS602E007: <ulink url="http://coltrane.eng.hq.xensource.com/release/XenServer-6.x/XS-6.0.2/hotfixes/XS602E007/57824/xe-phase-2/xenserver-cloud-supp.tgz">http://coltrane.eng.hq.xensource.com/release/XenServer-6.x/XS-6.0.2/hotfixes/XS602E007/57824/xe-phase-2/xenserver-cloud-supp.tgz</ulink></para>
+ <para>Download the CSP software onto the XenServer host from one of the following
+ links:</para>
+ <para>For hotfix XS602E005: <ulink
+ url="http://coltrane.eng.hq.xensource.com/release/XenServer-6.x/XS-6.0.2/hotfixes/XS602E005/56710/xe-phase-2/xenserver-cloud-supp.tgz"
+ >http://coltrane.eng.hq.xensource.com/release/XenServer-6.x/XS-6.0.2/hotfixes/XS602E005/56710/xe-phase-2/xenserver-cloud-supp.tgz</ulink></para>
+ <para>For hotfix XS602E007: <ulink
+ url="http://coltrane.eng.hq.xensource.com/release/XenServer-6.x/XS-6.0.2/hotfixes/XS602E007/57824/xe-phase-2/xenserver-cloud-supp.tgz"
+ >http://coltrane.eng.hq.xensource.com/release/XenServer-6.x/XS-6.0.2/hotfixes/XS602E007/57824/xe-phase-2/xenserver-cloud-supp.tgz</ulink></para>
</listitem>
<listitem>
<para>Extract the file:</para>
@@ -819,11 +941,13 @@ Done restarting router(s).
</listitem>
<listitem>
<para>Run the following script:</para>
- <para><command># xe-install-supplemental-pack xenserver-cloud-supp.iso</command></para>
+ <para><command># xe-install-supplemental-pack
+ xenserver-cloud-supp.iso</command></para>
</listitem>
<listitem>
- <para>If the XenServer host is part of a zone that uses basic networking, disable Open vSwitch (OVS):</para>
- <para><command># xe-switch-network-backend bridge</command></para>
+ <para>If the XenServer host is part of a zone that uses basic networking, disable
+ Open vSwitch (OVS):</para>
+ <para><command># xe-switch-network-backend bridge</command></para>
</listitem>
</itemizedlist>
</listitem>
@@ -834,16 +958,19 @@ Done restarting router(s).
<para>Run the following:</para>
<para><command>/opt/xensource/bin/setupxenserver.sh</command></para>
<note>
- <para>If the message "mv: cannot stat `/etc/cron.daily/logrotate': No such file or directory" appears, you can safely ignore it.</para>
+ <para>If the message "mv: cannot stat `/etc/cron.daily/logrotate': No such file or
+ directory" appears, you can safely ignore it.</para>
</note>
</listitem>
<listitem>
- <para>Run the following:</para>
- <para><command>for pbd in `xe pbd-list currently-attached=false| grep ^uuid | awk '{print $NF}'`; do xe pbd-plug uuid=$pbd ; </command>
- </para>
+ <para>Run the following:</para>
+ <para><command>for pbd in `xe pbd-list currently-attached=false| grep ^uuid | awk
+ '{print $NF}'`; do xe pbd-plug uuid=$pbd ; </command>
+ </para>
</listitem>
<listitem>
- <para>On each slave host in the Xen pool, repeat these steps, starting from "manually live migrate VMs."</para>
+ <para>On each slave host in the Xen pool, repeat these steps, starting from "manually
+ live migrate VMs."</para>
</listitem>
</orderedlist>
</listitem>
@@ -857,12 +984,25 @@ Done restarting router(s).
<para>Apache CloudStack 4.0 includes the following new features:</para>
<section id="inter-vlan-routing">
<title>Inter-VLAN Routing</title>
- <para>Inter-VLAN Routing is the capability to route network traffic between VLANs. This feature enables you to set up Virtual Private Clouds (VPC) that can hold multi-tier applications. These tiers are deployed on different VLANs that can communicate with each other. You can provision VLANs to the tiers your create, and VMs can be deployed on different tiers, such as Web, Application, or Database. The VLANs are connected to a virtual router, which facilitates communication between the VMs. In effect, you can segment VMs by means of VLANs into different networks that can host multi-tier applications. Such segmentation by means of VLANs logically separate application VMs for higher security and lower broadcasts, while remaining physically connected to the same device.</para>
+ <para>Inter-VLAN Routing is the capability to route network traffic between VLANs. This
+ feature enables you to set up Virtual Private Clouds (VPC) that can hold multi-tier
+ applications. These tiers are deployed on different VLANs that can communicate with each
+ other. You can provision VLANs to the tiers your create, and VMs can be deployed on
+ different tiers, such as Web, Application, or Database. The VLANs are connected to a
+ virtual router, which facilitates communication between the VMs. In effect, you can
+ segment VMs by means of VLANs into different networks that can host multi-tier
+ applications. Such segmentation by means of VLANs logically separate application VMs for
+ higher security and lower broadcasts, while remaining physically connected to the same
+ device.</para>
<para>This feature is supported on XenServer and VMware hypervisors.</para>
</section>
<section id="site-to-site-vpn">
<title>Site-to-Site VPN</title>
- <para>A Site-to-Site VPN connection helps you establish a secure connection from an enterprise datacenter to the cloud infrastructure. This allows users to access the guest VMs by establishing a VPN connection to the virtual router of the account from a device in the datacenter of the enterprise. Having this facility eliminates the need to establish VPN connections to individual VMs.</para>
+ <para>A Site-to-Site VPN connection helps you establish a secure connection from an
+ enterprise datacenter to the cloud infrastructure. This allows users to access the guest
+ VMs by establishing a VPN connection to the virtual router of the account from a device in
+ the datacenter of the enterprise. Having this facility eliminates the need to establish
+ VPN connections to individual VMs.</para>
<para>The supported endpoints on the remote datacenters are:</para>
<itemizedlist>
<listitem>
@@ -875,25 +1015,50 @@ Done restarting router(s).
</section>
<section id="local-storage-support">
<title>Local Storage Support for Data Volumes</title>
- <para>You can now create data volumes on local storage. The data volume is placed on the same XenServer host as the VM instance that is attached to the data volume. These local data volumes can be attached to virtual machines, detached, re-attached, and deleted just as with the other types of data volume. In earlier releases of CloudStack, only the root disk could be placed in local storage.</para>
- <para>Local storage is ideal for scenarios where persistence of data volumes and HA is not required. Some of the benefits include reduced disk I/O latency and cost reduction from using inexpensive local disks.</para>
- <para>In order for local volumes to be used, the feature must be enabled for the zone.</para>
- <para>You can create a data disk offering for local storage. When a user creates a new VM, they can select this disk offering in order to cause the data disk volume to be placed in local storage.</para>
- <para>You can not migrate a VM that has a volume in local storage to a different host, nor migrate the volume itself away to a different host. If you want to put a host into maintenance mode, you must first stop any VMs with local data volumes on that host.</para>
- <para>Local storage support for volumes is available for XenServer, KVM, and VMware hypervisors.</para>
+ <para>You can now create data volumes on local storage. The data volume is placed on the
+ same XenServer host as the VM instance that is attached to the data volume. These local
+ data volumes can be attached to virtual machines, detached, re-attached, and deleted just
+ as with the other types of data volume. In earlier releases of CloudStack, only the root
+ disk could be placed in local storage.</para>
+ <para>Local storage is ideal for scenarios where persistence of data volumes and HA is not
+ required. Some of the benefits include reduced disk I/O latency and cost reduction from
+ using inexpensive local disks.</para>
+ <para>In order for local volumes to be used, the feature must be enabled for the
+ zone.</para>
+ <para>You can create a data disk offering for local storage. When a user creates a new VM,
+ they can select this disk offering in order to cause the data disk volume to be placed in
+ local storage.</para>
+ <para>You can not migrate a VM that has a volume in local storage to a different host, nor
+ migrate the volume itself away to a different host. If you want to put a host into
+ maintenance mode, you must first stop any VMs with local data volumes on that host.</para>
+ <para>Local storage support for volumes is available for XenServer, KVM, and VMware
+ hypervisors.</para>
</section>
<section id="tags">
<title>Tags</title>
- <para>A tag is a key-value pair that stores metadata about a resource in the cloud. Tags are useful for categorizing resources. For example, you can tag a user VM with a value that indicates the user's city of residence. In this case, the key would be "city" and the value might be "Toronto" or "Tokyo." You can then request CloudStack to find all resources that have a given tag; for example, VMs for users in a given city.</para>
- <para>You can tag a user virtual machine, volume, snapshot, guest network, template, ISO, firewall rule, port forwarding rule, public IP address, security group, load balancer rule, project, VPC, network ACL, or static route. You can not tag a remote access VPN.</para>
- <para>You can work with tags through the UI or through the new API commands createTags, deleteTags, and listTags. You can define multiple tags for each resource. There is no limit on the number of tags you can define. Each tag can be up to 255 characters long. Users can define tags on the resources they own, and administrators can define tags on any resources in the cloud.</para>
- <para>A new optional input parameter, "tags," has been added to many of the list* API commands. The following example shows how to use this new parameter to find all the volumes having tag region=canada OR tag city=Toronto:</para>
+ <para>A tag is a key-value pair that stores metadata about a resource in the cloud. Tags are
+ useful for categorizing resources. For example, you can tag a user VM with a value that
+ indicates the user's city of residence. In this case, the key would be "city" and the
+ value might be "Toronto" or "Tokyo." You can then request CloudStack to find all resources
+ that have a given tag; for example, VMs for users in a given city.</para>
+ <para>You can tag a user virtual machine, volume, snapshot, guest network, template, ISO,
+ firewall rule, port forwarding rule, public IP address, security group, load balancer
+ rule, project, VPC, network ACL, or static route. You can not tag a remote access
+ VPN.</para>
+ <para>You can work with tags through the UI or through the new API commands createTags,
+ deleteTags, and listTags. You can define multiple tags for each resource. There is no
+ limit on the number of tags you can define. Each tag can be up to 255 characters long.
+ Users can define tags on the resources they own, and administrators can define tags on any
+ resources in the cloud.</para>
+ <para>A new optional input parameter, "tags," has been added to many of the list* API
+ commands. The following example shows how to use this new parameter to find all the
+ volumes having tag region=canada OR tag city=Toronto:</para>
<programlisting>command=listVolumes
- &listAll=true
- &tags[0].key=region
- &tags[0].value=canada
- &tags[1].key=city
- &tags[1].value=Toronto</programlisting>
+&listAll=true
+&tags[0].key=region
+&tags[0].value=canada
+&tags[1].key=city
+&tags[1].value=Toronto</programlisting>
<para>The following API commands have the new "tags" input parameter:</para>
<itemizedlist>
<listitem>
@@ -945,7 +1110,8 @@ Done restarting router(s).
</section>
<section id="aws-tags">
<title>AWS API Changes for Tags</title>
- <para>Some changes have been made to the Amazon Web Services API compatibility support in order to accommodate the new tagging feature.</para>
+ <para>Some changes have been made to the Amazon Web Services API compatibility support in
+ order to accommodate the new tagging feature.</para>
<para>New APIs:</para>
<informaltable>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
@@ -1015,7 +1181,8 @@ Done restarting router(s).
</entry>
<entry>
<para>Output now shows tags defined for each image.</para>
- <para>The following filters can now be passed in to limit the output result set: tag-key, tag-value and tag:key</para>
+ <para>The following filters can now be passed in to limit the output result set:
+ tag-key, tag-value and tag:key</para>
</entry>
</row>
<row>
@@ -1024,14 +1191,16 @@ Done restarting router(s).
</entry>
<entry>
<para>Output now shows tags defined for each image.</para>
- <para>The following filters can now be passed in to limit the output result set: tag-key, tag-value and tag:key</para>
+ <para>The following filters can now be passed in to limit the output result set:
+ tag-key, tag-value and tag:key</para>
</entry>
</row>
<row>
<entry>ec2-describe-volumes</entry>
<entry>
<para>Output now shows tags defined for each image.</para>
- <para>The following filters can now be passed in to limit the output result set: tag-key, tag-value and tag:key</para>
+ <para>The following filters can now be passed in to limit the output result set:
+ tag-key, tag-value and tag:key</para>
</entry>
</row>
</tbody>
@@ -1040,12 +1209,21 @@ Done restarting router(s).
</section>
<section id="secure-console-access-on-xenserver">
<title>Secure Console Access on XenServer</title>
- <para>With the addition of Secure Console feature, users can now securely access the VM consoles on the XenServer hypervisor. You can either SSH or use the View Console option in the Management Server to securely connect to the VMs on the XenServer host. The Management Server uses the xapi API to stream the VM consoles. However, there is no change in the way you can access the console of a VM. This feature is supported on XenServer 5.6 and 6.0 versions.</para>
+ <para>With the addition of Secure Console feature, users can now securely access the VM
+ consoles on the XenServer hypervisor. You can either SSH or use the View Console option in
+ the Management Server to securely connect to the VMs on the XenServer host. The Management
+ Server uses the xapi API to stream the VM consoles. However, there is no change in the way
+ you can access the console of a VM. This feature is supported on XenServer 5.6 and 6.0
+ versions.</para>
</section>
<section id="release-note-stopped-vm">
<title>Stopped VM</title>
- <para>This release supports creating VMs without starting them on the backend. You can determine whether the VM needs to be started as part of the VM deployment. A VM can be deployed in two ways: create and start a VM (the default method); create a VM and leave it in the stopped state.</para>
- <para>A new request parameter, startVM, is introduced in the deployVm API to support the stopped VM feature. The possible values are:</para>
+ <para>This release supports creating VMs without starting them on the backend. You can
+ determine whether the VM needs to be started as part of the VM deployment. A VM can be
+ deployed in two ways: create and start a VM (the default method); create a VM and leave it
+ in the stopped state.</para>
+ <para>A new request parameter, startVM, is introduced in the deployVm API to support the
+ stopped VM feature. The possible values are:</para>
<itemizedlist>
<listitem>
<para>true - The VM starts as a part of the VM deployment</para>
@@ -1057,7 +1235,11 @@ Done restarting router(s).
</section>
<section id="release-note-upload-existing-volume-to-vm">
<title>Uploading an Existing Volume to a Virtual Machine</title>
- <para>Existing data can now be made accessible to a virtual machine. This is called uploading a volume to the VM. For example, this is useful to upload data from a local file system and attach it to a VM. Root administrators, domain administrators, and end users can all upload existing volumes to VMs. The upload is performed by using HTTP. The uploaded volume is placed in the zone's secondary storage.</para>
+ <para>Existing data can now be made accessible to a virtual machine. This is called
+ uploading a volume to the VM. For example, this is useful to upload data from a local file
+ system and attach it to a VM. Root administrators, domain administrators, and end users
+ can all upload existing volumes to VMs. The upload is performed by using HTTP. The
+ uploaded volume is placed in the zone's secondary storage.</para>
<para>This functionality is supported for the following hypervisors:</para>
<itemizedlist>
<listitem>
@@ -1079,25 +1261,43 @@ Done restarting router(s).
</section>
<section id="dedicated-ha-hosts">
<title>Dedicated High-Availability Hosts</title>
- <para>One or more hosts can now be designated for use only by high-availability (HA) enabled VMs that are restarted due to a host failure. Setting up a pool of such dedicated HA hosts as the recovery destination for all HA-enabled VMs make it easier to determine which VMs are restarted as part of the high-availability function. You can designate a host as a dedicated-HA restart node only if the Dedicated HA Hosts feature is enabled by setting the appropriate global configuration parameter.</para>
+ <para>One or more hosts can now be designated for use only by high-availability (HA) enabled
+ VMs that are restarted due to a host failure. Setting up a pool of such dedicated HA hosts
+ as the recovery destination for all HA-enabled VMs make it easier to determine which VMs
+ are restarted as part of the high-availability function. You can designate a host as a
+ dedicated-HA restart node only if the Dedicated HA Hosts feature is enabled by setting the
+ appropriate global configuration parameter.</para>
</section>
<section id="support-for-aws-api">
<title>Support for Amazon Web Services API</title>
- <para>This release supports Amazon Web Services APIs, including Elastic Compute Cloud (EC2) API. Fidelity with the EC2 API and the installation experience for this functionality are both enhanced. In prior releases, users were required to install a separate component called CloudBridge, in addition to installing the Management Server. For new installations of CloudStack 4.0.0-incubating, this software is installed automatically along with CloudStack and runs in a more closely integrated fashion. The feature is disabled by default, but can be easily enabled by setting the appropriate global configuration parameter and performing a few setup steps.</para>
+ <para>This release supports Amazon Web Services APIs, including Elastic Compute Cloud (EC2)
+ API. Fidelity with the EC2 API and the installation experience for this functionality are
+ both enhanced. In prior releases, users were required to install a separate component
+ called CloudBridge, in addition to installing the Management Server. For new installations
+ of CloudStack 4.0.0-incubating, this software is installed automatically along with
+ CloudStack and runs in a more closely integrated fashion. The feature is disabled by
+ default, but can be easily enabled by setting the appropriate global configuration
+ parameter and performing a few setup steps.</para>
</section>
<section id="nicira-nvp-plugin">
<title>The Nicira NVP Plugin</title>
- <para>The Nicira NVP plug-in allows CloudStack to use the Nicira solution for virtualized network as a provider for CloudStack networks and services. In CloudStack 4.0.0-incubating this plug-in supports the Connectivity service. This service is responsible for creating Layer 2 networks supporting the networks created by guests. When a tenant creates a new network, instead of a traditional VLAN, a logical network will be created by sending the appropriate calls to the Nicira NVP Controller. The plug-in has been tested with Nicira NVP versions 2.1.0, 2.2.0 and 2.2.1.</para>
+ <para>The Nicira NVP plug-in allows CloudStack to use the Nicira solution for virtualized
+ network as a provider for CloudStack networks and services. In CloudStack 4.0.0-incubating
+ this plug-in supports the Connectivity service. This service is responsible for creating
+ Layer 2 networks supporting the networks created by guests. When a tenant creates a new
+ network, instead of a traditional VLAN, a logical network will be created by sending the
+ appropriate calls to the Nicira NVP Controller. The plug-in has been tested with Nicira
+ NVP versions 2.1.0, 2.2.0 and 2.2.1.</para>
</section>
<section id="castor-support">
<title>Support for CAStor Cluster</title>
- <para>CloudStack 4.0 supports using a CAStor cluster as the back-end storage system for a
- CloudStack S3 front-end. The CAStor back-end storage for CloudStack extends the existing
- storage classes and allows the storage configuration attribute to point to a CAStor
- cluster. This feature makes use of the CloudStack server's local disk to spool files
- before writing them to CAStor when handling the PUT operations. However, a file must be
- successfully written into the CAStor cluster prior to the return of a success code to the
- S3 client to ensure that the transaction outcome is correctly reported.</para>
+ <para>CloudStack 4.0.0-incubating supports using a CAStor cluster as the back-end storage
+ system for a CloudStack S3 front-end. The CAStor back-end storage for CloudStack extends
+ the existing storage classes and allows the storage configuration attribute to point to a
+ CAStor cluster. This feature makes use of the CloudStack server's local disk to spool
+ files before writing them to CAStor when handling the PUT operations. However, a file must
+ be successfully written into the CAStor cluster prior to the return of a success code to
+ the S3 client to ensure that the transaction outcome is correctly reported.</para>
<para>The S3 multipart file upload is not supported in this release. You are prompted with
proper error message if a multipart upload is attempted.</para>
</section>
@@ -1116,13 +1316,21 @@ Done restarting router(s).
</section>
<section id="rbd-support-kvm">
<title>Rados Block Device Support for KVM</title>
- <para>You can now use Rados Block Device (RBD) to run instances on Apache CloudStack 4.0.0-incubating. This can be done by adding a RBD pool as primary storage. Before using RBD, ensure that Qemu is compiled with RBD enabled, and the libvirt version is at least 0.10 with RBD enabled on the KVM host </para>
- <para>Create a disk offering for RBD so that you can ensure that StoragePoolAllocator chooses the RBD pool to deploy instances.</para>
+ <para>You can now use Rados Block Device (RBD) to run instances on Apache CloudStack
+ 4.0.0-incubating. This can be done by adding a RBD pool as primary storage. Before using
+ RBD, ensure that Qemu is compiled with RBD enabled, and the libvirt version is at least
+ 0.10 with RBD enabled on the KVM host </para>
+ <para>Create a disk offering for RBD so that you can ensure that StoragePoolAllocator
+ chooses the RBD pool to deploy instances.</para>
</section>
</section>
<section id="issues-fixed-4.0">
- <title>Issues Fixed in 4.0.0-incubating</title>
- <para>Many bugs include a defect number that reflects the bug number that was held in the bug tracker run by Citrix (bugs.cloudstack.org). The Apache CloudStack project now uses <ulink url="https://issues.apache.org/jira/browse/CLOUDSTACK">Jira</ulink> to manage its bugs, so some of the bugs that are referenced here may not be available to view. However, we are still including them for completeness.</para>
+ <title>Issues Fixed in 4.0.0-incubating</title>
+ <para>Many bugs include a defect number that reflects the bug number that was held in the bug
+ tracker run by Citrix (bugs.cloudstack.org). The Apache CloudStack project now uses <ulink
+ url="https://issues.apache.org/jira/browse/CLOUDSTACK">Jira</ulink> to manage its bugs, so
+ some of the bugs that are referenced here may not be available to view. However, we are
+ still including them for completeness.</para>
<informaltable>
<tgroup cols="2" align="left" colsep="1" rowsep="1">
<colspec colwidth="1*" colname="1" colnum="1"/>
@@ -1889,9 +2097,9 @@ Done restarting router(s).
<row>
<entry><para>CS-15789</para></entry>
<entry><para>Invalid global setting prevents management server to restart. For
- example, if you configure the "project.invite.timeout" parameter to
- "300" and attempt to restart management server, it fails without
- throwing a warning or setting the value to the default.</para>
+ example, if you configure the "project.invite.timeout" parameter to "300" and
+ attempt to restart management server, it fails without throwing a warning or
+ setting the value to the default.</para>
</entry>
</row>
<row>
@@ -2061,8 +2269,8 @@ Done restarting router(s).
<para>CS-15476</para>
</entry>
<entry>
- <para>The 2.2.14 to 4.0 upgrade fails if multiple untagged physical networks exist
- before the upgrade.</para>
+ <para>The 2.2.14 to 4.0.0-incubating upgrade fails if multiple untagged physical
+ networks exist before the upgrade.</para>
</entry>
</row>
<row>
@@ -2070,8 +2278,8 @@ Done restarting router(s).
<para>CS-15407</para>
</entry>
<entry>
- <para>After the 2.2.14 to 4.0 upgrade, VLAN allocation on multiple physical networks
- does not happen as expected.</para>
+ <para>After the 2.2.14 to 4.0.0-incubating upgrade, VLAN allocation on multiple
+ physical networks does not happen as expected.</para>
<para>To workaround this issue, follow the instructions given below:</para>
<orderedlist>
<listitem>
@@ -2238,14 +2446,14 @@ Done restarting router(s).
&tags[0].key=region
&tags[0].value=canada
&tags[1].key=city
-&tags[1].value=Toronto </programlisting></para>
+&tags[1].value=Toronto</programlisting></para>
</listitem>
<listitem>
<para>deleteTags. Remove tags from one or more resources. Example:
<programlisting>command=deleteTags
&resourceIds=1,12
&resourceType=Snapshot
-&tags[0].key=city </programlisting></para>
+&tags[0].key=city</programlisting></para>
</listitem>
<listitem>
<para>listTags (Show currently defined resource tags)</para>