Apache CloudStack Release Notes¶

What's New in 4.11.1.0¶

The new 4.11.1.0 version is a 4.12 maintainance release containing over 140 fixes and improvements on the 4.11.0.0 release.

These include the speeding up of virtual router deployments and fixes for corner cases effecting the new config drive and L2 features and some hypervisor specific fixes to improve compatibility with current hypervisor versions including the XCP-ng fork of XenServer.

What's New in 4.11.0.0¶

Version 4.11.0.0 included more than 400 commits, 220 pull requests that fixes more than 250 issues since the last release. Version 4.11.0.0 was a large release that was worked on for 8 months.

A LOT changed in this release, so this is not a complete list, but here is a quick summary of some of the changes:

• Support for XenServer 7.1, 7.2, 7.3 and 7.4, and support for XCP-ng 7.4.
• Improved support for VMware 6.5.
• Host-HA framework and HA-provider for KVM hosts with and NFS as primary storage, and a new background polling task manager.
• Secure agents communication: new certificate authority framework and a default built-in root CA provider.
• New network type - L2.
• CloudStack metrics exporter for Prometheus.
• Cloudian Hyperstore connector for CloudStack.
• Annotation feature for CloudStack entities such as hosts.
• Separation of volume snapshot creation on primary storage and backing operation on secondary storage.
• Limit admin access from specified CIDRs.
• Expansion of Management IP Range.
• Dedication of public IPs to SSVM and CPVM.
• Support for separate subnet for SSVM and CPVM.
• Bypass secondary storage template copy/transfer for KVM.
• Support for multi-disk OVA template for VMware.
• Storage overprovisioning for local storage.
• LDAP mapping with domain scope, and mapping of LDAP group to an account.
• Move user across accounts.
• Managed storage enhancements.
• Extend config drive support for user data, metadata, and password (Nuage Networks).
• Extra DHCP options support (Nuage Networks).
• Nuage VSP 5.0 support and caching of NuageVsp ID's.
• Nuage domain template selection per VPC and support for network migration.
• Support for watchdog timer to KVM Instances.
• Support for Secondary IPv6 Addresses and Subnets.
• IPv6 Prefix Delegation support in basic networking.
• Ability to specific MAC address while deploying VM or adding a NIC to a VM.
• VMware dvSwitch security policies configuration in network offering
• Allow more than 7 NICs to be added to a VMware VM.
• Network rate usage for guest offering for VRs.
• Usage metrics for VM snapshot on primary storage.
• Enable Netscaler inline mode.
• NCC integration in CloudStack.
• The retirement of the Midonet network plugin.
• Several UI Improvements.
• Embedded Jetty and improved CloudStack management server configuration.
• Improved support for Java 8 for building artifacts/modules, packaging, and in the systemvm template.
• A faster console proxy startup and service availability.
• A new Debian 9 based smaller systemvm template that patches systemvm without requiring reboot.
• Several optimizations and improvements to the virtual router including better support for redundant virtual routers and strongswan provided s2s and remote access vpn.

Issues Fixed in 4.11.1.0¶

Issues Fixed in 4.11.0.0¶

Supported OS Versions for Management Server¶

This section lists the operating systems that are supported for running CloudStack Management Server. Note that specific versions of the operating systems are tested, so compatibility with CentOS 6.3 may not indicate compatibility with CentOS 6.2, 6.1 and so on.

• RHEL versions 6.3, 6.5, 6.6 and 7.0
• CentOS versions 6.8, 7
• Ubuntu 14.04, 16.04, 17.04 LTS

Supported Hypervisor Versions¶

CloudStack supports three hypervisor families, XenServer with XAPI, KVM, and VMware with vSphere.

• CentOS 6.2+, 7.0+ with KVM

• Ubuntu 14.04LTS, 16.04LTS, 18.04LTS with KVM

• Red Hat Enterprise Linux 6.2 with KVM

• XenServer versions 6.1, 6.2 SP1, 6.5, 7.0, 7.1, 7.2 with latest hotfixes, XCP-ng 7.4

  注釈

  It is now required to enable HA on the XenServer pool in order to recover from a pool-master failure. Please refer to the XenServer documentation.

• VMware versions 5.0 Update 3, 5.1 Update 3, 5.5 Update 3b, 6.0 Update 2, and 6.5 GA

• LXC Host Containers on RHEL 7

• Windows Server 2012 R2 (with Hyper-V Role enabled)

• Hyper-V 2012 R2

• Oracle VM 3.0+

• Bare metal hosts are supported, which have no hypervisor. These hosts can run the following operating systems:

  • RHEL or CentOS, v6.2 or 6.3

    注釈

    Use libvirt version 0.9.10 for CentOS 6.3

  • Fedora 17

  • Ubuntu 12.04

For more information, see the Hypervisor Compatibility Matrix in the `CloudStack Installation Guide`_.

Supported External Devices¶

• Netscaler VPX and MPX versions 9.3, 10.1e and 10.5
• Netscaler SDX version 9.3, 10.1e and 10.5
• SRX (Model srx100b) versions 10.3 to 10.4 R7.5
• F5 11.X
• Force 10 Switch version S4810 for Baremetal Advanced Networks

Supported Browsers¶

The CloudStack Web-based UI should be compatible with any modern browser, but it's possible that some browsers will not render portions of the UI reliably, depending on their support of Web standards. For best results, one of the following browsers recommended:

• Firefox version 31 or later
• Google Chrome version 36.0+
• Safari 6+

Notice Of Management OSes and Hypervisors to be Deprecated¶

The following hypervisors will no longer be tested from the first release AFTER 1st June 2018. And will be removed from the CloudStack codebase from the first release after 1st November 2018.

• XenServer 6.2
• XenServer 6.5
• vSphere 5.0
• vSphere 5.1

The following hypervisors will no longer be tested from the first release AFTER 1st February 2019. And will be removed from the CloudStack codebase from the first release after 1st July 2019.

• vSphere 5.5

Please see CloudStack Wiki for details.

New API Commands¶

Parameters Changed API Commands¶

Java version upgraded to Java 1.8¶

As of Apache CloudStack 4.10, Java version required is 1.8 for the management-server, cloudstack-usage, KVM agent and system-VMs.

Java 8 JRE on Ubuntu¶

CloudStack 4.12.0.0 requires installation of Java 8 JRE from an external PPA such as openjdk-r for Ubuntu distributions where the openjdk-8 packages are not available from the main repositories such as on Ubuntu 14.04. The PPA can be added before installation/upgrade:

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

Users can also choose to install Java 8 distribution from Oracle, or Xulu-8 OpenJDK distribution from Azul.

Migrating to dynamic roles feature¶

As of Apache CloudStack 4.9, dynamic roles feature can be enabled after an upgrade. Dyanamic roles feature is enabled by default on new installations.

Please read more about using dynamic roles feature and process of migrating to using this after an upgrade.

Agent and KVM Host Security¶

Starting 4.11, a new CA framework has been introduced that is used to secure agent and management server connections. Starting 4.11.1, KVM hosts in UP state that are not secured (i.e. the KVM host agent and libvirtd don't have CA framework provisioned X509 certificates) will show up as 'Unsecure'. A new button in the UI is available as well as an API to secure and onboard such hosts.

Please read more about host security and process of migrating existing KVM hosts and agents to use the new security feature.

OVS plug-in¶

OVS plug-in functionality is disrupted if ovsdaemon crashes

A critical functionality issue came out with CLOUDSTACK-6779. On XenServer it is observed that on VIF unplug Ovs-Vswitchd is crashing resulting in loosing all the openflow rules added to the bridge. Ovs daemon gets started and creates a bridge but configure openflow rules are lost resulting in the disruption of connectivity for the VM's on the host.

Active-Directory Authentication (LDAP)¶

If using Active-Directory (LDAP/LDAPs) as user authentication; Upgrading to 4.3 and later require changes in Global Settings. After upgrading CloudStack to 4.3 or latest, following Global Settings must be change:

SystemVM 32bit deprecated¶

32bit versions of systemvm templates are in the process of behing deprecated. Upgrade instructions from this Release Notes use 64bit templates.

Explicit JDBC driver declaration¶

While upgrading, on some environments the following may be required to be added in CloudStack's db.properties file:

# Add these to your db.properties file

db.cloud.driver=jdbc:mysql

db.usage.driver=jdbc:mysql

Other Notes¶

If you are experiencing CloudStack UI issues, please consider upgrading your tomcat instance to version 6.0.43 (tested version, but earlier versions prior to 6.0.37 might work as well), to address the tomcat response issues caused by latency between the browser/client and CloudStack Management server.

Update System-VM templates¶

1. While running the existing 4.11.0.0 system, log in to the UI as root administrator.

2. In the left navigation bar, click Templates.

3. In Select view, click Templates.

4. Click Register template.

   The Register template dialog box is displayed.

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

   Hypervisor	Description
   XenServer	Name: systemvm-xenserver-4.11.1 Description: systemvm-xenserver-4.11.1 URL: http://download.cloudstack.org/systemvm/4.11/systemvmtemplate-4.11.1-xen.vhd.bz2 Zone: Choose the zone where this hypervisor is used Hypervisor: XenServer 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
   KVM	Name: systemvm-kvm-4.11.1 Description: systemvm-kvm-4.11.1 URL: http://download.cloudstack.org/systemvm/4.11/systemvmtemplate-4.11.1-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.11.1 Description: systemvm-vmware-4.11.1 URL: http://download.cloudstack.org/systemvm/4.11/systemvmtemplate-4.11.1-vmware.ova Zone: Choose the zone where this hypervisor is used Hypervisor: VMware Format: OVA OS Type: Other Linux 64-bit (or Debian 8.0 or 9.0 64-bit) Extractable: no Password Enabled: no Public: no Featured: no Routing: no
   HyperV	Name: systemvm-hyperv-4.11.1 Description: systemvm-hyperv-4.11.1 URL: http://download.cloudstack.org/systemvm/4.11/systemvmtemplate-4.11.1-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

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

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

Database Preparation¶

Backup current database

1. Stop your management server or servers. Run this on all management server hosts:

   $ sudo service cloudstack-management stop
   

2. If you are running a usage server or usage servers, stop those as well:

   $ sudo service cloudstack-usage stop
   

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

4. (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:

   $ 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:

   $ mysql -u cloud -p -e 'update cloud.storage_pool set path="/var/lib/libvirt/images" where path="/var/lib/libvirt/images/"';
   

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.

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

Java 8 JRE on Ubuntu¶

CloudStack 4.12.0.0 requires installation of Java 8 JRE from an external PPA such as openjdk-r for Ubuntu distributions where the openjdk-8 packages are not available from the main repositories such as on Ubuntu 14.04. The PPA can be added before installation/upgrade:

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

Users can also choose to install Java 8 distribution from Oracle, or Xulu-8 OpenJDK distribution from Azul.

deb http://cloudstack.apt-get.eu/ubuntu precise 4.10

deb http://cloudstack.apt-get.eu/ubuntu precise 4.11

wget -qO - http://cloudstack.apt-get.eu/release.asc | sudo apt-key add -

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, then upg-sysvm48.

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

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

yum install mysql-connector-python

[apache-cloudstack]
name=Apache CloudStack
baseurl=http://cloudstack.apt-get.eu/centos/6/4.10/
enabled=1
gpgcheck=0

rpm --import http://cloudstack.apt-get.eu/RPM-GPG-KEY

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.cloud.com.s3.amazonaws.com/tools/vhd-util

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:

1. Stop the Management Server:

   $ sudo service cloudstack-management stop
   

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

1. 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;
   

2. 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_;
   

3. Confirm that the table is updated:

   select * from cloud.cluster_details;
   

4. Find the ID of the correct row of vmware_data_center that you

   want to update

   select * from cloud.vmware_data_center;
   

5. 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_;
   

6. Confirm that the table is updated:

   select * from cloud.vmware_data_center;
   

Hypervisor: KVM¶

Restart management services¶

1. Now it's time to start the management server

   $ sudo service cloudstack-management start
   

2. If you use it, start the usage server

   $ sudo service cloudstack-usage start
   

Update System-VM templates¶

1. While running the existing 4.10.x system, log in to the UI as root administrator.

2. In the left navigation bar, click Templates.

3. In Select view, click Templates.

4. Click Register template.

   The Register template dialog box is displayed.

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

   Hypervisor	Description
   XenServer	Name: systemvm-xenserver-4.11.1 Description: systemvm-xenserver-4.11.1 URL: http://download.cloudstack.org/systemvm/4.11/systemvmtemplate-4.11.1-xen.vhd.bz2 Zone: Choose the zone where this hypervisor is used Hypervisor: XenServer 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
   KVM	Name: systemvm-kvm-4.11.1 Description: systemvm-kvm-4.11.1 URL: http://download.cloudstack.org/systemvm/4.11/systemvmtemplate-4.11.1-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.11.1 Description: systemvm-vmware-4.11.1 URL: http://download.cloudstack.org/systemvm/4.11/systemvmtemplate-4.11.1-vmware.ova Zone: Choose the zone where this hypervisor is used Hypervisor: VMware Format: OVA OS Type: Other Linux 64-bit (or Debian 8.0 or 9.0 64-bit) Extractable: no Password Enabled: no Public: no Featured: no Routing: no
   HyperV	Name: systemvm-hyperv-4.11.1 Description: systemvm-hyperv-4.11.1 URL: http://download.cloudstack.org/systemvm/4.11/systemvmtemplate-4.11.1-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

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

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

Database Preparation¶

Backup current database

1. Stop your management server or servers. Run this on all management server hosts:

   $ sudo service cloudstack-management stop
   

2. If you are running a usage server or usage servers, stop those as well:

   $ sudo service cloudstack-usage stop
   

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

4. (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:

   $ 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:

   $ mysql -u cloud -p -e 'update cloud.storage_pool set path="/var/lib/libvirt/images" where path="/var/lib/libvirt/images/"';
   

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.

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

Java 8 JRE on Ubuntu¶

CloudStack 4.12.0.0 requires installation of Java 8 JRE from an external PPA such as openjdk-r for Ubuntu distributions where the openjdk-8 packages are not available from the main repositories such as on Ubuntu 14.04. The PPA can be added before installation/upgrade:

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

Users can also choose to install Java 8 distribution from Oracle, or Xulu-8 OpenJDK distribution from Azul.

deb http://cloudstack.apt-get.eu/ubuntu precise 4.10

deb http://cloudstack.apt-get.eu/ubuntu precise 4.11

wget -qO - http://cloudstack.apt-get.eu/release.asc | sudo apt-key add -

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, then upg-sysvm48.

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

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

yum install mysql-connector-python

[apache-cloudstack]
name=Apache CloudStack
baseurl=http://cloudstack.apt-get.eu/centos/6/4.10/
enabled=1
gpgcheck=0

rpm --import http://cloudstack.apt-get.eu/RPM-GPG-KEY

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.cloud.com.s3.amazonaws.com/tools/vhd-util

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:

1. Stop the Management Server:

   $ sudo service cloudstack-management stop
   

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

1. 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;
   

2. 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_;
   

3. Confirm that the table is updated:

   select * from cloud.cluster_details;
   

4. Find the ID of the correct row of vmware_data_center that you

   want to update

   select * from cloud.vmware_data_center;
   

5. 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_;
   

6. Confirm that the table is updated:

   select * from cloud.vmware_data_center;
   

Hypervisor: KVM¶

Restart management services¶

1. Now it's time to start the management server

   $ sudo service cloudstack-management start
   

2. If you use it, start the usage server

   $ sudo service cloudstack-usage start
   

Update System-VM templates¶

1. While running the existing 4.9.x system, log in to the UI as root administrator.

2. In the left navigation bar, click Templates.

3. In Select view, click Templates.

4. Click Register template.

   The Register template dialog box is displayed.

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

   Hypervisor	Description
   XenServer	Name: systemvm-xenserver-4.11.1 Description: systemvm-xenserver-4.11.1 URL: http://download.cloudstack.org/systemvm/4.11/systemvmtemplate-4.11.1-xen.vhd.bz2 Zone: Choose the zone where this hypervisor is used Hypervisor: XenServer 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
   KVM	Name: systemvm-kvm-4.11.1 Description: systemvm-kvm-4.11.1 URL: http://download.cloudstack.org/systemvm/4.11/systemvmtemplate-4.11.1-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.11.1 Description: systemvm-vmware-4.11.1 URL: http://download.cloudstack.org/systemvm/4.11/systemvmtemplate-4.11.1-vmware.ova Zone: Choose the zone where this hypervisor is used Hypervisor: VMware Format: OVA OS Type: Other Linux 64-bit (or Debian 8.0 or 9.0 64-bit) Extractable: no Password Enabled: no Public: no Featured: no Routing: no
   HyperV	Name: systemvm-hyperv-4.11.1 Description: systemvm-hyperv-4.11.1 URL: http://download.cloudstack.org/systemvm/4.11/systemvmtemplate-4.11.1-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

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

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

Database Preparation¶

Backup current database

1. Stop your management server or servers. Run this on all management server hosts:

   $ sudo service cloudstack-management stop
   

2. If you are running a usage server or usage servers, stop those as well:

   $ sudo service cloudstack-usage stop
   

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

4. (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:

   $ 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:

   $ mysql -u cloud -p -e 'update cloud.storage_pool set path="/var/lib/libvirt/images" where path="/var/lib/libvirt/images/"';
   

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.

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

Java 8 JRE on Ubuntu¶

CloudStack 4.12.0.0 requires installation of Java 8 JRE from an external PPA such as openjdk-r for Ubuntu distributions where the openjdk-8 packages are not available from the main repositories such as on Ubuntu 14.04. The PPA can be added before installation/upgrade:

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

Users can also choose to install Java 8 distribution from Oracle, or Xulu-8 OpenJDK distribution from Azul.

deb http://cloudstack.apt-get.eu/ubuntu precise 4.8

deb http://cloudstack.apt-get.eu/ubuntu precise 4.9

wget -qO - http://cloudstack.apt-get.eu/release.asc | sudo apt-key add -

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, then upg-sysvm48.

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

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

yum install mysql-connector-python

[apache-cloudstack]
name=Apache CloudStack
baseurl=http://cloudstack.apt-get.eu/centos/6/4.8/
enabled=1
gpgcheck=0

rpm --import http://cloudstack.apt-get.eu/RPM-GPG-KEY

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.cloud.com.s3.amazonaws.com/tools/vhd-util

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:

1. Stop the Management Server:

   $ sudo service cloudstack-management stop
   

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

1. 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;
   

2. 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_;
   

3. Confirm that the table is updated:

   select * from cloud.cluster_details;
   

4. Find the ID of the correct row of vmware_data_center that you

   want to update

   select * from cloud.vmware_data_center;
   

5. 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_;
   

6. Confirm that the table is updated:

   select * from cloud.vmware_data_center;
   

Hypervisor: KVM¶

Restart management services¶

1. Now it's time to start the management server

   $ sudo service cloudstack-management start
   

2. If you use it, start the usage server

   $ sudo service cloudstack-usage start
   

Update System-VM templates¶

1. While running the existing 4.8.x system, log in to the UI as root administrator.

2. In the left navigation bar, click Templates.

3. In Select view, click Templates.

4. Click Register template.

   The Register template dialog box is displayed.

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

   Hypervisor	Description
   XenServer	Name: systemvm-xenserver-4.11.1 Description: systemvm-xenserver-4.11.1 URL: http://download.cloudstack.org/systemvm/4.11/systemvmtemplate-4.11.1-xen.vhd.bz2 Zone: Choose the zone where this hypervisor is used Hypervisor: XenServer 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
   KVM	Name: systemvm-kvm-4.11.1 Description: systemvm-kvm-4.11.1 URL: http://download.cloudstack.org/systemvm/4.11/systemvmtemplate-4.11.1-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.11.1 Description: systemvm-vmware-4.11.1 URL: http://download.cloudstack.org/systemvm/4.11/systemvmtemplate-4.11.1-vmware.ova Zone: Choose the zone where this hypervisor is used Hypervisor: VMware Format: OVA OS Type: Other Linux 64-bit (or Debian 8.0 or 9.0 64-bit) Extractable: no Password Enabled: no Public: no Featured: no Routing: no
   HyperV	Name: systemvm-hyperv-4.11.1 Description: systemvm-hyperv-4.11.1 URL: http://download.cloudstack.org/systemvm/4.11/systemvmtemplate-4.11.1-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

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

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

Database Preparation¶

Backup current database

1. Stop your management server or servers. Run this on all management server hosts:

   $ sudo service cloudstack-management stop
   

2. If you are running a usage server or usage servers, stop those as well:

   $ sudo service cloudstack-usage stop
   

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

4. (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:

   $ 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:

   $ mysql -u cloud -p -e 'update cloud.storage_pool set path="/var/lib/libvirt/images" where path="/var/lib/libvirt/images/"';
   

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.

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

Java 8 JRE on Ubuntu¶

CloudStack 4.12.0.0 requires installation of Java 8 JRE from an external PPA such as openjdk-r for Ubuntu distributions where the openjdk-8 packages are not available from the main repositories such as on Ubuntu 14.04. The PPA can be added before installation/upgrade:

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

Users can also choose to install Java 8 distribution from Oracle, or Xulu-8 OpenJDK distribution from Azul.

deb http://cloudstack.apt-get.eu/ubuntu precise 4.8

deb http://cloudstack.apt-get.eu/ubuntu precise 4.9

wget -qO - http://cloudstack.apt-get.eu/release.asc | sudo apt-key add -

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, then upg-sysvm48.

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

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

yum install mysql-connector-python

[apache-cloudstack]
name=Apache CloudStack
baseurl=http://cloudstack.apt-get.eu/centos/6/4.8/
enabled=1
gpgcheck=0

rpm --import http://cloudstack.apt-get.eu/RPM-GPG-KEY

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.cloud.com.s3.amazonaws.com/tools/vhd-util

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:

1. Stop the Management Server:

   $ sudo service cloudstack-management stop
   

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

1. 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;
   

2. 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_;
   

3. Confirm that the table is updated:

   select * from cloud.cluster_details;
   

4. Find the ID of the correct row of vmware_data_center that you

   want to update

   select * from cloud.vmware_data_center;
   

5. 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_;
   

6. Confirm that the table is updated:

   select * from cloud.vmware_data_center;
   

Hypervisor: KVM¶