Skip to content
Codex provides a historical context about devices connected to XMiDT.
Go Gherkin Dockerfile Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
deploy
docs/images
tests
.codeclimate.yml
.gitignore
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
LICENSE
MAINTAINERS.md
NOTICE
README.md
go.mod
go.sum

README.md

codex

Codex provides a historical context about devices connected to XMiDT.

Build Status codecov.io Code Climate Issue Count Go Report Card Apache V2 License GitHub release

Summary

Codex accepts incoming events, stores them in a postgres database, and provides event information by device id. This repo is a library of packages used to implement codex.

Table of Contents

Code of Conduct

This project and everyone participating in it are governed by the XMiDT Code Of Conduct. By participating, you agree to this Code.

The Pieces

  • Database: Any postgres database will work. In deploy/, cockroachdb is used. The services connect to the database using the codex-db library.
  • Svalinn: Registers to an endpoint to receive events (Optional). Has an endpoint that receives events as WRP Messages, parses them, and inserts them into the database.
  • Gungnir: Has endpoints that provide device information from the database.
  • Fenrir: Deletes old records from the database at an interval.
  • Heimdall: A consumer of Codex (sends requests to Gungnir) but also requests directly to the database to get a list of device IDs.

Install

This repo is a library of packages used for the codex project. There is no installation. To install each service, go to their respective READMEs.

Deploy

for deploying the project in Docker, refer to the deploy README.

Contributing

Refer to CONTRIBUTING.md.

You can’t perform that action at this time.