Deadlock server: centralized “manager” of the system

The server performs the following functions:

• holds the authoritative version of the access rules - also generates the offline database for controllers
• collects access logs
• provides software updates and time synchronization for the other devices
• monitors system state (and reports it to the management UIs)
• provides an API for the outside world (and all our tools).

Except for the contents of the database, it is entirely stateless. This simplifies the code and makes replication and failover trivial.

The server is separated into 3 independent modules: deadserver (communicates with controllers), deadapi (API for the outside world), and deadaux (auxiliary jobs).

Contents:

Concepts and common abstractions:

Start here

• Introduction
• cfiles – the “common files” abstraction

Communication with controllers:

deadserver

HTTP API for the outside world:

deadapi

• Introduction
• HTTP API
• Server-sent events

Auxiliary jobs supporting the other components:

deadaux

API documentation

API documentation

• common package
  • Subpackages
  • Submodules
  • common.rules module
  • common.tag_names module
  • common.tags module
  • Module contents
• common.cfiles package
  • Submodules
  • common.cfiles.filetypes module
  • common.cfiles.fs module
  • Module contents
• common.types package
  • Submodules
  • common.types.ipaddr module
  • common.types.record module
  • common.types.serializable module
  • common.types.utils module
  • Module contents
• common.utils package
  • Submodules
  • common.utils.conversions module
  • common.utils.db module
  • common.utils.logging module
  • Module contents
• config package
  • Submodules
  • config.defaults module
  • config.local module
  • Module contents
• controller module
• deadapi package
  • Subpackages
  • Submodules
  • deadapi.api module
  • deadapi.events module
  • deadapi.server module
  • deadapi.utils module
  • Module contents
• deadapi.resources package
  • Submodules
  • deadapi.resources.accesslog module
  • deadapi.resources.accesspoint module
  • deadapi.resources.controller module
  • deadapi.resources.identity_expr module
  • deadapi.resources.ruleset module
  • deadapi.resources.status module
  • Module contents
• deadaux package
  • Submodules
  • deadaux.echotest module
  • deadaux.offlinedb module
  • deadaux.utils module
  • Module contents
• deadcli module
• deadserver package
  • Subpackages
  • Submodules
  • deadserver.messages module
  • deadserver.server module
  • Module contents
• deadserver.handlers package
  • Submodules
  • deadserver.handlers.alog module
  • deadserver.handlers.ask module
  • deadserver.handlers.defs module
  • deadserver.handlers.echotest module
  • deadserver.handlers.ping module
  • deadserver.handlers.xfer module
  • Module contents
• integration_test module
• server
  • common package
  • config package
  • controller module
  • deadapi package
  • deadaux package
  • deadcli module
  • deadserver package
  • integration_test module
  • runapi module
  • runaux module
  • runsrv module
• runapi module
• runaux module
• runsrv module