Commit 97150763 authored by Etienne Allovon's avatar Etienne Allovon

Update xivo Upgrade page for Polaris

parent 651d1b2b
......@@ -31,17 +31,22 @@ There are two cases:
Upgrade to an **LTS** version
-----------------------------
Currently XiVO PBX *latest* **LTS** version is 2017.LTS1 also called XiVO Five and is the numeric release 2017.03. To upgrade you have to update the sources list to point to *xivo-five*. You have to do it with the command ``xivo-dist`` supplied in *XiVO PBX*::
To upgrade to a XiVO PBX **LTS** version you have to update the sources list by using the `xivo-dist` command::
xivo-dist xivo-five
xivo-dist <XiVO LTS VERSION>
or::
Currently there are two XiVO PBX **LTS** versions:
xivo-dist xivo-2017.03-latest
#. (**latest**) XiVO Polaris (2017.11) - released 2017/10/09::
xivo-dist xivo-polaris
.. note:: If you're in a version newer than 2017.03 (or XiVO 2017.LTS1 Five) like 2017.05, you **can't** downgrade to the
2017.03 version.
#. (*old*) XiVO Five (2017.03) - released 2017/04/03::
xivo-dist xivo-five
.. note:: Note that it is not possible to downgrade to any version.
.. _upgrade_specific_version_xpbx:
......@@ -49,12 +54,11 @@ or::
Upgrade to an **Intermediate** version
--------------------------------------
Between XiVO PBX LTS versions we release **Intermediate** versions (to which is given a limited support). To upgrade to a *specific* **Intermediate** version, you have to update the sources to point to this *specific* version. You have to do it with the ``xivo-dist`` command. For example, if you want to upgrade to **2017.06**::
xivo-dist xivo-2017.06-latest
.. note:: **Intermediate** version have a limited support. You should install LTS version only.
Between XiVO PBX LTS versions we release **Intermediate** versions (to which is given a limited support). To upgrade to a *specific* **Intermediate** version, you have to update the sources to point to this *specific* version. You have to do it with the ``xivo-dist`` command. For example, if you want to upgrade to **2017.06**::
.. note:: **Intermediate** version have a limited support. You should install LTS version only.
xivo-dist xivo-2017.12-latest
Preparing the upgrade
......@@ -62,7 +66,7 @@ Preparing the upgrade
To prepare the upgrade you should:
#. Read :ref:`xivosolutions_release` starting from your version to the version you target.
#. **Read carefully the** :ref:`xivosolutions_release` **starting from your current version to the version you target.**
#. Check 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`).
#. Finally, you can download the packages beforehand by running ``xivo-upgrade -d``. This is not mandatory,
......@@ -73,6 +77,14 @@ To prepare the upgrade you should:
Upgrade
=======
.. note:: About `xivo-upgrade` script see:
.. toctree::
:maxdepth: 2
xivo_upgrade_script
#. For custom setups, follow the required procedures described below (e.g. :ref:`upgrading-a-cluster`).
#. When ready, launch the upgrade process. **All XiVO PBX services will be stopped during the process**::
......@@ -120,62 +132,6 @@ Upgrading to/from an archive version
archives
.. _xivo-upgrade_script:
xivo-upgrade script
===================
.. note::
* You can't use xivo-upgrade if you have not run the wizard yet
* Upgrading from a version prior to *XiVO PBX* 1.2 is not supported.
* When upgrading XiVO, you **must** also upgrade **all** associated XiVO
Clients. There is currently no retro-compatibility on older *XiVO PBX* Client
versions.
This script will update *XiVO PBX* and restart all services.
There are 2 options you can pass to xivo-upgrade:
* ``-d`` to only download packages without installing them. **This will still upgrade the package containing xivo-upgrade and xivo-service**.
* ``-f`` to force upgrade, without asking for user confirmation
``xivo-upgrade`` uses the following environment variables:
* ``XIVO_CONFD_PORT`` to set the port used to query the :ref:`HTTP API of xivo-confd <confd-api>`
(default is 9486)
Troubleshooting
===============
Postgresql
----------
When upgrading XiVO, if you encounter problems related to the system locale, see
:ref:`postgresql_localization_errors`.
xivo-upgrade
------------
If xivo-upgrade fails or aborts in mid-process, the system might end up in a faulty condition. If in
doubt, run the following command to check the current state of xivo's firewall rules::
iptables -nvL
If, among others, it displays something like the following line (notice the DROP and 5060)::
0 0 DROP udp -- * * 0.0.0.0/0 0.0.0.0/0 udp dpt:5060
Then your XiVO will not be able to register any SIP phones. In this case, you must delete the DROP
rules with the following command::
iptables -D INPUT -p udp --dport 5060 -j DROP
Repeat this command until no more unwanted rules are left.
Upgrade Notes
=============
......
.. _xivo-upgrade_script:
*******************
xivo-upgrade script
*******************
Usage
=====
.. note::
* You can't use xivo-upgrade if you have not run the wizard yet
* Upgrading from a version prior to *XiVO PBX* 1.2 is not supported.
* When upgrading XiVO, you **must** also upgrade **all** associated XiVO
Clients. There is currently no retro-compatibility on older *XiVO PBX* Client
versions.
This script will update *XiVO PBX* and restart all services.
There are 2 options you can pass to xivo-upgrade:
* ``-d`` to only download packages without installing them. **This will still upgrade the package containing xivo-upgrade and xivo-service**.
* ``-f`` to force upgrade, without asking for user confirmation
``xivo-upgrade`` uses the following environment variables:
* ``XIVO_CONFD_PORT`` to set the port used to query the :ref:`HTTP API of xivo-confd <confd-api>`
(default is 9486)
Troubleshooting
===============
Postgresql
----------
When upgrading XiVO, if you encounter problems related to the system locale, see
:ref:`postgresql_localization_errors`.
xivo-upgrade
------------
If xivo-upgrade fails or aborts in mid-process, the system might end up in a faulty condition. If in
doubt, run the following command to check the current state of xivo's firewall rules::
iptables -nvL
If, among others, it displays something like the following line (notice the DROP and 5060)::
0 0 DROP udp -- * * 0.0.0.0/0 0.0.0.0/0 udp dpt:5060
Then your XiVO will not be able to register any SIP phones. In this case, you must delete the DROP
rules with the following command::
iptables -D INPUT -p udp --dport 5060 -j DROP
Repeat this command until no more unwanted rules are left.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment