Resilience Installation

Important

Before installing, make sure you understand the Resilience Architecture and links between components.

This page describes the necessary steps to install and configure the resilience solution in XiVO.

Overview 

First the chosen XiVO deployment must be ready: whether it is intended to deploy a XiVO, a CC or an XDS solution, the deployment must be ready and configured.
Then a slave stack must be installed and configured - see Resilience Slave Stack Installation:
1. a second XiVO must be installed (which will be the slave node).
2. and for CC and XDS deployment: a second CC stack linked to the slave XiVO node must be installed.
Finally configure the Resilience itself - see Resilience Configuration Details:
1. Configure one XiVO as master and fill in the slave address (VoIP interface)
2. Configure the other XiVO as slave and fill in the master address (VoIP interface)
3. Configure file synchronization
4. Follow specific steps depending on the deployment type (XiVO, CC, XDS)

That’s it, you now have a HA configuration, and every hour all the configuration done on the master will be reported to the slave.

Resilience Slave Stack Installation 

All Deployement 

Important

This is a mandatory step which applies to all deployment types: XiVO, CC and XDS.

Install a slave XIVO and configure (i.e. pass the Wizard) it.

CC Deployement 

Note

This applies to deployment types: CC and XDS.

Install and configure a slave CC linked to the slave XiVO previously installed: this means that when requested fill in the XiVO Slave IP address etc.

XDS Deployement 

Note

This applies to deployment types: XDS.

Nothing to install

Edge Deployement 

Note

This applies to deployment types: Edge.

On XiVO Slave configure the TURN secret for asterisk:
- Run the following script to generate the credentials for the TURN server (the <TURN_SECRET> is the secret generated during TURN Server Secret):
```
xivo-edge-gen-turn-cred <TURN_SECRET>
```
  Note
  
  This script will generate new turn username and password in /etc/asterisk/rtp.d/01-xivo-edge-turn-cred.conf
On CC Slave follow XiVO CC configuration to make it Edge aware.

Resilience Configuration Details 

Configure one XiVO as Master 

Note

Step to be run on XiVO Master

In XiVO Web interface go to Configuration ‣ Management ‣ High Availability page
Select Type of this node to Master
In the Remote address enter the VoIP address of the Slave node

HA Dashboard Master
Restart all services on XiVO: xivo-service restart all

Configure the other XiVO as Slave 

Note

Step to be run on XiVO Slave

In XiVO Web interface go to Configuration ‣ Management ‣ High Availability page
Select Type of this node to Slave
In the Remote address enter the VoIP address of the Master node

HA Dashboard Slave

Configure file synchronization 

Note

Step to be run on XiVO Master

Configure file synchronization: xivo-sync -i

Post-Configugration Steps 

When HA nodes is configured and file synchronization is setup here are the remaining manual steps to do:

On XiVO Master:
1. Force a first synchronization:
  
  Important
  
  For the command below, jq must be installed and the file sync between Main and Slave must have been initiated - see Configure file synchronization.
```
XSLAVE_ADDR=$(cat /etc/xivo/ha.conf |jq .remote_address|tr -d '"')
/usr/sbin/xivo-master-slave-db-replication $XSLAVE_ADDR
/usr/bin/xivo-sync
```

On XiVO Slave:

Force an update of the XIVO_UUID:

function remove_xivo_uuid_from_env() {
   local sed_args_forsystemd=(-i 's/"XIVO_UUID=[a-f0-9\-]\{36\}"//g' /etc/systemd/system.conf)
   local sed_args_env=(-i '/export XIVO_UUID/d' /etc/default/xivo)
   if sed "${sed_args_forsystemd[@]}" && sed "${sed_args_env[@]}" && rm -f /etc/profile.d/xivo_uuid.sh; then
      true
   else
      false
   fi
}
echo ""
echo "Current UUID in env and conf"
grep XIVO_UUID /etc/profile.d/xivo_uuid.sh /etc/systemd/system.conf /etc/default/xivo
echo ""
echo "Removing current UUID from env and conf"
remove_xivo_uuid_from_env
echo ""
echo "Updating UUID in conf"
xivo-configure-uuid

Restart services:
```
xivo-service restart all
```

Specific steps 

Note

Specific steps depending on the deployment type.

CC Deployment 

Nothing to do yet.

XDS Deployment 

The XiVO Master & Slave must share the same AMI secret. If you need to change it, adapt the slave stack with the master secret this way:

On XiVO Master execute the following which will configure the same AMI secret for xuc user on Master and Slave:

Important

For the command below, jq must be installed and the file sync between Main and Slave must have been initiated - see Configure file synchronization.

XMASTER_AMI_SECRET=$(grep -oP '^\s*secret\s*=\K.*' /etc/asterisk/manager.d/02-xivocc.conf)
XSLAVE_ADDR=$(cat /etc/xivo/ha.conf |jq .remote_address|tr -d '"')
ssh -i /root/.ssh/xivo_id_rsa root@$XSLAVE_ADDR "sed -i 's/secret.*/secret =$XMASTER_AMI_SECRET/' /etc/asterisk/manager.d/02-xivocc.conf; asterisk -rx 'manager reload'"
XSLAVE_AMI_SECRET=$(ssh -i /root/.ssh/xivo_id_rsa root@$XSLAVE_ADDR "grep -oP '^\s*secret\s*=\K.*' /etc/asterisk/manager.d/02-xivocc.conf")
if [ "$XMASTER_AMI_SECRET" == "$XSLAVE_AMI_SECRET" ]; then
  echo "Good! AMI secret are the same !"
else
  echo "Wrong! AMI secret are still not the same. Please check manually"
fi

On CC Slave:
- edit /etc/docker/compose/custom.env and set XIVO_AMI_SECRET with the same value as in the XiVOCC Master
- recreate xucserver:
```
xivocc-dcomp up -d xuc
xivocc-dcomp restart xuc # To be sure xuc is restarted anyway
```

Each MDS needs the Slave CC to be able to establish connection as well as the Master Xuc.

Note

Step to be done on each MDS nodes

On each MDS:
- edit the existing /etc/asterisk/manager.d/02-xuc.conf to add a new permit line (replace XIVOCC_SLAVE_IP with actual Slave XiVOCC IP address):
```
permit=XIVOCC_SLAVE_IP/255.255.255.255`
```
- reload AMI:
```
asterisk -rx "manager reload"
```