Go library for the HyperFleet desire contract and store backends. A desire is the declarative intent for a single Kubernetes resource on a management cluster (apply, delete, or read). Store backends persist that intent and its status so appliers can reconcile resources without ManifestWork-style bulk transport.
It collaborates with other HyperFleet components:
- API is the source of truth for fleet resource desired state and aggregated status
- Sentinel polls the API and publishes CloudEvents that drive reconciliation
- Adapter listens for those events, applies changes, and reports status back to the API
Prerequisites: Go 1.26+, Make
make build
make test
make lintRun make help for the full list of targets.
| Package | Description |
|---|---|
pkg/desire |
Desire types (ApplyDesire, DeleteDesire, ReadDesire), identity validation, SpecStore / StatusStore interfaces |
pkg/desire/store/memory |
In-memory store for unit tests |
pkg/desire/store/redis |
Redis-backed store with WATCH/MULTI/EXEC CAS |
pkg/desire/store/conformance |
Shared conformance suite exercised by both backends |
go get github.com/openshift-hyperfleet/hyperfleet-applier| Resource | Description |
|---|---|
make help |
Build, test, lint, format, and verify targets |
pkg/desire package docs |
Desire model, identity rules, and store contracts |
| Resource | Description |
|---|---|
| HyperFleet Architecture | System design |
| HyperFleet API Spec | API contract |
| Broker Library | Messaging abstraction |
| Infrastructure | Deployment automation |
Credentials are stored scoped to the applier's own partition by convention. Cryptographic enforcement of that scoping arrives with the production backends.
- Verify you're a member of the
openshift-hyperfleetorganization - Confirm you're added to the hyperfleet team
- Code reviews and approvals are managed through the OWNERS file
For access issues, contact a repository administrator or organization owner.
This project is licensed under the Apache License 2.0. See LICENSE for details.