Skip to content

Commit 29c1e2f

Browse files
authored
Merge pull request #17 from godon-dev/breeder_type_instead_of_name
docs: update README with --name and yaml config
2 parents 1eb7b09 + 377117b commit 29c1e2f

1 file changed

Lines changed: 22 additions & 9 deletions

File tree

README.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -75,18 +75,29 @@ godon_cli --hostname https://localhost:8443 --insecure breeder list
7575

7676
#### Create a Breeder
7777

78-
Create a YAML configuration file `breeder.yaml`:
78+
Create a YAML configuration file `breeder_config.yaml` with native YAML syntax:
7979

8080
```yaml
81-
name: "genetic-optimizer-1"
82-
config: >
83-
{"setting1": "value1", "setting2": 42, "optimization_target": "performance"}
81+
meta:
82+
configVersion: "0.2"
83+
description: "Linux network performance optimization"
84+
85+
breeder:
86+
type: "linux_performance"
87+
88+
settings:
89+
sysctl:
90+
net.ipv4.tcp_rmem:
91+
step: 100
92+
constraints:
93+
lower: 4096
94+
upper: 6291456
8495
```
8596
86-
Then create the breeder:
97+
Then create the breeder with a name:
8798
8899
```bash
89-
godon_cli breeder create --file breeder.yaml
100+
godon_cli breeder create --name "genetic-optimizer-1" --file breeder_config.yaml
90101
```
91102

92103
#### Show Breeder Details
@@ -97,14 +108,16 @@ godon_cli breeder show --id 550e8400-e29b-41d4-a716-446655440000
97108

98109
#### Update a Breeder
99110

100-
Create an update configuration file `breeder_update.yaml`:
111+
Create an update configuration file `breeder_update.yaml` with native YAML syntax:
101112

102113
```yaml
103114
uuid: "550e8400-e29b-41d4-a716-446655440000"
104115
name: "updated-genetic-optimizer"
105116
description: "Updated optimizer configuration"
106-
config: >
107-
{"setting1": "new_value1", "setting2": 100}
117+
config:
118+
setting1: "new_value1"
119+
setting2: 100
120+
optimization_target: "throughput"
108121
```
109122
110123
Then update:

0 commit comments

Comments
 (0)