TABLE OF CONTENTS

Introduction

The Linux Qmail module is discontinued and will no longer be available for installation starting from CloudBlue Commerce 21.0. This article explains how to remove the Linux Qmail module and all related data from your CloudBlue Commerce installation.

Supported Configurations

CloudBlue Commerce 20.5 with the Linux Qmail module.

Overview of the Removal Procedure

The removal procedure in general consists of the following steps:

  1. Prepare your installation for running the removal tool.
  2. Prepare the removal tool.
  3. Remove all packages related to the Linux Qmail module and its services from your system.

Note: Orders related to the module will be automatically archived by the removal tool. To learn more about the archiving of orders, please refer to the Billing Provider Guide.

The Removal Procedure

Step 1. Preparing Your Installation for Running the Removal Tool

Prepare your installation by following the instructions in this article.

Step 2. Preparing the Removal Tool

Obtain and prepare the removal tool as described in this article. After preparing it, go to the directory where the extracted contents are.

Step 3. Deactivating Service Templates

This is an optional step, but we highly recommend performing it. Deactivate all service templates related to the Linux Qmail module to make buying and provisioning new Linux Qmail subscriptions impossible. After deactivating a service template, all service plans based on it become unavailable for purchase. To remove these service plans from online stores, you must make them unpublished and synchronize the online stores.

To deactivate all service templates related to the Linux Qmail module, run the script as follows:

# python clean-up-qmail-module.py [--check-only] deactivate-service-templates

where:

--check-only is an optional parameter. If specified, the script performs all checks without making any changes.

Step 4. 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 Linux Qmail subscriptions from online stores impossible. Note that during the synchronization, all other settings, even those that are not related 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:

# python clean-up-qmail-module.py [--check-only] synchronize-online-stores

where:

--check-only is an optional parameter. If specified, the script performs all checks without making any changes.

Step 5. Removing Packages from Service Nodes

Remove all packages related to the Linux Qmail module from service nodes by running the script as follows:

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

where:

--check-only is an optional parameter. If specified, the script performs all checks without making any changes.

Step 6. 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,backup.properties,clustering.properties,logrotate.properties,qmail_cluster.properties,drweb.properties,drweb_daemon.properties,spamassassin.properties} /mnt/brands/puitconf_d/
  3. Restart Branding UI Cluster pods.

Step 7. Removing Packages from the Management Node

Remove all packages related to the Linux Qmail module from the management node and the internal package repository by running the script as follows:

# python clean-up-qmail-module.py [--check-only] uninstall-module

where:

--check-only is an optional parameter. If specified, the script performs all checks without making any changes.

Notes:

  • 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.
  • During this step, all Linux Qmail resources will be removed from your service templates and your system.

Step 7. Unregistering Service Nodes

If the Linux Qmail service nodes are not used by other services, unregister them.

Outcome

The Linux Qmail module and its data, including mailboxes and their contents, are removed from your system.