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

.. CloudStack Release Notes documentation main file, created by
   sphinx-quickstart on Fri Feb  7 16:00:59 2014.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

|menu_acs_logo|


Upgrading CloudStack
====================


This document contains the instructions for upgrading CloudStack from prior releases, to the current 
release.  Please read through all sections carefully before starting.

From ACS 4.16 onwards, seeding of system-VM Template is optional, as this will be taken care of by either the upgrade process or
in case of a fresh deployment, registration of the systemVM Template(s) is handled during the addition of the first image store to a zone.
The `cloudstack-management` package will now include the systemVM Templates for KVM, XenServer and VMWare. In case Templates aren't already registered
either prior upgrade or during fresh installation, ACS will handle the Template registration automatically, by mounting the secondary store onto the
management server, copying the respective Templates to the store and then creating the `template.properties` file.

From ACS 4.20.3 and 4.22.1 onwards, a starting Management Server that detects an
upgrade is needed will abort if it also finds mshost entries for other Management Servers that are up.
If as an operator starting a Management Server you get the error
`Database upgrade is required but the management server is running in
a clustered environment.` during upgrade, check if you have stopped
all other Management Servers in your environment and retry. If it still fails, it might be
that a Management Server has stopped un-gracefully and you need to fix the DB-entry
for it. For example, make sure all Management Servers are stopped by checking the
hosts in the output of `select name from mshost where state <> ‘Down’`
and then, when all is safe, run `update mshost set state = ‘Down'`

.. note::
   For information on the API changes and issues fixed in this release, please see the Release Notes section of the documentation

Contents:

.. toctree::
   :maxdepth: 1

   upgrade/upgrade_java_17_notes
   upgrade/mysql
   upgrade/valid_source
   upgrade/upgrade-4.20
   upgrade/upgrade-4.19
   upgrade/upgrade-4.18
   upgrade/upgrade-4.17
   upgrade/upgrade-4.16
   upgrade/upgrade-4.15
   upgrade/upgrade-4.14
   upgrade/upgrade-4.13
   upgrade/upgrade-4.12
   upgrade/upgrade-4.11
   upgrade/upgrade-4.10
   upgrade/upgrade-4.9
   upgrade/upgrade-4.8
   upgrade/upgrade-4.7
   upgrade/upgrade-4.6
   upgrade/upgrade-4.5
   upgrade/upgrade-4.4
   upgrade/upgrade-4.3
..   upgrade/upgrade-4.2
..   upgrade/upgrade-4.1
..   upgrade/upgrade-4.0
..   upgrade/upgrade-3.0.x
..   upgrade/upgrade-2.2.14