Restore Cloud Exchange - Netskope Technical Documentation

To take the Cloud Exchange backup, please refer to the steps provided in the Cloud Exchange Backup section.

Before proceeding with the restore, identify your Cloud Exchange deployment type to ensure you follow the appropriate restore path. See How to Identify your Cloud Exchange Deployment Type.

Containerized Deployment

Prerequisites:

Before initiating an restore, ensure that the backup file (ce_backup.zip) is stored in the ta_cloud_exchange/data/ folder.
Ensure you have the maintenance password readily available, as it will be needed to complete certain steps in this process.

Important

If the maintenance password is lost, the data could not be retained.

Notes

RabbiMQ data migration is not supported due to the change of queue type from Classic to Quorum queue.

Standalone Deployment

Go to the ta_cloud_exchange directory.
```
cd ta_cloud_exchange
```
Stop the containers.
```
sudo ./stop
```
Go to the data directory.
```
cd data
```

Remove mongo data, repos and plugins.

sudo rm -rf mongo-data/data/db/* repos/* plugins/* rabbitmq/data/*

Navigate back to the ta_cloud_exchange directory.
```
cd ..
```
Before proceeding, checkout the desired version of the repository. Replace v6.1.0 with the version you wish to use. Refer to the Netskope CE GitHub Tags for a list of available versions. For example, to checkout version 6.1.0:
```
git checkout v6.1.0
```
Go to the data directory.
```
cd data
```

Unzip file for mongo data, repos and plugins.

sudo unzip ce_backup.zip "mongo-data/*" "repos/*" "plugins/*" "custom_plugins/*" -d .

Navigate back to the ta_cloud_exchange directory.
```
cd ..
```
Run setup script
```
sudo python3 ./setup
```
Execute the start script using the below command.
```
sudo ./start
```

HA Deployment

For CE versions older than 6.0.0

On All Nodes (step: 1,2,3,4,5,6)

Go to the ta_cloud_exchange directory.
```
cd ta_cloud_exchange
```
To ensure proper CE as VM shutdown, stop both Secondary nodes and than stop the Primary node using below command:
```
sudo ./stop
```
Go to the data directory.
```
cd data
```

Remove mongo data, repos and plugins.

sudo rm -rf mongo-data/data/db/* repos/* plugins/* rabbitmq/data/*

Navigate back to the ta_cloud_exchange directory.
```
cd ..
```
Before proceeding, checkout the desired version of the repository. Replace v5.1.2 with the version you wish to use. Refer to the Netskope CE GitHub Tags for a list of available versions. For example, to checkout version 5.1.2:
```
git checkout v5.1.2
```
On Primary Node (step: 7,8,9,10,11)
Go to the data directory.
```
cd data
```
Unzip file for mongo data, repos and plugins. (When prompted with the replace confirmation message, enter A to select All and proceed with replacing all existing files.)
```
sudo unzip ce_backup.zip "mongo-data/*" -d .
sudo unzip ce_backup.zip "plugins/*" "repos/*" "custom_plugins/*" -d <shared_directory>
```
Navigate back to the ta_cloud_exchange directory.
```
cd ..
```
Run setup script
```
sudo python3 ./setup
```
To migrate the Mongo data, use this command one time only.
```
sudo ./restore_ha_backup
```
On Secondary Nodes (step: 12)
Execute the setup script on the secondary nodes with the –location option. Provide the path of the NFS-mounted directory in the –location option. And provide the IP address of the current machine.
```
sudo python3 ./setup --location <shared_directory>
```
On All Nodes (step: 13)
Launch Cloud Exchange on the primary node first. The script will wait until the migrations are complete. Then launch Cloud Exchange on the remaining nodes to join the cluster:
```
sudo ./start
```

For 6.0.0 and newer CE versions

On All Nodes (step: 1,2,3,4,5,6,7,8)

Go to the ta_cloud_exchange directory.
```
cd ta_cloud_exchange
```
To ensure proper CE as VM shutdown, stop both Secondary nodes and than stop the Primary node using below command:
```
sudo ./stop
```
Go to the data directory.
```
cd data
```

Remove mongo data, repos and plugins.

sudo rm -rf mongo-data/data/db/* repos/* plugins/* rabbitmq/data/*

Navigate back to the ta_cloud_exchange directory.
```
cd ..
```

Remove the TLS certificates by following the steps below:

sudo rm -rf data/ssl_certs/mongodb_rabbitmq_certs/tls_cert*

Before proceeding, checkout the desired version of the repository. Replace v6.1.0 with the version you wish to use. Refer to the Netskope CE GitHub Tags for a list of available versions. For example, to checkout version 6.1.0:
```
git checkout v6.1.0
```
Follow the Cloud Exchange Troubleshooting documentation to remove the GlusterFS shared storage volume and peer nodes.
On Primary Node (step: 9,10,11,12,13,14,15,16)
Go to the data directory.
```
cd data
```
Unzip file for mongo data, repos and plugins. (When prompted with the replace confirmation message, enter A to select All and proceed with replacing all existing files.)
```
sudo unzip ce_backup.zip "mongo-data/*" -d .
sudo mkdir /opt/shared/data/ -p
sudo unzip ce_backup.zip "plugins/*" "repos/*" "custom_plugins/*" -d /opt/shared/data
```
Navigate back to the ta_cloud_exchange directory.
```
cd ..
```

Copy and edit the cloudexchange config file using below commands:

cp cloudexchange.config.example cloudexchange.config
vi cloudexchange.config

Update the cloudexchange configuration file with values for required fields. Also, make sure to configure optional fields like proxy configuration, ui port etc if used/customised. JWT_SECRECT is optional, Setup script will generate new JWT secret if not provided
```
HA_ENABLED=True
HA_CURRENT_NODE=<current node ip>
HA_PRIMARY_NODE_IP=<current node ip>
HA_IP_LIST=<current node ip>
MAINTENANCE_PASSWORD=<old cloud exchange maintenance password>
JWT_SECRECT=<old cloud exchange JWT secret>
```
Run setup script
```
sudo python3 ./setup
```
To migrate the Mongo data, use this command one time only.
```
sudo ./restore_ha_backup
```
Execute the start script using the below command.
```
sudo ./start
```
On Secondary Nodes (step: 17)
To configure secondary nodes, follow the instructions provided in the Cloud Exchange High Availability page.

Cloud Exchange as a VM Deployment

Prerequisites:

Before initiating an restore, ensure that the backup file (ce_backup.zip) is stored in the /opt/cloudexchange/cloudexchange/data/ folder.
Ensure you have the maintenance password readily available, as it will be needed to complete certain steps in this process.

Important

If the maintenance password is lost, the data could not be retained.

Notes

RabbiMQ data migration is not supported due to the change of queue type from Classic to Quorum queue.

Standalone Deployment

Go to the /opt/cloudexchange/cloudexchange directory.
```
cd /opt/cloudexchange/cloudexchange
```
Stop the containers.
```
sudo ./stop
```
Go to the data directory.
```
cd data
```

Remove mongo data, repos and plugins.

sudo rm -rf mongo-data/data/db/* repos/* plugins/* rabbitmq/data/*

Unzip file for mongo data, repos and plugins.

sudo unzip ce_backup.zip "mongo-data/*" "repos/*" "plugins/*" "custom_plugins/*" -d .

Navigate back to the /opt/cloudexchange/cloudexchange directory.
```
cd ..
```
Run setup script
```
sudo python3 ./setup
```
Execute the start script using the below command.
```
sudo ./start
```

HA Deployment

For CE versions older than 6.0.0

On All Nodes (step: 1,2,3,4,5)

Go to the /opt/cloudexchange/cloudexchange directory.
```
cd /opt/cloudexchange/cloudexchange
```
To ensure proper CE as VM shutdown, stop both Secondary nodes and than stop the Primary node using below command:
```
sudo ./stop
```
Go to the data directory.
```
cd data
```

Remove mongo data, repos and plugins.

sudo rm -rf mongo-data/data/db/* repos/* plugins/* rabbitmq/data/*

Navigate back to the /opt/cloudexchange/cloudexchange directory.
```
cd ..
```
On Primary Node (step: 6,7,8,9,10)
Go to the data directory.
```
cd data
```
Unzip file for mongo data, repos and plugins. (When prompted with the replace confirmation message, enter A to select All and proceed with replacing all existing files.)
```
sudo unzip ce_backup.zip "mongo-data/*" -d .
sudo unzip ce_backup.zip "plugins/*" "repos/*" "custom_plugins/*" -d <shared_directory>
```
Navigate back to the /opt/cloudexchange/cloudexchange directory.
```
cd ..
```
Run setup script
```
sudo python3 ./setup
```
To migrate the Mongo data, use this command one time only.
```
sudo ./restore_ha_backup
```
On Secondary Nodes (step: 11)
Execute the setup script on the secondary nodes with the –location option. Provide the path of the NFS-mounted directory in the –location option. And provide the IP address of the current machine.
```
sudo python3 ./setup --location <shared_directory>
```
On All Nodes (step: 12)
Launch Cloud Exchange on the primary node first. The script will wait until the migrations are complete. Then launch Cloud Exchange on the remaining nodes to join the cluster:
```
sudo ./start
```

For 6.0.0 and newer CE versions

On All Nodes (step: 1,2,3,4,5,6,7)

Go to the /opt/cloudexchange/cloudexchange directory.
```
cd /opt/cloudexchange/cloudexchange
```
To ensure proper CE as VM shutdown, stop both Secondary nodes and than stop the Primary node using below command:
```
sudo ./stop
```
Go to the data directory.
```
cd data
```

Remove mongo data, repos and plugins.

sudo rm -rf mongo-data/data/db/* repos/* plugins/* rabbitmq/data/*

Navigate back to the /opt/cloudexchange/cloudexchange directory.
```
cd ..
```

Remove the TLS certificates by following the steps below:

sudo rm -rf data/ssl_certs/mongodb_rabbitmq_certs/tls_cert*

Follow the Cloud Exchange Troubleshooting documentation to remove the GlusterFS shared storage volume and peer nodes.
On Primary Node (step: 8,9,10,11,12,13,14,15)
Go to the data directory.
```
cd data
```
Unzip file for mongo data, repos and plugins. (When prompted with the replace confirmation message, enter A to select All and proceed with replacing all existing files.)
```
sudo unzip ce_backup.zip "mongo-data/*" -d .
sudo mkdir /opt/shared/data/ -p
sudo unzip ce_backup.zip "plugins/*" "repos/*" "custom_plugins/*" -d /opt/shared/data
```
Navigate back to the /opt/cloudexchange/cloudexchange directory.
```
cd ..
```

Copy and edit the cloudexchange config file using below commands:

cp cloudexchange.config.example cloudexchange.config
vi cloudexchange.config

Update the cloudexchange configuration file with values for required fields. Also, make sure to configure optional fields like proxy configuration, ui port etc if used/customised. JWT_SECRECT is optional, Setup script will generate new JWT secret if not provided
```
HA_ENABLED=True
HA_CURRENT_NODE=<current node ip>
HA_PRIMARY_NODE_IP=<current node ip>
HA_IP_LIST=<current node ip>
MAINTENANCE_PASSWORD=<old cloud exchange maintenance password>
JWT_SECRECT=<old cloud exchange JWT secret>
```
Run setup script
```
sudo python3 ./setup
```
To migrate the Mongo data, use this command one time only.
```
sudo ./restore_ha_backup
```
Execute the start script using the below command.
```
sudo ./start
```
On Secondary Nodes (step: 16)
To configure secondary nodes, follow the instructions provided in the Cloud Exchange High Availability page.

HA_ENABLED=True
HA_CURRENT_NODE=<current node ip>
HA_PRIMARY_NODE_IP=<current node ip>
HA_IP_LIST=<current node ip>
MAINTENANCE_PASSWORD=<old cloud exchange maintenance password>
JWT_SECRECT=<old cloud exchange JWT secret>