MetaDefender Cluster Control Center

Ignition file

The ignition file is required only for a clean installation.

The following fields are essential for the ignition file:

  • identity.host
  • identity.port
  • identity.connection_key
  • database.host
  • database.port
  • database.user
  • database.password
  • secure.encryption_key

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

  • Windows: C:\opswat\md_cluster_control_center.yml
  • Linux: /etc/opswat/md_cluster_control_center.yml

The ignition file includes fields:

Key pathValue typeAccepted valuesRequiredDescription
identity.hostStringRequiredIP address of the server where MD Cluster Identity Service server locates.
identity.portStringRequiredPort of MD Cluster Identity Service server is listening for connections from clients.
identity.connection_keyStringA string from 4 to 64 character long containing digits from 0 to 9 and characters from a/A to z/ZRequiredThe access key required to connect to the MD Cluster Identity Service server, ensuring it matches the value used by the server.
database.hostStringRequiredIP address / domain name of the server where PostgreSQL server locates.
database.portNumberRequiredPort of PostgreSQL server is listening for connections from clients.
database.userStringRequired

PostgreSQL server's user.

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

database.passwordStringRequiredPostgreSQL server's user credentials.
secure.encryption_keyStringA 32-character plain text composed of characters 'a'-'z' and digits '0'-'9'.RequiredThe encryption key is used to encrypt the sensitive data in the database.
rest.portNumberOptionalThe port where the server resides on. Default value is 8892
rest.log_pathStringOptionalLocation where logs are written.
rest.log_levelString
  • dump
  • debug
  • info
  • warning
  • error
OptionalLevel of log message.
log.streams[@].log_typeString
  • file
  • syslog
OptionalType of log device.
log.streams[@].log_levelString
  • dump
  • debug
  • info
  • warning
  • error
OptionalLevel of log message.
log.streams[@].log_pathString

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).
OptionalLocation where logs are written.

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

It may prevent MD Cluster API Gateway from successfully establishing a connection to MD Cluster Identity Service.

Configuration file

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

  • Windows: C:\Program Files\OPSWAT\MetaDefender Cluster Control Center\md_cluster_control_center.yml
  • Linux: /etc/md-cluster-control-center/md_cluster_control_center.yml

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

Sample

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 MD Cluster Identity Service.
YAML
Copy
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
Next to read:
Container-Based Setup
On This Page
MetaDefender Cluster Control CenterIgnition fileConfiguration fileSample