Upgrade Instruction from 4.6.x

Upgrade Instruction from 4.6.x

This section will guide you from CloudStack 4.6.x to CloudStack 4.14.0.0.

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.

Upgrade Steps:

Backup CloudStack database (MySQL)
Add package repository for MySQL connector
Upgrade CloudStack management server(s)
Update hypervisors specific dependencies

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).

Create RPM or Debian packages (as appropriate) and a repository from the 4.14.0.0 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 Management Server on Ubuntu or Management Server on CentOS/RHEL and Hypervisor: KVM hosts upgrade.

Instructions for creating packages from the CloudStack source are in the CloudStack Installation Guide.

Update System-VM templates

While running the existing 4.6.x system, log in to the UI as the root administrator.
In the left navigation bar, click Templates.
In Select view, click Templates.
Click Register template. The Register template dialog box is displayed.

In the Register template dialog box, specify the following values (do not change these):

Hypervisor	Description
XenServer	Name: systemvm-xenserver-4.14.0 Description: systemvm-xenserver-4.14.0 URL: http://download.cloudstack.org/systemvm/4.14/systemvmtemplate-4.14.0-xen.vhd.bz2 Zone: Choose the zone where this hypervisor is used Hypervisor: XenServer Format: VHD OS Type: Other Linux (64-bit) Extractable: no Password Enabled: no Public: no Featured: no Routing: no
KVM	Name: systemvm-kvm-4.14.0 Description: systemvm-kvm-4.14.0 URL: http://download.cloudstack.org/systemvm/4.14/systemvmtemplate-4.14.0-kvm.qcow2.bz2 Zone: Choose the zone where this hypervisor is used Hypervisor: KVM Format: QCOW2 OS Type: Debian GNU/Linux 7.0 (64-bit) (or the highest Debian release number available in the dropdown) Extractable: no Password Enabled: no Public: no Featured: no Routing: no
VMware	Name: systemvm-vmware-4.14.0 Description: systemvm-vmware-4.14.0 URL: http://download.cloudstack.org/systemvm/4.14/systemvmtemplate-4.14.0-vmware.ova Zone: Choose the zone where this hypervisor is used Hypervisor: VMware Format: OVA OS Type: Other Linux (64-bit) Extractable: no Password Enabled: no Public: no Featured: no Routing: no
HyperV	Name: systemvm-hyperv-4.14.0 Description: systemvm-hyperv-4.14.0 URL: http://download.cloudstack.org/systemvm/4.14/systemvmtemplate-4.14.0-hyperv.vhd.zip Zone: Choose the zone where this hypervisor is used Hypervisor: Hyper-V Format: VHD OS Type: Debian GNU/Linux 7.0 (64-bit) (or the highest Debian release number available in the dropdown) Extractable: no Password Enabled: no Public: no Featured: no Routing: no

Watch the screen to be sure that the template downloads successfully and enters the READY state. Do not proceed until this is successful.

Java Version Requirement

CloudStack 4.14 requires installation of Java 11 JRE for management server and the KVM agent. On installing or upgrading cloudstack-management and/or cloudstack-agent packages, please configure Java 11 as the default java version using:

$ sudo alternatives --config java

Note: For Ubuntu distributions where the openjdk-11 packages are not available from the main repositories, the JRE can be installed from an external PPA such as openjdk-r. The PPA can be added before installation/upgrade:

$ sudo add-apt-repository ppa:openjdk-r/ppa
$ sudo apt-get update

Database Preparation

Backup current database

Stop your management server or servers. Run this on all management server hosts:
```
$ sudo service cloudstack-management stop
```
If you are running a usage server or usage servers, stop those as well:
```
$ sudo service cloudstack-usage stop
```
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.
```
$ mysqldump -u root -p cloud > cloud-backup_`date '+%Y-%m-%d'.sql
$ mysqldump -u root -p cloud_usage > cloud_usage-backup_`date '+%Y-%m-%d'.sql
```

Management Server on Ubuntu

If you are using Ubuntu, follow this procedure to upgrade your packages. If not, skip to step Management Server on CentOS/RHEL.

Time zone requirements

As of CloudStack 4.14, you must explicitly configure time zone either in the MySQL server or JDBC driver (db.properties). In previous CloudStack versions, UTC time zone was assumed by default (all event’s have UTC time stamps), so the same UTC time zone should now be explicitly configured.

You can do this by editing the /etc/cloudstack/management/db.properties file and adding “serverTimezone=UTC” to the “db.cloud.url.params=” and “db.usage.url.params=” lines. Example lines, from a clean 4.14 installation, are given below:

db.cloud.url.params=prepStmtCacheSize=517&cachePrepStmts=true&sessionVariables=sql_mode='STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION'&serverTimezone=UTC
db.usage.url.params=serverTimezone=UTC

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.)

CloudStack apt repository

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:

deb http://download.cloudstack.org/ubuntu precise 4.6

We’ll change it to point to the new package repository:

deb http://download.cloudstack.org/ubuntu precise 4.9

Setup the public key for the above repository:

wget -qO - http://download.cloudstack.org/release.asc | sudo apt-key add -

If you’re using your own package repository, change this line to read as appropriate for your 4.14 repository.

Now update your apt package list:
```
$ sudo apt-get update
```
Now that you have the repository configured, it’s time to upgrade the cloudstack-management package.
```
$ sudo apt-get upgrade cloudstack-management
```
If you use CloudStack usage server
```
$ sudo apt-get upgrade cloudstack-usage
```

Management Server on CentOS/RHEL

If you are using CentOS or RHEL, follow this procedure to upgrade your packages. If not, skip to hypervisors section Hypervisor: XenServer.

Time zone requirements

db.cloud.url.params=prepStmtCacheSize=517&cachePrepStmts=true&sessionVariables=sql_mode='STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION'&serverTimezone=UTC
db.usage.url.params=serverTimezone=UTC

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.

Install new MySQL connector

Starting with 4.9.0, cloudstack-management RPM’s now depend on the mysql-connector-python package. Therefore Apache CloudStack 4.14.0.0 requires the instalation of the MySQL connector on CentOS.

MySQL connector RPM repository

Add a new yum repo /etc/yum.repos.d/mysql.repo:

[mysql-community]
name=MySQL Community connectors
baseurl=http://repo.mysql.com/yum/mysql-connectors-community/el/$releasever/$basearch/
enabled=1
gpgcheck=1

Import GPG public key from MySQL:

rpm --import http://repo.mysql.com/RPM-GPG-KEY-mysql

Install mysql-connector

yum install mysql-connector-python

CloudStack RPM 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 Xen.)

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:

[apache-cloudstack]
name=Apache CloudStack
baseurl=http://download.cloudstack.org/rhel/4.6/
enabled=1
gpgcheck=0

If you are using the community provided package repository, change the base url to http://download.cloudstack.org/centos/$releasever/4.9/.

Setup the GPG public key if you wish to enable gpgcheck=1:

rpm --import http://download.cloudstack.org/RPM-GPG-KEY

If you’re using your own package repository, change this line to read as appropriate for your 4.14 repository.

Remove the deprecated dependency for awsapi.
```
$ sudo rpm -e --nodeps cloudstack-awsapi
```
Now that you have the repository configured, it’s time to upgrade the cloudstack-management.
```
$ sudo yum upgrade cloudstack-management
```
If you use CloudStack usage server
```
$ sudo yum upgrade cloudstack-usage
```

Hypervisor: XenServer

(XenServer only) Copy vhd-utils file on CloudStack management servers. Copy the file vhd-utils to /usr/share/cloudstack-common/scripts/vm/hypervisor/xenserver.

wget -P /usr/share/cloudstack-common/scripts/vm/hypervisor/xenserver http://download.cloudstack.org/tools/vhd-util

Hypervisor: VMware

Warning

For VMware hypervisor CloudStack management server packages must be build using “noredist”. Refer to Building Non-OSS

(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 Management Server:

$ sudo service cloudstack-management stop

Generate the encrypted equivalent of your vCenter password:

$ java -classpath /usr/share/cloudstack-common/lib/jasypt-1.9.2.jar org.jasypt.intf.cli.JasyptPBEStringEncryptionCLI encrypt.sh input="_your_vCenter_password_" password="cat /etc/cloudstack/management/key" verbose=false

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:

$ mysql -u <username> -p<password>

select * from cloud.cluster_details;

Update the plain text password with the encrypted one

update cloud.cluster_details set value = '_ciphertext_from_step_1_'
where id = _id_from_step_2_;

Confirm that the table is updated:
```
select * from cloud.cluster_details;
```
Find the ID of the correct row of vmware_data_center that you

want to update
```
select * from cloud.vmware_data_center;
```

update the plain text password with the encrypted one:

update cloud.vmware_data_center set password = '_ciphertext_from_step_1_'
where id = _id_from_step_5_;

Confirm that the table is updated:
```
select * from cloud.vmware_data_center;
```

Hypervisor: KVM

(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 APT repo as detailed above.
Stop the running agent.
```
$ sudo service cloudstack-agent stop
```
Update the agent software.
```
$ sudo apt-get upgrade cloudstack-agent
```
Verify that the file /etc/cloudstack/agent/environment.properties has a

line that reads:
```
paths.script=/usr/share/cloudstack-common
```
If not, add the line.
Start the agent.
```
$ sudo service cloudstack-agent start
```

For KVM hosts, upgrade the cloudstack-agent package

Configure the CloudStack RPM repository as detailed above.
```
$ sudo yum upgrade cloudstack-agent
```
Verify that the file /etc/cloudstack/agent/environment.properties has a line that reads:
```
paths.script=/usr/share/cloudstack-common
```
If not, add the line.

Restart the agent:

$ sudo service cloudstack-agent stop
$ sudo service cloudstack-agent start

Restart management services

Now it’s time to start the management server
```
$ sudo service cloudstack-management start
```
If you use it, start the usage server
```
$ sudo service cloudstack-usage start
```