pkg/

pkg

Intention

pkg is the shared platform library surface of this repository. It is not one framework. It is the collection of cross-cutting contracts, runtime layers, and historical baggage that sibling services and controllers depend on.

The useful way to read it is as a small knowledge graph:

• API/object contract: apis, openapi, constants, errors
• Runtime/bootstrap and client layers: options, client
• Reconciler/controller stack: provisioners, manager, messaging
• Server/API stack: server
• Utilities and support layers: util

Reading Order

• Start with constants, errors, apis/unikorn/v1alpha1, and openapi for the shared contract vocabulary.
• Then read client and options for process bootstrap and client construction.
• controllers and provisioners: provisioners -> manager
• service APIs: server

Caveats

• This tree contains both deliberately shared platform layers and a fair amount of historical aggregation. Several packages are catch-alls that should eventually split rather than grow.
• Some subtrees are intentionally de-emphasized in this documentation pass: pkg/cd because it is legacy in-tree CD surface, and most of pkg/testing because it is test support rather than core runtime contract.