Linux

Overview

This section describes how to install and configure MetaDefender (MD) Cluster Identity Service on supported Linux distributions. After installation, MD Cluster Control Center can connect to MD Cluster Identity and monitor its system health.

Prerequisites

Before installing the MD Cluster Identity Service, ensure the following requirements are met.

RequirementDescription
Operating SystemUbuntu 22.04+, Debian 12+, Rocky 9+, or RHEL 9+.
PrivilegesRoot or sudo privileges
Installation packageDebian/Ubuntu: md-cluster-identity-service_<version>-1_amd64.deb Rocky/RHEL: md-cluster-identity-service-<version>-1.x86_64.rpm
Network access

Required port is open (default port: 8891).

A minimum network bandwidth of 1 Gbps is required.

Disk spaceA minimum of 50 GB of available disk space is required.

Create the ignition file

Create an ignition file in YAML format. This file contains the credentials required for the service to connect to the system.

The file must include the following keys:

KeyDescription
database.hostIP address or domain name of the server hosting PostgreSQL.
database.portIP address or domain name of the server hosting PostgreSQL.
database.userPostgreSQL server user. SUPERUSER privileges are required to set up the database and extensions during the initial configuration.
database.passwordPostgreSQL user password.
secure.connection_keyA 4–64 character alphanumeric string (a–z, A–Z, 0–9) used by MD Cluster Control Center to connect to the server.
secure.private_keyThe content of private key in X509 format.
secure.certificateThe content of certificate in X509 format.

Example ignition file:

YAML
Copy

Save the ignition file to the following path on the target machine:

Bash
Copy

The ignition file contains sensitive credentials. This file can be safely deleted any time after the installation is complete.

Install the service

  1. Copy the installer file (.deb or .rpm) to the target machine.
  2. Open Terminal.
  3. Run the following command to start the installation:
Bash
Copy

Verify the service status

  1. Open Terminal and run the following command:
Bash
Copy
  1. Check the active (running) field in the output.
  2. If the service is not running, start it manually:
Bash
Copy
  1. To ensure the service starts automatically at system boot:
Bash
Copy

Service management

ActionCommand
Check service statussudo systemctl status md-cluster-identity-service
Start servicesudo systemctl start md-cluster-identity-service
Stop servicesudo systemctl stop md-cluster-identity-service
Restart servicesudo systemctl restart md-cluster-identity-service
Enable service at bootsudo systemctl enable md-cluster-identity-service

Customize the service configuration

During installation, MD Cluster Identity Service generates a configuration file at:

Bash
Copy

To customize the service behavior:

  1. Open the configuration file in a text editor such as nano.
Bash
Copy
  1. Modify the required settings according to your environment.
  2. Save the changes.
  3. Restart the service to apply the new settings.
Bash
Copy

Directory structure

  • /etc/opswat/md_cluster_identity_service.yml: Service Ignition file.
  • /etc/md-cluster-identity-service/md_cluster_identity_service.yml: Service configuration file.
  • /var/log/md-cluster-identity-service/: Default log directory.
  • /var/lib/md-cluster-identity-service/: Contains persistent data required for the service to maintain state across reboots.

Log files

To check the service logs, open the file: /var/log/md-cluster-identity-service/identity-service.log

To check the system log, run the following in Terminal:

Bash
Copy

Uninstall the service

Bash
Copy

Troubleshooting

A. Service is not running

  1. Check the service status
Bash
Copy
  1. Start the service if it is not running:
Bash
Copy

B. Installation fails

Possible causes

  • Insufficient privileges.
  • Missing dependencies.

Solution

  • Ensure the installation command is executed with sudo.
  • Ensure dependencies are installed.

C. MD Cluster Control Center cannot connect to MD Cluster Identity Service.

Possible causes

  • Network connectivity issues.
  • Firewall restrictions.
  • PostgreSQL database connectivity issues

Solution

  • Ensure MD Cluster Control Center has network connectivity to MD Cluster Identity Service.
  • Verify that firewall rules allow inbound and outbound connections.
  • Verify PostgreSQL database connectivity and credentials in the ignition file.

Ignition file key reference

  • database.host (Required)

    • Value type: string.
    • Description: IP address or domain name of the server hosting PostgreSQL.

  • database.port (Required)

    • Value type: integer.
    • Description: PostgreSQL server port (default: 5432).

  • database.user (Required)

    • Value type: string.
    • Description: PostgreSQL server user. SUPERUSER privileges are required to set up the database and extensions during the initial configuration.

  • database.password (Required)

    • Value type: string.
    • Description: PostgreSQL user password.

  • secure.connection_key (Required)

    • Value type: string.
    • Description: Use a 4–64 character string that contains only numbers (0–9) and letters (a–z, A–Z). This string is used by clients to connect to the server. Set this value as the identity.connection_key in the MD Cluster Control Center configuration file.

  • secure.private_key (Required)

    • Value type: string.
    • Description: The content of private key in X509 format.

  • secure.certificate (Required)

    • Value type: string.
    • Description: The content of certificate in X509 format.
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
Next to read:
MD Cluster Control Center
null
On This Page
LinuxOverviewPrerequisitesCreate the ignition fileInstall the serviceVerify the service statusService managementCustomize the service configurationDirectory structureLog filesUninstall the serviceTroubleshootingIgnition file key reference