framework

package

Go to main page

Versions in this module

v2

v2.4.0

Mar 30, 2026

Changes in this version

+ func GetOutput[T any](reg *OutputRegistry, handlerName string, key string) (T, bool)

+ func Register[TInput any, TOutput any](r *Reconciler, handler Lifecycle[TInput, TOutput], ...)

+ type InputResolver func(reg *OutputRegistry) ([]TInput, error)

+ type Lifecycle interface

+ Check func(ctx context.Context, output TOutput) (Status, error)

+ Create func(ctx context.Context, input TInput) (TOutput, error)

+ Destroy func(ctx context.Context, output TOutput) error

+ Key func(input TInput) string

+ Name func() string

+ Recover func(ctx context.Context, input TInput) (TOutput, Status, error)

+ type LockEntry struct

+ Data any

+ HandlerName string

+ InputHash string

+ Key string

+ type LockFile struct

+ Entries []LockEntry

+ func LoadLockFile() (*LockFile, error)

+ func (lf *LockFile) Close() error

+ func (lf *LockFile) PurgeOrphans(registeredHandlers map[string]bool) error

+ func (lf *LockFile) Save() error

+ type OutputRegistry struct

+ type Reconciler struct

+ func NewReconciler() (*Reconciler, error)

+ func (r *Reconciler) Start(ctx context.Context) error

+ func (r *Reconciler) Stop(ctx context.Context) error

+ type Snapshot struct

+ Input TInput

+ Output TOutput

+ type Status string

+ const StatusDown

+ const StatusUnknown

+ const StatusUp

v2.3.0

Nov 3, 2025

v2.2.3

Oct 10, 2025

v2.2.2

Oct 10, 2025

v2.2.1

Sep 30, 2025

v2.2.0

Sep 29, 2025

v2.1.0

Sep 23, 2025

Changes in this version

+ const RegistryFile

+ func AddManager[TConfig any, TState any](ro *ResourceOrchestrator, handler ResourceHandler[TConfig, TState], ...)

+ type PersistentResourceEntry struct

+ Data any

+ HandlerName string

+ type ReconcileOperation struct

+ func (tro *ReconcileOperation[TConfig, TState]) Execute(ctx context.Context) error

+ func (tro *ReconcileOperation[TConfig, TState]) Name() string

+ func (tro *ReconcileOperation[TConfig, TState]) Stop(ctx context.Context) error

+ type ResourceChecker interface

+ CheckFromConfig func(ctx context.Context, config TConfig) (TState, domain.State, error)

+ CheckFromState func(ctx context.Context, state TState) (domain.State, error)

+ type ResourceCreator interface

+ Create func(ctx context.Context, config TConfig) (TState, error)

+ type ResourceDestroyer interface

+ Destroy func(ctx context.Context, state TState) error

type ResourceHandler

+ Equals func(a, b TConfig) bool

type ResourceManager

+ func (rm *ResourceManager[TConfig, TState]) Reconcile(ctx context.Context, desiredConfigs []TConfig) error

+ type ResourceNamer interface

+ Name func() string

+ type ResourceOperation interface

+ Execute func(ctx context.Context) error

+ Name func() string

+ Stop func(ctx context.Context) error

+ type ResourceOrchestrator struct

+ func NewResourceOrchestrator() (*ResourceOrchestrator, error)

+ func (ro *ResourceOrchestrator) Start(ctx context.Context) error

+ func (ro *ResourceOrchestrator) Stop(ctx context.Context) error

+ type ResourceRecord struct

+ Config TConfig

+ State TState

+ type ResourceRegistry struct

+ Entries []PersistentResourceEntry

+ func LoadResourceRegistry() (*ResourceRegistry, error)

+ func (rr *ResourceRegistry) Add(entry PersistentResourceEntry) error

+ func (rr *ResourceRegistry) Remove(entry PersistentResourceEntry) error

+ func (rr *ResourceRegistry) Save() error

v2.0.0

Sep 23, 2025

Changes in this version

+ const ResourceLockFile

+ func RunWithDryRunGuard[T any](config *Config, cb func() (T, error), defaultValue T) (T, error)

+ type Config struct

+ DryRun bool

+ type Resource struct

+ Handler string

+ Payload any

+ func NewResource(ctx context.Context, handler ResourceHandler, payload any) (*Resource, error)

+ func (r *Resource) Hash() (string, error)

+ type ResourceHandler interface

+ Down func(ctx context.Context, payload any) error

+ Name func(ctx context.Context) string

+ Status func(ctx context.Context, payload any) (domain.State, error)

+ Up func(ctx context.Context, payload any) error

+ type ResourceLock struct

+ Resources map[string]Resource

+ func LoadResourceLock() (*ResourceLock, error)

+ func (rl *ResourceLock) Add(resource Resource) error

+ func (rl *ResourceLock) DiffResources(desiredResources []Resource) (removed, added []Resource)

+ func (rl *ResourceLock) Has(resource Resource) bool

+ func (rl *ResourceLock) Remove(resource Resource) error

+ func (rl *ResourceLock) Save() error

+ func (rl *ResourceLock) SyncResource(ctx context.Context, handler ResourceHandler, resource Resource) error

+ type ResourceManager struct

+ func NewResourceManager(handlers map[string]ResourceHandler, resources []Resource) (*ResourceManager, error)

+ func (rm *ResourceManager) Start(ctx context.Context) error

+ func (rm *ResourceManager) Stop(ctx context.Context) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL