Upgrade

The XiVO Centralized User Management (XCU) upgrade.

Prepare sources list

Before upgrading you have to create or change your sources list. It should be located in the file /etc/apt/sources.list.d/xivo-dist.list.

You must change the sources list to point towards the version you want to upgrade.

For example if you want to upgrade to Freya GCU:

deb http://mirror.xivo.solutions/debian/ xivo-freya main

Upgrade steps

Preparing the upgrade

Upgrade

When you have checked the sources.list you can upgrade:

  1. Execute with the following commands:

    apt-get update
    apt-get install gcu-installer
    
  2. If are using postgresql installed using sources from Postgresql Wiki, upgrading gcu-installer may trigger installing new version of PostgreSQL (in parallel to curent one). Suggested action is to disable this new version. If for example GCU use postgresql 9.5 and new version 9.6 was added:

    • stop postgresql 9.6 manually by: service postgresql stop 9.6

    • disable postgresql 9.6 autostart: in /etc/postgresql/9.6/main/start.conf replace auto with disabled

    • ensure postgresql 9.5 is running by: service postgresql start 9.5

  3. Download the new images:

    docker-compose -p icdu -f /etc/docker/compose/icdu.yml pull
    
  4. And run the new container (All XCU services will be restarted):

    docker-compose -p icdu -f /etc/docker/compose/icdu.yml up -d
    

Note

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.

Version specific XCU upgrade procedures

Upgrade from versions before 2020.18

Before upgrading to version 2020.18, you must change the not_routed mode of all entity’s intervals.

For example, change not_routed mode to routed mode in table entity_intervals:

UPDATE entity_intervals SET interval_routing_mode = 'routed' WHERE interval_routing_mode = 'not_routed';

You can also do it per-entity and per-interval by doing it manually in the GCU web iunterface before the upgrade.

Upgrade from versions before 2018.04

Docker-CE must be installed instead of Docker Engine.

Upgrade from versions before 2017.06

If you installed GCU version older than 2017.06, you can upgrade it by following Installation instructions. Further instructions and notices:

  1. It is strongly recommended you backup your PostgreSQL icx database and SSH keys before proceeding.

  2. Installation will install new version of configuration files (like /etc/docker/compose/icdu.yml). If some file already exists with different content, you be prompted to choose correctly version or merge differences. Unless you are sure you need special version, use choice: install the package maintainer’s version.

  3. Installation will reuse your SSH certificate stored in /etc/docker/interface-centralisee/ssh_key if exists.

  4. Installation will reuse PostgreSQL user icx if exists - make sure it has password icx and access to database icx.

  5. Installation will reuse PostgreSQL database icx if exists.

Check carefully output of apt-get install gcu-installer, you will be informed about each component reused and about any manual checks or actions needed, if necessary.