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:05 UTC
[06/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-4.2.rst
----------------------------------------------------------------------
diff --git a/source/upgrade/upgrade-4.2.rst b/source/upgrade/upgrade-4.2.rst
index 327d101..574b48b 100644
--- a/source/upgrade/upgrade-4.2.rst
+++ b/source/upgrade/upgrade-4.2.rst
@@ -1,103 +1,58 @@
-Upgrade Instruction from 4.2.x
--------------------------------
+.. |version_to_upgrade| replace:: 4.2.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| 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.2.x 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.
-
-.. note:: The following upgrade instructions should be performed regardless of hypervisor type.
-
-#.
-
- #.
-
- While running the existing 4.2.x system, log in to the UI as root
- administrator.
-
- #.
-
- In the left navigation bar, click Templates.
-
- #.
-
- In Select view, click Templates.
+.. include:: _upgrade_header.rst
- #.
+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
+-------------------
- #.
+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:`ubuntu42` or :ref:`rhel42` and :ref:`kvm42` hosts upgrade.
- .. include:: /systemvm_templates.rst
+Instructions for creating packages from the CloudStack source are in the `CloudStack Installation Guide`_.
-#.
-
- 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:: _sysvm_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 <http://cloudstack.apache.org/downloads.html>`__
- for package repositories supplied by community members. You will need
- them for step `8 <#upgrade-deb-packages-|version|>`__ or step
- `11 <#upgrade-rpm-packages-|version|>`__.
+Database Preparation
+--------------------
- Instructions for creating packages from the CloudStack source are in
- the `Installation
- Guide <http://cloudstack.apache.org/docs/en-US/index.html>`__.
+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
$ 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
$ 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.
@@ -106,9 +61,7 @@ working on a production system.
$ 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:
@@ -124,339 +77,291 @@ working on a production system.
$ 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-|version|>`__.
- .. 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.
+.. _ubuntu42:
- #.
+Management Server Ubuntu
+------------------------
- 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.)
+If you are using Ubuntu, follow this procedure to upgrade your packages. If not, skip to step :ref:`rhel42`.
- Start by opening ``/etc/apt/sources.list.d/cloudstack.list`` on
- any systems that have CloudStack packages installed.
+.. 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.
- This file should have one line, which contains:
-
- .. sourcecode:: bash
-
- deb http://cloudstack.apt-get.eu/ubuntu precise 4.2
-
- 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.
-
- #.
-
- Now update your apt package list:
-
- .. sourcecode:: bash
-
- $ sudo apt-get update
-
- #.
-
- Now that you have the repository configured, it's time to upgrade
- the ``cloudstack-management`` package.
-
- .. sourcecode:: bash
-
- $ sudo apt-get upgrade cloudstack-management
-
- #.
-
- Now it's time to start the management server
-
- .. sourcecode:: bash
-
- $ sudo service cloudstack-management start
-
- #.
-
- If you use it, start the usage server
-
- .. sourcecode:: bash
-
- $ sudo service cloudstack-usage start
-
-#.
-
- (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:
+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.)
- #.
+.. _apt-repo42:
- Stop the Management Server:
+CloudStack apt repository
+^^^^^^^^^^^^^^^^^^^^^^^^^
- .. sourcecode:: bash
+ 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.2
+
+ We'll change it to point to the new package repository:
+
+ .. sourcecode:: bash
+
+ 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.
- $ sudo service cloudstack-management stop
+#. Now update your apt package list:
- #.
+ .. sourcecode:: bash
- Generate the encrypted equivalent of your vCenter password:
+ $ sudo apt-get update
- .. sourcecode:: bash
+#. Now that you have the repository configured, it's time to upgrade
+ the ``cloudstack-management`` package.
- $ 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
+ .. sourcecode:: bash
- 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
+ $ sudo apt-get upgrade cloudstack-management
- #.
+#. Now it's time to start the management server
- Find the ID of the row of cluster\_details table that you have to
- update:
+ .. sourcecode:: bash
- .. sourcecode:: bash
+ $ sudo service cloudstack-management start
- $ mysql -u <username> -p<password>
+#. If you use it, start the usage server
- .. sourcecode:: bash
+ .. sourcecode:: bash
- select * from cloud.cluster_details;
+ $ sudo service cloudstack-usage start
- #.
- Update the plain text password with the encrypted one
+.. _rhel42:
- .. sourcecode:: bash
+Management Server CentOS/RHEL
+-----------------------------
- update cloud.cluster_details set value = '_ciphertext_from_step_1_' where id = _id_from_step_2_;
+If you are using CentOS or RHEL, follow this procedure to upgrade your packages. If not, skip to hypervisors section, then :ref:`upg-sysvm42`.
- #.
+.. 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.
- Confirm that the table is updated:
+.. _rpm-repo42:
- .. sourcecode:: bash
+CloustStack RPM repository
+^^^^^^^^^^^^^^^^^^^^^^^^^^
- select * from cloud.cluster_details;
+ 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.)
- Find the ID of the correct row of vmware\_data\_center that you
- want to update
+ 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
- #.
+ [apache-cloudstack]
+ name=Apache CloudStack
+ baseurl=http://cloudstack.apt-get.eu/rhel/4.2/
+ enabled=1
+ gpgcheck=0
- update the plain text password with the encrypted one:
+ If you are using the community provided package repository, change
+ the base url to ``http://cloudstack.apt-get.eu/rhel/4.4/``
- .. sourcecode:: bash
+ If you're using your own package repository, change this line to
+ read as appropriate for your |version| repository.
- update cloud.vmware_data_center set password = '_ciphertext_from_step_1_' where id = _id_from_step_5_;
+#.
- #.
+ Now that you have the repository configured, it's time to upgrade the ``cloudstack-management``.
- Confirm that the table is updated:
+ .. sourcecode:: bash
- .. sourcecode:: bash
+ $ sudo yum upgrade cloudstack-management
- select * from cloud.vmware_data_center;
+#.
- #.
+ Now it's time to restart the management server
- Start the CloudStack Management server
+ .. sourcecode:: bash
- .. sourcecode:: bash
+ $ sudo service cloudstack-management start
- $ sudo service cloudstack-management start
-#.
+Hypervisor: Xen/XenServer
+-------------------------
- (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.
+ **(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``.
- #.
+Hypervisor: VMware
+------------------
- Configure the CloudStack apt repository as detailed above.
+ .. warning::
+ For VMware hypervisor CloudStack management server packages must be build using "noredist".
+ Refer to `Building from Source <http://docs.cloudstack.apache.org/projects/cloudstack-installation/en/latest/building_from_source.html>`_.
- #.
+ **(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:
- Stop the running agent.
+#. Stop the Management Server:
- .. sourcecode:: bash
+ .. sourcecode:: bash
- $ sudo service cloudstack-agent stop
+ $ sudo service cloudstack-management stop
- #.
+#. Generate the encrypted equivalent of your vCenter password:
- Update the agent software.
+ .. sourcecode:: bash
- .. 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
- $ sudo apt-get update cloudstack-agent
+ 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:
- Verify that the file
- ``/etc/cloudstack/agent/environment.properties`` has a line that
- reads:
+ .. sourcecode:: bash
- .. sourcecode:: bash
+ $ mysql -u <username> -p<password>
- paths.script=/usr/share/cloudstack-common
+ .. sourcecode:: bash
- If not, add the line.
+ select * from cloud.cluster_details;
- #.
+#. Update the plain text password with the encrypted one
- Start the agent.
+ .. sourcecode:: bash
- .. sourcecode:: bash
+ update cloud.cluster_details set value = '_ciphertext_from_step_1_' where id = _id_from_step_2_;
- $ sudo service cloudstack-agent start
+#. Confirm that the table is updated:
-#.
+ .. sourcecode:: bash
- If you are using CentOS or RHEL, follow this procedure to upgrade
- your packages. If not, skip to step `14 <#restart-system-vms-|version|>`__.
+ select * from cloud.cluster_details;
- .. 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.
+#. Find the ID of the correct row of vmware\_data\_center that you
+ want to update
- #.
+ .. 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.
+ select * from cloud.vmware_data_center;
- (No changes should be necessary for hosts that are running VMware
- or Xen.)
+#. Update the plain text password with the encrypted one:
- 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:
+ update cloud.vmware_data_center set password = '_ciphertext_from_step_1_' where id = _id_from_step_5_;
- .. sourcecode:: bash
+#. Confirm that the table is updated:
- [apache-cloudstack]
- name=Apache CloudStack
- baseurl=http://cloudstack.apt-get.eu/rhel/4.2/
- 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/
+ select * from cloud.vmware_data_center;
- If you're using your own package repository, change this line to
- read as appropriate for your |version| repository.
+#. Start the CloudStack Management server
- #.
+ .. sourcecode:: bash
- Now that you have the repository configured, it's time to install
- the ``cloudstack-management`` package by upgrading the older
- ``cloudstack-management`` package.
+ $ sudo service cloudstack-management start
- .. sourcecode:: bash
+.. _kvm42:
- $ sudo yum upgrade cloudstack-management
+Hypervisor: KVM
+---------------
- #.
+KVM on Ubuntu
+^^^^^^^^^^^^^
- Now it's time to restart the management server
+(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
+#. Configure the :ref:`apt-repo42` as detailed above.
- $ sudo service cloudstack-management start
+#. Stop the running agent.
- #.
+ .. sourcecode:: bash
- For KVM hosts, upgrade the ``cloudstack-agent`` package
+ $ sudo service cloudstack-agent stop
- .. sourcecode:: bash
+#. Update the agent software.
- $ sudo yum upgrade cloudstack-agent
+ .. sourcecode:: bash
- #.
+ $ sudo apt-get update cloudstack-agent
- 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
+ .. sourcecode:: bash
- paths.script=/usr/share/cloudstack-common
+ paths.script=/usr/share/cloudstack-common
- If not, add the line.
+ If not, add the line.
- #.
+#. Start the agent.
- Restart the agent:
+ .. sourcecode:: bash
- .. sourcecode:: bash
+ $ sudo service cloudstack-agent start
- $ sudo service cloudstack-agent stop
- $ sudo killall jsvc
- $ sudo service cloudstack-agent start
-#.
+KVM on CentOS/RHEL
+^^^^^^^^^^^^^^^^^^
+For KVM hosts, upgrade the ``cloudstack-agent`` package
- Now it's time to restart the management server
+#. Configure the :ref:`rpm-repo42` as detailed above.
.. sourcecode:: bash
- $ sudo 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
+ $ sudo service cloudstack-agent stop
+ $ sudo killall jsvc
+ $ sudo 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).
-
-#.
+ $ sudo service cloudstack-management start
- .. note:: **For Xen Hosts: Copy vhd-utils:** This step is only for CloudStack installs that are using Xen hosts.
+.. _upg-sysvm42:
+.. include:: _sysvm_restart.rst
- Copy the file ``vhd-utils`` to
- ``/usr/share/cloudstack-common/scripts/vm/hypervisor/xenserver``.
-.. include:: /global.rst
\ No newline at end of file
+.. include:: /global.rst
http://git-wip-us.apache.org/repos/asf/cloudstack-docs-rn/blob/bb313d3b/source/upgrade/upgrade-4.3.rst
----------------------------------------------------------------------
diff --git a/source/upgrade/upgrade-4.3.rst b/source/upgrade/upgrade-4.3.rst
index 37944af..76a5cab 100644
--- a/source/upgrade/upgrade-4.3.rst
+++ b/source/upgrade/upgrade-4.3.rst
@@ -1,7 +1,24 @@
-Upgrade Instruction from 4.3
-============================
-
-This section will guide you from CloudStack 4.3.x to CloudStack |version|.
+.. 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.
+
+.. |version_to_upgrade| replace:: 4.3
+
+Upgrade Instruction from |version_to_upgrade|
+=============================================
+
+This section will guide you from CloudStack |version_to_upgrade| to CloudStack |version|.
Any steps that are hypervisor-specific will be called out with a note.
@@ -32,66 +49,33 @@ 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:`ubuntu` or :ref:`rhel` and :ref:`kvm` hosts upgrade.
+them for :ref:`ubuntu43` or :ref:`rhel43` and :ref:`kvm43` hosts upgrade.
Instructions for creating packages from the CloudStack source are in the `CloudStack Installation Guide`_.
-Update System-VM template
--------------------------
-
-#.
-
- While running the existing 4.3.x system, log in to the UI as root
- administrator.
-
-#.
-
- In the left navigation bar, click Templates.
-
-#.
-
- In Select view, click Templates.
+.. include:: _sysvm_templates.rst
-#.
- 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
-
-
-Prepare Databases
------------------
+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
$ 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
$ 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.
@@ -100,9 +84,7 @@ Backup current database
$ 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:
@@ -119,12 +101,12 @@ Backup current database
$ mysql -u cloud -p -e 'update cloud.storage_pool set path="/var/lib/libvirt/images" where path="/var/lib/libvirt/images/"';
-.. _ubuntu:
+.. _ubuntu43:
-Ubuntu management server
-------------------------
+Management Server on Ubuntu
+---------------------------
-If you are using Ubuntu, follow this procedure to upgrade your packages. If not, skip to step `11 <#upgrade-rpm-packages-|version|>`__.
+If you are using Ubuntu, follow this procedure to upgrade your packages. If not, skip to step :ref:`rhel43`.
.. 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.
@@ -133,7 +115,7 @@ 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.)
-.. _apt-repo:
+.. _apt-repo43:
CloudStack apt repository
^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -156,51 +138,43 @@ CloudStack apt repository
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 upgrade
+#. Now that you have the repository configured, it's time to upgrade
the ``cloudstack-management`` package.
.. sourcecode:: bash
$ sudo apt-get upgrade cloudstack-management
-#.
-
- Now it's time to start the management server
+#. Now it's time to start the management server
.. sourcecode:: bash
$ sudo service cloudstack-management start
-#.
-
- If you use it, start the usage server
+#. If you use it, start the usage server
.. sourcecode:: bash
$ sudo service cloudstack-usage start
-.. _rhel:
+.. _rhel43:
-CentOS/RHEL management server
------------------------------
+Management Server on CentOS/RHEL
+--------------------------------
-If you are using CentOS or RHEL, follow this procedure to upgrade your packages. If not, skip to step `14 <#restart-system-vms-|version|>`__.
+If you are using CentOS or RHEL, follow this procedure to upgrade your packages. If not, skip to hypervisors section, then :ref:`upg-sysvm43`.
.. 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.
-.. _rpm-repo:
+.. _rpm-repo43:
CloustStack RPM repository
^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -231,24 +205,20 @@ CloustStack RPM repository
If you're using your own package repository, change this line to
read as appropriate for your |version| repository.
-#.
-
- Now that you have the repository configured, it's time to upgrade the ``cloudstack-management``.
+#. Now that you have the repository configured, it's time to upgrade the ``cloudstack-management``.
.. sourcecode:: bash
$ sudo yum upgrade cloudstack-management
-#.
-
- Now it's time to restart the management server
+#. Now it's time to restart the management server
.. sourcecode:: bash
$ sudo service cloudstack-management start
-Xen/XenServer hypervisor
+hypervisor: XenServer
------------------------
**(XenServer only)** Copy vhd-utils file on CloudStack management servers.
@@ -256,8 +226,8 @@ Xen/XenServer hypervisor
Copy the file `vhd-utils <http://download.cloud.com.s3.amazonaws.com/tools/vhd-util>`_ to
``/usr/share/cloudstack-common/scripts/vm/hypervisor/xenserver``.
-VMware hypervisor
------------------
+hypervisor: VMware
+------------------
.. warning::
For VMware hypervisor CloudStack management server packages must be build using "noredist".
@@ -267,17 +237,13 @@ VMware hypervisor
These steps will not affect running guests in the cloud. These steps
are required only for clouds using VMware clusters:
-#.
-
- Stop the Management Server:
+#. Stop the Management Server:
.. sourcecode:: bash
$ sudo service cloudstack-management stop
-#.
-
- Generate the encrypted equivalent of your vCenter password:
+#. Generate the encrypted equivalent of your vCenter password:
.. sourcecode:: bash
@@ -287,9 +253,7 @@ VMware hypervisor
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
+#. Find the ID of the row of cluster\_details table that you have to
update:
.. sourcecode:: bash
@@ -300,59 +264,47 @@ VMware hypervisor
select * from cloud.cluster_details;
-#.
-
- Update the plain text password with the encrypted one
+#. Update the plain text password with the encrypted one
.. sourcecode:: bash
update cloud.cluster_details set value = '_ciphertext_from_step_1_' where id = _id_from_step_2_;
-#.
-
- Confirm that the table is updated:
+#. Confirm that the table is updated:
.. sourcecode:: bash
select * from cloud.cluster_details;
-#.
-
- Find the ID of the correct row of vmware\_data\_center that you
+#. Find the ID of the correct row of vmware\_data\_center that you
want to update
.. sourcecode:: bash
select * from cloud.vmware_data_center;
-#.
-
- update the plain text password with the encrypted one:
+#. update the plain text password with the encrypted one:
.. sourcecode:: bash
update cloud.vmware_data_center set password = '_ciphertext_from_step_1_' where id = _id_from_step_5_;
-#.
-
- Confirm that the table is updated:
+#. Confirm that the table is updated:
.. sourcecode:: bash
select * from cloud.vmware_data_center;
-#.
-
- Start the CloudStack Management server
+#. Start the CloudStack Management server
.. sourcecode:: bash
$ sudo service cloudstack-management start
-.. _kvm:
+.. _kvm43:
-KVM hypervisor
---------------
+hypervisor: KVM
+---------------
KVM on Ubuntu
^^^^^^^^^^^^^
@@ -362,29 +314,21 @@ 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 :ref:`apt-repo` as detailed above.
+#. Configure the :ref:`apt-repo43` as detailed above.
-#.
-
- Stop the running agent.
+#. Stop the running agent.
.. sourcecode:: bash
$ sudo service cloudstack-agent stop
-#.
-
- Update the agent software.
+#. Update the agent software.
.. sourcecode:: bash
$ sudo apt-get update cloudstack-agent
-#.
-
- Verify that the file
+#. Verify that the file
``/etc/cloudstack/agent/environment.properties`` has a line that
reads:
@@ -394,9 +338,7 @@ hosts.
If not, add the line.
-#.
-
- Start the agent.
+#. Start the agent.
.. sourcecode:: bash
@@ -407,17 +349,13 @@ KVM on CentOS/RHEL
^^^^^^^^^^^^^^^^^^
For KVM hosts, upgrade the ``cloudstack-agent`` package
-#.
-
- Configure the :ref:`rpm-repo` as detailed above.
+#. Configure the :ref:`rpm-repo43` as detailed above.
.. sourcecode:: bash
$ sudo yum upgrade cloudstack-agent
-#.
-
- Verify that the file
+#. Verify that the file
``/etc/cloudstack/agent/environment.properties`` has a line that
reads:
@@ -427,9 +365,7 @@ For KVM hosts, upgrade the ``cloudstack-agent`` package
If not, add the line.
-#.
-
- Restart the agent:
+#. Restart the agent:
.. sourcecode:: bash
@@ -437,53 +373,13 @@ For KVM hosts, upgrade the ``cloudstack-agent`` package
$ sudo killall jsvc
$ sudo service cloudstack-agent start
-#.
-
- Now it's time to restart the management server
+#. Now it's time to restart the management server
.. sourcecode:: bash
$ sudo service cloudstack-management start
-.. _upg-sysvm:
-
-System-VMs and Virtual-Routers
-------------------------------
-
-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 <http://docs.cloudstack.apache.org/projects/cloudstack-installation/en/latest/configuration.html#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:
-
-.. sourcecode:: bash
-
- # nohup cloudstack-sysvmadm -d IP address -u cloud -p -a > sysvm.log 2>&1 &
-
-You can monitor the log for progress. The process of restarting the
-system VMs can take an hour or more.
-
-.. sourcecode:: bash
-
- # tail -f sysvm.log
-
-The output to ``sysvm.log`` will look something like this:
-
-.. 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).
-
+.. _upg-sysvm43:
+.. include:: _sysvm_restart.rst
.. include:: /global.rst
http://git-wip-us.apache.org/repos/asf/cloudstack-docs-rn/blob/bb313d3b/source/upgrade/valid_source.rst
----------------------------------------------------------------------
diff --git a/source/upgrade/valid_source.rst b/source/upgrade/valid_source.rst
index 1aca761..f9e1a09 100644
--- a/source/upgrade/valid_source.rst
+++ b/source/upgrade/valid_source.rst
@@ -1,5 +1,20 @@
+.. 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.
+
Validate |version| source code tarball
---------------------------------------
+======================================
#.