MetaDefender Distributed Cluster Worker

Ignition file

The ignition file is required only for a clean installation.

The following fields are essential for the ignition file:

  • secure.connection_key
  • secure.private_key
  • secure.certificate

To install MetaDefender Distributed Cluster (MDDC) Worker server, ignition file in YML format is required at the following location:

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

The ignition file includes fields:

Key pathValue typeAccepted valuesRequiredDescription
secure.connection_keyStringA string from 4 to 64 character long containing digits from 0 to 9 and characters from a/A to z/ZRequired

An arbitrary string that enables clients to connect to the server.

Use this value as input when adding a MDDC Worker in the UI of the MDDC Control Center.

secure.private_keyStringRequiredContent of private key in X509 format.
secure.certificateStringRequiredContent of certificate in X509 format.
rest.hostStringOptional

IP address (V4/V6) or host where the server resides on. Default value is '*'

Notes: value '*'allows the service to accept connections from all network interfaces.

To bind the service to a specific interface, specify its IP address or domain name. For example, to listen on all IPv4 interfaces, set the host to 0.0.0.0

rest.portNumberA string from 4 to 64 character long containing digits from 0 to 9 and characters from a/A to z/ZOptionalThe port where the server resides on. Default value is 8893
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.

Configuration file

After successfully installing, MDDC Worker generates a configuration file with changeable settings at the following location::

  • Windows: C:\Program Files\OPSWAT\MetaDefender Distributed Cluster Worker\mddc_worker.yml
  • Linux: /etc/mddc-worker/mddc_worker.yml

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

Sample

OpenSSL or a similar tool (e.g., ssh-keygen) can create a pair of public and private keys in X509 format.
YAML
Copy
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
Next to read:
MetaDefender Distributed Cluster Control Center
On This Page
MetaDefender Distributed Cluster WorkerIgnition fileConfiguration fileSample