Skip to content

Commit ace04ea

Browse files
willcl-arkwillcl-ark
authored
Merge pull request #493 from willcl-ark/disable-graph
2 parents d1802fe + 8ba9370 commit ace04ea

File tree

3 files changed

+81
-146
lines changed

3 files changed

+81
-146
lines changed

‎.github/workflows/apidocs.yml

+4
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,7 @@ jobs:
2929
run: |
3030
source .venv/bin/activate
3131
python3 resources/scripts/apidocs.py
32+
33+
- uses: stefanzweifel/git-auto-commit-action@v5
34+
with:
35+
commit_message: Update apidocs on ${{ github.head_ref }}

‎docs/warcli.md

+76-125
Original file line numberDiff line numberDiff line change
@@ -17,17 +17,79 @@ parameters in <angle brackets>.
1717

1818
## API Commands
1919

20-
### `warcli help`
21-
Display help information for the given [command] (and sub-command).
22-
If no command is given, display help for the main CLI.
20+
### `warcli auth`
21+
Authenticate with a warnet cluster using a kube config file
2322

2423
options:
25-
| name | type | required | default |
26-
|----------|--------|------------|-----------|
27-
| commands | String | | |
24+
| name | type | required | default |
25+
|-------------|--------|------------|-----------|
26+
| kube_config | String | yes | |
27+
28+
### `warcli create`
29+
Create a new warnet project in the specified directory
30+
31+
options:
32+
| name | type | required | default |
33+
|-----------|--------|------------|-----------|
34+
| directory | Path | yes | |
35+
36+
### `warcli deploy`
37+
Deploy a warnet with topology loaded from \<directory>
38+
39+
options:
40+
| name | type | required | default |
41+
|-----------|--------|------------|-----------|
42+
| directory | Path | yes | |
43+
44+
### `warcli down`
45+
Bring down a running warnet
46+
47+
48+
### `warcli init`
49+
Initialize a warnet project in the current directory
50+
51+
52+
### `warcli quickstart`
53+
Setup warnet
54+
55+
56+
### `warcli run`
57+
Run a scenario from a file
58+
59+
options:
60+
| name | type | required | default |
61+
|-----------------|--------|------------|-----------|
62+
| scenario_file | Path | yes | |
63+
| additional_args | String | | |
64+
65+
### `warcli status`
66+
Display the unified status of the Warnet network and active scenarios
2867

29-
### `warcli setup`
30-
Check Warnet requirements are installed
68+
69+
### `warcli stop`
70+
Stop a running scenario or all scenarios
71+
72+
options:
73+
| name | type | required | default |
74+
|---------------|--------|------------|-----------|
75+
| scenario_name | String | | |
76+
77+
## Admin
78+
79+
### `warcli admin create`
80+
Create a new warnet project in the specified directory
81+
82+
options:
83+
| name | type | required | default |
84+
|-----------|--------|------------|-----------|
85+
| directory | Func | yes | |
86+
87+
### `warcli admin init`
88+
Initialize a warnet project in the current directory
89+
90+
91+
### `warcli admin namespaces`
92+
Namespaces commands
3193

3294

3395
## Bitcoin
@@ -51,14 +113,14 @@ options:
51113
| no_sort | Bool | | False |
52114

53115
### `warcli bitcoin messages`
54-
Fetch messages sent between \<tank_a pod name> and \<tank_b pod name> in [network]
116+
Fetch messages sent between \<tank_a pod name> and \<tank_b pod name> in [chain]
55117

56118
options:
57-
| name | type | required | default |
58-
|---------|--------|------------|-----------|
59-
| tank_a | String | yes | |
60-
| tank_b | String | yes | |
61-
| network | String | | "regtest" |
119+
| name | type | required | default |
120+
|--------|--------|------------|-----------|
121+
| tank_a | String | yes | |
122+
| tank_b | String | yes | |
123+
| chain | String | | "regtest" |
62124

63125
### `warcli bitcoin rpc`
64126
Call bitcoin-cli \<method> [params] on \<tank pod name>
@@ -72,40 +134,12 @@ options:
72134

73135
## Graph
74136

75-
### `warcli graph create`
76-
Create a cycle graph with \<number> nodes, and include 7 extra random outbounds per node.
77-
Returns XML file as string with or without --outfile option
78-
79-
options:
80-
| name | type | required | default |
81-
|--------------|--------|------------|-----------|
82-
| number | Int | yes | |
83-
| outfile | Path | | |
84-
| version | String | | "27.0" |
85-
| bitcoin_conf | Path | | |
86-
| random | Bool | | False |
87-
88137
### `warcli graph import-json`
89138
Create a cycle graph with nodes imported from lnd `describegraph` JSON file,
90139
and additionally include 7 extra random outbounds per node. Include lightning
91140
channels and their policies as well.
92141
Returns XML file as string with or without --outfile option.
93142

94-
options:
95-
| name | type | required | default |
96-
|----------|--------|------------|-----------|
97-
| infile | Path | yes | |
98-
| outfile | Path | | |
99-
| cb | String | | |
100-
| ln_image | String | | |
101-
102-
### `warcli graph validate`
103-
Validate a \<graph file> against the schema.
104-
105-
options:
106-
| name | type | required | default |
107-
|--------|--------|------------|-----------|
108-
| graph | Path | yes | |
109143

110144
## Image
111145

@@ -124,87 +158,4 @@ options:
124158
| arches | String | | |
125159
| action | String | | "load" |
126160

127-
## Namespaces
128-
129-
### `warcli namespaces deploy`
130-
Deploy namespaces with users from a \<namespaces_file>
131-
132-
options:
133-
| name | type | required | default |
134-
|------------|--------|------------|----------------------------|
135-
| namespaces | String | | "two_namespaces_two_users" |
136-
137-
### `warcli namespaces destroy`
138-
Destroy a specific namespace or all warnet- prefixed namespaces
139-
140-
options:
141-
| name | type | required | default |
142-
|-------------|--------|------------|-----------|
143-
| destroy_all | Bool | | False |
144-
| namespace | String | | |
145-
146-
### `warcli namespaces list`
147-
List all namespaces with 'warnet-' prefix
148-
149-
150-
## Network
151-
152-
### `warcli network connected`
153-
Determine if all p2p connections defined in graph are established
154-
155-
156-
### `warcli network down`
157-
Bring down a running warnet
158-
159-
160-
### `warcli network logs`
161-
Get Kubernetes logs from the RPC server
162-
163-
options:
164-
| name | type | required | default |
165-
|--------|--------|------------|-----------|
166-
| follow | Bool | | False |
167-
168-
### `warcli network start`
169-
Start a warnet with topology loaded from \<network_name> into [network]
170-
171-
options:
172-
| name | type | required | default |
173-
|--------------|--------|------------|------------------|
174-
| network_name | String | | "6_node_bitcoin" |
175-
| network | String | | "warnet" |
176-
| logging | Bool | | False |
177-
178-
### `warcli network status`
179-
Return pod status
180-
181-
182-
## Scenarios
183-
184-
### `warcli scenarios active`
185-
List running scenarios "name": "pid" pairs
186-
187-
188-
### `warcli scenarios available`
189-
List available scenarios in the Warnet Test Framework
190-
191-
192-
### `warcli scenarios run`
193-
Run \<scenario> from the Warnet Test Framework with optional arguments
194-
195-
options:
196-
| name | type | required | default |
197-
|-----------------|--------|------------|-----------|
198-
| scenario | String | yes | |
199-
| additional_args | String | | |
200-
201-
### `warcli scenarios run-file`
202-
Run \<scenario_path> from the Warnet Test Framework with optional arguments
203-
204-
options:
205-
| name | type | required | default |
206-
|-----------------|--------|------------|-----------|
207-
| scenario_path | String | yes | |
208-
| additional_args | String | | |
209-
210161

‎src/warnet/graph.py

+1-21
Original file line numberDiff line numberDiff line change
@@ -2,33 +2,13 @@
22

33
import click
44

5-
from .util import DEFAULT_TAG
65

7-
8-
@click.group(name="graph")
6+
@click.group(name="graph", hidden=True)
97
def graph():
108
"""Create and validate network graphs"""
119

1210

1311
@graph.command()
14-
@click.argument("number", type=int)
15-
@click.option("--outfile", type=click.Path())
16-
@click.option("--version", type=str, default=DEFAULT_TAG)
17-
@click.option("--bitcoin_conf", type=click.Path())
18-
@click.option("--random", is_flag=True)
19-
def create(number: int, outfile: Path, version: str, bitcoin_conf: Path, random: bool = False):
20-
"""
21-
Create a cycle graph with <number> nodes, and include 7 extra random outbounds per node.
22-
Returns XML file as string with or without --outfile option
23-
"""
24-
raise Exception("Not Implemented")
25-
26-
27-
@graph.command()
28-
@click.argument("infile", type=click.Path())
29-
@click.option("--outfile", type=click.Path())
30-
@click.option("--cb", type=str)
31-
@click.option("--ln_image", type=str)
3212
def import_json(infile: Path, outfile: Path, cb: str, ln_image: str):
3313
"""
3414
Create a cycle graph with nodes imported from lnd `describegraph` JSON file,

0 commit comments

Comments
 (0)