AhaCell 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_AHACELL_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_AHACELL_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_AHACELL_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_AHACELL_AHA_NETWORK

Command Line Argument

--aha-network

aha:registry

The telepath URL of the aha service registry.

Type

['string', 'array']

Environment Variable

SYN_AHACELL_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_AHACELL_AHA_SVCINFO

aha:urls

A list of all available AHA server URLs.

Type

['string', 'array']

Environment Variable

SYN_AHACELL_AHA_URLS

auth:anon

Allow anonymous telepath access by mapping to the given user name.

Type

string

Environment Variable

SYN_AHACELL_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_AHACELL_AUTH_PASSWD

Command Line Argument

--auth-passwd

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_AHACELL_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_AHACELL_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_AHACELL_CELL_GUID

Command Line Argument

--cell-guid

dmon:listen

A config-driven way to specify the telepath bind URL.

Type

['string', 'null']

Environment Variable

SYN_AHACELL_DMON_LISTEN

https:headers

Headers to add to all HTTPS server responses.

Type

object

Environment Variable

SYN_AHACELL_HTTPS_HEADERS

https:port

A config-driven way to specify the HTTPS port.

Type

['integer', 'null']

Environment Variable

SYN_AHACELL_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_AHACELL_INAUGURAL

mirror

A telepath URL for our upstream mirror (we must be a backup!).

Type

string

Environment Variable

SYN_AHACELL_MIRROR

Command Line Argument

--mirror

nexslog:async

(Experimental) Map the nexus log LMDB instance with map_async=True.

Type

boolean

Default Value

False

Environment Variable

SYN_AHACELL_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

False

Environment Variable

SYN_AHACELL_NEXSLOG_EN

Command Line Argument

--nexslog-en