Distributed Deployment

Owned by SUPPORT
Last updated: Nov 05, 2024
6 min read

1. Application Server Installation

1.1 Application Server Hardware requirements

Storage

  • Applications Services basic storage

50G storage space is necessary for the installation of the application, which will be used for the storage of images and all kinds of log information.

  • Applications Files storage

For file storage, we support two methods: local storage and object storage. The necessary hard drive space largely depends on your usage, the size, and number of attachments that you receive through your conversations etc.

Consider using an object storage option provided by AWS, Azure etc., if you want to stay flexible and accommodate the growing storage requirements. CloudCX also supports other S3 API compatible services, for example: Minio.

Note: Local storage is recommended to be selected only in the test environment or if there is no large capacity expansion requirement in the future. We recommend using object storage to meet the storage expansion requirements that may exist in the future.

CPU

CPU requirements are dependent on the usage and expected workload. Your workload is influenced by factors such as — but not limited to — how active your users are, how many conversations do you receive and the conversation channels which you are using.

The following is the recommended minimum CPU hardware guidance for a handful of example CloudCX conversation base sizes.

  • 4 cores is the recommended minimum number of cores and supports up to 10,000 conversations a day.

  • 8 cores supports up to 20,000 conversations a day.

  • More conversations? Consider scaling horizontally by adding more application servers.

NOTE: Each CPU core needs 2.5Ghz or Higher.

Memory

Memory requirements are dependent on the usage and expected workload. Your workload is influenced by factors such as — but not limited to — How active your users are, how many conversations do you receive and the conversation channels which you are using.

The following is the recommended minimum Memory hardware guidance for a handful of example CloudCX conversation base sizes.

  • 8 GB RAM is the required minimum memory size and supports up to 10,000 conversations a day.

    • We are always working to reduce the memory requirement.

  • 16 GB RAM supports up to 20,000 conversations a day.

  • More conversations? Consider scaling horizontally by adding more application servers.

Note: Add at least 1GB of swap memory to the machine to ensure that the machine doesn't run out of resources during an upgrade.

1.2 Preparing the Linux Host Machine

Tasks that MUST be completed before installing CloudCX application

  • If the Linux on which CloudCX will be installed is located in a LAN, assign a static LAN IP address; if it's in a public network, please assign a static IP address to the public network.

  • Install all available updates & service packs before installing CloudCX.

  • Do not install PostgreSQL on your CloudCX Server.

  • Ensure that all power-saving options for your System and Network adapters are disabled (by setting the system to High Performance).

  • Do not install TeamViewer, VPN, and other similar software on the host machine.

  • CloudCX must NOT be installed on a host that is a DNS or DHCP server.

  • Port must be permitted by your firewall: TCP: 9006, 9001, 443

  • Please also ensure the above ports have not been used by other applications.

  • Ensure server date-time is synced correctly, how to check date-time?

  • Ensure the server must have at least 8G of memory.

  • Please reserve 50G space to install & use the CloudCX application.

  • Should perform all Linux commands by the root user, please su root First.

1.3 Installation Steps of Application Server

1.3.1 Make directory and change directory

mkdir -p /opt/cloud_cx/ && cd /opt/cloud_cx/

1.3.2 Download install scripts

curl https://raw.githubusercontent.com/cloud-cx/cloudfon-cx-install/main/v4.0.0/cloud_cx_ctl.sh -o cloud_cx_ctl.sh
curl https://raw.githubusercontent.com/cloud-cx/cloudfon-cx-install/main/v4.0.0/install_docker_cx.sh -o install_docker_cx.sh

1.3.3 Install docker environment and configure firewall.

1.3.4 Install CX Application Service

1.3.5 Login and configure the CloudCX.

Open Browser, input “https://host:9006/”, the “host” is the IP address or domain name of your CloudCX server (Linux Server). 

1.3.6 CX Control Commands

  • Show CloudCX services status

  • Restart CloudCX services

  • Restart the selected service of CloudCX

  • Stop CloudCX Services

  • Stop the selected service of CloudCX

  • Start CloudCX Services

  • Start the selected service of CloudCX

  • Uninstall CloudCX Services

2. Midware Server (MariaDB & Redis) Installation

2.1 Midware Server Hardware requirements

Midware Server includes database and caching services, default database is MariaDB and the caching service is Redis. Normally, they will be deployed on the same server. You can install it with one click according to our Midware Service installation script.

Storage

The server running MariaDB & Redis should have at least 10 GB of storage available, though the exact requirements depend on the usage of your CloudCX Instance.

CPU

The server running MariaDB & Redis should have at least 4 cores of CPU, though the exact requirements depend on the usage of your CloudCX Instance.

Memory

The server running MariaDB & Redis should have at least 8 GB of RAM, though the exact requirements depend on the usage of your CloudCX Instance.

2.2 Preparing the Linux Host Machine

Tasks that MUST be completed before installing CloudCX Midware:

  • If the Linux on which Midware will be installed is located in a LAN, assign a static LAN IP address; if it's in a public network, please assign a static IP address to the public network.

  • Install all available updates & service packs before installing Midware.

  • Do not install PostgreSQL on your Midware Server.

  • Ensure that all power-saving options for your System and Network adapters are disabled (by setting the system to High Performance).

  • Do not install TeamViewer, VPN, and other similar software on the host machine.

  • Midware must NOT be installed on a host that is a DNS or DHCP server.

  • Ensure server date-time is synced correctly, how to check date-time?

  • Ensure the server must have at least 8G of memory.

  • Please reserve at least 10G space to install the Midware application.

  • Midware recommends deploying on the same LAN as the CloudCX application server(It's best to use the same switch in the cloud)

  • Mideware can also be deployed under different switches in the cloud, which requires exposing the ports of the database and Redis. Firewall policies can be added to control that only CloudCX application servers are allowed to access.

2.3 Midware Server Installation Steps

  • Make directory and change directory

  • Download install scripts

  • Install docker environment and configure firewall.

  • Install CX Midware Services

3. Uninstall CloudCX

Please use the below steps to uninstall the CloudCX for Linux.

Uninstall the CX

Stop and delete the CX Docker instances.