node

type AddCapabilityRequest struct {
	Metadata     core.Metadata
	CapabilityID string
}

type AddDisruptionRequest struct {
	Metadata   core.Metadata
	Disruption Disruption
}

type CreateRequest struct {
	Name                    string    // Name is the name of the Node.
	UpdateDomain            string    // UpdateDomain is the update domain of the Node.
	TotalResources          Resources // TotalResources is the total resources available on the Node.
	SystemReservedResources Resources // SystemReservedResources is the resources reserved for system use.
	CapabilityIDs           []string  // Capabilities is a list of capabilities that the Node has.
	LocalVolumes            []LocalVolume
}

type CreateResponse struct {
	Record NodeRecord
}

type DeleteRequest struct {
	Metadata core.Metadata
}

type Disruption struct {
	ID          string
	ShouldEvict bool
	StartTime   time.Time
	Status      DisruptionStatus
}

type DisruptionState string

type DisruptionStatus struct {
	State   DisruptionState
	Message string
}

type GetResponse struct {
	Record NodeRecord
}

type Ledger interface {
	// Create creates a new Node.
	Create(context.Context, *CreateRequest) (*CreateResponse, error)
	// GetByID retrieves a Node by its ID
	GetByID(context.Context, string) (*GetResponse, error)
	// GetByName retrieves a Node by its name.
	GetByName(context.Context, string) (*GetResponse, error)
	// UpdateStatus updates the state and message of an existing Node.
	UpdateStatus(context.Context, *UpdateStatusRequest) (*UpdateResponse, error)
	// List returns a list of Node that match the provided filters.
	List(context.Context, *ListRequest) (*ListResponse, error)
	// Delete deletes a Node.
	Delete(context.Context, *DeleteRequest) error

	AddDisruption(context.Context, *AddDisruptionRequest) (*UpdateResponse, error)
	UpdateDisruptionStatus(context.Context, *UpdateDisruptionStatusRequest) (*UpdateResponse, error)
	RemoveDisruption(context.Context, *RemoveDisruptionRequest) (*UpdateResponse, error)

	AddCapability(context.Context, *AddCapabilityRequest) (*UpdateResponse, error)
	RemoveCapability(context.Context, *RemoveCapabilityRequest) (*UpdateResponse, error)
}

type ListRequest struct {
	Filters NodeListFilters
}

type ListResponse struct {
	Records []NodeRecord
}

type LocalVolume struct {
	MountPath       string
	StorageClass    string
	StorageCapacity uint32
}

type NodeListFilters struct {
	IDIn       []string // IN condition
	NameIn     []string // IN condition
	VersionGte *uint64  // Greater than or equal condition
	VersionLte *uint64  // Less than or equal condition
	VersionEq  *uint64  // Equal condition

	IncludeDeleted bool   // IncludeDeleted indicates whether to include soft-deleted records in the result.
	Limit          uint32 // Limit is the maximum number of records to return.

	StateIn            []NodeState
	StateNotIn         []NodeState
	RemainingCoresGte  *uint32
	RemainingCoresLte  *uint32
	RemainingMemoryGte *uint32
	RemainingMemoryLte *uint32
	ClusterIDIn        []string
	UpdateDomainIn     []string
	PayloadNameIn      []string
	PayloadNameNotIn   []string
}

type NodeRecord struct {
	Metadata core.Metadata // Metadata is the metadata that identifies the Node. It is a combination of the Node's name and version.
	Name     string        // Name is the name of the Node.
	Status   NodeStatus    // Status is the status of the Node.

	ClusterID               string    // ClusterID is the ID of the Cluster to which the Node belongs.
	UpdateDomain            string    // UpdateDomain is the update domain of the Node.
	TotalResources          Resources // TotalResources is the total resources available on the Node.
	SystemReservedResources Resources // SystemReservedResources is the resources reserved for system use.
	RemainingResources      Resources // RemainingResources is the resources available for application use.

	LocalVolumes  []LocalVolume // LocalVolumes is a list of local volumes attached to the Node.
	CapabilityIDs []string      // Capabilities is a list of capabilities that the Node has.
	Disruptions   []Disruption  // Disruptions is a list of disruptions that are scheduled or approved for the Node.
}

type NodeState string

type NodeStatus struct {
	State   NodeState // State is the discrete condition of the resource.
	Message string    // Message is a human-readable description of the resource's state.
}

type RemoveCapabilityRequest struct {
	Metadata     core.Metadata
	CapabilityID string
}

type RemoveDisruptionRequest struct {
	Metadata     core.Metadata
	DisruptionID string
}

type Repository interface {
	Insert(context.Context, NodeRecord) error
	GetByID(context.Context, string) (NodeRecord, error)
	GetByName(context.Context, string) (NodeRecord, error)
	UpdateStatus(context.Context, core.Metadata, NodeStatus, string) error
	Delete(context.Context, core.Metadata) error
	List(context.Context, NodeListFilters) ([]NodeRecord, error)

	InsertDisruption(context.Context, core.Metadata, Disruption) error
	DeleteDisruption(ctx context.Context, metadata core.Metadata, disruptionID string) error
	UpdateDisruptionStatus(ctx context.Context, metadata core.Metadata, disruptionID string, status DisruptionStatus) error

	InsertCapability(ctx context.Context, metadata core.Metadata, capabilityID string) error
	DeleteCapability(ctx context.Context, metadata core.Metadata, capabilityID string) error
}

type Resources struct {
	Cores  uint32
	Memory uint32
}

type UpdateDisruptionStatusRequest struct {
	Metadata     core.Metadata
	DisruptionID string
	Status       DisruptionStatus
}

type UpdateResponse struct {
	Record NodeRecord
}

type UpdateStatusRequest struct {
	Metadata  core.Metadata
	Status    NodeStatus
	ClusterID string
}