mirror of
https://github.com/mudler/LocalAI.git
synced 2026-07-02 20:37:03 -04:00
* feat(distributed): support multiple replicas of one model on the same node The distributed scheduler implicitly assumed `(node_id, model_name)` was unique, but the schema didn't enforce it and the worker keyed all gRPC processes by model name alone. With `MinReplicas=2` against a single worker, the reconciler "scaled up" every 30s but the registry never advanced past 1 row — the worker re-loaded the model in-place every tick until VRAM fragmented and the gRPC process died. This change introduces multi-replica-per-node as a first-class concept, with capacity-aware scheduling, a circuit breaker, and VRAM soft-reservation. Operators can declare per-node capacity via the worker flag `--max-replicas-per-model` (mirrored as auto-label `node.replica-slots=N`) or override per-node from the UI. * Schema: BackendNode gains MaxReplicasPerModel (default 1) and ReservedVRAM. NodeModel gains ReplicaIndex (composite with node_id + model_name). ModelSchedulingConfig gains UnsatisfiableUntil/Ticks for the reconciler circuit breaker. * Registry: replica_index threaded through SetNodeModel, RemoveNodeModel, IncrementInFlight, DecrementInFlight, TouchNodeModel, GetNodeModel, SetNodeModelLoadInfo and the InFlightTrackingClient. New helpers: CountReplicasOnNode, NextFreeReplicaIndex (with ErrNoFreeSlot), RemoveAllNodeModelReplicas, FindNodesWithFreeSlot, ClusterCapacityForModel, ReserveVRAM/ReleaseVRAM (atomic UPDATE with ErrInsufficientVRAM), and the unsatisfiable-flag CRUD. * Worker: processKey now `<modelID>#<replicaIndex>` so concurrent loads of the same model land on distinct ports. Adds CLI flag --max-replicas-per-model (env LOCALAI_MAX_REPLICAS_PER_MODEL, default 1) and emits the auto-label. * Router: scheduleNewModel filters candidates by free slot, allocates the replica index, and soft-reserves VRAM before installing the backend. evictLRUAndFreeNode now deletes the targeted row by ID instead of all replicas of the model on the node — fixes a latent bug where evicting one replica orphaned its siblings. * Reconciler: caps scale-up at ClusterCapacityForModel so a misconfig (MinReplicas > capacity) doesn't loop forever. After 3 consecutive ticks of capacity==0 it sets UnsatisfiableUntil for a 5m cooldown and emits a warning. ClearAllUnsatisfiable fires from Register, ApproveNode, SetNodeLabel(s), RemoveNodeLabel and UpdateMaxReplicasPerModel so a new node joining or label changes wake the reconciler immediately. scaleDownIdle removes highest-replica-index first to keep slots compact. * Heartbeat resets reserved_vram to 0 — worker is the source of truth for actual free VRAM; the reservation is only for the in-tick race window between two scheduling decisions. * Probe path (reconciler.probeLoadedModels and health.doCheckAll) now pass the row's replica_index to RemoveNodeModel so an unreachable replica doesn't orphan healthy siblings. * Admin override: PUT /api/nodes/:id/max-replicas-per-model sets a sticky override (preserved across worker re-registration). DELETE clears the override so the worker's flag applies again on next register. Required because Kong defaults the worker flag to 1, so every worker restart would have silently reverted the UI value. * React UI: always-visible slot badge on the node row (muted at default 1, accented when >1); inline editor in the expanded drawer with pencil-to-edit, Save/Cancel, Esc/Enter, "(override)" indicator when the value is admin-set, and a "Reset" button to hand control back to the worker. Soft confirm when shrinking the cap below the count of loaded replicas. Scheduling rules table gets an "Unsatisfiable until HH:MM" status badge surfacing the cooldown. * node.replica-slots filtered out of the labels strip on the row to avoid duplicating the slot badge. 23 new Ginkgo specs (registry, reconciler, inflight, health) cover: multi-replica row independence, RemoveNodeModel of one replica preserving siblings, NextFreeReplicaIndex slot allocation including ErrNoFreeSlot, capacity-gated scale-up with circuit breaker tripping and recovery on Register, scheduleDownIdle ordering, ClusterCapacity math, ReserveVRAM admission gating, Heartbeat reset, override survival across worker re-registration, and ResetMaxReplicasPerModel handing control back. Plus 8 stdlib tests for the worker processKey / CLI / auto-label. Closes the flap reproduced on Qwen3.6-35B against the nvidia-thor worker (single 128 GiB node, MinReplicas=2): the reconciler now caps the scale-up at the cluster's actual capacity instead of looping. Signed-off-by: Ettore Di Giacinto <mudler@localai.io> Assisted-by: claude-code:opus-4-7 [Read] [Edit] [Bash] [Skill:critique] [Skill:audit] [Skill:polish] [Skill:golang-testing] * refactor(react-ui/nodes): tighten capacity editor copy + adopt ActionMenu for row actions * Capacity editor hint trimmed from operator-doc-style ("Sourced from the worker's `--max-replicas-per-model` flag. Changing it here makes it a sticky admin override that survives worker restarts." → "Saved values stick across worker restarts.") and the override-state copy similarly compressed. The full mechanic is no longer needed in the UI — the override pill carries the meaning and the docs cover the rest. * Node row actions migrated from an inline cluster of icon buttons (Drain / Resume / Trash) to the kebab ActionMenu used by /manage for per-row model actions, so dense Nodes tables stay clean. Approve stays as a prominent primary button — it's a stateful admission gate, not a routine action, and elevating it matches how /manage surfaces install-time decisions outside the menu. * The expanded drawer's Labels section now filters node.replica-slots out of the editable label list. The label is owned by the Capacity editor above; surfacing it again as an editable label invited confusion (the Capacity save would clobber any direct edit). Both backend and agent workers benefit — they share the row rendering path, so the action menu and label filter apply to both. Signed-off-by: Ettore Di Giacinto <mudler@localai.io> Assisted-by: claude-code:opus-4-7 [Edit] [chrome-devtools-mcp] [Skill:critique] [Skill:audit] [Skill:polish] * fix(react-ui/nodes): suppress slot badge on agent workers Agent workers don't load models, so the per-node replica capacity is inapplicable to them. Showing "1× slots" on agent rows was a tiny inconsistency from the unified rendering path — gate the badge on node_type !== 'agent' so it only appears on backend workers. Signed-off-by: Ettore Di Giacinto <mudler@localai.io> Assisted-by: claude-code:opus-4-7 [Edit] [chrome-devtools-mcp] * refactor(react-ui/nodes): distill expanded drawer + restyle scheduling form The expanded node drawer used to stack five panels — slot badge, filled capacity box, Loaded Models h4+empty-state, Installed Backends h4+empty-state, Labels h4+chips+form — making routine inspections feel like a control panel. The scheduling rule form wrapped its mode toggle as two 50%-width filled buttons that competed visually with the actual primary action. * Drawer: collapse three rarely-touched config zones (Capacity, Backends, Labels) into one `<details>` "Manage" disclosure (closed by default) with small uppercase eyebrow labels for each zone instead of parallel h4 sub-headings. Loaded Models stays as the at-a-glance headline with a single-line empty hint instead of a boxed empty state. CapacityEditor renders flat (no filled background) — the Manage disclosure provides framing. * Scheduling form: replace the chunky 50%-width button-tabs with the project's existing `.segmented` control (icon + label, sized to content). Mode hint becomes a single tied line below. Fields stack vertically with helper text under inputs and a hairline divider above the right-aligned Save / Cancel. The empty drawer collapses from ~5 stacked sections (~280px tall) to two lines (~80px). The scheduling form now reads as a designed dialog instead of raw building blocks. Both surfaces now match the typographic density and weight of the rest of the admin pages. Signed-off-by: Ettore Di Giacinto <mudler@localai.io> Assisted-by: claude-code:opus-4-7 [Edit] [chrome-devtools-mcp] [Skill:distill] [Skill:audit] [Skill:polish] * feat(react-ui/nodes): replace scheduling form's model picker with searchable combobox The native <select> made operators scroll through every gallery entry to find a model name. The project already has SearchableModelSelect (used in Studio/Talk/etc.) which combines free-text search with the gallery list and accepts typed model names that aren't installed yet — useful for pre-staging a scheduling rule before the node it'll run on has finished bootstrapping. Also drops the now-unused useModels import (the combobox manages the gallery hook internally). Signed-off-by: Ettore Di Giacinto <mudler@localai.io> Assisted-by: claude-code:opus-4-7 [Edit] * refactor(react-ui/nodes): consolidate key/value chip editor + add replica preset chips The Nodes page was rendering the same key=value chip pattern in two places with subtly different markup: the Labels editor in the expanded drawer and (post-distill) the Node Selector input in the scheduling form. The form's input was also a comma-separated string that operators were getting wrong. * Extract <KeyValueChips> as a fully controlled chip-builder. Parent owns the map and decides what onAdd/onRemove does — form state for the scheduling form, API calls for the live drawer Labels editor. Same visuals everywhere; one component to change when polish needs apply. * Replace the comma-separated Node Selector text input with KeyValueChips. Operators were copying syntax from docs and missing commas; the chip vocabulary makes the key=value structure self-documenting. * Add <ReplicaInput>: numeric input + quick-pick preset chips for Min/Max replicas. Picked over a slider because replica counts are exact specs derived from VRAM math (operator decision, not a fuzzy estimate). The chips give one-click access to common values (1/2/3/4 for Min, 0=no-limit/2/4/8 for Max) without the slider's special-value problem (MaxReplicas=0 is categorical, not a position on a continuum). * Drop the now-unused labelInputs state in the Nodes page (the inline label editor's per-node draft state lived there and is now owned by KeyValueChips). Signed-off-by: Ettore Di Giacinto <mudler@localai.io> Assisted-by: claude-code:opus-4-7 [Edit] [Skill:distill] * test: fix CI fallout from multi-replica refactor (e2e/distributed + playwright) Two breakages caught by CI that didn't surface in the local run: * tests/e2e/distributed/*.go — multiple files used the pre-PR2 registry signatures for SetNodeModel / IncrementInFlight / DecrementInFlight / RemoveNodeModel / TouchNodeModel / GetNodeModel / SetNodeModelLoadInfo and one stale adapter.InstallBackend call in node_lifecycle_test.go. All updated to pass replicaIndex=0 — these tests don't exercise multi-replica behavior, they just need to compile against the new signatures. The chip-builder tests in core/services/nodes/ already cover the multi-replica logic. * core/http/react-ui/e2e/nodes-per-node-backend-actions.spec.js — the drawer's distill refactor moved Backends inside a "Manage" <details> disclosure that's collapsed by default. The test helper expanded the node row but never opened Manage, so the per-node backend table was never in the DOM. Helper now clicks `.node-manage > summary` after expanding the row. All 100 playwright tests pass locally; tests/e2e/distributed compiles clean. Signed-off-by: Ettore Di Giacinto <mudler@localai.io> Assisted-by: claude-code:opus-4-7 [Edit] [Bash] --------- Signed-off-by: Ettore Di Giacinto <mudler@localai.io>
588 lines
22 KiB
Go
588 lines
22 KiB
Go
package nodes
|
||
|
||
import (
|
||
"context"
|
||
"runtime"
|
||
"time"
|
||
|
||
. "github.com/onsi/ginkgo/v2"
|
||
. "github.com/onsi/gomega"
|
||
|
||
"github.com/mudler/LocalAI/core/services/testutil"
|
||
"gorm.io/gorm"
|
||
)
|
||
|
||
// ---------------------------------------------------------------------------
|
||
// Fake ModelScheduler
|
||
// ---------------------------------------------------------------------------
|
||
|
||
type fakeScheduler struct {
|
||
scheduleNode *BackendNode
|
||
scheduleErr error
|
||
scheduleCalls []scheduleCall
|
||
}
|
||
|
||
type scheduleCall struct {
|
||
modelName string
|
||
candidateIDs []string
|
||
}
|
||
|
||
func (f *fakeScheduler) ScheduleAndLoadModel(_ context.Context, modelName string, candidateNodeIDs []string) (*BackendNode, error) {
|
||
f.scheduleCalls = append(f.scheduleCalls, scheduleCall{modelName, candidateNodeIDs})
|
||
return f.scheduleNode, f.scheduleErr
|
||
}
|
||
|
||
var _ = Describe("ReplicaReconciler", func() {
|
||
var (
|
||
db *gorm.DB
|
||
registry *NodeRegistry
|
||
)
|
||
|
||
BeforeEach(func() {
|
||
if runtime.GOOS == "darwin" {
|
||
Skip("testcontainers requires Docker, not available on macOS CI")
|
||
}
|
||
db = testutil.SetupTestDB()
|
||
var err error
|
||
registry, err = NewNodeRegistry(db)
|
||
Expect(err).ToNot(HaveOccurred())
|
||
})
|
||
|
||
// Helper to register a healthy node with enough replica capacity for
|
||
// most tests. Pre-PR4 the reconciler ignored capacity, so existing
|
||
// fixtures didn't bother setting MaxReplicasPerModel — bumping the
|
||
// default here keeps the test intent ("scale up enough") working under
|
||
// the new capacity-aware logic. Tests that specifically exercise the
|
||
// circuit breaker should register nodes with a tighter cap.
|
||
registerNode := func(name, address string) *BackendNode {
|
||
node := &BackendNode{
|
||
Name: name,
|
||
NodeType: NodeTypeBackend,
|
||
Address: address,
|
||
MaxReplicasPerModel: 4,
|
||
}
|
||
Expect(registry.Register(context.Background(), node, true)).To(Succeed())
|
||
return node
|
||
}
|
||
|
||
// Helper to set up a scheduling config.
|
||
setSchedulingConfig := func(modelName string, minReplicas, maxReplicas int, nodeSelector string) {
|
||
cfg := &ModelSchedulingConfig{
|
||
ModelName: modelName,
|
||
MinReplicas: minReplicas,
|
||
MaxReplicas: maxReplicas,
|
||
NodeSelector: nodeSelector,
|
||
}
|
||
Expect(registry.SetModelScheduling(context.Background(), cfg)).To(Succeed())
|
||
}
|
||
|
||
Context("model below min_replicas", func() {
|
||
It("scales up to min_replicas", func() {
|
||
node := registerNode("node-1", "10.0.0.1:50051")
|
||
setSchedulingConfig("model-a", 2, 4, "")
|
||
|
||
scheduler := &fakeScheduler{
|
||
scheduleNode: node,
|
||
}
|
||
reconciler := NewReplicaReconciler(ReplicaReconcilerOptions{
|
||
Registry: registry,
|
||
Scheduler: scheduler,
|
||
DB: db,
|
||
})
|
||
|
||
// No replicas loaded — should schedule 2
|
||
reconciler.reconcile(context.Background())
|
||
|
||
Expect(scheduler.scheduleCalls).To(HaveLen(2))
|
||
Expect(scheduler.scheduleCalls[0].modelName).To(Equal("model-a"))
|
||
Expect(scheduler.scheduleCalls[1].modelName).To(Equal("model-a"))
|
||
})
|
||
})
|
||
|
||
Context("all replicas busy and below max_replicas", func() {
|
||
It("scales up by 1", func() {
|
||
node := registerNode("node-busy", "10.0.0.2:50051")
|
||
setSchedulingConfig("model-b", 1, 4, "")
|
||
|
||
// Load 2 replicas, both busy (in_flight > 0)
|
||
Expect(registry.SetNodeModel(context.Background(), node.ID, "model-b", 0, "loaded", "addr1", 0)).To(Succeed())
|
||
Expect(registry.IncrementInFlight(context.Background(), node.ID, "model-b", 0)).To(Succeed())
|
||
|
||
node2 := registerNode("node-busy-2", "10.0.0.3:50051")
|
||
Expect(registry.SetNodeModel(context.Background(), node2.ID, "model-b", 0, "loaded", "addr2", 0)).To(Succeed())
|
||
Expect(registry.IncrementInFlight(context.Background(), node2.ID, "model-b", 0)).To(Succeed())
|
||
|
||
scheduler := &fakeScheduler{
|
||
scheduleNode: node,
|
||
}
|
||
reconciler := NewReplicaReconciler(ReplicaReconcilerOptions{
|
||
Registry: registry,
|
||
Scheduler: scheduler,
|
||
DB: db,
|
||
})
|
||
|
||
reconciler.reconcile(context.Background())
|
||
|
||
Expect(scheduler.scheduleCalls).To(HaveLen(1))
|
||
Expect(scheduler.scheduleCalls[0].modelName).To(Equal("model-b"))
|
||
})
|
||
})
|
||
|
||
Context("all replicas busy and at max_replicas", func() {
|
||
It("does not scale up", func() {
|
||
node := registerNode("node-max", "10.0.0.4:50051")
|
||
setSchedulingConfig("model-c", 1, 2, "")
|
||
|
||
// Load 2 replicas (at max), both busy
|
||
Expect(registry.SetNodeModel(context.Background(), node.ID, "model-c", 0, "loaded", "addr1", 0)).To(Succeed())
|
||
Expect(registry.IncrementInFlight(context.Background(), node.ID, "model-c", 0)).To(Succeed())
|
||
|
||
node2 := registerNode("node-max-2", "10.0.0.5:50051")
|
||
Expect(registry.SetNodeModel(context.Background(), node2.ID, "model-c", 0, "loaded", "addr2", 0)).To(Succeed())
|
||
Expect(registry.IncrementInFlight(context.Background(), node2.ID, "model-c", 0)).To(Succeed())
|
||
|
||
scheduler := &fakeScheduler{
|
||
scheduleNode: node,
|
||
}
|
||
reconciler := NewReplicaReconciler(ReplicaReconcilerOptions{
|
||
Registry: registry,
|
||
Scheduler: scheduler,
|
||
DB: db,
|
||
})
|
||
|
||
reconciler.reconcile(context.Background())
|
||
|
||
Expect(scheduler.scheduleCalls).To(BeEmpty())
|
||
})
|
||
})
|
||
|
||
Context("idle replicas above min_replicas", func() {
|
||
It("scales down after idle delay", func() {
|
||
node1 := registerNode("node-idle-1", "10.0.0.6:50051")
|
||
node2 := registerNode("node-idle-2", "10.0.0.7:50051")
|
||
node3 := registerNode("node-idle-3", "10.0.0.8:50051")
|
||
setSchedulingConfig("model-d", 1, 4, "")
|
||
|
||
// Load 3 replicas, all idle with last_used in the past
|
||
pastTime := time.Now().Add(-10 * time.Minute)
|
||
for _, n := range []*BackendNode{node1, node2, node3} {
|
||
Expect(registry.SetNodeModel(context.Background(), n.ID, "model-d", 0, "loaded", "", 0)).To(Succeed())
|
||
// Set last_used to past time to trigger scale-down
|
||
db.Model(&NodeModel{}).Where("node_id = ? AND model_name = ?", n.ID, "model-d").
|
||
Update("last_used", pastTime)
|
||
}
|
||
|
||
unloader := &fakeUnloader{}
|
||
reconciler := NewReplicaReconciler(ReplicaReconcilerOptions{
|
||
Registry: registry,
|
||
Unloader: unloader,
|
||
DB: db,
|
||
ScaleDownDelay: 1 * time.Minute, // short delay for test
|
||
})
|
||
|
||
reconciler.reconcile(context.Background())
|
||
|
||
// Should scale down 2 replicas (3 - floor of 1)
|
||
Expect(unloader.unloadCalls).To(HaveLen(2))
|
||
})
|
||
})
|
||
|
||
Context("idle replicas at min_replicas", func() {
|
||
It("does not scale down", func() {
|
||
node1 := registerNode("node-keep-1", "10.0.0.9:50051")
|
||
node2 := registerNode("node-keep-2", "10.0.0.10:50051")
|
||
setSchedulingConfig("model-e", 2, 4, "")
|
||
|
||
// Load exactly 2 replicas (at min), both idle with past last_used
|
||
pastTime := time.Now().Add(-10 * time.Minute)
|
||
for _, n := range []*BackendNode{node1, node2} {
|
||
Expect(registry.SetNodeModel(context.Background(), n.ID, "model-e", 0, "loaded", "", 0)).To(Succeed())
|
||
db.Model(&NodeModel{}).Where("node_id = ? AND model_name = ?", n.ID, "model-e").
|
||
Update("last_used", pastTime)
|
||
}
|
||
|
||
unloader := &fakeUnloader{}
|
||
reconciler := NewReplicaReconciler(ReplicaReconcilerOptions{
|
||
Registry: registry,
|
||
Unloader: unloader,
|
||
DB: db,
|
||
ScaleDownDelay: 1 * time.Minute,
|
||
})
|
||
|
||
reconciler.reconcile(context.Background())
|
||
|
||
Expect(unloader.unloadCalls).To(BeEmpty())
|
||
})
|
||
})
|
||
|
||
Context("model with node_selector", func() {
|
||
It("passes candidate node IDs to scheduler", func() {
|
||
node1 := registerNode("gpu-node", "10.0.0.11:50051")
|
||
node2 := registerNode("cpu-node", "10.0.0.12:50051")
|
||
|
||
// Add labels — only node1 matches the selector
|
||
Expect(registry.SetNodeLabel(context.Background(), node1.ID, "gpu.vendor", "nvidia")).To(Succeed())
|
||
Expect(registry.SetNodeLabel(context.Background(), node2.ID, "gpu.vendor", "none")).To(Succeed())
|
||
|
||
setSchedulingConfig("model-f", 1, 2, `{"gpu.vendor":"nvidia"}`)
|
||
|
||
scheduler := &fakeScheduler{
|
||
scheduleNode: node1,
|
||
}
|
||
reconciler := NewReplicaReconciler(ReplicaReconcilerOptions{
|
||
Registry: registry,
|
||
Scheduler: scheduler,
|
||
DB: db,
|
||
})
|
||
|
||
// No replicas loaded — should schedule 1 with candidate node IDs
|
||
reconciler.reconcile(context.Background())
|
||
|
||
Expect(scheduler.scheduleCalls).To(HaveLen(1))
|
||
Expect(scheduler.scheduleCalls[0].modelName).To(Equal("model-f"))
|
||
Expect(scheduler.scheduleCalls[0].candidateIDs).To(ContainElement(node1.ID))
|
||
Expect(scheduler.scheduleCalls[0].candidateIDs).ToNot(ContainElement(node2.ID))
|
||
})
|
||
})
|
||
|
||
Describe("Capacity gating + circuit breaker (PR4)", func() {
|
||
// Helper: register a node with an explicit per-model replica cap.
|
||
// Tests in this Describe block want to exercise both "fits" and
|
||
// "doesn't fit" capacity scenarios precisely.
|
||
registerCappedNode := func(name, address string, cap int) *BackendNode {
|
||
node := &BackendNode{
|
||
Name: name,
|
||
NodeType: NodeTypeBackend,
|
||
Address: address,
|
||
MaxReplicasPerModel: cap,
|
||
}
|
||
Expect(registry.Register(context.Background(), node, true)).To(Succeed())
|
||
return node
|
||
}
|
||
|
||
It("caps scale-up at cluster capacity instead of looping forever", func() {
|
||
// 1 node × 1 slot = capacity 1, but MinReplicas=2.
|
||
// Pre-PR4 this looped: every 30s "scaling up to meet minimum"
|
||
// because the registry never grew to 2. Post-PR4 the reconciler
|
||
// does the math up front and only schedules 1 (the achievable
|
||
// target), then flags unsatisfiable on the next ticks.
|
||
node := registerCappedNode("cap-1-slot", "10.0.0.40:50051", 1)
|
||
Expect(registry.SetModelScheduling(context.Background(), &ModelSchedulingConfig{
|
||
ModelName: "tight-model",
|
||
MinReplicas: 2,
|
||
})).To(Succeed())
|
||
|
||
scheduler := &fakeScheduler{scheduleNode: node}
|
||
reconciler := NewReplicaReconciler(ReplicaReconcilerOptions{
|
||
Registry: registry,
|
||
Scheduler: scheduler,
|
||
DB: db,
|
||
})
|
||
|
||
reconciler.reconcile(context.Background())
|
||
|
||
Expect(scheduler.scheduleCalls).To(HaveLen(1),
|
||
"only 1 schedule call: capacity is 1, not the requested 2 — must not loop")
|
||
})
|
||
|
||
It("flags unsatisfiable after threshold consecutive ticks at capacity 0", func() {
|
||
// 1 node × 1 slot, already loaded. Capacity=0, but MinReplicas=2.
|
||
// Each tick increments UnsatisfiableTicks; once we cross the
|
||
// threshold the cooldown timestamp is set and further ticks
|
||
// short-circuit (the scheduler is no longer called).
|
||
node := registerCappedNode("cb-node", "10.0.0.41:50051", 1)
|
||
Expect(registry.SetNodeModel(context.Background(), node.ID, "cb-model", 0, "loaded", "addr1", 0)).To(Succeed())
|
||
Expect(registry.SetModelScheduling(context.Background(), &ModelSchedulingConfig{
|
||
ModelName: "cb-model",
|
||
MinReplicas: 2,
|
||
})).To(Succeed())
|
||
|
||
scheduler := &fakeScheduler{scheduleNode: node}
|
||
reconciler := NewReplicaReconciler(ReplicaReconcilerOptions{
|
||
Registry: registry,
|
||
Scheduler: scheduler,
|
||
DB: db,
|
||
})
|
||
|
||
// Drive enough ticks to cross the threshold, plus a couple more
|
||
// to confirm the cooldown holds.
|
||
for i := 0; i < unsatisfiableTickThreshold+2; i++ {
|
||
reconciler.reconcile(context.Background())
|
||
}
|
||
|
||
cfg, err := registry.GetModelScheduling(context.Background(), "cb-model")
|
||
Expect(err).ToNot(HaveOccurred())
|
||
Expect(cfg.UnsatisfiableUntil).ToNot(BeNil(),
|
||
"reconciler must flag the config after threshold ticks of capacity exhaustion")
|
||
Expect(cfg.UnsatisfiableUntil.After(time.Now())).To(BeTrue(),
|
||
"cooldown must point to the future")
|
||
// Capacity 0 + cooldown active means the scheduler shouldn't have
|
||
// been invoked at all — capacity was 0 from the first tick.
|
||
Expect(scheduler.scheduleCalls).To(BeEmpty(),
|
||
"capacity was always 0 — no schedule attempts should have been made")
|
||
})
|
||
|
||
It("clears unsatisfiable on a successful scale-up", func() {
|
||
// Pre-flag the config (simulate a prior unsatisfiable run), then
|
||
// register enough capacity and tick — the reconciler must clear
|
||
// the flag and proceed.
|
||
node := registerCappedNode("clear-node", "10.0.0.42:50051", 4)
|
||
until := time.Now().Add(-1 * time.Second) // already-expired cooldown
|
||
Expect(registry.SetModelScheduling(context.Background(), &ModelSchedulingConfig{
|
||
ModelName: "clear-model",
|
||
MinReplicas: 1,
|
||
UnsatisfiableTicks: 5,
|
||
UnsatisfiableUntil: &until,
|
||
})).To(Succeed())
|
||
|
||
scheduler := &fakeScheduler{scheduleNode: node}
|
||
reconciler := NewReplicaReconciler(ReplicaReconcilerOptions{
|
||
Registry: registry,
|
||
Scheduler: scheduler,
|
||
DB: db,
|
||
})
|
||
|
||
reconciler.reconcile(context.Background())
|
||
|
||
Expect(scheduler.scheduleCalls).To(HaveLen(1),
|
||
"expired cooldown should not block scheduling")
|
||
|
||
cfg, err := registry.GetModelScheduling(context.Background(), "clear-model")
|
||
Expect(err).ToNot(HaveOccurred())
|
||
Expect(cfg.UnsatisfiableUntil).To(BeNil(), "successful scale-up must clear the cooldown")
|
||
Expect(cfg.UnsatisfiableTicks).To(Equal(0), "successful scale-up must reset the counter")
|
||
})
|
||
|
||
It("recovers when a new node joins (ClearAllUnsatisfiable on Register)", func() {
|
||
// One full node, then config flagged unsatisfiable. Adding a
|
||
// second node simulates the user's recovery question: capacity
|
||
// returns, cooldown clears, the next tick schedules.
|
||
node1 := registerCappedNode("rec-node-1", "10.0.0.43:50051", 1)
|
||
Expect(registry.SetNodeModel(context.Background(), node1.ID, "rec-model", 0, "loaded", "addr1", 0)).To(Succeed())
|
||
|
||
until := time.Now().Add(unsatisfiableCooldown)
|
||
Expect(registry.SetModelScheduling(context.Background(), &ModelSchedulingConfig{
|
||
ModelName: "rec-model",
|
||
MinReplicas: 2,
|
||
UnsatisfiableTicks: unsatisfiableTickThreshold,
|
||
UnsatisfiableUntil: &until,
|
||
})).To(Succeed())
|
||
|
||
// New node registers — this is the recovery event.
|
||
registerCappedNode("rec-node-2", "10.0.0.44:50051", 1)
|
||
|
||
cfg, err := registry.GetModelScheduling(context.Background(), "rec-model")
|
||
Expect(err).ToNot(HaveOccurred())
|
||
Expect(cfg.UnsatisfiableUntil).To(BeNil(),
|
||
"Register must clear unsatisfiable flags so the reconciler retries")
|
||
Expect(cfg.UnsatisfiableTicks).To(Equal(0))
|
||
})
|
||
|
||
It("recovers when node labels change (ClearAllUnsatisfiable on label ops)", func() {
|
||
node := registerCappedNode("lbl-node", "10.0.0.45:50051", 1)
|
||
until := time.Now().Add(unsatisfiableCooldown)
|
||
Expect(registry.SetModelScheduling(context.Background(), &ModelSchedulingConfig{
|
||
ModelName: "lbl-model",
|
||
MinReplicas: 2,
|
||
UnsatisfiableTicks: unsatisfiableTickThreshold,
|
||
UnsatisfiableUntil: &until,
|
||
})).To(Succeed())
|
||
|
||
// Adding a label could change which models the node matches via
|
||
// a NodeSelector, so capacity for some config may have just
|
||
// changed. ClearAllUnsatisfiable lets the reconciler re-check.
|
||
Expect(registry.SetNodeLabel(context.Background(), node.ID, "tier", "fast")).To(Succeed())
|
||
|
||
cfg, err := registry.GetModelScheduling(context.Background(), "lbl-model")
|
||
Expect(err).ToNot(HaveOccurred())
|
||
Expect(cfg.UnsatisfiableUntil).To(BeNil())
|
||
})
|
||
})
|
||
|
||
Describe("ClusterCapacityForModel", func() {
|
||
It("sums (max_replicas_per_model - replicas[node, model]) over candidates", func() {
|
||
// Three nodes with caps 4, 2, 1. Loaded counts: 1, 0, 1 → free
|
||
// slots: 3, 2, 0 → total capacity 5.
|
||
a := &BackendNode{Name: "cap-a", NodeType: NodeTypeBackend, Address: "10.0.0.50:50051", MaxReplicasPerModel: 4}
|
||
b := &BackendNode{Name: "cap-b", NodeType: NodeTypeBackend, Address: "10.0.0.51:50051", MaxReplicasPerModel: 2}
|
||
c := &BackendNode{Name: "cap-c", NodeType: NodeTypeBackend, Address: "10.0.0.52:50051", MaxReplicasPerModel: 1}
|
||
Expect(registry.Register(context.Background(), a, true)).To(Succeed())
|
||
Expect(registry.Register(context.Background(), b, true)).To(Succeed())
|
||
Expect(registry.Register(context.Background(), c, true)).To(Succeed())
|
||
|
||
Expect(registry.SetNodeModel(context.Background(), a.ID, "cap-model", 0, "loaded", "x", 0)).To(Succeed())
|
||
Expect(registry.SetNodeModel(context.Background(), c.ID, "cap-model", 0, "loaded", "y", 0)).To(Succeed())
|
||
|
||
cap, err := registry.ClusterCapacityForModel(context.Background(), "cap-model", nil)
|
||
Expect(err).ToNot(HaveOccurred())
|
||
Expect(cap).To(Equal(5))
|
||
|
||
// Restricting to {b, c}: b free=2, c free=0 → capacity 2.
|
||
cap, err = registry.ClusterCapacityForModel(context.Background(), "cap-model", []string{b.ID, c.ID})
|
||
Expect(err).ToNot(HaveOccurred())
|
||
Expect(cap).To(Equal(2))
|
||
})
|
||
})
|
||
})
|
||
|
||
// fakeProber lets tests control whether a model's gRPC address "responds".
|
||
type fakeProber struct {
|
||
alive map[string]bool
|
||
calls int
|
||
}
|
||
|
||
func (f *fakeProber) IsAlive(_ context.Context, address string) bool {
|
||
f.calls++
|
||
if f.alive == nil {
|
||
return false
|
||
}
|
||
return f.alive[address]
|
||
}
|
||
|
||
var _ = Describe("ReplicaReconciler — state reconciliation", func() {
|
||
var (
|
||
db *gorm.DB
|
||
registry *NodeRegistry
|
||
)
|
||
|
||
BeforeEach(func() {
|
||
if runtime.GOOS == "darwin" {
|
||
Skip("testcontainers requires Docker, not available on macOS CI")
|
||
}
|
||
db = testutil.SetupTestDB()
|
||
var err error
|
||
registry, err = NewNodeRegistry(db)
|
||
Expect(err).ToNot(HaveOccurred())
|
||
})
|
||
|
||
Describe("probeLoadedModels", func() {
|
||
It("removes loaded models whose gRPC address is unreachable", func() {
|
||
node := &BackendNode{Name: "n1", NodeType: NodeTypeBackend, Address: "10.0.0.1:50051"}
|
||
Expect(registry.Register(context.Background(), node, true)).To(Succeed())
|
||
// Two loaded models — one stale (will probe), one fresh (skipped).
|
||
stale := &NodeModel{
|
||
ID: "stale-1",
|
||
NodeID: node.ID,
|
||
ModelName: "stale-model",
|
||
Address: "10.0.0.1:12345",
|
||
State: "loaded",
|
||
UpdatedAt: time.Now().Add(-5 * time.Minute),
|
||
}
|
||
fresh := &NodeModel{
|
||
ID: "fresh-1",
|
||
NodeID: node.ID,
|
||
ModelName: "fresh-model",
|
||
Address: "10.0.0.1:54321",
|
||
State: "loaded",
|
||
UpdatedAt: time.Now(), // within probeStaleAfter
|
||
}
|
||
Expect(db.Create(stale).Error).To(Succeed())
|
||
Expect(db.Create(fresh).Error).To(Succeed())
|
||
|
||
prober := &fakeProber{alive: map[string]bool{"10.0.0.1:12345": false}}
|
||
rc := NewReplicaReconciler(ReplicaReconcilerOptions{
|
||
Registry: registry,
|
||
DB: db,
|
||
Prober: prober,
|
||
ProbeStaleAfter: 2 * time.Minute,
|
||
})
|
||
|
||
rc.probeLoadedModels(context.Background())
|
||
|
||
// Stale was unreachable — row removed.
|
||
var after []NodeModel
|
||
Expect(db.Find(&after).Error).To(Succeed())
|
||
Expect(after).To(HaveLen(1))
|
||
Expect(after[0].ModelName).To(Equal("fresh-model"))
|
||
// Prober was only called once (the fresh row was filtered out).
|
||
Expect(prober.calls).To(Equal(1))
|
||
})
|
||
|
||
It("keeps reachable models and bumps their updated_at", func() {
|
||
node := &BackendNode{Name: "n1", NodeType: NodeTypeBackend, Address: "10.0.0.1:50051"}
|
||
Expect(registry.Register(context.Background(), node, true)).To(Succeed())
|
||
stale := &NodeModel{
|
||
ID: "stale-2",
|
||
NodeID: node.ID,
|
||
ModelName: "alive-model",
|
||
Address: "10.0.0.1:12345",
|
||
State: "loaded",
|
||
UpdatedAt: time.Now().Add(-5 * time.Minute),
|
||
}
|
||
Expect(db.Create(stale).Error).To(Succeed())
|
||
|
||
prober := &fakeProber{alive: map[string]bool{"10.0.0.1:12345": true}}
|
||
rc := NewReplicaReconciler(ReplicaReconcilerOptions{
|
||
Registry: registry,
|
||
DB: db,
|
||
Prober: prober,
|
||
ProbeStaleAfter: 2 * time.Minute,
|
||
})
|
||
|
||
rc.probeLoadedModels(context.Background())
|
||
|
||
var after NodeModel
|
||
Expect(db.First(&after, "id = ?", "stale-2").Error).To(Succeed())
|
||
Expect(after.UpdatedAt).To(BeTemporally("~", time.Now(), time.Second))
|
||
})
|
||
})
|
||
|
||
Describe("UpsertPendingBackendOp + RecordPendingBackendOpFailure", func() {
|
||
It("upserts on the composite key rather than duplicating rows", func() {
|
||
node := &BackendNode{Name: "n1", NodeType: NodeTypeBackend, Address: "10.0.0.1:50051"}
|
||
Expect(registry.Register(context.Background(), node, true)).To(Succeed())
|
||
|
||
Expect(registry.UpsertPendingBackendOp(context.Background(), node.ID, "foo", OpBackendDelete, nil)).To(Succeed())
|
||
// Second call for the same (node, backend, op) should not create a
|
||
// new row — that's how re-issuing a delete works.
|
||
Expect(registry.UpsertPendingBackendOp(context.Background(), node.ID, "foo", OpBackendDelete, nil)).To(Succeed())
|
||
|
||
var rows []PendingBackendOp
|
||
Expect(db.Find(&rows).Error).To(Succeed())
|
||
Expect(rows).To(HaveLen(1))
|
||
})
|
||
|
||
It("increments attempts and moves next_retry_at out on failure", func() {
|
||
node := &BackendNode{Name: "n1", NodeType: NodeTypeBackend, Address: "10.0.0.1:50051"}
|
||
Expect(registry.Register(context.Background(), node, true)).To(Succeed())
|
||
Expect(registry.UpsertPendingBackendOp(context.Background(), node.ID, "foo", OpBackendDelete, nil)).To(Succeed())
|
||
|
||
var row PendingBackendOp
|
||
Expect(db.First(&row).Error).To(Succeed())
|
||
before := row.NextRetryAt
|
||
|
||
Expect(registry.RecordPendingBackendOpFailure(context.Background(), row.ID, "boom")).To(Succeed())
|
||
Expect(db.First(&row, row.ID).Error).To(Succeed())
|
||
Expect(row.Attempts).To(Equal(1))
|
||
Expect(row.LastError).To(Equal("boom"))
|
||
Expect(row.NextRetryAt).To(BeTemporally(">", before))
|
||
})
|
||
})
|
||
|
||
Describe("NewNodeRegistry malformed-row pruning", func() {
|
||
It("drops queue rows for agent nodes and non-existent nodes on startup", func() {
|
||
agent := &BackendNode{Name: "agent-1", NodeType: NodeTypeAgent, Address: "x"}
|
||
Expect(registry.Register(context.Background(), agent, true)).To(Succeed())
|
||
backend := &BackendNode{Name: "backend-1", NodeType: NodeTypeBackend, Address: "y"}
|
||
Expect(registry.Register(context.Background(), backend, true)).To(Succeed())
|
||
|
||
// Three rows: one for a valid backend node (should survive),
|
||
// one for an agent node (pruned), one for an empty backend name
|
||
// on the valid node (pruned).
|
||
Expect(registry.UpsertPendingBackendOp(context.Background(), backend.ID, "foo", OpBackendInstall, nil)).To(Succeed())
|
||
Expect(registry.UpsertPendingBackendOp(context.Background(), agent.ID, "foo", OpBackendInstall, nil)).To(Succeed())
|
||
Expect(registry.UpsertPendingBackendOp(context.Background(), backend.ID, "", OpBackendInstall, nil)).To(Succeed())
|
||
|
||
// Re-instantiating the registry runs the cleanup migration.
|
||
_, err := NewNodeRegistry(db)
|
||
Expect(err).ToNot(HaveOccurred())
|
||
|
||
var rows []PendingBackendOp
|
||
Expect(db.Find(&rows).Error).To(Succeed())
|
||
Expect(rows).To(HaveLen(1))
|
||
Expect(rows[0].NodeID).To(Equal(backend.ID))
|
||
Expect(rows[0].Backend).To(Equal("foo"))
|
||
})
|
||
})
|
||
})
|