Skip to content

Commit b128340

Browse files
doc: noded documentation
1 parent 4f1e55b commit b128340

1 file changed

Lines changed: 45 additions & 0 deletions

File tree

docs/cmds/noded.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Noded
2+
3+
This module is responsible of registering the node on the grid, and handling of grid events. It reports the node’s capacity (CPU, memory, storage, GPU, etc.), monitors performance and health, registers the node on the blockchain.
4+
5+
## How it works
6+
7+
- Connects to `Redis` message broker over `zbus`
8+
- Prints **Node ID** or **Node network** if their flags were passed
9+
- Collects node info:
10+
- Node capacity (CPU, memory, disk)
11+
- Whether the node is booted via `efi`
12+
- `DMI` Info (Desktop Management Interface)
13+
- Name of the hypervisor used on the node
14+
- List of available GPUs, logs GPUs info
15+
- Starts a registrar service and publishes node info
16+
- Registers the node on the blockchain
17+
- Monitor node performance:
18+
- `NTP` check
19+
- `iperf` (network performance measurement)
20+
- `cpubench` (CPU benchmark)
21+
- `public ip` (validity of public ip)
22+
- Streams events to the blockchain (substrate)
23+
- Keeps track of environment changes (Substrate URLs)
24+
25+
## Usage
26+
27+
```sh
28+
noded --broker unix:///var/run/redis.sock
29+
```
30+
31+
```sh
32+
noded --id
33+
```
34+
35+
```sh
36+
noded --net
37+
```
38+
39+
### Command-line flags
40+
41+
| Flag | Description | Default |
42+
| ---------- | ----------------------------------------------- | --------------------------- |
43+
| `--broker` | Connection string to the message BROKER | `unix:///var/run/redis.sock`|
44+
| `--id` | print node id and exit | false |
45+
| `--net` | print node network and exit | false |

0 commit comments

Comments
 (0)