Giter Club home page Giter Club logo

arkheon's Introduction

Arkheon

Arkheon is a very simple FastAPI-based web application to record memories of your NixOS deployments.

Arkheon preview

API documentation

Records a deployment

POST /record/<identifier>
{ "toplevel": $toplevel, "bootspec": $bootspec, ... }

This will record a deployment at this point in time for that <identifier> machine.

Developer TODO

Short term

  • API to register webhooks to call upon deployments: regex on machine identifier?
  • Webhook push on each record
  • Production packaging
  • NixOS module

Medium term

  • Client side NixOS module / automation:
    • colmena can record at any effective activation (i.e. can compute it at dry activation time the closure, send it only if any switch operation is done either boot, test or effective activation).
  • Move to PostgreSQL
  • Do proper bulk insertion when possible
  • Cache results to comparisons as they are immutable (on-disk? LRU policy?)
  • Pre-compute comparisons between deployment N - 1 and N at record time as a background task
  • NixOS tests
  • Prometheus endpoint for metrics?
  • Recognize if a deployment is idempotent and do nothing, e.g. if the closure is already stored, create a new deployment and reflink it to the previous one.
  • Netbox synchronization
  • Linking Git metadata and deployment data

Long term

  • Deployments/closures can be sealed to prevent any tampering, do something like FSPRG:
    • Generate a verification key that should be stored somewhere else.
    • Generate a sealing key that can stay on the deployment of arkheon.
    • and do it like FSS.
    • Will probably require the involvement of Rust to write it properly and re-expose it via Python.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.