Configuration¶

The service allowed two variant of configuration:

use the Configurator service

use the configuration file

The service reads settings from the configuration file by default.

You can specify the –luna-config option for pulling settings from the Configurator service, see configurator.

Auto reload configuration¶

The service supports an auto-reload of configurations. You can enable this feature by specifying a config-reload option in the command line. The service periodically checks new settings. If current settings and new pulled settings are the same the service will not perform any actions. You can specify the check period in the pulling-time command line argument (10 seconds by default).

If a configuration fetching has failed, the service will work without applying any changes to the existing configurations.

If check connections with the new configuration have failed, the service will retry pulling new configuration after pulling-time seconds. The service will shut down after 10 failed attempts.

Warning

Service can work incorrectly while the new settings are being applied. It is strongly recommended not to send requests to the service when you change important settings (database credentials, work plugins list, and others).

Configuration file for administrator¶

# LUNA Faces configuration file

[LUNA_CONFIGURATOR]

#: [integer] load configs from LUNA Configurator
USE_CONFIGURATOR = 0
#: [string] LUNA Configurator protocol, IP address, and port
LUNA_CONFIGURATOR_ORIGIN = http://127.0.0.1:5070
#: [integer] API version of the LUNA Configurator
LUNA_CONFIGURATOR_API  = 1


[LUNA_FACES_DB]

#: [string] type of database: "postgres" or "oracle"; "postgres" type is used by default
DB_TYPE = postgres
#: [string] database username
DB_USER = luna
#: [string] database password
DB_PASSWORD = luna
#: [string] database IP address
DB_HOST = 127.0.0.1
#: [integer] database listener port, 5432 - default for "postgres" type, 1521 - default for "oracle" type
DB_PORT = 5432
#: [string] database name for "postgres" type, SID name for "oracle" type
DB_NAME = luna_faces

[LUNA_FACES_DB.DB_SETTINGS]

#: [integer] database connection pool size
CONNECTION_POOL_SIZE = 5

[LUNA_ATTRIBUTES_DB]

#: [string] database password
PASSWORD =
#: [string] database IP address
HOST = 127.0.0.1
#: [integer] database listener port, 5432 - default for "postgres" type, 1521 - default for "oracle" type
PORT = 6379
#: [integer] Redis database number (0-15)
NUMBER = 0


[LUNA_ATTRIBUTES_DB.SENTINEL]

#: [string] sentinel master name
MASTER_NAME = luna_attributes
#: [list(string)] list of Redis Sentinel listeners (example [127.0.0.1:26379, 10.0.4.1:26379])
SENTINELS = []


[ATTRIBUTES_STORAGE_POLICY]

#: [integer] default time to live of temporary attributes (in seconds), default: 5 minutes
DEFAULT_TTL = 300
#: [integer] maximum time to live of temporary attributes (in seconds), default: 1 day
MAX_TTL = 86400


[LUNA_LICENSES_ADDRESS]

#: LUNA Faces protocol, IP address, and port
ORIGIN = http://127.0.0.1:5120
#: API version of the LUNA Faces
API_VERSION = 1


[LUNA_FACES_LOGGER]

#: [string] folder, where logs are saved (relative path begins in directory with application)
FOLDER_WITH_LOGS = ./
#: [string] level of debug print, by priority: "ERROR", "WARNING", "INFO", "DEBUG"
LOG_LEVEL = INFO
#: [string] time format used in log records: "LOCAL" or "UTC"
LOG_TIME = LOCAL
#: [integer] maximum log file size in megabytes before performing rotation (0 - without rotation)
MAX_LOG_FILE_SIZE = 1024
#: send log to stdout
LOG_TO_STDOUT = 1
#: send log to file
LOG_TO_FILE = 1
#: allow multiline stack trace in logs
MULTILINE_STACK_TRACE = 1


[INFLUX_MONITORING]

#: [integer] send data for monitoring to InfluxDB
SEND_DATA_FOR_MONITORING = 1
#: [string] InfluxDB 2.x workspace
ORGANIZATION =
#: [string] InfluxDB 2.x authentication token
TOKEN =
#: [string] InfluxDB 2.x bucket name
BUCKET = luna_monitoring
#: [string] InfluxDB IP address
HOST = 127.0.0.1
#: [integer] InfluxDB port
PORT = 8086
#: [integer] use HTTPS to connect to InfluxDB
USE_SSL = 0
#: [integer] frequency of sending monitoring data to InfluxDB (in seconds)
FLUSHING_PERIOD = 1


[OTHER]

#: [integer] database number; set 0 if replication is disabled; for more information see 'replication' in sphinx documentation.
DATABASE_NUMBER = 0
#: [string] default face descriptor version
DEFAULT_FACE_DESCRIPTOR_VERSION = 59
#: [integer] use materialized views; for more information see 'materialized.rst' document in 'docs\sphinx\source' folder
USE_MATERIAL_VIEWS = 0
#: [integer] maximum number of database connection checks for each request; if DB is unavailable, an error is returned; when the value <=0 is set, no checks are performed
LUNA_FACES_DB_PING_MAX_COUNT = 0
#: [string] time format used in database records: "LOCAL" or "UTC"
STORAGE_TIME = LOCAL
#: list of active plugins
LUNA_FACES_ACTIVE_PLUGINS = []

Extended administrator configuration¶

Module contains constants.

configs.config.BACKGROUND_REMOVAL_BATCH_SIZE = 10000¶: objects’ bath size for background removal

configs.config.DB_CONNECT_TIMEOUT = 5¶: Connection timeout for database in seconds

configs.config.DELETE_REQUEST_MAX_SIZE = 10000¶: max items what can be deleted for one deletion request on /faces/extended

configs.config.MAX_FACES_COUNT_TO_REEXTRACT_OR_GC = 1000¶: max descriptors count to removing at once

configs.config.MAX_JSON_ARRAY_SIZE = 1000¶: max size of any array in any json in incoming request