The WebHosting Linux module is discontinued and will no longer be available for installation starting from CloudBlue Commerce 21.0. 

If you want to upgrade to the latest version of CloudBlue Commerce (21.0 and later), you will need to stop signing up new customers to hosting services and notify your existing hosting customers that they need to back up and migrate their websites elsewhere.

When they finish migrating websites, you can remove the customers' accounts with data and run a cleanup tool to delete all components related to WebHosting Linux from CloudBlue Commerce.

This article explains how to use the cleanup tool.

Supported configurations

  • CloudBlue Commerce 20.5

What happens during cleanup

The cleanup tool does the following:

  1. Deactivates all service templates related to the WebHosting Linux module to make it impossible to buy and provision new WebHosting Linux subscriptions from UX1 Marketplace.
  2. (Optional) Synchronizes all online stores (UX1 Marketplaces) to unpublish the service plans that are based on the deactivated service templates. You should do this to prevent users from purchasing WebHosting Linux subscriptions in online stores.
  3. Removes all packages related to the WebHosting Linux module from service nodes.
  4. Archives all orders related to the WebHosting Linux module. To learn more about the archiving of orders, please refer to the Billing Provider Guide.
  5. Removes all packages related to the WebHosting Linux module from the internal repository on the management node.


Installing the cleanup tool

To obtain and install the cleanup tool, use the instructions in this article.


Preparing for cleanup

To remove the WebHosting Linux module from your installation of CloudBlue Commerce, you need to remove or migrate all websites and webspaces from the service nodes related to the WebHosting Linux module. The cleanup tool does not do anything to customer or reseller subscriptions. You must process them on your own.

To remove the subscriptions that are no longer needed, follow the instructions in this guide.

During the creation of new reseller accounts associated with the WebHosting Linux module, the system may create webspaces for resellers on one of WebHosting Linux shared hosting nodes. To proceed with the cleanup, you must subscribe resellers to other service plans that do not contain WebHosting Linux resources. The following is an overview of the steps that you need to perform:

  1. In the Provider Panel of CloudBlue Commerce, create a service template.
  2. In Billing, create a reseller service template.
  3. In Billing, create a service plan based on the reseller template.
  4. In Billing, locate the service plan to which the reseller is currently subscribed, and add the service plan that you created in step 3 to the list of plans available for upgrade.
  5. In Billing, locate the reseller's subscription, click Switch Plan, and select the plan that you created in step 3.
  6. In Billing, process the order related to the plan change.

Removing WebHosting Linux resources from customers' subscriptions

If there are subscriptions that include resources related to WebHosting Linux and other resources (for example, DNS resources), such subscriptions cannot be deleted as they may be used by other services. In such a case, to continue with the cleanup process, you need to do either of the following:

  1. Switch all subscriptions with resources related to WebHosting Linux to another service plan.
  2. Remove resources related to WebHosting Linux.

To remove resources related to WebHosting Linux from subscriptions, please use the instructions provided in this article.

Removing WebHosting Linux resources from resellers' subscriptions

If there are WebHosting Linux resources in a reseller subscription, do the following:
Step 1. Notify the reseller that they must migrate their websites and the websites of their customers elsewhere. When they finish migrating, remove the subscriptions.

Step 2. Log in to the Reseller Panel on behalf of that reseller and remove all WebHosting Linux resources from service templates.

Step 3. Log in to the Provider Panel and switch the reseller's subscription to another plan that does not include WebHosting Linux resources.

Performing the cleanup

You can clean up your installation of CloudBlue Commerce by subsequently running the following commands:

  1. deactivate-service-templates
  2. synchronize-online-stores
  3. remove-packages-from-service-nodes
  4. uninstall-module

If you want to ensure that all the cleanup steps can be carried out successfully, you can run each of these commands with the –check-only key. It performs all checks without making any changes to your CloudBlue Commerce installation.

To view the help page for the cleanup tool, 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 WebHosting Linux module to make it impossible to buy and provision new WebHosting Linux subscriptions from Customer Panel (UX1). After deactivating a service template, all service plans based on it become no longer available for purchasing. To remove these plans from online stores (Marketplaces), you must synchronize the online stores.

To deactivate the service templates related to WebHosting Linux, run the script as follows:

# ./clean-up-whl-module.py [--check-only] deactivate-service-templates

Where:

[--check-only] is an optional parameter that performs all checks without making any changes to the CloudBlue Commerce installation.

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 it impossible to buy and provision new WebHosting Linux subscriptions from online stores. Note that during the synchronization, all other settings, even those that are not related to 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-whl-module.py [--check-only] synchronize-online-stores

Where:

[--check-only] is an optional parameter that performs all checks without making any changes to the CloudBlue Commerce installation.

Step 3. Removing packages from service nodes

This step removes all packages related to the WebHosting Linux module from service nodes. Any user data related to these modules are not removed. During this step, all nodes related to the WebHosting Linux module are detached automatically. While the nodes are detached, CloudBlue Commerce cannot operate on them. For this reason, we recommend performing this step outside the normal business hours.

To remove all packages related to the WebHosting Linux module from service nodes, run the script as follows:

# ./clean-up-whl-module.py [--check-only] remove-packages-from-service-nodes

Where:

[--check-only] is an optional parameter that performs all checks without making any changes to the CloudBlue Commerce installation.

After this step is completed, you can manually remove these nodes from CloudBlue Commerce 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:

  1. Login to the Kubernetes node via SSH.
  2. 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/{amt_st.properties,apache.properties,backup.properties,web_hosting.properties,common_filemanager.properties,crontabs.properties,db_manager.properties,domain_parking.properties,proftpd.properties,logrotate.properties} /mnt/brands/puitconf_d/
  3. Restart Branding UI Cluster pods.

Step 5. Uninstalling the WebHosting Linux module

Note: During this step, the pa-agent and pau services will be restarted.

To remove all packages related to the WebHosting Linux module from the internal repository on the management node, run the script as follows:

# ./clean-up-whl-module.py [--check-only] uninstall-module

Where:

[--check-only] is an optional parameter that performs all checks without making any changes to the CloudBlue Commerce installation.

The outcome

After all cleanup steps are performed, you will be able to upgrade CloudBlue Commerce to version 21.0. All items related to the WebHosting Linux module will be removed from CloudBlue Commerce:

  • Service templates will be disabled.
  • Subscriptions, including websites, databases, and applications, will be removed from CloudBlue Commerce.
  • Service nodes will be detached.
  • The WebHosting Linux module will be removed.