@@ -34,7 +34,7 @@ cd hyperfleet-adapter
3434### Install Dependencies
3535
3636``` bash
37- make tidy
37+ make mod- tidy
3838```
3939
4040### Build
@@ -128,9 +128,9 @@ hyperfleet-adapter/
128128| ` make image-push ` | Build and push container image to registry |
129129| ` make image-dev ` | Build and push to personal Quay registry (requires QUAY_USER) |
130130| ` make fmt ` | Format code |
131- | ` make tidy ` | Tidy Go module dependencies |
131+ | ` make mod- tidy ` | Tidy Go module dependencies |
132132| ` make clean ` | Clean build artifacts |
133- | ` make verify ` | Run format check and go vet |
133+ | ` make verify ` | Run lint and test |
134134
135135💡 ** Tip:** Use ` make help ` to see all available targets with descriptions
136136
@@ -169,7 +169,7 @@ A HyperFleet Adapter requires several files for configuration:
169169- ** Adapter Task config** : Configures the adapter task steps that will create resources
170170- ** Broker configuration** : Configures the specific broker to use by the adapter framework to receive CloudEvents
171171
172- To see all configuration options read [ configuration.md] ( configuration.md ) file
172+ To see all configuration options read [ configuration.md] ( docs/ configuration.md) file
173173
174174#### Adapter configuration
175175
@@ -178,14 +178,16 @@ settings for the adapter process, such as client connections, retries, and broke
178178subscription details. It is loaded with Viper, so values can be overridden by CLI flags
179179and environment variables in this priority order: CLI flags > env vars > file > defaults.
180180
181+ Fields use ** snake_case** naming.
182+
181183- ** Path** : ` HYPERFLEET_ADAPTER_CONFIG ` (required)
182- - ** Common fields** : ` spec. adapter.version` , ` spec.debugConfig ` , ` spec. clients.*`
183- (HyperFleet API, Maestro, broker, Kubernetes)
184+ - ** Common fields** : ` adapter.name ` , ` adapter.version ` , ` debug_config ` , ` clients.* `
185+ (HyperFleet API: ` clients.hyperfleet_api ` , Maestro: ` clients.maestro ` , broker: ` clients.broker ` , Kubernetes: ` clients.kubernetes ` )
184186
185187Reference examples:
186188
187189- ` configs/adapter-deployment-config.yaml ` (full reference with env/flag notes)
188- - ` charts/examples/adapter-config.yaml ` (minimal deployment example)
190+ - ` charts/examples/kubernetes/ adapter-config.yaml ` (minimal deployment example)
189191
190192#### Adapter task configuration
191193
@@ -194,12 +196,12 @@ processing events: parameters, preconditions, resources to create, and post-acti
194196This file is loaded as ** static YAML** (no Viper overrides) and is required at runtime.
195197
196198- ** Path** : ` HYPERFLEET_TASK_CONFIG ` (required)
197- - ** Key sections** : ` spec. params` , ` spec. preconditions` , ` spec. resources` , ` spec. post`
199+ - ** Key sections** : ` params ` , ` preconditions ` , ` resources ` , ` post `
198200- ** Resource manifests** : inline YAML or external file via ` manifest.ref `
199201
200202Reference examples:
201203
202- - ` charts/examples/adapter-task-config.yaml ` (worked example)
204+ - ` charts/examples/kubernetes/ adapter-task-config.yaml ` (worked example)
203205- ` configs/adapter-task-config-template.yaml ` (complete schema reference)
204206
205207### Broker Configuration
0 commit comments