MetaDefender Distributed Cluster Control Center

Ignition file

Info

The ignition file is required only for a fresh installation.

To install MetaDefender Distributed Cluster Control Center server, ignition file in YML format is required at the following location:

  • Windows: C:\opswat\mddc_control_center.yml

  • Linux: /etc/opswat/mddc_control_center.yml

The ignition file includes keys

Key path

Value type

Accepted values

Required

Description

identity.host

string


required

IP address of the server where MDDC Identity Service server locates.

identity.port

string


required

Port of MDDC Identity Service server is listening for connections from clients.

identity.connection_key

string

  • A string from 4 to 64 character long containing digits from 0 to 9 and characters from a/A to z/Z

required

The access key required to connect to the MDDC Identity Service server, ensuring it matches the value used by the server.

database.host

string


required

IP address / domain name of the server where PostgreSQL server locates.

database.port

number


required

Port of PostgreSQL server is listening for connections from clients.

database.user

string


required

PostgreSQL server's user.

SUPERUSER privilege is required to setup the server's database and extensions for the first time.

database.password

string


required

PostgreSQL server's user credentials.

secure.encryption_key

string

A 32-character plain text composed of characters 'a'-'z' and digits '0'-'9'.

required

The encryption key is used to encrypt the sensitive data in the database.

rest.port

number


optional

The port where the server resides on. Default value is 8892

rest.log_path

string


optional

Location where logs are written.

rest.log_level

string

  • dump

  • debug

  • info

  • warning

  • error

optional

Level of log message.

log.streams[@].log_type

string

  • file

  • syslog

optional

Type of log device.

log.streams[@].log_level

string

  • dump

  • debug

  • info

  • warning

  • error

optional

Level of log message.

log.streams[@].log_path

string

If log.streams[@].log_type is "file" then log.streams[@].log_path is the path to a file on file system where logs are written.

If log.streams[@].log_type is "syslog" then

  • log.streams[@].log_path can be [tcp/udp]://host:port where host:port is the host and port to a remote syslog server that supports TCP or UDP protocol.

  • log.streams[@].log_path can be "local" to write log to local syslog server (Linux only).

optional

Location where logs are written.

Warning

Avoid using the loopback IP address (such as localhost or 127.0.0.1 ) for key identity.host .

It may prevent the MetaDefender Distributed Cluster API Gateway from successfully establishing a connection to MetaDefender Distributed Cluster Identity Service.

Configuration file

After successfully installing, MetaDefender Distributed Cluster Control Center generates a configuration file with changeable settings at the following location:

  • Windows: C:\Program Files\OPSWAT\MetaDefender Distributed Cluster Control Center\mddc_control_center.yml

  • Linux: /etc/mddc-control-center/mddc_control_center.yml

Info

The service must be restarted to take the new configurations into effect.

Sample

Warning

database.host, database.port, database.user, and database.password should be updated with the appropriate values of your Postgres host/IP, port, username, and password.

identity.host should be updated with the appropriate host or IP of your MetaDefender Distributed Cluster Identity Service.

database: host: "your_postgres_host_ip" port: 5432 user: "your_postgres_username" password: "your_postgres_admin_password" identity: host: "your_mddc_identity_service_host_ip" port: 8891 connection_key: "1234abcd" secure: encryption_key: "12345678123456781234567812345678" # [a-z0-9]{32}