Skip to content

Commit

Permalink
docs: add restart to graph schema
Browse files Browse the repository at this point in the history
  • Loading branch information
@pinheadmz
pinheadmz committed Aug 19, 2024
1 parent 871d153 commit a63c348
Showing 1 changed file with 20 additions and 18 deletions.
38 changes: 20 additions & 18 deletions docs/graph.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ lightning network channel (see [lightning.md](lightning.md)).
<key id="services" attr.name="services" attr.type="string" for="graph" />
<key id="version" attr.name="version" attr.type="string" for="node" />
<key id="image" attr.name="image" attr.type="string" for="node" />
<key id="restart" attr.name="restart" attr.type="boolean" for="node" />
<key id="bitcoin_config" attr.name="bitcoin_config" attr.type="string" for="node" />
<key id="tc_netem" attr.name="tc_netem" attr.type="string" for="node" />
<key id="exporter" attr.name="exporter" attr.type="boolean" for="node" />
Expand All @@ -67,21 +68,22 @@ lightning network channel (see [lightning.md](lightning.md)).
</graphml>
```

| key | for | type | default | explanation |
|----------------|-------|---------|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| services | graph | string | | A space-separated list of extra service containers to deploy in the network. See [docs/services.md](services.md) for complete list of available services |
| version | node | string | | Bitcoin Core version with an available Warnet tank image on Dockerhub. May also be a GitHub repository with format user/repository:branch to build from source code |
| image | node | string | | Bitcoin Core Warnet tank image on Dockerhub with the format repository/image:tag |
| bitcoin_config | node | string | | A string of Bitcoin Core options in command-line format, e.g. '-debug=net -blocksonly' |
| tc_netem | node | string | | A tc-netem command as a string beginning with 'tc qdisc add dev eth0 root netem' |
| exporter | node | boolean | False | Whether to attach a Prometheus data exporter to the tank |
| metrics | node | string | Block count, peers in/out, mempool size | A space-separated string of RPC queries to scrape by prometheus |
| collect_logs | node | boolean | False | Whether to collect Bitcoin Core debug logs with Promtail |
| build_args | node | string | | A string of configure options used when building Bitcoin Core from source code, e.g. '--without-gui --disable-tests' |
| ln | node | string | | Attach a lightning network node of this implementation (currently only supports 'lnd' or 'cln') |
| ln_image | node | string | | Specify a lightning network node image from Dockerhub with the format repository/image:tag |
| ln_cb_image | node | string | | Specify a lnd Circuit Breaker image from Dockerhub with the format repository/image:tag |
| ln_config | node | string | | A string of arguments for the lightning network node in command-line format, e.g. '--protocol.wumbo-channels --bitcoin.timelockdelta=80' |
| channel_open | edge | string | | Indicate that this edge is a lightning channel with these arguments passed to lnd openchannel |
| source_policy | edge | string | | Update the channel originator policy by passing these arguments passed to lnd updatechanpolicy |
| target_policy | edge | string | | Update the channel partner policy by passing these arguments passed to lnd updatechanpolicy |
| key | for | type | default | explanation |
|----------------|-------|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| services | graph | string | | A space-separated list of extra service containers to deploy in the network. See [docs/services.md](services.md) for complete list of available services |
| version | node | string | | Bitcoin Core version with an available Warnet tank image on Dockerhub. May also be a GitHub repository with format user/repository:branch to build from source code |
| image | node | string | | Bitcoin Core Warnet tank image on Dockerhub with the format repository/image:tag |
| restart | node | boolean | True | Automatically restart the tank on failure |
| bitcoin_config | node | string | | A string of Bitcoin Core options in command-line format, e.g. '-debug=net -blocksonly' |
| tc_netem | node | string | | A tc-netem command as a string beginning with 'tc qdisc add dev eth0 root netem' |
| exporter | node | boolean | False | Whether to attach a Prometheus data exporter to the tank |
| metrics | node | string | | A space-separated string of RPC queries to scrape by Prometheus |
| collect_logs | node | boolean | False | Whether to collect Bitcoin Core debug logs with Promtail |
| build_args | node | string | | A string of configure options used when building Bitcoin Core from source code, e.g. '--without-gui --disable-tests' |
| ln | node | string | | Attach a lightning network node of this implementation (currently only supports 'lnd' or 'cln') |
| ln_image | node | string | | Specify a lightning network node image from Dockerhub with the format repository/image:tag |
| ln_cb_image | node | string | | Specify a lnd Circuit Breaker image from Dockerhub with the format repository/image:tag |
| ln_config | node | string | | A string of arguments for the lightning network node in command-line format, e.g. '--protocol.wumbo-channels --bitcoin.timelockdelta=80' |
| channel_open | edge | string | | Indicate that this edge is a lightning channel with these arguments passed to lnd openchannel |
| source_policy | edge | string | | Update the channel originator policy by passing these arguments passed to lnd updatechanpolicy |
| target_policy | edge | string | | Update the channel partner policy by passing these arguments passed to lnd updatechanpolicy |

0 comments on commit a63c348

Please sign in to comment.