Skip to content

Commit f47813a

Browse files
committed
docs(api): clarify ImpWarmPool.SnapshotRef resolves via BaseSnapshot election
1 parent 0948751 commit f47813a

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

api/v1alpha1/impwarmpool_types.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
44

55
// ImpWarmPoolSpec defines a pool of pre-booted VMs ready for instant assignment.
66
type ImpWarmPoolSpec struct {
7-
// SnapshotRef names the ImpVMSnapshot to boot pool members from.
7+
// SnapshotRef names the ImpVMSnapshot parent to boot pool members from.
8+
// The pool controller uses status.baseSnapshot on the referenced object
9+
// to resolve the elected execution artifact. The pool stays idle until
10+
// a base snapshot has been elected via `kubectl imp elect`.
811
SnapshotRef string `json:"snapshotRef"`
912

1013
// Size is the number of pre-booted VMs to maintain in the pool.

0 commit comments

Comments
 (0)