4.15.1 upgrade notes

Signed-off-by: Rohit Yadav <rohit.yadav@shapeblue.com>

Author: rohityadavcloud

source/_global.rst

@@ -25,19 +25,19 @@
 
 .. Latest version systemvm template name
 
-.. |sysvm64-version|     replace:: 4.15.0
-.. |sysvm64-name-xen|    replace:: systemvm-xenserver-4.15.0
-.. |sysvm64-name-kvm|    replace:: systemvm-kvm-4.15.0
-.. |sysvm64-name-vmware| replace:: systemvm-vmware-4.15.0
-.. |sysvm64-name-hyperv| replace:: systemvm-hyperv-4.15.0
-.. |sysvm64-name-ovm|    replace:: systemvm-ovm-4.15.0
+.. |sysvm64-version|     replace:: 4.15.1
+.. |sysvm64-name-xen|    replace:: systemvm-xenserver-4.15.1
+.. |sysvm64-name-kvm|    replace:: systemvm-kvm-4.15.1
+.. |sysvm64-name-vmware| replace:: systemvm-vmware-4.15.1
+.. |sysvm64-name-hyperv| replace:: systemvm-hyperv-4.15.1
+.. |sysvm64-name-ovm|    replace:: systemvm-ovm-4.15.1
 
 .. Latest version systemvm template URL
-.. |sysvm64-url-xen|    replace:: http://download.cloudstack.org/systemvm/4.15/systemvmtemplate-4.15.0-xen.vhd.bz2
-.. |sysvm64-url-kvm|    replace:: http://download.cloudstack.org/systemvm/4.15/systemvmtemplate-4.15.0-kvm.qcow2.bz2
-.. |sysvm64-url-vmware| replace:: http://download.cloudstack.org/systemvm/4.15/systemvmtemplate-4.15.0-vmware.ova
-.. |sysvm64-url-hyperv| replace:: http://download.cloudstack.org/systemvm/4.15/systemvmtemplate-4.15.0-hyperv.vhd.zip
-.. |sysvm64-url-ovm|    replace:: http://download.cloudstack.org/systemvm/4.15/systemvmtemplate-4.15.0-ovm.raw.bz2
+.. |sysvm64-url-xen|    replace:: http://download.cloudstack.org/systemvm/4.15/systemvmtemplate-4.15.1-xen.vhd.bz2
+.. |sysvm64-url-kvm|    replace:: http://download.cloudstack.org/systemvm/4.15/systemvmtemplate-4.15.1-kvm.qcow2.bz2
+.. |sysvm64-url-vmware| replace:: http://download.cloudstack.org/systemvm/4.15/systemvmtemplate-4.15.1-vmware.ova
+.. |sysvm64-url-hyperv| replace:: http://download.cloudstack.org/systemvm/4.15/systemvmtemplate-4.15.1-hyperv.vhd.zip
+.. |sysvm64-url-ovm|    replace:: http://download.cloudstack.org/systemvm/4.15/systemvmtemplate-4.15.1-ovm.raw.bz2
 
 .. Version specific: 4.5 systemvm template URL
 .. |acs45-sysvm64-url-xen|    replace:: http://download.cloudstack.org/systemvm/4.5/systemvm64template-4.5-xen.vhd.bz2

source/conf.py

@@ -26,7 +26,7 @@
 # The short X.Y version
 version = '4.15'
 # The full version, including alpha/beta/rc tags
-release = '4.15.0.0'
+release = '4.15.1.0'
 
 rst_epilog = """
 .. include:: /_global.rst 

source/upgrading/index.rst

@@ -37,6 +37,7 @@ Contents:
 .. toctree::
    :maxdepth: 1
 
+   upgrade/upgrade-4.15
    upgrade/upgrade-4.14
    upgrade/upgrade-4.13
    upgrade/upgrade-4.12

source/upgrading/upgrade/upgrade-4.15.rst

@@ -0,0 +1,314 @@
+.. 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.15.x
+
+Upgrade Instruction from |version_to_upgrade|
+=============================================
+
+
+This section will show you how to upgrade from CloudStack |version_to_upgrade| to latest
+CloudStack |release|.
+
+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.
+
+Overview of Upgrade Steps:
+----------------------------
+
+#. Check any customisations and integrations
+#. Upload the |sysvm64-version| System VM template if not already using it.
+#. Confirm Java 11 is the default Java version
+#. Stop all running management servers
+#. Backup CloudStack database (MySQL)
+#. Add "serverTimezone=UTC" to your "db.properties"
+#. Upgrade 1st CloudStack management server
+#. Update hypervisors specific dependencies
+#. Restart 1st management server
+#. Check that your upgraded environment works as expected
+#. Upgrade and restart the remaining management servers
+
+
+.. include:: _customisation_warnings.rst
+
+.. warning::
+    If you are not already using the |sysvm64-version| System VM template you will need to
+    upgrade your System VM template prior to performing the upgrade of the
+    CloudStack packages.
+
+.. include:: _sysvm_templates.rst
+
+.. include:: _java_version.rst
+
+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 |release| 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:`ubuntu414` or :ref:`kvm414` hosts upgrade.
+
+Instructions for creating packages from the CloudStack source are in the
+`CloudStack Installation Guide`_.
+
+Database Preparation
+--------------------
+
+Backup current database
+
+#. Stop your management server or servers. Run this on all management
+   server hosts:
+
+   .. parsed-literal::
+
+      $ sudo service cloudstack-management stop
+
+#. If you are running a usage server or usage servers, stop those as well:
+
+   .. parsed-literal::
+
+      $ 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.
+
+   .. parsed-literal::
+
+      $ mysqldump -u root -p -R cloud > cloud-backup_`date '+%Y-%m-%d'`.sql
+      $ mysqldump -u root -p cloud_usage > cloud_usage-backup_`date '+%Y-%m-%d'`.sql
+
+
+.. _ubuntu414:
+.. _apt-repo414:
+
+Management Server
+-----------------
+
+.. include:: _timezone.rst
+
+Ubuntu
+######
+
+If you are using Ubuntu, follow this procedure to upgrade your packages. If
+not, skip to step :ref:`rhel414`.
+
+.. 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.)
+
+Edit your ``/etc/apt/sources.list.d/cloudstack.list`` file on
+any systems that have CloudStack packages installed to points to version |version|
+
+This file should have one line, which contains:
+
+.. parsed-literal::
+
+   deb http://download.cloudstack.org/ubuntu bionic |version|
+
+Setup the public key for the above repository:
+
+.. parsed-literal::
+
+   wget -qO - http://download.cloudstack.org/release.asc | sudo apt-key add -
+
+#. Now update your apt package list:
+
+   .. parsed-literal::
+
+      $ sudo apt-get update
+
+#. Now that you have the repository configured, it's time to upgrade
+   the ``cloudstack-management`` package.
+
+   .. parsed-literal::
+
+      $ sudo apt-get upgrade cloudstack-management
+
+#. If you use CloudStack usage server
+
+   .. parsed-literal::
+
+      $ sudo apt-get upgrade cloudstack-usage
+
+
+.. _rhel414:
+.. _rpm-repo414:
+
+CentOS/RHEL
+##############
+
+If you are using CentOS or RHEL, follow this procedure to upgrade your
+packages. If not, skip to hypervisors section :ref:`upg_hyp_414`.
+
+.. 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
+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.)
+
+Change your ``/etc/yum.repos.d/cloudstack.repo`` file on
+any systems that have CloudStack packages installed to points to version |version|.
+
+This file should have content similar to the following:
+
+.. parsed-literal::
+
+   [apache-cloudstack]
+   name=Apache CloudStack
+   baseurl=http://download.cloudstack.org/centos/$releasever/|version|/
+   enabled=1
+   gpgcheck=0
+
+Setup the GPG public key if you wish to enable ``gpgcheck=1``:
+
+.. parsed-literal::
+
+   rpm --import http://download.cloudstack.org/RPM-GPG-KEY
+
+#. Now that you have the repository configured, it's time to upgrade the
+   ``cloudstack-management``.
+
+   .. parsed-literal::
+
+      $ sudo yum upgrade cloudstack-management
+
+#. If you use CloudStack usage server
+
+   .. parsed-literal::
+
+      $ sudo yum upgrade cloudstack-usage
+
+.. _upg_hyp_414:
+
+Upgrade Hypervisors
+-------------------
+
+Hypervisor: XenServer
+#####################
+
+
+No additional steps are required for XenServer Hypervisor for this upgrade.
+
+
+Hypervisor: VMware
+###################
+
+.. warning::
+   For VMware hypervisor, CloudStack management server packages must be
+   built using "noredist". Refer to :ref:`building-noredist`.
+
+
+No additional steps are requried for the VMware Hypervisor for this upgrade.
+
+
+.. _kvm414:
+
+Hypervisor: KVM
+#################
+
+KVM on Ubuntu
+""""""""""""""
+
+(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 :ref:`APT repo <apt-repo414>` as detailed above.
+
+#. Stop the running agent.
+
+   .. parsed-literal::
+
+      $ sudo service cloudstack-agent stop
+
+#. Update the agent software.
+
+   .. parsed-literal::
+
+      $ sudo apt-get upgrade cloudstack-agent
+
+#. Start the agent.
+
+   .. parsed-literal::
+
+      $ sudo service cloudstack-agent start
+
+
+KVM on CentOS/RHEL
+"""""""""""""""""""
+
+For KVM hosts, upgrade the ``cloudstack-agent`` package
+
+#. Configure the :ref:`rpm-repo414` as detailed above.
+
+   .. parsed-literal::
+
+      $ sudo yum install -y epel-release
+      $ sudo yum install -y python36-libvirt
+      $ sudo yum upgrade cloudstack-agent
+
+#. Restart the agent:
+
+   .. parsed-literal::
+
+      $ sudo service cloudstack-agent stop
+      $ sudo service cloudstack-agent start
+
+
+Restart management services
+---------------------------
+
+#. Now it's time to start the management server
+
+   .. parsed-literal::
+
+      $ sudo service cloudstack-management start
+
+#. If you use it, start the usage server
+
+   .. parsed-literal::
+
+      $ sudo service cloudstack-usage start
+
+System-VMs and Virtual-Routers
+------------------------------
+
+.. include:: _sysvm_restart.rst