You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by se...@apache.org on 2014/05/21 08:34:06 UTC
[07/10] split rnotes.rst in upgrade dir and remove it. Update Upgrade
instruction to 4.4. Fix rst formating
http://git-wip-us.apache.org/repos/asf/cloudstack-docs-rn/blob/bb313d3b/source/upgrade/upgrade-3.0.x.rst
----------------------------------------------------------------------
diff --git a/source/upgrade/upgrade-3.0.x.rst b/source/upgrade/upgrade-3.0.x.rst
index 19c898f..51ffe8b 100644
--- a/source/upgrade/upgrade-3.0.x.rst
+++ b/source/upgrade/upgrade-3.0.x.rst
@@ -1,126 +1,106 @@
-Upgrade Instruction from 3.0.x
-------------------------------
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information#
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
-.. warning::
- :name: Depreciation of realhostip.com DNS and SSL certificate
-
- The realhostip.com dynamic DNS resolution service is being retired this
- summer. In advance of that, CloudStack 4.3 and later no longer uses realhostip.com
- DNS domains or SSL certificates to encrypt Console Proxy or file copy
- communications.
+.. |version_to_upgrade| replace:: 3.0.x
+Upgrade Instruction from |version_to_upgrade|
+=============================================
+This section will guide you from Citrix CloudStack |version_to_upgrade| to Apache CloudStack |version|.
-This section will guide you from Citrix CloudStack 3.0.x to Apache
-CloudStack |version|. Sections that are hypervisor-specific will be called out
-with a note.
+.. include:: _upgrade_header.rst
- .. note:: The following upgrade instructions should be performed regardless of hypervisor type.
+.. important:: **Package Structure Changes:** The package structure for CloudStack has changed significantly since the |version_to_upgrade| releases. If you've compiled your own packages, you'll notice that the package names and the number of packages has changed. This is *not* a bug. However, this *does* mean that the procedure is not as simple as an ``apt-get upgrade`` or ``yum update``, so please follow this section carefully.
- #.
+Packages repository
+-------------------
- While running the existing 3.0.x system, log in to the UI as root
- administrator.
+Most users of CloudStack manage the installation and upgrades of
+CloudStack with one of Linux's predominant package systems, RPM or
+APT. This guide assumes you'll be using RPM and Yum (for Red Hat
+Enterprise Linux or CentOS), or APT and Debian packages (for Ubuntu).
- #.
+Create RPM or Debian packages (as appropriate) and a repository from
+the |version| source, or check the Apache CloudStack downloads page at
+http://cloudstack.apache.org/downloads.html
+for package repositories supplied by community members. You will need
+them for :ref:`ubuntu40` or :ref:`rhel40` hosts upgrade.
- In the left navigation bar, click Templates.
+Instructions for creating packages from the CloudStack source are in the `CloudStack Installation Guide`_.
- #.
+.. include:: _sysvm_templates.rst
- In Select view, click Templates.
+Upgrade Steps
+-------------------
- #.
-
- Click Register template.
-
- The Register template dialog box is displayed.
-
- #.
-
- In the Register template dialog box, specify the following values
- (do not change these):
-
- .. include:: /systemvm_templates.rst
-
- #.
-
- Watch the screen to be sure that the template downloads
- successfully and enters the READY state. Do not proceed until this
- is successful.
-
-#.
-
- (KVM on RHEL 6.0/6.1 only) If your existing CloudStack deployment
+#. (KVM on RHEL 6.0/6.1 only) If your existing CloudStack deployment
includes one or more clusters of KVM hosts running RHEL 6.0 or RHEL
6.1, perform the following:
- #.
-
- Ensure that you upgrade the operating system version on those
+ #. Ensure that you upgrade the operating system version on those
hosts before upgrading CloudStack
To do that, change the yum repository for each system with
CloudStack packages, that implies that all the Management Servers
and any hosts that have the KVM agent.
- #.
-
- Open ``/etc/yum.repos.d/cloudstack.repo`` on any systems that have
+ #. Open ``/etc/yum.repos.d/cloudstack.repo`` on any systems that have
CloudStack packages installed.
- #.
-
- Edit as follows:
+ #. Edit as follows:
.. sourcecode:: bash
- [upgrade]
- name=rhel63
- baseurl=url-of-your-rhel6.3-repo
- enabled=1
- gpgcheck=0
- [apache CloudStack]
- name= Apache CloudStack
- baseurl= http://cloudstack.apt-get.eu/rhel/4.0/
- enabled=1
- gpgcheck=0
+ [upgrade]
+ name=rhel63
+ baseurl=url-of-your-rhel6.3-repo
+ enabled=1
+ gpgcheck=0
+ [apache CloudStack]
+ name= Apache CloudStack
+ baseurl= http://cloudstack.apt-get.eu/rhel/4.4/
+ enabled=1
+ gpgcheck=0
If you are using the community provided package repository, change
- the baseurl to http:// cloudstack.apt-get.eu/rhel/4.3/
+ the baseurl to ``http://cloudstack.apt-get.eu/rhel/4.4/``
If you are using your own package repository, change this line to
- read as appropriate for your 4.3 repository.
-
- #.
+ read as appropriate for your |version| repository.
- Now that you have the repository configured, upgrade the host
+ #. Now that you have the repository configured, upgrade the host
operating system from RHEL 6.0 to 6.3:
.. sourcecode:: bash
# yum upgrade
-#.
-
- Stop all Usage Servers if running. Run this on all Usage Server
+#. Stop all Usage Servers if running. Run this on all Usage Server
hosts.
.. sourcecode:: bash
# service cloud-usage stop
-#.
-
- Stop the Management Servers. Run this on all Management Server hosts.
+#. Stop the Management Servers. Run this on all Management Server hosts.
.. sourcecode:: bash
# service cloud-management stop
-#.
-
- On the MySQL master, take a backup of the MySQL databases. We
+#. 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.
@@ -131,24 +111,17 @@ with a note.
.. sourcecode:: bash
# mysqldump -u root -pmysql_password cloud > cloud-backup.dmp
- # mysqldump -u root -pmysql_password cloud_usage > cloud-usage-backup.dmp
-
-#.
+ # mysqldump -u root -pmysql_password cloud_usage > cloud-usage-backup.dmp
- Either build RPM/DEB packages as detailed in the Installation Guide,
+#. 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 CloudStack binaries.
-#.
-
- If you are using Ubuntu, follow this procedure to upgrade your
- packages. If not, skip to step `8 <#upgrade-rpm-packages-302>`__.
+#. If you are using Ubuntu, follow this procedure to upgrade your packages. If not, skip to step `8 <#upgrade-rpm-packages-302>`__.
.. note:: **Community Packages:** This section assumes you're using the community supplied packages for CloudStack. If you've created your own packages and APT repository, substitute your own URL for the ones used in these examples.
- #.
-
- The first order of business will be to change the sources list for
+ #. The first order of business will be to change the sources list for
each system with CloudStack packages. This means all management
servers, and any hosts that have the KVM agent. (No changes should
be necessary for hosts that are running VMware or Xen.)
@@ -166,22 +139,18 @@ with a note.
.. sourcecode:: bash
- deb http://cloudstack.apt-get.eu/ubuntu precise 4.3
+ deb http://cloudstack.apt-get.eu/ubuntu precise 4.4
If you're using your own package repository, change this line to
read as appropriate for your |version| repository.
- #.
-
- Now update your apt package list:
+ #. Now update your apt package list:
.. sourcecode:: bash
$ sudo apt-get update
- #.
-
- Now that you have the repository configured, it's time to install
+ #. Now that you have the repository configured, it's time to install
the ``cloudstack-management`` package. This will pull in any other
dependencies you need.
@@ -189,10 +158,7 @@ with a note.
$ sudo apt-get install cloudstack-management
- #.
-
- You will need to manually install the ``cloudstack-agent``
- package:
+ #. You will need to manually install the ``cloudstack-agent`` package:
.. sourcecode:: bash
@@ -206,31 +172,23 @@ with a note.
When prompted whether you wish to keep your configuration, say
Yes.
- #.
-
- Verify that the file
- ``/etc/cloudstack/agent/environment.properties`` has a line that
- reads:
+ #. Verify that the file ``/etc/cloudstack/agent/environment.properties`` has a line that reads:
.. sourcecode:: bash
- paths.script=/usr/share/cloudstack-common
+ paths.script=/usr/share/cloudstack-common
If not, add the line.
- #.
-
- Restart the agent:
+ #. Restart the agent:
.. sourcecode:: bash
- service cloud-agent stop
- killall jsvc
- service cloudstack-agent start
-
- #.
+ service cloud-agent stop
+ killall jsvc
+ service cloudstack-agent start
- During the upgrade, ``log4j-cloud.xml`` was simply copied over, so
+ #. During the upgrade, ``log4j-cloud.xml`` was simply copied over, so
the logs will continue to be added to
``/var/log/cloud/agent/agent.log``. There's nothing *wrong* with
this, but if you prefer to be consistent, you can change this by
@@ -238,30 +196,23 @@ with a note.
.. sourcecode:: bash
- cd /etc/cloudstack/agent
- mv log4j-cloud.xml.dpkg-dist log4j-cloud.xml
- service cloudstack-agent restart
-
- #.
+ cd /etc/cloudstack/agent
+ mv log4j-cloud.xml.dpkg-dist log4j-cloud.xml
+ service cloudstack-agent restart
- Once the agent is running, you can uninstall the old cloud-\*
+ #. Once the agent is running, you can uninstall the old cloud-\*
packages from your system:
.. sourcecode:: bash
sudo dpkg --purge cloud-agent
-#.
-
- If you are using CentOS or RHEL, follow this procedure to upgrade
- your packages. If not, skip to step
- `9 <#correct-components-xml-302>`__.
+#. If you are using CentOS or RHEL, follow this procedure to upgrade your packages. If not, skip to step `9 <#correct-components-xml-302>`__.
- .. note:: **Community Packages:** This section assumes you're using the community supplied packages for CloudStack. If you've created your own packages and yum repository, substitute your own URL for the ones used in these examples.
+ .. note::
+ **Community Packages:** This section assumes you're using the community supplied packages for CloudStack. If you've created your own packages and yum repository, substitute your own URL for the ones used in these examples.
- #.
-
- The first order of business will be to change the yum repository
+ #. The first order of business will be to change the yum repository
for each system with CloudStack packages. This means all
management servers, and any hosts that have the KVM agent. (No
changes should be necessary for hosts that are running VMware or
@@ -274,21 +225,19 @@ with a note.
.. sourcecode:: bash
- [apache-cloudstack]
- name=Apache CloudStack
- baseurl=http://cloudstack.apt-get.eu/rhel/4.0/
- enabled=1
- gpgcheck=0
+ [apache-cloudstack]
+ name=Apache CloudStack
+ baseurl=http://cloudstack.apt-get.eu/rhel/4.0/
+ enabled=1
+ gpgcheck=0
If you are using the community provided package repository, change
- the baseurl to http://cloudstack.apt-get.eu/rhel/4.3/
+ the baseurl to ``http://cloudstack.apt-get.eu/rhel/4.4/``
If you're using your own package repository, change this line to
- read as appropriate for your 4.3 repository.
-
- #.
+ read as appropriate for your |version| repository.
- Now that you have the repository configured, it's time to install
+ #. Now that you have the repository configured, it's time to install
the ``cloudstack-management`` package by upgrading the older
``cloud-client`` package.
@@ -296,9 +245,7 @@ with a note.
$ sudo yum upgrade cloud-client
- #.
-
- For KVM hosts, you will need to upgrade the ``cloud-agent``
+ #. For KVM hosts, you will need to upgrade the ``cloud-agent``
package, similarly installing the new version as
``cloudstack-agent``.
@@ -311,9 +258,7 @@ with a note.
``environment.properties`` from ``/etc/cloud/agent`` to
``/etc/cloudstack/agent``.
- #.
-
- Verify that the file
+ #. Verify that the file
``/etc/cloudstack/agent/environment.properties`` has a line that
reads:
@@ -323,9 +268,7 @@ with a note.
If not, add the line.
- #.
-
- Restart the agent:
+ #. Restart the agent:
.. sourcecode:: bash
@@ -333,35 +276,27 @@ with a note.
killall jsvc
service cloudstack-agent start
-#.
-
- If you have made changes to your copy of
+#. If you have made changes to your copy of
``/etc/cloud/management/components.xml`` 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.2.x.
+ compatible with version 4.x.x.
- #.
-
- Make a backup copy of ``/etc/cloud/management/components.xml``.
+ #. Make a backup copy of ``/etc/cloud/management/components.xml``.
For example:
.. sourcecode:: bash
# mv /etc/cloud/management/components.xml /etc/cloud/management/components.xml-backup
- #.
-
- Copy ``/etc/cloud/management/components.xml.rpmnew`` to create a
+ #. Copy ``/etc/cloud/management/components.xml.rpmnew`` to create a
new ``/etc/cloud/management/components.xml``:
.. sourcecode:: bash
# cp -ap /etc/cloud/management/components.xml.rpmnew /etc/cloud/management/components.xml
- #.
-
- Merge your changes from the backup file into the new
+ #. Merge your changes from the backup file into the new
``components.xml``.
.. sourcecode:: bash
@@ -370,9 +305,7 @@ with a note.
.. note:: If you have more than one management server node, repeat the upgrade steps on each node.
-#.
-
- After upgrading to |version|, API clients are expected to send plain text
+#. After upgrading to |version|, API clients are expected to send plain text
passwords for login and user creation, instead of MD5 hash. Incase,
api client changes are not acceptable, following changes are to be
made for backward compatibility:
@@ -397,9 +330,7 @@ with a note.
PlainTextUserAuthenticator works the same way MD5UserAuthenticator
worked prior to |version|
-#.
-
- Start the first Management Server. Do not start any other Management
+#. Start the first Management Server. Do not start any other Management
Server nodes yet.
.. sourcecode:: bash
@@ -412,33 +343,23 @@ with a note.
.. note:: 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.
-#.
-
- Start all Usage Servers (if they were running on your previous
+#. Start all Usage Servers (if they were running on your previous
version). Perform this on each Usage Server host.
``# service cloudstack-usage start``
-#.
-
- Additional steps are required for each KVM host. These steps will not
+#. 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.
- #.
-
- Configure a yum or apt repository containing the CloudStack
+ #. Configure a yum or apt repository containing the CloudStack
packages as outlined in the Installation Guide.
- #.
-
- Stop the running agent.
+ #. Stop the running agent.
``# service cloud-agent stop``
- #.
-
- Update the agent software with one of the following command sets
+ #. Update the agent software with one of the following command sets
as appropriate for your environment.
``# yum update cloud-*``
@@ -447,25 +368,19 @@ with a note.
``# apt-get upgrade cloud-*``
- #.
-
- Edit ``/etc/cloudstack/agent/agent.properties`` to change the
+ #. Edit ``/etc/cloudstack/agent/agent.properties`` to change the
resource parameter from
"com.cloud.agent.resource.computing.LibvirtComputingResource" to
"com.cloud.hypervisor.kvm.resource.LibvirtComputingResource".
- #.
-
- Upgrade all the existing bridge names to new bridge names by
+ #. Upgrade all the existing bridge names to new bridge names by
running this script:
.. sourcecode:: bash
# cloudstack-agent-upgrade
- #.
-
- Install a libvirt hook with the following commands:
+ #. Install a libvirt hook with the following commands:
.. sourcecode:: bash
@@ -473,31 +388,23 @@ with a note.
# cp /usr/share/cloudstack-agent/lib/libvirtqemuhook /etc/libvirt/hooks/qemu
# chmod +x /etc/libvirt/hooks/qemu
- #.
-
- Restart libvirtd.
+ #. Restart libvirtd.
.. sourcecode:: bash
# service libvirtd restart
- #.
-
- Start the agent.
+ #. Start the agent.
.. sourcecode:: bash
# service cloudstack-agent start
- #.
-
- When the Management Server is up and running, log in to the
+ #. 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.
-#.
-
- Log in to the CloudStack UI as administrator, and check the status of
+#. 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.
@@ -506,29 +413,20 @@ with a note.
Do not proceed to the next step until the hosts show in Up state.
-#.
-
- If you are upgrading from 3.0.x, perform the following:
+#. If you are upgrading from 3.0.x, perform the following:
- #.
-
- Ensure that the admin port is set to 8096 by using the
- "integration.api.port" global parameter.
+ #. Ensure that the admin port is set to 8096 by using the "integration.api.port" global parameter.
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.
- #.
-
- Restart the Management Server.
+ #. Restart the Management Server.
.. note:: 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.
-#.
-
- Run the ``cloudstack-sysvmadm`` script to stop, then start, all
+#. Run the ``cloudstack-sysvmadm`` 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
@@ -542,22 +440,16 @@ with a note.
This might take up to an hour or more to run, depending on the number
of accounts in the system.
-#.
-
- If needed, upgrade all Citrix XenServer hypervisor hosts in your
+#. If needed, upgrade all Citrix XenServer hypervisor hosts in your
cloud to a version supported by CloudStack |version|. The supported
versions are XenServer 5.6 SP2 and 6.0.2. Instructions for upgrade
can be found in the CloudStack |version| Installation Guide under
"Upgrading XenServer Versions."
-#.
-
- Now apply the XenServer hotfix XS602E003 (and any other needed
+#. Now apply the XenServer hotfix XS602E003 (and any other needed
hotfixes) to XenServer v6.0.2 hypervisor hosts.
- #.
-
- Disconnect the XenServer cluster from CloudStack.
+ #. Disconnect the XenServer cluster from CloudStack.
In the left navigation bar of the CloudStack UI, select
Infrastructure. Under Clusters, click View All. Select the
@@ -572,15 +464,11 @@ with a note.
the unmanaged state, there is no connection to the hosts in the
cluster.
- #.
-
- To clean up the VLAN, log in to one XenServer host and run:
+ #. To clean up the VLAN, log in to one XenServer host and run:
``/opt/xensource/bin/cloud-clean-vlan.sh``
- #.
-
- Now prepare the upgrade by running the following on one XenServer
+ #. Now prepare the upgrade by running the following on one XenServer
host:
``/opt/xensource/bin/cloud-prepare-upgrade.sh``
@@ -588,9 +476,7 @@ with a note.
If you see a message like "can't eject CD", log in to the VM and
unmount the CD, then run this script again.
- #.
-
- Upload the hotfix to the XenServer hosts. Always start with the
+ #. 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.
@@ -604,9 +490,7 @@ with a note.
.. note:: (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.
- #.
-
- Manually live migrate all VMs on this host to another host. First,
+ #. Manually live migrate all VMs on this host to another host. First,
get a list of the VMs on this host:
``# xe vm-list``
@@ -618,9 +502,7 @@ with a note.
.. note:: **Troubleshooting:** 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: ``/opt/xensource/bin/make_migratable.sh b6cf79c8-02ee-050b-922f-49583d9f1a14``.
- #.
-
- Apply the hotfix. First, get the UUID of this host:
+ #. Apply the hotfix. First, get the UUID of this host:
.. sourcecode:: bash
@@ -636,9 +518,7 @@ with a note.
xe patch-apply host-uuid=host-uuid uuid=hotfix-uuid
- #.
-
- Copy the following files from the CloudStack Management Server to
+ #. Copy the following files from the CloudStack Management Server to
the host.
@@ -662,72 +542,54 @@ with a note.
+-------------------------+-------------------------------------------------+
- #.
-
- (Only for hotfixes XS602E005 and XS602E007) You need to apply a
+ #. (Only for hotfixes XS602E005 and XS602E007) You need to apply a
new Cloud Support Pack.
- -
-
- Download the CSP software onto the XenServer host from one of
+ - Download the CSP software onto the XenServer host from one of
the following links:
For hotfix XS602E005:
- `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>`__
+ `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>`_
For hotfix XS602E007:
- `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>`__
-
- -
+ `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>`_
- Extract the file:
+ - Extract the file:
.. sourcecode:: bash
- # tar xf xenserver-cloud-supp.tgz
+ # tar xf xenserver-cloud-supp.tgz
- -
-
- Run the following script:
+ - Run the following script:
.. sourcecode:: bash
- # xe-install-supplemental-pack xenserver-cloud-supp.iso
-
- -
+ # xe-install-supplemental-pack xenserver-cloud-supp.iso
- If the XenServer host is part of a zone that uses basic
+ - If the XenServer host is part of a zone that uses basic
networking, disable Open vSwitch (OVS):
.. sourcecode:: bash
- # xe-switch-network-backend bridge
+ # xe-switch-network-backend bridge
- #.
+ #. Reboot this XenServer host.
- Reboot this XenServer host.
-
- #.
-
- Run the following:
+ #. Run the following:
.. sourcecode:: bash
- /opt/xensource/bin/setupxenserver.sh
+ /opt/xensource/bin/setupxenserver.sh
.. note:: If the message "mv: cannot stat \`/etc/cron.daily/logrotate': No such file or directory" appears, you can safely ignore it.
- #.
-
- Run the following:
+ #. Run the following:
.. sourcecode:: bash
- for pbd in `xe pbd-list currently-attached=false| grep ^uuid | awk '{print $NF}'`; do xe pbd-plug uuid=$pbd ;
-
- #.
+ for pbd in `xe pbd-list currently-attached=false| grep ^uuid | awk '{print $NF}'`; do xe pbd-plug uuid=$pbd ;
- On each slave host in the Xen pool, repeat these steps, starting
+ #. On each slave host in the Xen pool, repeat these steps, starting
from "manually live migrate VMs."
.. note:: **Troubleshooting Tip:** 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.
http://git-wip-us.apache.org/repos/asf/cloudstack-docs-rn/blob/bb313d3b/source/upgrade/upgrade-4.0.rst
----------------------------------------------------------------------
diff --git a/source/upgrade/upgrade-4.0.rst b/source/upgrade/upgrade-4.0.rst
index e7bf0b0..65cccf5 100644
--- a/source/upgrade/upgrade-4.0.rst
+++ b/source/upgrade/upgrade-4.0.rst
@@ -1,121 +1,88 @@
-Upgrade Instruction from 4.0.x
-------------------------------
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information#
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
-.. warning::
- :name: Depreciation of realhostip.com DNS and SSL certificate
-
- The realhostip.com dynamic DNS resolution service is being retired this
- summer. In advance of that, CloudStack 4.3 and later no longer uses realhostip.com
- DNS domains or SSL certificates to encrypt Console Proxy or file copy
- communications.
-
-This section will guide you from CloudStack 4.0.x versions to CloudStack |version|.
-
-Any steps that are hypervisor-specific will be called out with a note.
-
-.. warning:: **Package Structure Changes:** The package structure for CloudStack has changed significantly since the 4.0.x releases. If you've compiled your own packages, you'll notice that the package names and the number of packages has changed. This is *not* a bug. However, this *does* mean that the procedure is not as simple as an ``apt-get upgrade`` or ``yum update``, so please follow this section carefully.
-
-We recommend reading through this section once or twice before beginning
-your upgrade procedure, and working through it on a test system before
-working on a production system.
-
-#.
-
- Most users of CloudStack manage the installation and upgrades of
- CloudStack with one of Linux's predominant package systems, RPM or
- APT. This guide assumes you'll be using RPM and Yum (for Red Hat
- Enterprise Linux or CentOS), or APT and Debian packages (for Ubuntu).
-
- Create RPM or Debian packages (as appropriate) and a repository from
- the 4.3.0 source, or check the Apache CloudStack downloads page at
- `http://cloudstack.apache.org/downloads.html <http://cloudstack.apache.org/downloads.html>`__
- for package repositories supplied by community members. You will need
- them for step `9 <#upgrade-deb-packages-40to43>`__ or step
- `10 <#upgrade-rpm-packages-40to41>`__.
-
- Instructions for creating packages from the CloudStack source are in
- the `Installation
- Guide <http://cloudstack.apache.org/docs/en-US/index.html>`__.
-
- .. note:: The following upgrade instructions should be performed regardless of hypervisor type.
-
- #.
-
- While running the existing 4.0.0 system, log in to the UI as root
- administrator.
-
- #.
-
- In the left navigation bar, click Templates.
+.. |version_to_upgrade| replace:: 4.0.x
- #.
+Upgrade Instruction from |version_to_upgrade|
+=============================================
- In Select view, click Templates.
+This section will guide you from CloudStack |version_to_upgrade| versions to CloudStack |version|.
- #.
+.. include:: _upgrade_header.rst
- Click Register template.
+.. warning:: **Package Structure Changes:** The package structure for CloudStack has changed significantly since the |version_to_upgrade| releases. If you've compiled your own packages, you'll notice that the package names and the number of packages has changed. This is *not* a bug. However, this *does* mean that the procedure is not as simple as an ``apt-get upgrade`` or ``yum update``, so please follow this section carefully.
- The Register template dialog box is displayed.
+Packages repository
+-------------------
- #.
+Most users of CloudStack manage the installation and upgrades of
+CloudStack with one of Linux's predominant package systems, RPM or
+APT. This guide assumes you'll be using RPM and Yum (for Red Hat
+Enterprise Linux or CentOS), or APT and Debian packages (for Ubuntu).
- In the Register template dialog box, specify the following values
- (do not change these):
+Create RPM or Debian packages (as appropriate) and a repository from
+the |version| source, or check the Apache CloudStack downloads page at
+http://cloudstack.apache.org/downloads.html
+for package repositories supplied by community members. You will need
+them for :ref:`ubuntu40` or :ref:`rhel40` hosts upgrade.
- .. include:: /systemvm_templates.rst
+Instructions for creating packages from the CloudStack source are in the `CloudStack Installation Guide`_.
+.. include:: _sysvm_templates.rst
-#.
+Database Preparation
+--------------------
- Stop your management server or servers. Run this on all management
+#. Stop your management server or servers. Run this on all management
server hosts:
.. sourcecode:: bash
- # service cloud-management stop
+ # service cloud-management stop
-#.
-
- If you are running a usage server or usage servers, stop those as
+#. If you are running a usage server or usage servers, stop those as
well:
.. sourcecode:: bash
- # service cloud-usage stop
-
-#.
+ # service cloud-usage stop
- Make a backup of your MySQL database. If you run into any issues or
+#. Make a backup of your MySQL database. If you run into any issues or
need to roll back the upgrade, this will assist in debugging or
restoring your existing environment. You'll be prompted for your
password.
.. sourcecode:: bash
- # mysqldump -u root -p cloud > cloudstack-backup.sql
+ # mysqldump -u root -p cloud > cloudstack-backup.sql
-#.
-
- Whether you're upgrading a Red Hat/CentOS based system or Ubuntu
+#. Whether you're upgrading a Red Hat/CentOS based system or Ubuntu
based system, you're going to need to stop the CloudStack management
server before proceeding.
.. sourcecode:: bash
- # service cloud-management stop
-
-#.
+ # service cloud-management stop
- If you have made changes to ``/etc/cloud/management/components.xml``,
+#. If you have made changes to ``/etc/cloud/management/components.xml``,
you'll need to carry these over manually to the new file,
``/etc/cloudstack/management/componentContext.xml``. This is not done
automatically. (If you're unsure, we recommend making a backup of the
original ``components.xml`` to be on the safe side.
-#.
-
- After upgrading to |version|, API clients are expected to send plain text
+#. After upgrading to |version|, API clients are expected to send plain text
passwords for login and user creation, instead of MD5 hash. Incase,
api client changes are not acceptable, following changes are to be
made for backward compatibility:
@@ -126,249 +93,194 @@ working on a production system.
.. sourcecode:: bash
- <!-- Security adapters -->
- <bean id="userAuthenticators" class="com.cloud.utils.component.AdapterList">
- <property name="Adapters">
- <list>
- <ref bean="PlainTextUserAuthenticator"/>
- <ref bean="MD5UserAuthenticator"/>
- <ref bean="LDAPUserAuthenticator"/>
- </list>
- </property>
- </bean>
-
- PlainTextUserAuthenticator works the same way MD5UserAuthenticator
- worked prior to |version|.
-
-#.
-
- If you are using Ubuntu, follow this procedure to upgrade your
- packages. If not, skip to step `10 <#upgrade-rpm-packages-40to43>`__.
-
- .. note:: **Community Packages:** This section assumes you're using the community supplied packages for CloudStack. If you've created your own packages and APT repository, substitute your own URL for the ones used in these examples.
-
- #.
-
- The first order of business will be to change the sources list for
- each system with CloudStack packages. This means all management
- servers, and any hosts that have the KVM agent. (No changes should
- be necessary for hosts that are running VMware or Xen.)
-
- Start by opening ``/etc/apt/sources.list.d/cloudstack.list`` on
- any systems that have CloudStack packages installed.
-
- This file should have one line, which contains:
-
- .. sourcecode:: bash
+ <!-- Security adapters -->
+ <bean id="userAuthenticators" class="com.cloud.utils.component.AdapterList">
+ <property name="Adapters">
+ <list>
+ <ref bean="PlainTextUserAuthenticator"/>
+ <ref bean="MD5UserAuthenticator"/>
+ <ref bean="LDAPUserAuthenticator"/>
+ </list>
+ </property>
+ </bean>
- deb http://cloudstack.apt-get.eu/ubuntu precise 4.0
+ PlainTextUserAuthenticator works the same way MD5UserAuthenticator worked prior to 4.1.
- We'll change it to point to the new package repository:
+.. _ubuntu40:
- .. sourcecode:: bash
+Ubuntu
+------
- deb http://cloudstack.apt-get.eu/ubuntu precise 4.3
+If you are using Ubuntu, follow this procedure to upgrade your packages. If not, skip to :ref:`rhel40`.
- If you're using your own package repository, change this line to
- read as appropriate for your 4.3.0 repository.
+.. note::
+ **Community Packages:** This section assumes you're using the community supplied packages for CloudStack. If you've created your own packages and APT repository, substitute your own URL for the ones used in these examples.
- #.
+#. The first order of business will be to change the sources list for
+ each system with CloudStack packages. This means all management
+ servers, and any hosts that have the KVM agent. (No changes should
+ be necessary for hosts that are running VMware or Xen.)
- Now update your apt package list:
+ Start by opening ``/etc/apt/sources.list.d/cloudstack.list`` on any systems that have CloudStack packages installed.
- .. sourcecode:: bash
+ This file should have one line, which contains:
- $ sudo apt-get update
-
- #.
-
- Now that you have the repository configured, it's time to install
- the ``cloudstack-management`` package. This will pull in any other
- dependencies you need.
-
- .. sourcecode:: bash
-
- $ sudo apt-get install cloudstack-management
-
- #.
-
- You will need to manually install the ``cloudstack-agent``
- package:
-
- .. sourcecode:: bash
-
- $ sudo apt-get install cloudstack-agent
-
- During the installation of ``cloudstack-agent``, APT will copy
- your ``agent.properties``, ``log4j-cloud.xml``, and
- ``environment.properties`` from ``/etc/cloud/agent`` to
- ``/etc/cloudstack/agent``.
-
- When prompted whether you wish to keep your configuration, say
- Yes.
-
- #.
+ .. sourcecode:: bash
- Verify that the file
- ``/etc/cloudstack/agent/environment.properties`` has a line that
- reads:
+ deb http://cloudstack.apt-get.eu/ubuntu precise 4.0
- .. sourcecode:: bash
+ We'll change it to point to the new package repository:
- paths.script=/usr/share/cloudstack-common
+ .. sourcecode:: bash
- If not, add the line.
+ deb http://cloudstack.apt-get.eu/ubuntu precise 4.4
- #.
+ If you're using your own package repository, change this line to
+ read as appropriate for your |version| repository.
- Restart the agent:
+#. Now update your apt package list:
- .. sourcecode:: bash
+ .. sourcecode:: bash
- service cloud-agent stop
- killall jsvc
- service cloudstack-agent start
+ $ sudo apt-get update
- #.
+#. Now that you have the repository configured, it's time to install
+ the ``cloudstack-management`` package. This will pull in any other
+ dependencies you need.
- During the upgrade, ``log4j-cloud.xml`` was simply copied over, so
- the logs will continue to be added to
- ``/var/log/cloud/agent/agent.log``. There's nothing *wrong* with
- this, but if you prefer to be consistent, you can change this by
- copying over the sample configuration file:
+ .. sourcecode:: bash
- .. sourcecode:: bash
+ $ sudo apt-get install cloudstack-management
- cd /etc/cloudstack/agent
- mv log4j-cloud.xml.dpkg-dist log4j-cloud.xml
- service cloudstack-agent restart
+#. You will need to manually install the ``cloudstack-agent`` package:
- #.
+ .. sourcecode:: bash
- Once the agent is running, you can uninstall the old cloud-\*
- packages from your system:
+ $ sudo apt-get install cloudstack-agent
- .. sourcecode:: bash
+ During the installation of ``cloudstack-agent``, APT will copy
+ your ``agent.properties``, ``log4j-cloud.xml``, and
+ ``environment.properties`` from ``/etc/cloud/agent`` to
+ ``/etc/cloudstack/agent``.
- sudo dpkg --purge cloud-agent
+ When prompted whether you wish to keep your configuration, say
+ Yes.
-#.
+#. Verify that the file ``/etc/cloudstack/agent/environment.properties`` has a line that reads:
- If you are using CentOS or RHEL, follow this procedure to upgrade
- your packages. If not, skip to step
- `11 <#restart-system-vms-40to41>`__.
+ .. sourcecode:: bash
- .. note:: **Community Packages:** This section assumes you're using the community supplied packages for CloudStack. If you've created your own packages and yum repository, substitute your own URL for the ones used in these examples.
+ paths.script=/usr/share/cloudstack-common
- #.
+ If not, add the line.
- The first order of business will be to change the yum repository
- for each system with CloudStack packages. This means all
- management servers, and any hosts that have the KVM agent. (No
- changes should be necessary for hosts that are running VMware or
- Xen.)
+#. Restart the agent:
- Start by opening ``/etc/yum.repos.d/cloudstack.repo`` on any
- systems that have CloudStack packages installed.
+ .. sourcecode:: bash
- This file should have content similar to the following:
+ service cloud-agent stop
+ killall jsvc
+ service cloudstack-agent start
- .. sourcecode:: bash
+#. During the upgrade, ``log4j-cloud.xml`` was simply copied over, so
+ the logs will continue to be added to
+ ``/var/log/cloud/agent/agent.log``. There's nothing *wrong* with
+ this, but if you prefer to be consistent, you can change this by
+ copying over the sample configuration file:
- [apache-cloudstack]
- name=Apache CloudStack
- baseurl=http://cloudstack.apt-get.eu/rhel/4.0/
- enabled=1
- gpgcheck=0
+ .. sourcecode:: bash
- If you are using the community provided package repository, change
- the baseurl to http://cloudstack.apt-get.eu/rhel/4.3/
+ cd /etc/cloudstack/agent
+ mv log4j-cloud.xml.dpkg-dist log4j-cloud.xml
+ service cloudstack-agent restart
- If you're using your own package repository, change this line to
- read as appropriate for your |version| repository.
+#. Once the agent is running, you can uninstall the old cloud-\*
+ packages from your system:
- #.
+ .. sourcecode:: bash
- Now that you have the repository configured, it's time to install
- the ``cloudstack-management`` package by upgrading the older
- ``cloud-client`` package.
+ sudo dpkg --purge cloud-agent
- .. sourcecode:: bash
+.. _rhel40:
- $ sudo yum upgrade cloud-client
+CentOS/RHEL
+-----------
- #.
+If you are using CentOS or RHEL, follow this procedure to upgrade your packages. If not, skip to step :ref:`upg-sysvm40`.
- For KVM hosts, you will need to upgrade the ``cloud-agent``
- package, similarly installing the new version as
- ``cloudstack-agent``.
+.. note:: **Community Packages:** This section assumes you're using the community supplied packages for CloudStack. If you've created your own packages and yum repository, substitute your own URL for the ones used in these examples.
- .. sourcecode:: bash
+#. The first order of business will be to change the yum repository
+ for each system with CloudStack packages. This means all
+ management servers, and any hosts that have the KVM agent. (No
+ changes should be necessary for hosts that are running VMware or
+ Xen.)
- $ sudo yum upgrade cloud-agent
+ Start by opening ``/etc/yum.repos.d/cloudstack.repo`` on any
+ systems that have CloudStack packages installed.
- During the installation of ``cloudstack-agent``, the RPM will copy
- your ``agent.properties``, ``log4j-cloud.xml``, and
- ``environment.properties`` from ``/etc/cloud/agent`` to
- ``/etc/cloudstack/agent``.
+ This file should have content similar to the following:
- #.
+ .. sourcecode:: bash
- Verify that the file
- ``/etc/cloudstack/agent/environment.properties`` has a line that
- reads:
+ [apache-cloudstack]
+ name=Apache CloudStack
+ baseurl=http://cloudstack.apt-get.eu/rhel/4.0/
+ enabled=1
+ gpgcheck=0
- .. sourcecode:: bash
+ If you are using the community provided package repository, change the baseurl to ``http://cloudstack.apt-get.eu/rhel/4.4/``
- paths.script=/usr/share/cloudstack-common
+ If you're using your own package repository, change this line to read as appropriate for your |version| repository.
- If not, add the line.
+#. Now that you have the repository configured, it's time to install
+ the ``cloudstack-management`` package by upgrading the older
+ ``cloud-client`` package.
- #.
+ .. sourcecode:: bash
- Restart the agent:
+ $ sudo yum upgrade cloud-client
- .. sourcecode:: bash
+#. **For KVM hosts**, you will need to upgrade the ``cloud-agent``
+ package, similarly installing the new version as
+ ``cloudstack-agent``.
- service cloud-agent stop
- killall jsvc
- service cloudstack-agent start
+ .. sourcecode:: bash
-#.
+ $ sudo yum upgrade cloud-agent
- Once you've upgraded the packages on your management servers, you'll
- need to restart the system VMs. Make sure port 8096 is open in your
- local host firewall to do this.
+ During the installation of ``cloudstack-agent``, the RPM will copy
+ your ``agent.properties``, ``log4j-cloud.xml``, and
+ ``environment.properties`` from ``/etc/cloud/agent`` to
+ ``/etc/cloudstack/agent``.
- There is a script that will do this for you, all you need to do is
- run the script and supply the IP address for your MySQL instance and
- your MySQL credentials:
+#. Verify that the file ``/etc/cloudstack/agent/environment.properties`` has a line that reads:
.. sourcecode:: bash
- # nohup cloudstack-sysvmadm -d IP address -u cloud -p -a > sysvm.log 2>&1 &
+ paths.script=/usr/share/cloudstack-common
- You can monitor the log for progress. The process of restarting the
- system VMs can take an hour or more.
+ If not, add the line.
+
+#. Restart the agent:
.. sourcecode:: bash
- # tail -f sysvm.log
+ service cloud-agent stop
+ killall jsvc
+ service cloudstack-agent start
- The output to ``sysvm.log`` will look something like this:
+Hypervisor: XenServer
+---------------------
- .. sourcecode:: bash
+ **(XenServer only)** Copy vhd-utils file on CloudStack management servers.
+
+ Copy the file `vhd-utils <http://download.cloud.com.s3.amazonaws.com/tools/vhd-util>`_ to
+ ``/usr/share/cloudstack-common/scripts/vm/hypervisor/xenserver``.
- Stopping and starting 1 secondary storage vm(s)...
- Done stopping and starting secondary storage vm(s)
- Stopping and starting 1 console proxy vm(s)...
- Done stopping and starting console proxy vm(s).
- Stopping and starting 4 running routing vm(s)...
- Done restarting router(s).
-#. .. note:: *For Xen Hosts: Copy vhd-utils:** This step is only for CloudStack installs that are using Xen hosts.
+.. _upg-sysvm40:
- Copy the file ``vhd-utils`` to
- ``/usr/share/cloudstack-common/scripts/vm/hypervisor/xenserver``.
+.. include:: _sysvm_restart.rst
.. include:: /global.rst
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/cloudstack-docs-rn/blob/bb313d3b/source/upgrade/upgrade-4.1.rst
----------------------------------------------------------------------
diff --git a/source/upgrade/upgrade-4.1.rst b/source/upgrade/upgrade-4.1.rst
index 2931bf9..1fcc21a 100644
--- a/source/upgrade/upgrade-4.1.rst
+++ b/source/upgrade/upgrade-4.1.rst
@@ -1,476 +1,362 @@
-Upgrade Instruction from 4.1.x
--------------------------------
+.. |version_to_upgrade| replace:: 4.1.x
-This section contains upgrade instructions from prior versions of
-CloudStack to Apache CloudStack |version|. We include instructions on
-upgrading to Apache CloudStack from pre-Apache versions of Citrix
-CloudStack (last version prior to Apache is 3.0.2) and from the releases
-made while CloudStack was in the Apache Incubator.
+Upgrade Instruction from |version_to_upgrade|
+=============================================
-If you run into any issues during upgrades, please feel free to ask
-questions on users@cloudstack.apache.org or dev@cloudstack.apache.org.
+This section will guide you from CloudStack |version_to_upgrade| versions to CloudStack |version|.
-.. warning::
- :name: Depreciation of realhostip.com DNS and SSL certificate
-
- The realhostip.com dynamic DNS resolution service is being retired this
- summer. In advance of that, CloudStack 4.3 and later no longer uses realhostip.com
- DNS domains or SSL certificates to encrypt Console Proxy or file copy
- communications.
-
-
-This section will guide you from CloudStack 4.1.x versions to CloudStack |version|.
-
-Any steps that are hypervisor-specific will be called out with a note.
-
-We recommend reading through this section once or twice before beginning
-your upgrade procedure, and working through it on a test system before
-working on a production system.
-
-#.
-
- Most users of CloudStack manage the installation and upgrades of
- CloudStack with one of Linux's predominant package systems, RPM or
- APT. This guide assumes you'll be using RPM and Yum (for Red Hat
- Enterprise Linux or CentOS), or APT and Debian packages (for Ubuntu).
-
-#.
-
- .. note:: The following upgrade instructions should be performed regardless of hypervisor type.
-
- #.
-
- While running the existing 4.1.x system, log in to the UI as root
- administrator.
-
- #.
-
- In the left navigation bar, click Templates.
-
- #.
+.. include:: _upgrade_header.rst
- In Select view, click Templates.
- #.
+Upgrade Steps:
- Click Register template.
+#. Install new System-VM templates
+#. Backup CloudStack database (MySQL)
+#. Upgrade CloudStack packages
+#. Update hypervisors specific dependencies
+#. Restart System-VMs and Virtual-Routers
- The Register template dialog box is displayed.
- #.
+Packages repository
+-------------------
- In the Register template dialog box, specify the following values
- (do not change these):
+Most users of CloudStack manage the installation and upgrades of
+CloudStack with one of Linux's predominant package systems, RPM or
+APT. This guide assumes you'll be using RPM and Yum (for Red Hat
+Enterprise Linux or CentOS), or APT and Debian packages (for Ubuntu).
- .. include:: /systemvm_templates.rst
+Create RPM or Debian packages (as appropriate) and a repository from
+the |version| source, or check the Apache CloudStack downloads page at
+http://cloudstack.apache.org/downloads.html
+for package repositories supplied by community members. You will need
+them for :ref:`ubuntu41` or :ref:`rhel41` and :ref:`kvm41` hosts upgrade.
+Instructions for creating packages from the CloudStack source are in the `CloudStack Installation Guide`_.
-#.
+.. include:: _sysvm_templates.rst
- Create RPM or Debian packages (as appropriate) and a repository from
- the 4.3.0 source, or check the Apache CloudStack downloads page at
- `http://cloudstack.apache.org/downloads.html <http://cloudstack.apache.org/downloads.html>`__
- for package repositories supplied by community members. You will need
- them for step `8 <#upgrade-deb-packages-41to42>`__ or step
- `11 <#upgrade-rpm-packages-41to43>`__.
- Instructions for creating packages from the CloudStack source are in
- the `Installation
- Guide <http://cloudstack.apache.org/docs/en-US/index.html>`__.
+Database Preparation
+--------------------
-#.
+Backup current database
- Stop your management server or servers. Run this on all management
+#. Stop your management server or servers. Run this on all management
server hosts:
.. sourcecode:: bash
- # service cloudstack-management stop
+ $ sudo service cloudstack-management stop
-#.
-
- If you are running a usage server or usage servers, stop those as
+#. If you are running a usage server or usage servers, stop those as
well:
.. sourcecode:: bash
- # service cloudstack-usage stop
-
-#.
+ $ sudo service cloudstack-usage stop
- Make a backup of your MySQL database. If you run into any issues or
+#. Make a backup of your MySQL database. If you run into any issues or
need to roll back the upgrade, this will assist in debugging or
restoring your existing environment. You'll be prompted for your
password.
.. sourcecode:: bash
- # mysqldump -u root -p cloud > cloudstack-backup.sql
+ $ mysqldump -u root -p cloud > cloudstack-backup.sql
-#.
-
- (KVM Only) If primary storage of type local storage is in use, the
+#. **(KVM Only)** If primary storage of type local storage is in use, the
path for this storage needs to be verified to ensure it passes new
validation. Check local storage by querying the cloud.storage\_pool
table:
.. sourcecode:: bash
- #mysql -u cloud -p -e "select id,name,path from cloud.storage_pool where pool_type='Filesystem'"
+ $ mysql -u cloud -p -e "select id,name,path from cloud.storage_pool where pool_type='Filesystem'"
If local storage paths are found to have a trailing forward slash,
remove it:
.. sourcecode:: bash
- #mysql -u cloud -p -e 'update cloud.storage_pool set path="/var/lib/libvirt/images" where path="/var/lib/libvirt/images/"';
-
-#.
-
- If you are using Ubuntu, follow this procedure to upgrade your
- packages. If not, skip to step `11 <#upgrade-rpm-packages-41to42>`__.
-
- .. note::
-
- **Community Packages:** This section assumes you're using the community supplied packages for CloudStack. If you've created your own packages and APT repository, substitute your own URL for the ones used in these examples.
-
- #.
-
- The first order of business will be to change the sources list for
- each system with CloudStack packages. This means all management
- servers, and any hosts that have the KVM agent. (No changes should
- be necessary for hosts that are running VMware or Xen.)
-
- Start by opening ``/etc/apt/sources.list.d/cloudstack.list`` on
- any systems that have CloudStack packages installed.
-
- This file should have one line, which contains:
-
- .. sourcecode:: bash
-
- deb http://cloudstack.apt-get.eu/ubuntu precise 4.1
-
- We'll change it to point to the new package repository:
-
- .. sourcecode:: bash
-
- deb http://cloudstack.apt-get.eu/ubuntu precise 4.3
-
- If you're using your own package repository, change this line to
- read as appropriate for your |version| repository.
-
- #.
+ $ mysql -u cloud -p -e 'update cloud.storage_pool set path="/var/lib/libvirt/images" where path="/var/lib/libvirt/images/"';
- Now update your apt package list:
- .. sourcecode:: bash
-
- $ sudo apt-get update
+.. _ubuntu41:
- #.
+Management Server Ubuntu
+------------------------
- Now that you have the repository configured, it's time to install
- the ``cloudstack-management`` package. This will pull in any other
- dependencies you need.
-
- .. sourcecode:: bash
+If you are using Ubuntu, follow this procedure to upgrade your packages. If not, skip to step :ref:`rhel41`.
- $ sudo apt-get install cloudstack-management
+.. note::
+ **Community Packages:** This section assumes you're using the community supplied packages for CloudStack. If you've created your own packages and APT repository, substitute your own URL for the ones used in these examples.
- #.
-
- You will need to manually install the ``cloudstack-agent``
- package:
-
- .. sourcecode:: bash
+#. The first order of business will be to change the sources list for
+ each system with CloudStack packages. This means all management
+ servers, and any hosts that have the KVM agent. (No changes should
+ be necessary for hosts that are running VMware or Xen.)
- $ sudo apt-get install cloudstack-agent
+ Start by opening ``/etc/apt/sources.list.d/cloudstack.list`` on
+ any systems that have CloudStack packages installed.
- During the installation of ``cloudstack-agent``, APT will copy
- your ``agent.properties``, ``log4j-cloud.xml``, and
- ``environment.properties`` from ``/etc/cloud/agent`` to
- ``/etc/cloudstack/agent``.
+ This file should have one line, which contains:
- When prompted whether you wish to keep your configuration, say
- Yes.
-
- #.
-
- Verify that the file
- ``/etc/cloudstack/agent/environment.properties`` has a line that
- reads:
+ .. sourcecode:: bash
- .. sourcecode:: bash
+ deb http://cloudstack.apt-get.eu/ubuntu precise 4.1
- paths.script=/usr/share/cloudstack-common
+ We'll change it to point to the new package repository:
- If not, add the line.
+ .. sourcecode:: bash
- #.
+ deb http://cloudstack.apt-get.eu/ubuntu precise 4.4
- Restart the agent:
+ If you're using your own package repository, change this line to
+ read as appropriate for your |version| repository.
- .. sourcecode:: bash
+#. Now update your apt package list:
- service cloudstack-agent stop
- killall jsvc
- service cloudstack-agent start
+ .. sourcecode:: bash
-#.
+ $ sudo apt-get update
- (VMware only) Additional steps are required for each VMware cluster.
- These steps will not affect running guests in the cloud. These steps
- are required only for clouds using VMware clusters:
+#. Now that you have the repository configured, it's time to install
+ the ``cloudstack-management`` package. This will pull in any other
+ dependencies you need.
- #.
+ .. sourcecode:: bash
- Stop the Management Server:
+ $ sudo apt-get install cloudstack-management
- .. sourcecode:: bash
+#. You will need to manually install the ``cloudstack-agent``
+ package:
- service cloudstack-management stop
+ .. sourcecode:: bash
- #.
+ $ sudo apt-get install cloudstack-agent
- Generate the encrypted equivalent of your vCenter password:
+ During the installation of ``cloudstack-agent``, APT will copy
+ your ``agent.properties``, ``log4j-cloud.xml``, and
+ ``environment.properties`` from ``/etc/cloud/agent`` to
+ ``/etc/cloudstack/agent``.
- .. sourcecode:: bash
+ When prompted whether you wish to keep your configuration, say
+ Yes.
- java -classpath /usr/share/cloudstack-common/lib/jasypt-1.9.0.jar org.jasypt.intf.cli.JasyptPBEStringEncryptionCLI encrypt.sh input="_your_vCenter_password_" password="`cat /etc/cloudstack/management/key`" verbose=false
+#. Verify that the file
+ ``/etc/cloudstack/agent/environment.properties`` has a line that
+ reads:
- Store the output from this step, we need to add this in
- cluster\_details table and vmware\_data\_center tables in place of
- the plain text password
+ .. sourcecode:: bash
- #.
+ paths.script=/usr/share/cloudstack-common
- Find the ID of the row of cluster\_details table that you have to
- update:
+ If not, add the line.
- .. sourcecode:: bash
+#. Restart the agent:
- mysql -u <username> -p<password>
+ .. sourcecode:: bash
- .. sourcecode:: bash
+ service cloudstack-agent stop
+ killall jsvc
+ service cloudstack-agent start
- select * from cloud.cluster_details;
+.. _rhel41:
- #.
+Management Server on CentOS/RHEL
+--------------------------------
- Update the plain text password with the encrypted one
+If you are using CentOS or RHEL, follow this procedure to upgrade your packages. If not, skip to hypervisors section, then :ref:`upg-sysvm41`.
- .. sourcecode:: bash
+.. note::
+ **Community Packages:** This section assumes you're using the community supplied packages for CloudStack. If you've created your own packages and yum repository, substitute your own URL for the ones used in these examples.
- update cloud.cluster_details set value = '_ciphertext_from_step_1_' where id = _id_from_step_2_;
+.. _rpm-repo41:
- #.
+CloustStack RPM repository
+^^^^^^^^^^^^^^^^^^^^^^^^^^
- Confirm that the table is updated:
+ The first order of business will be to change the yum repository
+ for each system with CloudStack packages. This means all
+ management servers, and any hosts that have the KVM agent.
- .. sourcecode:: bash
+ (No changes should be necessary for hosts that are running VMware
+ or Xen.)
- select * from cloud.cluster_details;
+ Start by opening ``/etc/yum.repos.d/cloudstack.repo`` on any
+ systems that have CloudStack packages installed.
- #.
+ This file should have content similar to the following:
- Find the ID of the correct row of vmware\_data\_center that you
- want to update
+ .. sourcecode:: bash
- .. sourcecode:: bash
+ [apache-cloudstack]
+ name=Apache CloudStack
+ baseurl=http://cloudstack.apt-get.eu/rhel/4.1/
+ enabled=1
+ gpgcheck=0
- select * from cloud.vmware_data_center;
+ If you are using the community provided package repository, change
+ the base url to ``http://cloudstack.apt-get.eu/rhel/4.4/``
- #.
+ If you're using your own package repository, change this line to
+ read as appropriate for your |version| repository.
- update the plain text password with the encrypted one:
+#. Now that you have the repository configured, it's time to install
+ the ``cloudstack-management`` package by upgrading the older
+ ``cloudstack-management`` package.
- .. sourcecode:: bash
+ .. sourcecode:: bash
- update cloud.vmware_data_center set password = '_ciphertext_from_step_1_' where id = _id_from_step_5_;
+ $ sudo yum upgrade cloudstack-management
- #.
+Hypervisor: Xen/XenServer
+-------------------------
- Confirm that the table is updated:
+ **(XenServer only)** Copy vhd-utils file on CloudStack management servers.
+
+ Copy the file `vhd-utils <http://download.cloud.com.s3.amazonaws.com/tools/vhd-util>`_ to
+ ``/usr/share/cloudstack-common/scripts/vm/hypervisor/xenserver``.
- .. sourcecode:: bash
- select * from cloud.vmware_data_center;
+Hypervisor: VMware
+------------------
- #.
+(VMware only) Additional steps are required for each VMware cluster.
+These steps will not affect running guests in the cloud. These steps
+are required only for clouds using VMware clusters:
- Start the CloudStack Management server
+#. Stop the Management Server:
- .. sourcecode:: bash
+ .. sourcecode:: bash
- service cloudstack-management start
+ service cloudstack-management stop
-#.
+#. Generate the encrypted equivalent of your vCenter password:
- (KVM only) 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.
+ .. sourcecode:: bash
- #.
+ java -classpath /usr/share/cloudstack-common/lib/jasypt-1.9.0.jar org.jasypt.intf.cli.JasyptPBEStringEncryptionCLI encrypt.sh input="_your_vCenter_password_" password="`cat /etc/cloudstack/management/key`" verbose=false
- Configure the CloudStack yum repository as detailed above.
+ Store the output from this step, we need to add this in
+ cluster\_details table and vmware\_data\_center tables in place of
+ the plain text password
- #.
+#. Find the ID of the row of cluster\_details table that you have to
+ update:
- Stop the running agent.
+ .. sourcecode:: bash
- .. sourcecode:: bash
+ mysql -u <username> -p<password>
- # service cloud-agent stop
+ .. sourcecode:: bash
- #.
+ select * from cloud.cluster_details;
- Update the agent software.
+#. Update the plain text password with the encrypted one
- .. sourcecode:: bash
+ .. sourcecode:: bash
- # yum update cloudstack-agent
+ update cloud.cluster_details set value = '_ciphertext_from_step_1_' where id = _id_from_step_2_;
- #.
+#. Confirm that the table is updated:
- Start the agent.
+ .. sourcecode:: bash
- .. sourcecode:: bash
+ select * from cloud.cluster_details;
- # service cloudstack-agent start
+#. Find the ID of the correct row of vmware\_data\_center that you
+ want to update
-#.
+ .. sourcecode:: bash
- If you are using CentOS or RHEL, follow this procedure to upgrade
- your packages. If not, skip to step
- `13 <#restart-system-vms-41to42>`__.
+ select * from cloud.vmware_data_center;
- .. note::
-
- **Community Packages:** This section assumes you're using the community supplied packages for CloudStack. If you've created your own packages and yum repository, substitute your own URL for the ones used in these examples.
+#. Update the plain text password with the encrypted one:
- #.
+ .. sourcecode:: bash
- The first order of business will be to change the yum repository
- for each system with CloudStack packages. This means all
- management servers, and any hosts that have the KVM agent.
+ update cloud.vmware_data_center set password = '_ciphertext_from_step_1_' where id = _id_from_step_5_;
- (No changes should be necessary for hosts that are running VMware
- or Xen.)
+#. Confirm that the table is updated:
- Start by opening ``/etc/yum.repos.d/cloudstack.repo`` on any
- systems that have CloudStack packages installed.
+ .. sourcecode:: bash
- This file should have content similar to the following:
+ select * from cloud.vmware_data_center;
- .. sourcecode:: bash
+#. Start the CloudStack Management server
- [apache-cloudstack]
- name=Apache CloudStack
- baseurl=http://cloudstack.apt-get.eu/rhel/4.0/
- enabled=1
- gpgcheck=0
+ .. sourcecode:: bash
- If you are using the community provided package repository, change
- the base url to http://cloudstack.apt-get.eu/rhel/4.3/
+ service cloudstack-management start
- If you're using your own package repository, change this line to
- read as appropriate for your |version| repository.
+.. _kvm41:
- #.
+Hypervisor: KVM
+---------------
- Now that you have the repository configured, it's time to install
- the ``cloudstack-management`` package by upgrading the older
- ``cloudstack-management`` package.
+KVM on Ubuntu
+^^^^^^^^^^^^^
- .. sourcecode:: bash
-
- $ sudo yum upgrade cloudstack-management
+ **(KVM only)** 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.
- #.
+ #. Configure the CloudStack yum repository as detailed above.
- For KVM hosts, you will need to upgrade the ``cloud-agent``
- package, similarly installing the new version as
- ``cloudstack-agent``.
+ #. Stop the running agent.
.. sourcecode:: bash
- $ sudo yum upgrade cloudstack-agent
-
- #.
+ # service cloud-agent stop
- Verify that the file
- ``/etc/cloudstack/agent/environment.properties`` has a line that
- reads:
+ #. Update the agent software.
.. sourcecode:: bash
- paths.script=/usr/share/cloudstack-common
-
- If not, add the line.
-
- #.
+ # yum update cloudstack-agent
- Restart the agent:
+ #. Start the agent.
.. sourcecode:: bash
- service cloudstack-agent stop
- killall jsvc
- service cloudstack-agent start
-
-#.
+ # service cloudstack-agent start
- Now it's time to restart the management server
+KVM on CentOS
+^^^^^^^^^^^^^
+#. Configure the :ref:`rpm-repo41` as detailed above.
.. sourcecode:: bash
- # service cloudstack-management start
-
-#.
+ $ sudo yum upgrade cloudstack-agent
- Once you've upgraded the packages on your management servers, you'll
- need to restart the system VMs. Ensure that the admin port is set to
- 8096 by using the "integration.api.port" global parameter. 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.
- Changing this parameter will require management server restart. Also
- make sure port 8096 is open in your local host firewall to do this.
-
- There is a script that will do this for you, all you need to do is
- run the script and supply the IP address for your MySQL instance and
- your MySQL credentials:
+#. Verify that the file
+ ``/etc/cloudstack/agent/environment.properties`` has a line that
+ reads:
.. sourcecode:: bash
- # nohup cloudstack-sysvmadm -d IP address -u cloud -p -a > sysvm.log 2>&1 &
+ paths.script=/usr/share/cloudstack-common
+
+ If not, add the line.
- You can monitor the log for progress. The process of restarting the
- system VMs can take an hour or more.
+#. Restart the agent:
.. sourcecode:: bash
- # tail -f sysvm.log
+ service cloudstack-agent stop
+ killall jsvc
+ service cloudstack-agent start
- The output to ``sysvm.log`` will look something like this:
+#. Now it's time to restart the management server
.. sourcecode:: bash
- Stopping and starting 1 secondary storage vm(s)...
- Done stopping and starting secondary storage vm(s)
- Stopping and starting 1 console proxy vm(s)...
- Done stopping and starting console proxy vm(s).
- Stopping and starting 4 running routing vm(s)...
- Done restarting router(s).
-
-#.
+ # service cloudstack-management start
- .. note::
-
- **For Xen Hosts: Copy vhd-utils:** This step is only for CloudStack installs that are using Xen hosts.
+.. _upg-sysvm41:
- Copy the file ``vhd-utils`` to
- ``/usr/share/cloudstack-common/scripts/vm/hypervisor/xenserver``.
+.. include:: _sysvm_restart.rst
.. include:: /global.rst
\ No newline at end of file