Skip to content

Commit c577b29

Browse files
pinheadmzpinheadmz
committed
docs: update for metrics
1 parent 112b3c9 commit c577b29

File tree

4 files changed

+42
-36
lines changed

4 files changed

+42
-36
lines changed

‎docs/graph.md‎

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ lightning network channel (see [lightning.md](lightning.md)).
5050
<key id="bitcoin_config" attr.name="bitcoin_config" attr.type="string" for="node" />
5151
<key id="tc_netem" attr.name="tc_netem" attr.type="string" for="node" />
5252
<key id="exporter" attr.name="exporter" attr.type="boolean" for="node" />
53+
<key id="metrics" attr.name="metrics" attr.type="string" for="node" />
5354
<key id="collect_logs" attr.name="collect_logs" attr.type="boolean" for="node" />
5455
<key id="build_args" attr.name="build_args" attr.type="string" for="node" />
5556
<key id="ln" attr.name="ln" attr.type="string" for="node" />
@@ -66,20 +67,21 @@ lightning network channel (see [lightning.md](lightning.md)).
6667
</graphml>
6768
```
6869

69-
| key | for | type | default | explanation |
70-
|----------------|-------|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
71-
| 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 |
72-
| 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 |
73-
| image | node | string | | Bitcoin Core Warnet tank image on Dockerhub with the format repository/image:tag |
74-
| bitcoin_config | node | string | | A string of Bitcoin Core options in command-line format, e.g. '-debug=net -blocksonly' |
75-
| tc_netem | node | string | | A tc-netem command as a string beginning with 'tc qdisc add dev eth0 root netem' |
76-
| exporter | node | boolean | False | Whether to attach a Prometheus data exporter to the tank |
77-
| collect_logs | node | boolean | False | Whether to collect Bitcoin Core debug logs with Promtail |
78-
| build_args | node | string | | A string of configure options used when building Bitcoin Core from source code, e.g. '--without-gui --disable-tests' |
79-
| ln | node | string | | Attach a lightning network node of this implementation (currently only supports 'lnd') |
80-
| ln_image | node | string | | Specify a lightning network node image from Dockerhub with the format repository/image:tag |
81-
| ln_cb_image | node | string | | Specify a lnd Circuit Breaker image from Dockerhub with the format repository/image:tag |
82-
| 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' |
83-
| channel_open | edge | string | | Indicate that this edge is a lightning channel with these arguments passed to lnd openchannel |
84-
| source_policy | edge | string | | Update the channel originator policy by passing these arguments passed to lnd updatechanpolicy |
85-
| target_policy | edge | string | | Update the channel partner policy by passing these arguments passed to lnd updatechanpolicy |
70+
| key | for | type | default | explanation |
71+
|----------------|-------|---------|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
72+
| 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 |
73+
| 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 |
74+
| image | node | string | | Bitcoin Core Warnet tank image on Dockerhub with the format repository/image:tag |
75+
| bitcoin_config | node | string | | A string of Bitcoin Core options in command-line format, e.g. '-debug=net -blocksonly' |
76+
| tc_netem | node | string | | A tc-netem command as a string beginning with 'tc qdisc add dev eth0 root netem' |
77+
| exporter | node | boolean | False | Whether to attach a Prometheus data exporter to the tank |
78+
| metrics | node | string | Block count, peers in/out, mempool size | A space-separated string of RPC queries to scrape by prometheus |
79+
| collect_logs | node | boolean | False | Whether to collect Bitcoin Core debug logs with Promtail |
80+
| build_args | node | string | | A string of configure options used when building Bitcoin Core from source code, e.g. '--without-gui --disable-tests' |
81+
| ln | node | string | | Attach a lightning network node of this implementation (currently only supports 'lnd' or 'cln') |
82+
| ln_image | node | string | | Specify a lightning network node image from Dockerhub with the format repository/image:tag |
83+
| ln_cb_image | node | string | | Specify a lnd Circuit Breaker image from Dockerhub with the format repository/image:tag |
84+
| 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' |
85+
| channel_open | edge | string | | Indicate that this edge is a lightning channel with these arguments passed to lnd openchannel |
86+
| source_policy | edge | string | | Update the channel originator policy by passing these arguments passed to lnd updatechanpolicy |
87+
| target_policy | edge | string | | Update the channel partner policy by passing these arguments passed to lnd updatechanpolicy |

‎docs/warcli.md‎

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,6 @@ options:
2626
|----------|--------|------------|-----------|
2727
| commands | String | | |
2828

29-
### `warcli setup`
30-
Run the Warnet quick start setup script
31-
32-
3329
## Bitcoin
3430

3531
### `warcli bitcoin debug-log`
@@ -73,6 +69,18 @@ options:
7369

7470
## Cluster
7571

72+
### `warcli cluster deploy`
73+
Setup Warnet using the current kubectl-configured cluster
74+
75+
76+
### `warcli cluster minikube-clean`
77+
Reinit minikube images
78+
79+
80+
### `warcli cluster minikube-setup`
81+
Setup minikube for use with Warnet
82+
83+
7684
### `warcli cluster port-start`
7785
Port forward (runs as a detached process)
7886

@@ -81,11 +89,7 @@ Port forward (runs as a detached process)
8189
Stop the port forwarding process
8290

8391

84-
### `warcli cluster start`
85-
Setup and start Warnet with minikube
86-
87-
88-
### `warcli cluster stop`
92+
### `warcli cluster teardown`
8993
Stop the warnet server and tear down the cluster
9094

9195

@@ -129,19 +133,19 @@ options:
129133
## Image
130134

131135
### `warcli image build`
132-
Build bitcoind and bitcoin-cli from \<repo>/\<branch> as \<registry>:\<tag>.
136+
Build bitcoind and bitcoin-cli from \<repo> at \<commit_sha> as \<registry>:\<tag>.
133137
Optionally deploy to remote registry using --action=push, otherwise image is loaded to local registry.
134138

135139
options:
136140
| name | type | required | default |
137141
|------------|--------|------------|-----------|
138142
| repo | String | yes | |
139-
| branch | String | yes | |
143+
| commit_sha | String | yes | |
140144
| registry | String | yes | |
141145
| tag | String | yes | |
142146
| build_args | String | | |
143147
| arches | String | | |
144-
| action | String | | |
148+
| action | String | | "load" |
145149

146150
## Ln
147151

@@ -207,11 +211,11 @@ options:
207211
Start a warnet with topology loaded from a \<graph_file> into [network]
208212

209213
options:
210-
| name | type | required | default |
211-
|------------|--------|------------|-----------------------------------|
212-
| graph_file | Path | | src/warnet/graphs/default.graphml |
213-
| force | Bool | | False |
214-
| network | String | | "warnet" |
214+
| name | type | required | default |
215+
|------------|--------|------------|----------------------------------|
216+
| graph_file | Path | | resources/graphs/default.graphml |
217+
| force | Bool | | False |
218+
| network | String | | "warnet" |
215219

216220
### `warcli network status`
217221
Get status of a warnet named [network]

‎resources/scripts/apidocs.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
from tabulate import tabulate
99
from warnet.cli.main import cli
1010

11-
file_path = Path(os.path.dirname(os.path.abspath(__file__))) / ".." / "docs" / "warcli.md"
11+
file_path = Path(os.path.dirname(os.path.abspath(__file__))) / ".." / ".." / "docs" / "warcli.md"
1212

1313
doc = ""
1414

‎resources/scripts/graphdocs.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
graph_schema = load_schema()
1111

12-
file_path = Path(os.path.dirname(os.path.abspath(__file__))) / ".." / "docs" / "graph.md"
12+
file_path = Path(os.path.dirname(os.path.abspath(__file__))) / ".." / ".." / "docs" / "graph.md"
1313

1414
doc = ""
1515

0 commit comments

Comments
 (0)