VM Setup

Setup order requirement

MetaDefender Distributed Cluster consists of the following components along with their corresponding default ports.

The system administrator should adhere to the following service installation sequence to prevent conflicts:

1. Install Redis, RabbitMQ, Postgres, MDDC File Storage, MDDC Identity Service.
2. Install MDDC Control Center.
3. Install MDDC Worker on the targeted machines (for deploying MDDC API Gateway or MetaDefender Core).

Install Redis Caching Server

1. Follow steps to install Redis Caching server.
2. Access Redis configuration file/etc/redis/redis.conf for editing.
3. Comment out the bind setting and set protected-mode option to no.

...

# The following line should be commented

# bind 127.0.0.1

...

# The following line should be uncommented and set to no

protected-mode no

...

4. Restart the service.

# Red Hat/Rocky

 $ sudo systemctl enable redis

 $ sudo systemctl restart redis

​

# Debian/Ubuntu

$ sudo systemctl enable redis-server

$ sudo systemctl restart redis-server

Install RabbitMQ Message Broker

Windows

1. Download Erlang and follow the instructions to install Erlang.
2. Download RabbitMQ for Windows.
3. Run the executable file as administrator, follow instructions to complete the RabbitMQ installation.
4. In Command Prompt, change working directory to <RabbitMQ installation folder>/rabbitmq_server-<version>/sbin and run the following command:

> rabbitmqctl.bat add_user <username> <password>

> rabbitmqctl.bat set_permissions -p / <username> "." "." "."

> rabbitmqctl.bat set_user_tags <username> administrator

Linux

1. Download Erlang and follow the instructions to install Erlang and its dependencies.
2. Download RabbitMQ for Red Hat/Rocky or Debian/Ubuntu .
3. In Terminal, run the following command:

# Red Hat/Rocky

$ sudo rpm -Uvh --nodeps rabbitmq-server-<rabbitmq version>.el8.noarch.rpm

$ sudo systemctl enable rabbitmq-server

$ sudo systemctl start rabbitmq-server

# Debian/Ubuntu

$ sudo dpkg -i rabbitmq-server_<rabbitmq version>_all.deb

4. In Terminal, run the following command:

$ sudo rabbitmqctl add_user <username> <password>

$ sudo rabbitmqctl set_permissions -p / <username> "." "." "."

$ sudo rabbitmqctl set_user_tags <username> administrator

Install PostgreSQL Database Server

1. Download PostgreSQL Database Server.
2. Follow steps to setup Postgres Database Server to allow connections from external applications.
3. Restart Postgres Database Server.

Install MetaDefender Distributed Cluster File Storage

1. Build Ignition file for MDDC File Storage service.
2. Start Command Prompt as Administrator on Windows or Terminal on Linux and run the following command:

# Windows

> msiexec.exe /i <mddc_file_storage_package> /qn

​

# Debian or Ubuntu

$ sudo apt -y install uuid

$ sudo dpkg -i <mddc_file_storage_package> || sudo apt install -f

​

# Red Hat or Rocky

$ sudo dnf -y install uuid

$ sudo yum install <mddc_file_storage_package> -y

3. Check the service status.

Install MetaDefender Distributed Cluster Identity Service

1. Build Ignition file for MDDC Identity Service.
2. Start Command Prompt as Administrator on Windows or Terminal on Linux and run the following command:

# Windows

> msiexec.exe /i <mddc_identity_service_package> /qn

​

# Ubuntu or Debian

$ sudo apt -y install uuid

$ sudo dpkg -i <mddc_identity_service_package> || sudo apt install -f

​

# Red Hat or Rocky

$ sudo dnf -y install uuid

$ sudo yum install <mddc_identity_service_package> -y

3. Check the service status.

Install MetaDefender Distributed Cluster Control Center

1. Build Ignition file for MDDC Control Center service.
2. Start Command Prompt as Administrator on Windows or Terminal on Linux and run the following command:

# Windows

> msiexec.exe /i <mddc_control_center_package> /qn

​

# Ubuntu or Debian

$ sudo apt -y install uuid

$ sudo dpkg -i <mddc_control_center_package> || sudo apt install -f

​

# Red Hat or Rocky

$ sudo dnf -y install uuid

$ sudo yum install <mddc_control_center_package> -y

3. Check the service status.

Setup Data Lake and Data Warehouse

1. Go to C:\Program Files\OPSWAT\MetaDefender Distributed Cluster Control Center directory in Windows Command Prompt or /usr/sbin directory in Linux Terminal.
2. Run the following command:

# Windows

> mddc-dbready.exe --host=<postgres-host> --port=<postgres-port> --user=<postgres-user> --password=<postgres-password> --target=lake,warehouse

​

# Linux (Ubuntu, Debian, Red Hat or Rocky)

$ mddc-dbready --host=<postgres-host> --port=<postgres-port> --user=<postgres-user> --password=<postgres-password> --target=lake,warehouse

Install MetaDefender Distributed Cluster Worker

You need to prepare at least 2 VMs for Worker: one for MetaDefender Core and one for API Gateway.

1. Build Ignition file for MDDC Worker service.
2. Start Command Prompt as Administrator on Windows or Terminal on Linux and run the following command:

# Windows

> msiexec.exe /i <mddc_worker_package> /qn

​

# Ubuntu or Debian

$ sudo apt -y install uuid

$ sudo dpkg -i <mddc_worker_package> || sudo apt install -f

​

# Red Hat or Rocky

$ sudo dnf -y install uuid

$ sudo yum install <mddc_worker_package> -y

3. Check the service status.
4. Repeat the above steps for other MDDC Workers.

Configurations

When all the Workers are installed successfully, it marks a completed installation. Now, heading to essential configuration steps.

Connect essential services

1. Sign in to MDDC Control Center web console with the initial administrator user account that you created in Install MetaDefender Distributed Cluster Identity Service.
2. Go to Inventory > Services and select Add Service.
3. Choose the service type and fill out the fields required by the services.
4. Click Save.

5. Check status of the service connections.

Submit MetaDefender Core and MDDC API Gateway packages

1. Sign in to MDDC Control Center web console with the initial administrator user account that you created in Install MetaDefender Distributed Cluster Identity Service.
2. Go to Inventory > Packages and select Upload package.
3. Select MetaDefender Core/MDDC API Gateway installation files.
4. Click Upload.

Connect to MDDC Workers

1. Sign in to MDDC Control Center web console with the initial administrator user account that you created in Install MetaDefender Distributed Cluster Identity Service.
2. Go to Inventory > Workers and select Add workers.
3. Complete the required fields to add new workers and select Submit.

3. Check the status of the Worker connections.

Deploy MetaDefender Core and API Gateway instances

1. Sign in to MDDC Control Center web console with the initial administrator user account that you created in Install MetaDefender Distributed Cluster Identity Service.
2. Go to Inventory > Workers and select Deploy workers.
3. Choose the workers for deployment and decide which package will be deployed on the workers.

3. Choose Next.
4. Confirm the deployment details, then click Deploy and Finish.
5. Hold off until the deployment is completed successfully.

6. Once the system is up, MDDC API Gateway can efficiently accept scan requests.