Skip to content

Commit 02ef87a

Browse files
pinheadmzgithub-actions[bot]
authored andcommitted
Update apidocs on
1 parent ebdc0e4 commit 02ef87a

File tree

1 file changed

+39
-18
lines changed

1 file changed

+39
-18
lines changed

docs/warnet.md

Lines changed: 39 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ parameters in <angle brackets>.
1414
## API Commands
1515

1616
### `warnet auth`
17-
Authenticate with a warnet cluster using a kube config file
17+
Authenticate with a Warnet cluster using a kubernetes config file
1818

1919
options:
2020
| name | type | required | default |
2121
|-------------|--------|------------|-----------|
22-
| kube_config | String | yes | |
22+
| auth_config | String | yes | |
2323

2424
### `warnet create`
2525
Create a new warnet network
@@ -33,14 +33,20 @@ Open the Warnet dashboard in default browser
3333
Deploy a warnet with topology loaded from \<directory>
3434

3535
options:
36-
| name | type | required | default |
37-
|-----------|--------|------------|-----------|
38-
| directory | Path | yes | |
39-
| debug | Bool | | False |
36+
| name | type | required | default |
37+
|--------------|--------|------------|-----------|
38+
| directory | Path | yes | |
39+
| debug | Bool | | False |
40+
| namespace | String | | |
41+
| to_all_users | Bool | | False |
4042

4143
### `warnet down`
4244
Bring down a running warnet quickly
4345

46+
options:
47+
| name | type | required | default |
48+
|--------|--------|------------|-----------|
49+
| force | Bool | | False |
4450

4551
### `warnet init`
4652
Initialize a warnet project in the current directory
@@ -50,10 +56,11 @@ Initialize a warnet project in the current directory
5056
Show the logs of a pod
5157

5258
options:
53-
| name | type | required | default |
54-
|----------|--------|------------|-----------|
55-
| pod_name | String | | "" |
56-
| follow | Bool | | False |
59+
| name | type | required | default |
60+
|-----------|--------|------------|-----------|
61+
| pod_name | String | | "" |
62+
| follow | Bool | | False |
63+
| namespace | String | | "default" |
5764

5865
### `warnet new`
5966
Create a new warnet project in the specified directory
@@ -74,6 +81,7 @@ options:
7481
| debug | Bool | | False |
7582
| source_dir | Path | | |
7683
| additional_args | String | | |
84+
| namespace | String | | |
7785

7886
### `warnet setup`
7987
Setup warnet
@@ -104,6 +112,15 @@ options:
104112

105113
## Admin
106114

115+
### `warnet admin create-kubeconfigs`
116+
Create kubeconfig files for ServiceAccounts
117+
118+
options:
119+
| name | type | required | default |
120+
|----------------|--------|------------|---------------|
121+
| kubeconfig_dir | String | | "kubeconfigs" |
122+
| token_duration | Int | | 172800 |
123+
107124
### `warnet admin init`
108125
Initialize a warnet project in the current directory
109126

@@ -118,9 +135,10 @@ Namespaces commands
118135
Fetch the Bitcoin Core debug log from \<tank pod name>
119136

120137
options:
121-
| name | type | required | default |
122-
|--------|--------|------------|-----------|
123-
| tank | String | yes | |
138+
| name | type | required | default |
139+
|-----------|--------|------------|-----------|
140+
| tank | String | yes | |
141+
| namespace | String | | |
124142

125143
### `warnet bitcoin grep-logs`
126144
Grep combined bitcoind logs using regex \<pattern>
@@ -135,6 +153,8 @@ options:
135153
### `warnet bitcoin messages`
136154
Fetch messages sent between \<tank_a pod name> and \<tank_b pod name> in [chain]
137155

156+
Optionally, include a namespace like so: tank-name.namespace
157+
138158
options:
139159
| name | type | required | default |
140160
|--------|--------|------------|-----------|
@@ -146,11 +166,12 @@ options:
146166
Call bitcoin-cli \<method> [params] on \<tank pod name>
147167

148168
options:
149-
| name | type | required | default |
150-
|--------|--------|------------|-----------|
151-
| tank | String | yes | |
152-
| method | String | yes | |
153-
| params | String | | |
169+
| name | type | required | default |
170+
|-----------|--------|------------|-----------|
171+
| tank | String | yes | |
172+
| method | String | yes | |
173+
| params | String | | |
174+
| namespace | String | | |
154175

155176
## Graph
156177

0 commit comments

Comments
 (0)