Skip to content
This repository has been archived by the owner on Sep 30, 2024. It is now read-only.

Commit

Permalink
docs: add basic readme (#3)
Browse files Browse the repository at this point in the history
  • Loading branch information
scarmuega authored Dec 11, 2023
1 parent c5b75b1 commit a551288
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Demeter Daemon

This is the core component of the Demeter platform. It's a daemon that runs on each k8s cluster (as a STS not a k8s Daemon) and has the following responsibilities:

- serve as entry-point for RPC management interactions with end-users
- synchronize state with peer clusters in the same fabric
- synchronize state with global events from the distributed ledger (aka: blockchain)
- synchronize local k8s state with desired global state as defined by the fabric

For more detail of the above, please refer to the [architecture docs](https://github.com/demeter-run/architecture).

## Usage

This component is meant to be installed as part of the cluster provisioning procedure, please refer to the Demeter [up instructions](https://github.com/demeter-run/up).

If you wish to run this component in isolation, the recommended approach is to use the available [OCI image](https://github.com/demeter-run/daemon/pkgs/container/daemon).

## Development

This component is built using Rust. To develop you'll need the Rust toolchain with version 1.70 or higher. You can build and run the daemon using Cargo as show in the following example:

```sh
cargo run
```

0 comments on commit a551288

Please sign in to comment.