chore: rename ClusterContext to NodeContext
This commit is contained in:
22
README.md
22
README.md
@@ -14,14 +14,28 @@ SProcket ORchestration Engine
|
||||
|
||||
- ESP8266
|
||||
|
||||
## Configuration
|
||||
## Architecture
|
||||
|
||||
### Auto Discovery
|
||||
|
||||
A node periodically executes 2 tasks responsible for auto discovers:
|
||||
|
||||
- send discovery: send UDP packet on broadcast address to discover nodes
|
||||
- listen for discovery: receive UDP packets and send response back to the node who initiated discovery
|
||||
|
||||
Discovered nodes are added to the so cluster memberlist.
|
||||
Another periodic task will then call the `/api/node/status` endpoint over HTTP on each node in the memberlist to get detailed informations about the node (e.g. freeHeap, available API endpoints).
|
||||
|
||||
## Develop
|
||||
|
||||
### Configuration
|
||||
|
||||
Choose one of your nodes as the API node to interact with the cluster and configure it in `.env`:
|
||||
```sh
|
||||
export API_NODE=10.0.1.x
|
||||
```
|
||||
|
||||
## Build
|
||||
### Build
|
||||
|
||||
Build the firmware:
|
||||
|
||||
@@ -29,14 +43,14 @@ Build the firmware:
|
||||
./ctl.sh build
|
||||
```
|
||||
|
||||
## Flash
|
||||
### Flash
|
||||
|
||||
Flash firmware to a connected device:
|
||||
|
||||
```sh
|
||||
./ctl.sh flash
|
||||
```
|
||||
## OTA
|
||||
### OTA
|
||||
|
||||
Update one nodes:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user