MetaDefender Distributed Cluster Identity Service

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
  • database.host
  • database.port
  • database.user
  • database.password

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

  • Windows: C:\opswat\mddc_identity_service.yml
  • Linux: /etc/opswat/mddc_identity_service.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 for the key identity.connection_key in configuration file of MetaDefender Distributed Cluster Control Center.

secure.private_keyStringRequiredContent of private key in X509 format.
secure.certificateStringRequiredContent of certificate in X509 format.
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.
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.portNumberOptionalThe port where the server resides on. Default value is 8891
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.
user.nameStringOptionalUser name for the initial administrator user account.
user.passwordStringOptionalPassword for the initial administrator user account.
user.emailStringBasic email format, a string starts with non whitespace/non @ characters, contains one @symbol, and ends with non whitespace/non @ characters.OptionalE-mail address for the initial administrator user account.
user.apikeyStringstring of exactly 36 characters composed of uppercase and lowercase letters (A-Z, a-z) and digits (0-9)OptionalAPI key for the initial administrator user account.

Configuration file

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

  • Windows: C:\Program Files\OPSWAT\MetaDefender Distributed Cluster Identity Service\mddc_identity_service.yml
  • Linux: /etc/mddc-identity-service/mddc_identity_service.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.

OpenSSL or a similar tool (e.g., ssh-keygen) can create a pair of public and private keys in X.509 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 Worker
On This Page
MetaDefender Distributed Cluster Identity ServiceIgnition fileConfiguration fileSample