Cortex Configuration Options
The following are boot-time configuration options for the cell. See Configuring a Cell for details on how to set these options.
aha:admin
An AHA client certificate CN to register as a local admin user.
- Type
string
- Environment Variable
SYN_CORTEX_AHA_ADMIN
- Command Line Argument
--aha-admin
aha:leader
The AHA service name to claim as the active instance of a storm service.
- Type
string
- Environment Variable
SYN_CORTEX_AHA_LEADER
- Command Line Argument
--aha-leader
aha:name
The name of the cell service in the aha service registry.
- Type
string
- Environment Variable
SYN_CORTEX_AHA_NAME
- Command Line Argument
--aha-name
aha:network
The AHA service network. This makes aha:name/aha:leader relative names.
- Type
string
- Environment Variable
SYN_CORTEX_AHA_NETWORK
- Command Line Argument
--aha-network
aha:registry
The telepath URL of the aha service registry.
- Type
['string', 'array']
- Environment Variable
SYN_CORTEX_AHA_REGISTRY
aha:svcinfo
An AHA svcinfo object. If set, this overrides self discovered Aha service information.
- Type
object
- Properties
The object expects the following properties:
{ "properties": { "urlinfo": { "properties": { "host": { "type": "string" }, "port": { "type": "integer" }, "schema": { "type": "string" } }, "required": [ "host", "port", "scheme" ], "type": "object" } }, "required": [ "urlinfo" ] }
- Environment Variable
SYN_CORTEX_AHA_SVCINFO
auth:anon
Allow anonymous telepath access by mapping to the given user name.
- Type
string
- Environment Variable
SYN_CORTEX_AUTH_ANON
- Command Line Argument
--auth-anon
auth:passwd
Set to <passwd> (local only) to bootstrap the root user password.
- Type
string
- Environment Variable
SYN_CORTEX_AUTH_PASSWD
- Command Line Argument
--auth-passwd
axon
A telepath URL for a remote axon.
- Type
string
- Environment Variable
SYN_CORTEX_AXON
- Command Line Argument
--axon
backup:dir
A directory outside the service directory where backups will be saved. Defaults to ./backups in the service storage directory.
- Type
string
- Environment Variable
SYN_CORTEX_BACKUP_DIR
- Command Line Argument
--backup-dir
cell:ctor
An optional python path to the Cell class. Used by stemcell.
- Type
string
- Environment Variable
SYN_CORTEX_CELL_CTOR
- Command Line Argument
--cell-ctor
cell:guid
An optional hard-coded GUID to store as the permanent GUID for the cell.
- Type
string
- Environment Variable
SYN_CORTEX_CELL_GUID
- Command Line Argument
--cell-guid
cron:enable
Enable cron jobs running.
- Type
boolean
- Default Value
True
- Environment Variable
SYN_CORTEX_CRON_ENABLE
- Command Line Argument
--cron-enable
dmon:listen
A config-driven way to specify the telepath bind URL.
- Type
['string', 'null']
- Environment Variable
SYN_CORTEX_DMON_LISTEN
http:proxy
An aiohttp-socks compatible proxy URL to use storm HTTP API.
- Type
string
- Environment Variable
SYN_CORTEX_HTTP_PROXY
- Command Line Argument
--http-proxy
https:headers
Headers to add to all HTTPS server responses.
- Type
object
- Environment Variable
SYN_CORTEX_HTTPS_HEADERS
https:port
A config-driven way to specify the HTTPS port.
- Type
['integer', 'null']
- Environment Variable
SYN_CORTEX_HTTPS_PORT
inaugural
Data used to drive configuration of the Cell upon first startup.
- Type
object
- Properties
The object expects the following properties:
{ "defs": { "role": { "additionalProperties": false, "properties": { "name": { "pattern": "^(?!all$).+$", "type": "string" }, "rules": { "items": { "$ref": "#/properties/inaugural/defs/rule" }, "type": "array" } }, "required": [ "name" ], "type": "object" }, "rule": { "items": [ { "type": "boolean" }, { "items": { "type": "string" }, "type": "array" } ], "maxItems": 2, "minItems": 2, "type": "array" }, "user": { "additionalProperties": false, "properties": { "admin": { "default": false, "type": "boolean" }, "email": { "type": "string" }, "name": { "pattern": "^(?!root$).+$", "type": "string" }, "roles": { "items": { "type": "string" }, "type": "array" }, "rules": { "items": { "$ref": "#/properties/inaugural/defs/rule" }, "type": "array" } }, "required": [ "name" ], "type": "object" } }, "properties": { "roles": { "items": { "$ref": "#/properties/inaugural/defs/role" }, "type": "array" }, "users": { "items": { "$ref": "#/properties/inaugural/defs/user" }, "type": "array" } } }
- Environment Variable
SYN_CORTEX_INAUGURAL
jsonstor
A telepath URL for a remote jsonstor.
- Type
string
- Environment Variable
SYN_CORTEX_JSONSTOR
- Command Line Argument
--jsonstor
layer:lmdb:map_async
Set the default lmdb:map_async value in LMDB layers.
- Type
boolean
- Default Value
True
- Environment Variable
SYN_CORTEX_LAYER_LMDB_MAP_ASYNC
- Command Line Argument
--layer-lmdb-map_async
layer:lmdb:max_replay_log
Set the max size of the replay log for all layers.
- Type
integer
- Default Value
10000
- Environment Variable
SYN_CORTEX_LAYER_LMDB_MAX_REPLAY_LOG
- Command Line Argument
--layer-lmdb-max_replay_log
layers:lockmemory
Should new layers lock memory for performance by default.
- Type
boolean
- Default Value
False
- Environment Variable
SYN_CORTEX_LAYERS_LOCKMEMORY
- Command Line Argument
--layers-lockmemory
layers:logedits
Whether nodeedits are logged in each layer.
- Type
boolean
- Default Value
True
- Environment Variable
SYN_CORTEX_LAYERS_LOGEDITS
- Command Line Argument
--layers-logedits
max:nodes
Maximum number of nodes which are allowed to be stored in a Cortex.
- Type
integer
- Environment Variable
SYN_CORTEX_MAX_NODES
mirror
A telepath URL for our upstream mirror (we must be a backup!).
- Type
string
- Environment Variable
SYN_CORTEX_MIRROR
- Command Line Argument
--mirror
modules
A list of module classes to load.
- Type
array
- Default Value
[]
- Environment Variable
SYN_CORTEX_MODULES
nexslog:async
(Experimental) Map the nexus log LMDB instance with map_async=True.
- Type
boolean
- Default Value
False
- Environment Variable
SYN_CORTEX_NEXSLOG_ASYNC
- Command Line Argument
--nexslog-async
nexslog:en
Record all changes to the cell. Required for mirroring (on both sides).
- Type
boolean
- Default Value
True
- Environment Variable
SYN_CORTEX_NEXSLOG_EN
- Command Line Argument
--nexslog-en
provenance:en
Enable provenance tracking for all writes.
- Type
boolean
- Default Value
False
- Environment Variable
SYN_CORTEX_PROVENANCE_EN
- Command Line Argument
--provenance-en
storm:interface:scrape
Enable Storm scrape interfaces when using $lib.scrape APIs.
- Type
boolean
- Default Value
True
- Environment Variable
SYN_CORTEX_STORM_INTERFACE_SCRAPE
- Command Line Argument
--storm-interface-scrape
storm:interface:search
Enable Storm search interfaces for lookup mode.
- Type
boolean
- Default Value
True
- Environment Variable
SYN_CORTEX_STORM_INTERFACE_SEARCH
- Command Line Argument
--storm-interface-search
storm:log
Log storm queries via system logger.
- Type
boolean
- Default Value
False
- Environment Variable
SYN_CORTEX_STORM_LOG
- Command Line Argument
--storm-log
storm:log:level
Logging log level to emit storm logs at.
- Type
['integer', 'string']
- Default Value
'INFO'
- Environment Variable
SYN_CORTEX_STORM_LOG_LEVEL
tls:ca:dir
An optional directory of CAs which are added to the TLS CA chain for Storm HTTP API calls.
- Type
string
- Environment Variable
SYN_CORTEX_TLS_CA_DIR
- Command Line Argument
--tls-ca-dir
trigger:enable
Enable triggers running.
- Type
boolean
- Default Value
True
- Environment Variable
SYN_CORTEX_TRIGGER_ENABLE
- Command Line Argument
--trigger-enable