MetaDefender Distributed 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 Distributed Cluster Control (MDDC) 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 fields:

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.

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

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

Configuration file

After successfully installing, MDDC 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

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 MDDC Identity Service.

YAML
    
 
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}
Copy

Last updated on

Was this page helpful?