@@ -14,12 +14,12 @@ parameters in <angle brackets>.
14
14
## API Commands
15
15
16
16
### ` warnet auth `
17
- Authenticate with a warnet cluster using a kube config file
17
+ Authenticate with a Warnet cluster using a kubernetes config file
18
18
19
19
options:
20
20
| name | type | required | default |
21
21
| -------------| --------| ------------| -----------|
22
- | kube_config | String | yes | |
22
+ | auth_config | String | yes | |
23
23
24
24
### ` warnet create `
25
25
Create a new warnet network
@@ -33,14 +33,20 @@ Open the Warnet dashboard in default browser
33
33
Deploy a warnet with topology loaded from \< directory>
34
34
35
35
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 |
40
42
41
43
### ` warnet down `
42
44
Bring down a running warnet quickly
43
45
46
+ options:
47
+ | name | type | required | default |
48
+ | --------| --------| ------------| -----------|
49
+ | force | Bool | | False |
44
50
45
51
### ` warnet init `
46
52
Initialize a warnet project in the current directory
@@ -50,10 +56,11 @@ Initialize a warnet project in the current directory
50
56
Show the logs of a pod
51
57
52
58
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" |
57
64
58
65
### ` warnet new `
59
66
Create a new warnet project in the specified directory
@@ -74,6 +81,7 @@ options:
74
81
| debug | Bool | | False |
75
82
| source_dir | Path | | |
76
83
| additional_args | String | | |
84
+ | namespace | String | | |
77
85
78
86
### ` warnet setup `
79
87
Setup warnet
@@ -104,6 +112,15 @@ options:
104
112
105
113
## Admin
106
114
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
+
107
124
### ` warnet admin init `
108
125
Initialize a warnet project in the current directory
109
126
@@ -118,9 +135,10 @@ Namespaces commands
118
135
Fetch the Bitcoin Core debug log from \< tank pod name>
119
136
120
137
options:
121
- | name | type | required | default |
122
- | --------| --------| ------------| -----------|
123
- | tank | String | yes | |
138
+ | name | type | required | default |
139
+ | -----------| --------| ------------| -----------|
140
+ | tank | String | yes | |
141
+ | namespace | String | | |
124
142
125
143
### ` warnet bitcoin grep-logs `
126
144
Grep combined bitcoind logs using regex \< pattern>
@@ -135,6 +153,8 @@ options:
135
153
### ` warnet bitcoin messages `
136
154
Fetch messages sent between \< tank_a pod name> and \< tank_b pod name> in [ chain]
137
155
156
+ Optionally, include a namespace like so: tank-name.namespace
157
+
138
158
options:
139
159
| name | type | required | default |
140
160
| --------| --------| ------------| -----------|
@@ -146,11 +166,12 @@ options:
146
166
Call bitcoin-cli \< method> [ params] on \< tank pod name>
147
167
148
168
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 | | |
154
175
155
176
## Graph
156
177
0 commit comments