Skip to content

Commit 0d7c7e4

Browse files
authored
Merge pull request #27 from godon-dev/feature_targets
docs: add target management to README
2 parents 77dab31 + 9257a3e commit 0d7c7e4

1 file changed

Lines changed: 41 additions & 1 deletion

File tree

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ A Rust-based CLI tool for controlling and managing the Godon optimizer breeders
66

77
- **Breeder Management**: List, create, show, update, and delete breeder configurations
88
- **Credential Management**: Store and manage SSH keys, API tokens, and other sensitive data
9-
- **YAML-based Configuration**: Simple YAML files for breeders and credentials
9+
- **Target Management**: Define and manage target hosts for optimization runs
10+
- **YAML-based Configuration**: Simple YAML files for breeders, credentials, and targets
1011
- **RESTful API Integration**: Communicates with the Godon Control API
1112
- **Cross-platform Support**: Currently Linux x86_64, extensible to other platforms
1213

@@ -178,6 +179,45 @@ godon_cli credential show --id 550e8400-e29b-41d4-a716-446655440001
178179
godon_cli credential delete --id 550e8400-e29b-41d4-a716-446655440001
179180
```
180181

182+
### Target Management
183+
184+
#### List Targets
185+
186+
```bash
187+
godon_cli target list
188+
```
189+
190+
#### Create a Target
191+
192+
Create a YAML configuration file `target.yaml`:
193+
194+
```yaml
195+
name: "production-web-01"
196+
targetType: "ssh"
197+
address: "192.168.1.100"
198+
username: "deploy"
199+
description: "Production web server"
200+
allowsDowntime: false
201+
```
202+
203+
Then create the target:
204+
205+
```bash
206+
godon_cli target create --file target.yaml
207+
```
208+
209+
#### Show Target Details
210+
211+
```bash
212+
godon_cli target show --id 550e8400-e29b-41d4-a716-446655440022
213+
```
214+
215+
#### Delete a Target
216+
217+
```bash
218+
godon_cli target delete --id 550e8400-e29b-41d4-a716-446655440022
219+
```
220+
181221
## Configuration
182222

183223
The CLI connects to the Godon API using these default settings:

0 commit comments

Comments
 (0)