upgrade.rst 3.76 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
*******
Upgrade
*******

Overview
========

The following components will be upgraded :

- Docker images
- xivocc-installer package

13 14
.. warning:: This upgrade procedure applies only to XiVO CC installed via the ``xivocc-installer`` package.

15

Etienne Allovon's avatar
Etienne Allovon committed
16
Before upgrading you have to check or change your sources list.
17
It should be located in the file :file:`/etc/apt/sources.list.d/xivo-dist.list`.
18

19
There are three cases:
Etienne Allovon's avatar
Etienne Allovon committed
20

21 22
#. :ref:`Upgrade to an LTS XiVO CC version <upgrade_latest_version_xcc>`,
#. :ref:`Upgrade to an Intermediate version <upgrade_specific_version_xcc>`,
23 24
#. :ref:`Upgrade to the latest subversion <upgrade_latest_subversion_xcc>` of your current installed version.

25 26
.. warning:: Note that it is not possible to downgrade to any version.

27 28

.. _upgrade_latest_version_xcc:
Etienne Allovon's avatar
Etienne Allovon committed
29

30
Upgrade to an **LTS** version
31
-----------------------------
Etienne Allovon's avatar
Etienne Allovon committed
32

33
Currently XiVO CC *latest* **LTS** version is Polaris and is the numeric release 2017.11. To upgrade to the latest version the sources list must point towards *debian* URI and *xivo-polaris* suite::
Etienne Allovon's avatar
Etienne Allovon committed
34

35
    deb http://mirror.xivo.solutions/debian/ xivo-polaris main
36

37
or point towards *archive* URI and *xivo-2017.11-latest* suite::
38

39
    deb http://mirror.xivo.solutions/archive/ xivo-2017.11-latest main
40

Etienne Allovon's avatar
Etienne Allovon committed
41

42 43
.. _upgrade_specific_version_xcc:

44 45
Upgrade to an **Intermediate** version
--------------------------------------
Etienne Allovon's avatar
Etienne Allovon committed
46

47 48
.. note:: **Intermediate** versions have a limited support. You should install LTS version only.

49
Between two LTS versions we release **Intermediate** versions (to which is given a limited support). To upgrade to a *specific* **Intermediate** version the sources list must point towards *archive* URI and *xivo-VERSION-latest* suite.
Etienne Allovon's avatar
Etienne Allovon committed
50

51
For example if you want to upgrade to **2017.06** version you should have::
Etienne Allovon's avatar
Etienne Allovon committed
52

53
    deb http://mirror.xivo.solutions/archive/ xivo-2017.06-latest main
54 55

Note the ``/archive/`` and ``-2017.06-latest`` above.
Etienne Allovon's avatar
Etienne Allovon committed
56

57 58 59

.. _upgrade_latest_subversion_xcc:

60 61
Upgrade to latest **subversion**
--------------------------------
62

63 64 65
.. important:: For version older than Five (2017.03), see `XiVO Five documentation <https://documentation.xivo.solutions/projects/five>`_


66 67
After the release of a *version* (e.g. *2017.11*) we may backport some bugfixes in this version.
We will then create a **subversion** (e.g. 2017.11 **.01**) shipping these bugfixes.
68 69
To upgrade to the **latest subversion** of your current installed *version* you need to:

Etienne Allovon's avatar
Etienne Allovon committed
70
#. Verify that the :file:`/etc/docker/compose/factory.env` file has
71

72
   #. ``XIVOCC_TAG=VERSION`` (where ``VERSION`` is your current installed *version* - e.g. *2017.11*)
73 74 75 76
   #. and ``XIVOCC_DIST=latest``
#. Then update the images with ``xivocc-dcomp pull`` command,
#. And upgrade the containers with ``xivocc-dcomp up -d`` command.

77

78 79 80 81 82 83 84 85
Preparing the upgrade
=====================

To prepare the upgrade you should:

#. Read :ref:`xivosolutions_release` starting from your version to the version you target.


86
Upgrade
Etienne Allovon's avatar
Etienne Allovon committed
87
=======
88

Etienne Allovon's avatar
Etienne Allovon committed
89
When you have checked the sources.list you can upgrade with the following commands::
90 91

    apt-get update
Etienne Allovon's avatar
Etienne Allovon committed
92
    apt-get install xivocc-installer
93

94 95
The current ``docker-compose.yml`` file will be renamed to ``docker-compose.yml.dpkg-old`` and new template downloaded.
A new ``docker-compose.yml`` file will be rendered from the template using the current xivocc version.
96

97 98 99
Then you have to:

#. Download the new images::
100

101
    xivocc-dcomp pull
102

103
#. And run the new container (**All XiVO CC services will be restarted**)::
104

105
    xivocc-dcomp up -d
Etienne Allovon's avatar
Etienne Allovon committed
106

107
.. note::
108
   Please, ensure your server date is correct before starting. If system date differs too much from correct date, you may get an authentication error preventing download of the docker images.
109

110 111 112 113
Post Upgrade
============

Check your upgrade through :ref:`check-list`.
Etienne Allovon's avatar
Etienne Allovon committed
114 115 116 117

Upgrade notes
=============

118
See :ref:`xivosolutions_release` for version specific informations.