Categorygithub.com/Comcast/codex
module
0.10.0
Repository: https://github.com/comcast/codex.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
0
Dependents
0
Files
0

# README

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.

The Pieces

  • Database: Any postgres database will work. In deploy/, cockroachdb is used.
  • 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.

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.

# Packages

No description provided by the author
No description provided by the author
cipher package is a helper package for encrypting and decrypting messages.
package db provides some overarching variables, structs, and interfaces that different database implementations can use and implement and consumers can expect.
No description provided by the author
No description provided by the author
No description provided by the author