shared-libraries

Shared Libraries (pkg/lib)

Analyzed from commit: baf9c7bcc307ed9358ad59886a5536366a050012 on 2026-09-17 Source paths: pkg/lib/

Package Purpose

pkg/lib/ is the shared Go library forked from konveyor/controller v0.11.0. Every Forklift controller, inventory collector, and REST handler depends on these packages for status conditions, inventory persistence, migration itineraries, cross-resource reference tracking, structured logging, and error wrapping. Understanding these patterns is prerequisite to reading any controller code.

---

Key Types and Structs

Condition (pkg/lib/condition)

type Condition struct {
    Type               string   // e.g. "Ready", "ReconcileFailed"
    Status             string   // "True" or "False"
    Category           string   // Critical, Error, Warn, Required, Advisory, ...
    Reason             string
    Message            string
    Suggestion         string
    LastTransitionTime v1.Time
    Durable            bool     // survives staging sweeps
    Items              []string // referenced in Message
    staged             bool     // internal: set this reconcile cycle
}

type Conditions struct {
    List    []Condition
    staging bool
    explain Explain
}

Built-in types: ReconcileFailed, Ready. Built-in categories: Critical, Error, Warn, Required, Advisory, plus pending-state categories ValidatingVDDK, VMMissingGuestIPs, VMMissingChangedBlockTracking, SharedDisks.

Itinerary (pkg/lib/itinerary)

type Step struct {
    Name string
    All  Flag   // ALL predicate flags must be true
    Any  Flag   // ANY predicate flag must be true
}

type Itinerary struct {
    Pipeline
    Predicate
    Name string
}

type Progress struct {
    Completed int64
    Total     int64
}

Inventory container (pkg/lib/inventory/container)

type Container struct {
    content map[Key]Collector  // Key = ObjectReference (Kind + UID)
}

type Collection struct {
    Stored   fb.Iterator
    Tx       *model.Tx
    Shepherd Shepherd
    Added, Updated, Deleted int
}