Removing the Hosted Exchange Module from CloudBlue Commerce
Original Publishing Date:
2020-03-05
TABLE OF CONTENTS
Introduction
This article explains how to remove the Hosted Exchange module and all related data from CloudBlue Commerce installations.
Supported Configurations
CloudBlue Commerce 20.5 with the Hosted Exchange module.
What Happens During Cleanup
During the removal of the Hosted Exchange module, you will use a cleanup tool. The cleanup tool:
- Deactivates all service templates related to the Hosted Exchange module to make buying and provisioning new Hosted Exchange subscriptions impossible in both CCP v1 and CCP v2 (also referred to as UX1 for Customers).
- (Optional) Synchronizes all online stores to unpublish the service plans that are based on the deactivated service templates. You should do this to prevent users from purchasing Hosted Exchange subscriptions in online stores.
- Removes all packages related to the Hosted Exchange module from service nodes.
- Archives all orders related to the Hosted Exchange module. To learn more about the archiving of orders, please refer to the Billing Provider Guide.
- Removes all packages related to the Hosted Exchange module from the internal repository on the management node.
Installing the Cleanup Tool
Obtain and install the cleanup tool as described in this article.
Preparing for Cleanup
Before starting the cleanup tool, you need to remove or migrate all Exchange organizations from service nodes related to the Hosted Exchange module. The cleanup tool does not do anything to customer or reseller subscriptions, so you must process them on your own.
You can remove ("destroy" in Billing terms) the subscriptions that are no longer needed by following this guide.
Preparing Your Installation for Running the Cleanup Tool
Prepare your installation by following the instructions in this article.
Removing the Provider's Hosted Exchange Organization (If Applicable)
Execute the attached script on the management node to remove the provider's Hosted Exchange organization:
# python unprovideProviderExchangeOrg.py
During the execution, the script checks that there is no mail service, mailboxes, and other objects linked to the provider's organization. If such objects exist, log in to the Hosting CP, remove them, and execute the script again.
As a result, tasks will be scheduled. Wait for the tasks to complete.
Performing Cleanup
You can clean up your CloudBlue Commerce installation by subsequently running the following commands:
- deactivate-service-templates
- synchronize-online-stores
- remove-packages-from-service-nodes
- uninstall-module
If you want to ensure that all cleanup steps can be carried out successfully, you can run each of these commands with the -–check-only option. If this option is specified, the cleanup tool performs all checks without making any changes to your CloudBlue Commerce installation.
To view the help page for the cleanup tool, either run the tool without any arguments or run it with the --help (-h) option.
Note: You must run the cleanup tool on the management node as root.
Step 1. Deactivating Service Templates
You need to deactivate all service templates related to the Hosted Exchange module so that buying and provisioning new Hosted Exchange subscriptions from CCP v1 and from CCP v2 is no longer possible. After deactivating a service template, all service plans based on it are no longer available for purchase in CCP v1 and CCP v2. To remove these service plans from online stores, you must make them unpublished and synchronize the online stores.
To deactivate service templates related to the Hosted Exchange module, run the script as follows:
# ./clean-up-hosted-exchange.py [--check-only] deactivate-service-templates
where:
--check-only is an optional parameter. If specified, the cleanup tool performs all checks without making any changes.
Step 2. Synchronizing Online Stores
This is an optional step, but we highly recommend performing it. You should unpublish the service plans that are based on the deactivated service templates to make buying and provisioning new Hosted Exchange subscriptions from online stores impossible. Note that during the synchronization, all other settings, even those unrelated to the service plans, will be synchronized as well. If you do not want to synchronize some of the online stores at this moment, synchronize online stores manually.
To synchronize all online stores, run the script as follows:
# ./clean-up-hosted-exchange.py [--check-only] synchronize-online-stores
where:
--check-only is an optional parameter. If specified, the cleanup tool performs all checks without making any changes.
Step 3. Removing Packages from Service Nodes
In this step, all packages related to the Hosted Exchange module are removed from service nodes. We recommend performing this step outside business hours.
To remove all packages related to the Hosted Exchange module from service nodes, run the script as follows:
# ./clean-up-hosted-exchange.py [--check-only] remove-packages-from-service-nodes
where:
--check-only is an optional parameter. If specified, the cleanup tool performs all checks without making any changes.
After this step is completed, you can manually remove these nodes from your CloudBlue Commerce installation and decommission them if needed.
Step 4. Updating UI configuration files on Branding UI Cluster in Kubernetes
If you have a Branding UI Cluster in Kubernetes then perform the following:
- Login to the Kubernetes node via SSH.
- Execute the following command:
kubectl exec $(kubectl get pod -l service=branding-ui-cluster-ui --output=jsonpath={.items..metadata.name} | head -n 1) -c branding-ui-cluster-ui -- mv -f /mnt/brands/puitconf/{stat_profile.properties,whc.properties,amt_st.properties,active_directory.properties,backup.properties,exchange.properties} /mnt/brands/puitconf_d/
- Restart Branding UI Cluster pods.
Step 5. Unregistering the Messaging and Collaboration Module
Note: During this step, the pa-agent service on your management node and the pau services on your management node and UI servers will be restarted. We recommend that you perform this step outside business hours.
To remove all packages related to the Hosted Exchange module from the internal repository on the management node, run the script as follows:
# ./clean-up-hosted-exchange.py [--check-only] uninstall-module
where:
--check-only is an optional parameter. If specified, the cleanup tool performs all checks without making any changes.
The Outcome
After all the cleanup steps are performed, you can upgrade your installation. All items related to the Hosted Exchange module will be removed from CloudBlue Commerce.
Now that you removed the Hosted Exchange module, you can proceed to the removal of the Windows Hosting Infrastructure (WHI) components, as described in this article.