implement first 2 vmid scheduler plugin

Author: sp-yduck

cloud/scheduler/README.md

@@ -1,3 +1,47 @@
 # qemu-scheduler
 
 Scheduling refers to making sure that VM(QEMU) are matched to Proxmox Nodes.
+
+## How to specify vmid
+qemu-scheduler reads context and find key registerd to scheduler. If the context has any value of the registerd key, qemu-scheduler uses the plugin that matchies the key.
+
+### Range Plugin
+You can specify vmid range with `(start id)-(end id)` format.
+```
+key: vmid.qemu-scheduler/range
+value(example): 100-150
+```
+
+### Regex Plugin
+```
+key: vmid.qemu-scheduler/regex
+value(example): (12[0-9]|130)
+```
+
+## How qemu-scheduler works with CAPPX
+CAPPX passes all the annotation (of `ProxmoxMachine`) key-values to scheduler's context. So if you will use Range Plugin for your `ProxmoxMachine`, your manifest must look like following.
+```sh
+apiVersion: infrastructure.cluster.x-k8s.io/v1beta1
+kind: ProxmoxMachine
+metadata:
+    name: sample-machine
+    annotations:
+        vmid.qemu-scheduler/range: 100-150 # this means your vmid will be chosen from the range of 100 to 150.
+```
+
+Also, you can specifies these annotations via `MachineDeployment` since Cluster API propagates some metadatas (ref: [metadata-propagation](https://cluster-api.sigs.k8s.io/developer/architecture/controllers/metadata-propagation.html#metadata-propagation)).
+
+For example, your `MachineDeployment` may look like following.
+```sh
+apiVersion: cluster.x-k8s.io/v1beta1
+kind: MachineDeployment
+metadata:
+  annotations:
+    caution: "# do not use here, because this annotation won't be propagated to your ProxmoxMachine"
+  name: sample-machine-deployment
+spec:
+  template:
+    metadata:
+      annotations:
+        vmid.qemu-scheduler/range: 100-150 # this annotation will be propagated to your ProxmoxMachine via MachineSet
+```

cloud/scheduler/framework/cycle_state.go

@@ -1,68 +1,68 @@
-package framework
-
-import (
-	"github.com/sp-yduck/proxmox-go/api"
-	"github.com/sp-yduck/proxmox-go/proxmox"
-)
-
-type CycleState struct {
-	completed bool
-	err       error
-	result    SchedulerResult
-}
-
-type SchedulerResult struct {
-	vmid     int
-	node     string
-	instance *proxmox.VirtualMachine
-}
-
-func NewCycleState() CycleState {
-	return CycleState{completed: false, err: nil}
-}
-
-func (c *CycleState) SetComplete() {
-	c.completed = true
-}
-
-func (c *CycleState) IsCompleted() bool {
-	return c.completed
-}
-
-func (c *CycleState) SetError(err error) {
-	c.err = err
-}
-
-func (c *CycleState) Error() error {
-	return c.err
-}
-
-func (c *CycleState) QEMU() *api.VirtualMachine {
-	return c.result.instance.VM
-}
-
-func (c *CycleState) UpdateState(completed bool, err error, result *SchedulerResult) {
-	c.completed = completed
-	c.err = err
-	c.result = *result
-}
-
-func NewSchedulerResult(vmid int, node string, instance *proxmox.VirtualMachine) SchedulerResult {
-	return SchedulerResult{vmid: vmid, node: node, instance: instance}
-}
-
-func (c *CycleState) Result() SchedulerResult {
-	return c.result
-}
-
-func (r *SchedulerResult) Node() string {
-	return r.node
-}
-
-func (r *SchedulerResult) VMID() int {
-	return r.vmid
-}
-
-func (r *SchedulerResult) Instance() *proxmox.VirtualMachine {
-	return r.instance
-}
+package framework
+
+import (
+	"github.com/sp-yduck/proxmox-go/api"
+	"github.com/sp-yduck/proxmox-go/proxmox"
+)
+
+type CycleState struct {
+	completed bool
+	err       error
+	result    SchedulerResult
+}
+
+type SchedulerResult struct {
+	vmid     int
+	node     string
+	instance *proxmox.VirtualMachine
+}
+
+func NewCycleState() CycleState {
+	return CycleState{completed: false, err: nil}
+}
+
+func (c *CycleState) SetComplete() {
+	c.completed = true
+}
+
+func (c *CycleState) IsCompleted() bool {
+	return c.completed
+}
+
+func (c *CycleState) SetError(err error) {
+	c.err = err
+}
+
+func (c *CycleState) Error() error {
+	return c.err
+}
+
+func (c *CycleState) QEMU() *api.VirtualMachine {
+	return c.result.instance.VM
+}
+
+func (c *CycleState) UpdateState(completed bool, err error, result *SchedulerResult) {
+	c.completed = completed
+	c.err = err
+	c.result = *result
+}
+
+func NewSchedulerResult(vmid int, node string, instance *proxmox.VirtualMachine) SchedulerResult {
+	return SchedulerResult{vmid: vmid, node: node, instance: instance}
+}
+
+func (c *CycleState) Result() SchedulerResult {
+	return c.result
+}
+
+func (r *SchedulerResult) Node() string {
+	return r.node
+}
+
+func (r *SchedulerResult) VMID() int {
+	return r.vmid
+}
+
+func (r *SchedulerResult) Instance() *proxmox.VirtualMachine {
+	return r.instance
+}

cloud/scheduler/framework/interface.go

@@ -1,27 +1,28 @@
-package framework
-
-import (
-	"context"
-
-	"github.com/sp-yduck/proxmox-go/api"
-)
-
-type Plugin interface {
-	// return plugin name
-	Name() string
-}
-
-type NodeFilterPlugin interface {
-	Plugin
-	Filter(ctx context.Context, state *CycleState, config api.VirtualMachineCreateOptions, nodeInfo *NodeInfo) *Status
-}
-
-type NodeScorePlugin interface {
-	Plugin
-	Score(ctx context.Context, state *CycleState, config api.VirtualMachineCreateOptions, nodeInfo *NodeInfo) (int64, *Status)
-}
-
-type VMIDPlugin interface {
-	Plugin
-	Select(ctx context.Context, state *CycleState, config api.VirtualMachineCreateOptions) (int, error)
-}
+package framework
+
+import (
+	"context"
+
+	"github.com/sp-yduck/proxmox-go/api"
+)
+
+type Plugin interface {
+	// return plugin name
+	Name() string
+}
+
+type NodeFilterPlugin interface {
+	Plugin
+	Filter(ctx context.Context, state *CycleState, config api.VirtualMachineCreateOptions, nodeInfo *NodeInfo) *Status
+}
+
+type NodeScorePlugin interface {
+	Plugin
+	Score(ctx context.Context, state *CycleState, config api.VirtualMachineCreateOptions, nodeInfo *NodeInfo) (int64, *Status)
+}
+
+type VMIDPlugin interface {
+	Plugin
+	PluginKey() CtxKey
+	Select(ctx context.Context, state *CycleState, config api.VirtualMachineCreateOptions, nextid int, usedID map[int]bool) (int, error)
+}