upgrade.rst 4.27 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 25

Preparing the upgrade
=====================

26
There are two cases:
27

28 29 30
#. :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.

31

32
.. _upgrade_to_lts_version_xpbx:
33

34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
Upgrade to another LTS version
------------------------------

To prepare the upgrade you should:

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

    xivo-dist xivo-aldebaran

#. **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)
#. **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`
#. **Check also** if you are in a specific setup that requires a :ref:`specific procedure <upgrade_specific_proc>`
   to be followed (e.g. :ref:`upgrading-a-cluster`).
#. 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
#. **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::
64

65
    xivo-dist xivo-polaris
66

67
#. And then upgrade, see `Upgrading`_
68 69


70 71
Upgrading
=========
72

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

75
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

79
    xivo-upgrade
80

81
#. Verify that the docker services were downloaded::
82

83
    xivo-dcomp pull
84

85
#. Upgrade the docker services::
86

87
    xivo-dcomp up -d --remove-orphans
88 89


90 91
Post Upgrade
============
92

93
When finished:
94

95
* Check that all services are running::
96

97
   xivo-service status all
98

99 100 101
* 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.
102

103

104 105 106 107 108 109 110
.. _upgrade_lts_manual_steps:

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

.. toctree::
   :maxdepth: 1
111

112 113
   upgrade_from_five_to_polaris
   upgrade_from_polaris_to_aldebaran
114
   upgrade_from_aldebaran_to_borealis
Tomas Taraba's avatar
Tomas Taraba committed
115
   upgrade_from_borealis_to_callisto
116 117


118
.. _upgrade_specific_proc:
119

120 121
Specific procedures
===================
122

123 124
.. toctree::
   :maxdepth: 1
125

126 127
   cluster
   migrate_i386_to_amd64
128
   asterisk_latest
129
   xivocc_recording
130
   debian_9_stretch_upgrade_notes
131
   callisto_outcall_to_route_migration_guide
132 133


134
.. _version_specific_upgrade:
135

136 137
Version-specific upgrade procedures
===================================
138

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

141 142
.. toctree::
   :maxdepth: 2
143

144 145
   switch_xivosolutions
   other_version_specific
146 147


148
Upgrading to/from an archive version
149
------------------------------------
150

151 152
.. toctree::
   :maxdepth: 1
153

154
   archives
155 156


157 158 159
Upgrade Notes
=============

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