@@ -15,7 +15,7 @@ This tool allows users to create/get/update farm/account/node on a specified ne
15
15
2 . Navigate to the project directory:
16
16
17
17
``` sh
18
- cd node-registrar/tools/ registrar-cli
18
+ cd tfgrid4-sdk-go/ registrar-cli/
19
19
```
20
20
21
21
3 . Build the application:
@@ -26,18 +26,168 @@ This tool allows users to create/get/update farm/account/node on a specified ne
26
26
27
27
## Usage
28
28
29
+ ## Create Command
30
+
31
+ Create command allows users to create an account or a farm
32
+
33
+ ### Create New Account
34
+
35
+ ** Flags** :
36
+
37
+ - ` --network ` (required): Specifies the network (` dev ` , ` qa ` , ` test ` , ` main ` ).
38
+ - ` --seed ` (optional): create an account of a seed.
39
+ - ` --relays ` (optional): relays urls.
40
+ - ` --rmb-enc-key ` (optional): rmb encryption key.
41
+
42
+ ** Example Usage** :
43
+
44
+ ``` sh
45
+ ➜ registrar-cli git:(add-registrar-cli-tool) ✗ ./registrar-cli create account --network dev
46
+ 5:00PM INF New Seed (Hex): 7f40eb52530f1a1c1253873cf17d44bd66d3e5ba71a14d0deba7df5517c9ed12
47
+ 5:00PM INF public key (Hex): c394d84de07fac2b2477588dace29a165a469fe0a9dbc8056686d3340054bf9d
48
+ 5:00PM INF account is created successfully twinID=33
49
+ ```
50
+
51
+ ### Create New Farm
52
+
53
+ ** Flags** :
54
+
55
+ - ` --farm_name ` (required): The name of the farm to create.
56
+ - ` --network ` (required): Specifies the network (` dev ` , ` qa ` , ` test ` , ` main ` ).
57
+ - ` --seed ` (required): A hexadecimal representation of the seed.
58
+ - ` --dedicated ` (optional default: false): is the farm dedicated.
59
+
60
+ ** Example Usage** :
61
+
62
+ ``` sh
63
+ ➜ registrar-cli git:(add-registrar-cli-tool) ✗ ./registrar-cli create farm --farm-name testFarm1 --seed < seed> --network dev
64
+ 5:03PM INF farm is created successfully farmID=12
65
+ ```
66
+
67
+ ## Get Command
68
+
69
+ Get command allows users to get account, farm, node or zos version.
70
+
71
+ ### Get Account
72
+
73
+ ** Flags** :
74
+
75
+ - ` --network ` (required): Specifies the network (` dev ` , ` qa ` , ` test ` , ` main ` ).
76
+ - ` --twin-id ` (optional): twin id of the account needed to be loaded.
77
+ - ` --public-key ` (optional): public key of the account needed to be loaded.
78
+
79
+ ** Example Usage** :
80
+
81
+ ``` sh
82
+ ➜ registrar-cli git:(add-registrar-cli-tool) ✗ go run main.go get account --network dev --twin-id 33
83
+ 5:00PM INF account={" public_key" :" w5TYTeB/rCskd1iNrOKaFlpGn+Cp28gFZobTNABUv50=" ," relays" :[]," rmb_enc_key" :" " ," twin_id" :33}
84
+ ➜
85
+ ➜ registrar-cli git:(add-registrar-cli-tool) ✗ go run main.go get account --network dev --public-key < public-key>
86
+ 5:01PM INF account={" public_key" :" w5TYTeB/rCskd1iNrOKaFlpGn+Cp28gFZobTNABUv50=" ," relays" :[]," rmb_enc_key" :" " ," twin_id" :33}
87
+ ```
88
+
89
+ ### Get Farm
90
+
91
+ ** Flags** :
92
+
93
+ - ` --network ` (required): Specifies the network (` dev ` , ` qa ` , ` test ` , ` main ` ).
94
+ - ` --farm-id ` (optional): id of the farm needed to be loaded.
95
+
96
+ ** Example Usage** :
97
+
98
+ ``` sh
99
+ ➜ registrar-cli git:(add-registrar-cli-tool) ✗ go run main.go get farm --farm-id 12 --network dev
100
+ 5:03PM INF farm={" dedicated" :false," farm_id" :12," farm_name" :" testFarm1" ," twin_id" :33}
101
+ ```
102
+
103
+ ### Get Node
104
+
105
+ ** Flags** :
106
+
107
+ - ` --network ` (required): Specifies the network (` dev ` , ` qa ` , ` test ` , ` main ` ).
108
+ - ` --node-id ` (optional): id of the node needed to be loaded.
109
+ - ` --twin-id ` (optional): twin id of the node needed to be loaded.
110
+
111
+ ** Example Usage** :
112
+
113
+ ``` sh
114
+ ➜ registrar-cli git:(add-registrar-cli-tool) ✗ go run main.go get node --network dev --node-id 1
115
+ 12:36PM INF node={" Approved" :false," farm_id" :4," interfaces" :[{" ips" :" 192.168.123.22" ," mac" :" 54:fe:9a:b0:73:61" ," name" :" zos" }]," location" :{" city" :" Cairo" ," country" :" Egypt" ," latitude" :" 30.0588" ," longitude" :" 31.2268" }," node_id" :1," resources" :{" cru" :4," hru" :1073741824000," mru" :6230032384," sru" :1610612736000}," secure_boot" :false," serial_number" :" Not Specified" ," twin_id" :5," uptime" :null," virtualized" :true}
116
+ ➜
117
+ ➜ registrar-cli git:(add-registrar-cli-tool) ✗ go run main.go get node --network dev --twin-id 5
118
+ 12:36PM INF node={" Approved" :false," farm_id" :4," interfaces" :[{" ips" :" 192.168.123.22" ," mac" :" 54:fe:9a:b0:73:61" ," name" :" zos" }]," location" :{" city" :" Cairo" ," country" :" Egypt" ," latitude" :" 30.0588" ," longitude" :" 31.2268" }," node_id" :1," resources" :{" cru" :4," hru" :1073741824000," mru" :6230032384," sru" :1610612736000}," secure_boot" :false," serial_number" :" Not Specified" ," twin_id" :5," uptime" :null," virtualized" :true}
119
+ ```
120
+
121
+ ### Get Zos Version
122
+
123
+ ** Flags** :
124
+
125
+ - ` --network ` (required): Specifies the network (` dev ` , ` qa ` , ` test ` , ` main ` ).
126
+
127
+ ** Example Usage** :
128
+
129
+ ``` sh
130
+ ➜ registrar-cli git:(add-registrar-cli-tool) ✗ go run main.go get version --network dev
131
+ 12:40PM INF zosVersion={" safe_to_upgrade" :true," version" :" v0.1.8" }
132
+ ```
133
+
134
+ ## Update Command
135
+
136
+ Update command allows users to update account, farm or zos version.
137
+
138
+ ### Update Account
139
+
140
+ ** Flags** :
141
+
142
+ - ` --network ` (required): Specifies the network (` dev ` , ` qa ` , ` test ` , ` main ` ).
143
+ - ` --seed ` (required): A hexadecimal representation of the seed.
144
+ - ` --relays ` (optional): new relays urls.
145
+ - ` --rmb-enc-key ` (optional): new rmb encryption key.
146
+
147
+ ** Example Usage** :
148
+
29
149
``` sh
30
- ./registrar-cli -seed < seed> -network < network> -farm_name < farm_name>
150
+ ➜ registrar-cli git:(add-registrar-cli-tool) ✗ go run main.go update account --network dev --seed < seed> --relays wss://relay.dev.grid.tf
151
+ 5:02PM INF account is updated successfully
152
+ ➜
153
+ ➜ registrar-cli git:(add-registrar-cli-tool) ✗ go run main.go get account --network dev --twin-id 33
154
+ 5:02PM INF account={" public_key" :" w5TYTeB/rCskd1iNrOKaFlpGn+Cp28gFZobTNABUv50=" ," relays" :[" wss://relay.dev.grid.tf" ]," rmb_enc_key" :" " ," twin_id" :33}
31
155
```
32
156
33
- ### Parameters
157
+ ### Update Farm
158
+
159
+ ** Flags** :
160
+
161
+ - ` --network ` (required): Specifies the network (` dev ` , ` qa ` , ` test ` , ` main ` ).
162
+ - ` --seed ` (required): A hexadecimal representation of the seed.
163
+ - ` --farm-id ` (optional): id of the farm needed to be loaded.
164
+ - ` --farm_name ` (optional): The new name of the farm.
165
+ - ` --dedicated ` (optional): update the farm to dedicated.
166
+
167
+ ** Example Usage** :
168
+
169
+ ``` sh
170
+ ➜ registrar-cli git:(add-registrar-cli-tool) ✗ go run main.go update farm --farm-name notTestFarm1 --seed < seed> --network dev --farm-id 12
171
+ 5:04PM INF farm is updated successfully
172
+ ➜
173
+ ➜ registrar-cli git:(add-registrar-cli-tool) ✗ go run main.go get farm --farm-id 12 --network dev
174
+ 5:04PM INF farm={" dedicated" :false," farm_id" :12," farm_name" :" notTestFarm1" ," twin_id" :33}
175
+ ```
176
+
177
+ ### Update Zos Version
178
+
179
+ ** Flags** :
34
180
35
- - ` -seed ` (required): A hexadecimal string used as a private key seed .
36
- - ` -network ` (required): Specifies the network ( ` dev ` , ` qa ` , ` test ` , ` main ` ).
37
- - ` -farm_name ` (required): The name of the farm to create.
181
+ - ` --network ` (required): Specifies the network ( ` dev ` , ` qa ` , ` test ` , ` main ` ) .
182
+ - ` --version ` (required): new zos version to be set on specific network ( ` v0.1.x ` )
183
+ - ` --safe-to-upgrade ` (required): if this version is safe to upgrade
38
184
39
- ### Example Usage
185
+ ** Example Usage** :
40
186
41
187
``` sh
42
- ./registrar-cli -seed aabbccddeeff00112233445566778899aabbccddeeff00112233445566778899 -network dev -farm_name MyFarm
188
+ ➜ registrar-cli git:(add-registrar-cli-tool) ✗ go run main.go update version --network dev --version v0.1.8 --safe-to-upgrade --seed < seed>
189
+ 5:07PM INF farm is updated successfully
190
+ ➜
191
+ ➜ registrar-cli git:(add-registrar-cli-tool) ✗ go run main.go get version --network dev
192
+ 5:07PM INF zosVersion={" safe_to_upgrade" :true," version" :" v0.1.8" }
43
193
```
0 commit comments