Removing the Windows Shared Hosting module from Odin Automation
Original Publishing Date:
2020-01-23
Introduction
The Windows Shared Hosting module is discontinued and will no longer be available for installation starting from Odin Automation 8.0. Providers willing to offer Windows-based hosting services should migrate their customers from Windows Shared Hosting to WebHosting Plesk by means of the Migration Manager tool, and then clean up Odin Automation by using the clean-up-wsh-module cleanup tool. Otherwise, they will not be able to upgrade to Odin Automation 8.0 or later.
This article explains how to remove the Windows Shared Hosting module and all related data from Odin Automation installations.
NOTE: The procedure implies pa-agent and pau services restart at the last stage, so it is required to plan a maintenance window to run the script on Step 4.
Supported configurations
Odin Automation 7.4 with the Windows Shared Hosting module.
What happens during cleanup
The cleanup tool does the following:
- Deactivates all service templates related to the Windows Shared Hosting module to make it impossible to buy and provision new Windows Shared Hosting subscriptions from CCPv1 and CCPv2 (also referred to as UX1).
- (Optional) Synchronizes all online stores so as to unpublish the service plans that are based on the deactivated service templates. You should do this to prevent users from purchasing Windows Shared Hosting subscriptions in online stores.
- Removes all packages related to the Windows Shared Hosting module from service nodes.
- Removes all packages related to the Windows Shared Hosting module from the internal repository on the management node.
Installing the cleanup tool
Download the clean-up tool to the CloudBlue management node (MN) and extract its contents.
Make sure you have the latest version of the tool. The version number is specified in the archive name and in the VERSION file inside the tool archive.
Preparing for cleanup
To remove the Windows Shared Hosting module from your installation of Odin Automation, you need to remove or migrate all websites and webspaces from the service nodes related to the Windows Shared Hosting module. The cleanup tool does not do anything to customer or reseller subscriptions. You must process them on your own.
If you want customers' websites to continue to operate after you remove the module and upgrade Odin Automation to a later version, you must migrate users' subscriptions by following this guide.
Or you can remove ("destroy" in Billing terms) the subscriptions that are no longer needed by following this guide.
During the creation of new reseller accounts associated with the Windows Shared Hosting module, the system may create webspaces for resellers on one of Windows Shared Hosting nodes. To proceed with the cleanup, you must subscribe resellers to other service plans that do not contain Windows Shared Hosting resources. The following is an overview of the steps that you need to perform:
- In the Provider Panel of Odin Automation, create a service template by following these instructions.
- In Billing, create a reseller service template.
- In Billing, create a service plan based on the reseller template.
- 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.
- In Billing, locate the reseller's subscription, click Switch Plan, and select the plan that you created in step 3.
- In Billing, process the order related to the plan change.
Removing Windows Shared Hosting resources from customers' subscriptions
If there are subscriptions that include resources related to Windows Shared Hosting 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:
- Switch all subscriptions with resources related to Windows Shared Hosting to another service plan.
- Remove resources related to Windows Shared Hosting.
To remove resources related to Windows Shared Hosting from subscriptions, do the following:
- Set limits on those resources to 0 in all subscriptions.
- Remove resources related to Windows Shared Hosting from all service templates.
- Synchronize subscriptions with Windows Shared Hosting resources with service plans.
Removing Windows Shared Hosting resources from resellers' subscriptions
If there are Windows Shared Hosting resources in a reseller subscription, do the following:
Step 1. Perform any of the following:
- Migrate the customers' subscriptions under that reseller to WebHosting Plesk. After that, remove Windows Shared Hosting subscriptions or switch them to another service plan that does not include Windows Shared Hosting resources.
- Switch the customers' subscriptions under that reseller to another service plan that does not include Windows Shared Hosting resources.
- Remove the subscriptions if they are no longer needed.
Step 2. Log in to the Reseller Panel on behalf of that reseller, and remove all Windows Shared Hosting 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 Windows Shared Hosting resources.
Attaching and detaching service nodes during the removal of subscriptions or switching them to another plan
If you plan to reuse the nodes that host Windows Shared Hosting subscriptions (which may also host SharePoint services) and keep the content of websites on the nodes, you first need to detach the nodes from Odin Automation, delete the subscriptions from Odin Automation or switch them to another service plan, and then attach the nodes back to Odin Automation. You can detach nodes using the command "detach-nodes":
# ./clean-up-wsh-module.py detach-nodes
This command detaches Windows-based service nodes that host the following services: Active Directory IIS, File Manager, AWStats Web Statistics, MS SQL Server, Web Data Administrator, myLittleAdmin, Domain Parking, SSL Proxy, Customer Backup Server, and SharePoint.
Important: MySQL and PostgreSQL database servers are not related to Windows-based service nodes. They will not be detached as a result of running this command. When you delete subscriptions that use MySQL or PostgreSQL databases, the databases will be removed as well. If you want to keep these databases, you need to back them up before removing subscriptions, and then restore them after subscriptions are removed. You might want to keep the databases if you migrated from Windows Shared Hosting to WebHosting Plesk.
Note: While a node is detached from Odin Automation, no operations (such as the creation or removal of websites and databases) can be performed on it. For this reason, we recommend detaching the nodes outside the normal business hours and within a planned maintenance window.
To attach the nodes back to Odin Automation, use the following command:
# ./clean-up-wsh-module.py attach-nodes --node-ids <node IDs>
where:
--node-ids specifies a comma-separated list of IDs of service nodes that should be attached to Odin Automation.
Performing the cleanup
You can clean up your installation of Odin Automation 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 of 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 Odin Automation 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 Windows Shared Hosting module to make it impossible to buy and provision new Windows Shared Hosting subscriptions from CCPv1 and CCPv2. After deactivating a service template, all service plans based on it become no longer available for purchasing in CCPv1 and CCPv2. To remove these plans from online stores, you must synchronize the online stores.
To deactivate the service templates related to Windows Shared Hosting, run the script as follows:
# ./clean-up-wsh-module.py [--check-only] deactivate-service-templates
Where:
[--check-only] is an optional parameter that performs all checks without making any changes to the Odin Automation 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 Windows Shared Hosting 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-wsh-module.py [--check-only] synchronize-online-stores
Where:
[--check-only] is an optional parameter that performs all checks without making any changes to the Odin Automation installation.
Step 3. Removing packages from service nodes
This step removes all packages related to the Windows Shared Hosting module from service nodes. Any user data related to these modules are not removed. During this step, all nodes related to the Windows Shared Hosting module are detached automatically. While the nodes are detached, Odin Automation cannot operate on them. For this reason, we recommend performing this step outside the normal business hours.
To remove all packages related to the Windows Shared Hosting module from service nodes, run the script as follows:
# ./clean-up-wsh-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 Odin Automation installation.
After this step is completed, you can manually remove these nodes from Odin Automation and decommission them if needed. Be sure not to remove database service nodes that might be used by WebHosting Plesk after migration.
Step 4. Uninstalling Windows Shared Hosting module
Note: During this step, the pa-agent and pau services will be restarted.
To remove all packages related to the Windows Shared Hosting module from the internal repository on the management node, run the script as follows:
# ./clean-up-wsh-module.py [--check-only] uninstall-module
Where:
[--check-only] is an optional parameter that performs all checks without making any changes to the Odin Automation installation.
The outcome
After all cleanup steps are performed, it will be possible to upgrade Odin Automation to Odin Automation 8.0. All items related to the Windows Shared Hosting module will be removed from Odin Automation:
- Service templates will be disabled.
- Subscriptions, including websites, databases, and applications, will be removed from Odin Automation. Note that the removal of databases may affect the content of websites that were migrated to WebHosting Plesk.
- Service nodes will be detached.
- The Windows Shared Hosting module will be removed.
Internal content