Installation

Overview

This section describes how to install and set up MetaDefender Cluster (MD Cluster), a distributed system composed of multiple services, including:

  • Redis
  • RabbitMQ
  • PostgreSQL
  • MetaDefender Cluster File Storage (MD Cluster File Storage)
  • MetaDefender Cluster Identity (MD Cluster Identity)
  • MetaDefender Cluster Control Center (MD Cluster Control Center)
  • MetaDefender Cluster Worker (MD Cluster Worker)

MD Cluster can be deployed on virtual machines or physical servers. After installation, all services are connected to MD Cluster Control Center, where licensing is activated and system health is monitored.

Architecture Overview

MD Cluster consists of the following components:

ComponentDefault portDescription
Redis6379Caching and fast data access
RabbitMQ5672Message broker
PostgreSQL5432Persistent data storage
MD Cluster File Storage8890File storage service
MD Cluster Identity Service8891Authentication and authorization service
MD Cluster Control Center8892Central control and management
MD Cluster Worker8893Instance lifecycle management

All other services must be connected to MD Cluster Control Center for the system to function correctly.

Prerequisites

Ensure the following requirements are met before starting the installation.

RequirementDescription
Deployment typeVirtual machines or physical servers.
PrivilegesAdministrator privileges on Windows; Root or sudo access on Linux
NetworkAll nodes must be able to communicate with each other
PortRequired ports for Redis, RabbitMQ, PostgreSQL, and MD Cluster services must be open
Time synchronizationNTP must be configured across all nodes
ResourcesAdequate CPU, RAM, and disk for each service

Ensure that firewall rules allow communication between all services (Redis, RabbitMQ, PostgreSQL, and MD Cluster services).

Installation procedure

Step 1: Install infrastructure services

Install the required third-party services on designated nodes.

  1. Install Redis on Windows, Linux, or Air-gapped.
  2. Install RabbitMQ on Windows, Linux, or Air-gapped.
  3. Install PostgreSQL on Windows, Linux, or Air-gapped.

Ensure all services are installed and running before proceeding to the next step.

Step 2: Install and setup core MD Cluster services

  1. Install MD Cluster File Storage on Windows or Linux.
  2. Install MD Cluster Identity Service on Windows or Linux.
  3. Install MD Cluster Control Center on Windows or Linux.
  4. Setup Data Lake and Warehouse.

Step 3: Connect services to Control Center

After installation, register all infrastructure services and MD Cluster File Storage to Control Center.

  1. Sign in to MD Cluster Control Center console using your administrator account.
  2. From the sidebar, go to Inventory > Services.
  3. Follow the instructions to add the services.
  4. Verify connectivity to
    1. PostgreSQL (including DataLake and Data Warehouse)
    2. File Storage
    3. RabbitMQ
    4. Redis

Step 4: Install and register MD Cluster Worker

  1. Follow the instructions to obtain the installation script.
  2. Access each target machine and run the script.
  3. Sign in to MD Cluster Control Center console.
  4. From the sidebar, go to Inventory > Workers.
  5. Verify that the installed workers are showing as Available.

Step 5: Submit execution installers

Execution installers are deployable units managed by MD Cluster Worker, responsible for executing defined processing tasks within the system’s main flow. These installers are:

  • MetaDefender Core (MD Core)
  • MetaDefender Cluster API Gateway (MD Cluster API Gateway)
  • MetaDefender Cluster Callback Service (MD Cluster Callback Service)

Typical steps:

  1. Sign in to MD Cluster Control Center console using your administrator account.
  2. From the sidebar, go to Inventory > Installers.
  3. Follow the instructions to upload the installers.

While MD Core and MD Cluster API Gateway are essential to the main flow, MD Cluster Callback Service is optional and only needed when scan results are delivered via webhooks.

Step 6: Deploy execution instances

  1. Sign in to MD Cluster Control Center console.
  2. From the sidebar, go to Inventory > Workers.
  3. Ensure that MD Cluster Workers are showing as Available.
  1. Follow the instructions to deploy execution instances.
  2. Verify that all instances are successfully deployed.

At least one instance of MD Cluster API gateway and MD Core must be deployed on MD Cluster Workers for the system to function fully.

Step 7: Activate license

  1. Sign in to MD Cluster Control Center console.
  2. From the sidebar, go to Inventory > License
  3. Follow the instructions to activate the product according to your license type.
  4. Confirm activation.

Step 8: Verify system activity

After licensing, verify system status.

  1. Submit file to MD Cluster API Gateway.
  2. Sign in to the MD Cluster Control Center console.
  3. Go to History > Processing and confirm that the files has been processed

Log files

PlatformServiceLog location
WindowsMD Cluster Control CenterC:\Program Files\OPSWAT\MetaDefender Cluster Control Center\data\log\control-center.log
LinuxMD Cluster Control Centervar/log/md-cluster-control-center/control-center.log
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
Next to read:
PostgreSQL
null
On This Page
InstallationOverviewArchitecture OverviewPrerequisitesInstallation procedureLog filesStep 1: Install infrastructure servicesStep 2: Install and setup core MD Cluster servicesStep 3: Connect services to Control CenterStep 4: Install and register MD Cluster WorkerStep 5: Submit execution installersStep 6: Deploy execution instancesStep 7: Activate licenseStep 8: Verify system activity