upgrade.rst 4.1 KB
Newer Older
1 2
.. _upgrade:

3 4 5
*******
Upgrade
*******
6

7
Upgrading a *XiVO PBX* is done by executing commands through a terminal on the
8
server.
9

10
.. note:: Downgrade is not supported
11

12 13
Overview
========
14

15
The upgrade consists of the following steps:
16

17 18
* switch the version via ``xivo-dist`` utility
* upgrade via the ``xivo-upgrade`` utility: it will upgrade the system (Debian packages) and the *XiVO PBX* packages
19

20
.. warning:: The following applies to *XiVO PBX* **>= 2016.03**. For older version, see :ref:`version_specific_upgrade` section.
21

22

23 24
Preparing the upgrade
=====================
25

26 27 28 29 30 31 32 33 34 35 36
There are two cases:

#. :ref:`Upgrade to another LTS XiVO PBX version <upgrade_to_lts_version_xpbx>`,
#. :ref:`Upgrade to the latest Bugfix release <upgrade_latest_ltsbugfixrel_xpbx>` of your current installed LTS version.


.. _upgrade_to_lts_version_xpbx:

Upgrade to another LTS version
------------------------------

37
To prepare the upgrade you should:
38

39
#. Switch the sources to the new XiVO PBX **LTS** version with ``xivo-dist``, for example, to switch to Aldebaran LTS version::
40 41 42

    xivo-dist xivo-aldebaran

43 44
#. **Read carefully the** :ref:`xivosolutions_release` starting from your current version to the version you target (read **even more
   carefully** the New features and Behavior changes between LTS)
Etienne Allovon's avatar
Etienne Allovon committed
45
#. **Check** the specific instructions and manual steps *from your current LTS to your targetted LTS* and all intermediate LTS: see :ref:`upgrade_lts_manual_steps`
46
#. **Check also** if you are in a specific setup that requires a :ref:`specific procedure <upgrade_specific_proc>`
47
   to be followed (e.g. :ref:`upgrading-a-cluster`).
48
#. And then upgrade, see `Upgrading`_
49 50


51
.. _upgrade_latest_ltsbugfixrel_xpbx:
52

53 54
Upgrade to latest Bugfix release of an LTS version
--------------------------------------------------
55

56 57 58
After the release of an **LTS** *version* (e.g. *Polaris*) we may backport some bugfixes in this version.
We will then create a **subversion** (e.g. Polaris **.04**) shipping these bugfixes.
These bugfix version does not contain any behavior change.
59

60
To upgrade to the **latest subversion** of your current installed *version* you need to:
61

62 63 64 65 66 67 68 69 70 71 72 73 74 75
#. **Read carefully the** :ref:`xivosolutions_release` starting from your installed version (e.g. Polaris.00) to the latest bugfix release (e.g. Polaris.04).
#. Verify that the debian sources list corresponds to your *installed LTS* or refix it, for example for Polaris::

    xivo-dist xivo-polaris

#. And then upgrade, see `Upgrading`_


Upgrading
=========

.. note:: About `xivo-upgrade` script usage see :ref:`xivo-upgrade_script`

After having prepared your upgrade (see above), you can upgrade:
76

77
#. When ready, launch the upgrade process. **All XiVO PBX services will be stopped during the process**::
78

Etienne Allovon's avatar
Etienne Allovon committed
79
    xivo-upgrade
80

81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
#. Download the new config-mgt service::

    xivo-dcomp pull

#. Upgrade the config-mgt service::

    xivo-dcomp up -d


Post Upgrade
============

When finished:

* Check that all services are running::

   xivo-service status all

* Check that all the docker services are in the correct version. Compare the output of ``xivo-dcomp version`` with the table in :ref:`xivosolutions_release`
* Check that services are correctly working like SIP registration, ISDN link status,
  internal/incoming/outgoing calls, XiVO Client connections etc.


.. _upgrade_lts_manual_steps:

Manual steps for LTS upgrade
============================

.. toctree::
   :maxdepth: 1

   upgrade_from_five_to_polaris
   upgrade_from_polaris_to_aldebaran
114 115


116
.. _upgrade_specific_proc:
117

118 119
Specific procedures
===================
120

121 122
.. toctree::
   :maxdepth: 1
123

124 125
   cluster
   migrate_i386_to_amd64
126
   asterisk_latest
127
   xivocc_recording
128 129


130
.. _version_specific_upgrade:
131

132 133
Version-specific upgrade procedures
===================================
134

135
.. note:: If your *XiVO PBX* is **below 2016.03** you have first to :ref:`switch-to-xivo.solutions` mirrors.
136

137 138
.. toctree::
   :maxdepth: 2
139

140 141
   switch_xivosolutions
   other_version_specific
142 143


144
Upgrading to/from an archive version
145
------------------------------------
146

147 148
.. toctree::
   :maxdepth: 1
149

150
   archives
151 152


153 154 155
Upgrade Notes
=============

156
See :ref:`xivosolutions_release` for version specific informations.
Sebastien Duthil's avatar
Sebastien Duthil committed
157