use enable instead of disable for plugin config

Author: sp-yduck

cloud/scheduler/README.md

@@ -8,7 +8,12 @@ Basic flow of the node selection process is `filter => score => select one node
 
 ### Filter Plugins
 
-Filter plugins filter the node based on nodename, overcommit ratio etc.
+Filter plugins filter the node based on nodename, overcommit ratio etc. So that we can avoid to run qemus on not desired Proxmox nodes.
+
+- [NodeName plugin](./plugins/nodename/node_name.go) (pass the node matching specified node name)
+- [CPUOvercommit plugin](./plugins/overcommit/cpu_overcommit.go) (pass the node that has enough cpu against running vm)
+- [MemoryOvercommit plugin](./plugins/overcommit/memory_overcommit.go) (pass the node that has enough memory against running vm)
+- [NodeRegex plugin](./plugins/regex/node_regex.go) (pass the node matching specified regex)
 
 #### regex plugin
 
@@ -20,11 +25,17 @@ value(example): node[0-9]+
 
 ### Score Plugins
 
-Score plugins score the nodes based on resource etc.
+Score plugins score the nodes based on resource etc. So that we can run qemus on the most appropriate Proxmox node.
+
+- [NodeResource plugin](./plugins/noderesource/node_resrouce.go) (nodes with more resources have higher scores)
+- [Random plugin](./plugins/random/random.go) (just a reference implementation of score plugin)
 
 ## 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](./plugins/idrange/idrange.go) (select minimum availabe vmid from the specified id range)
+- [VMIDRegex plugin](./plugins/regex/vmid_regex.go) (select minimum availabe vmid matching specified regex)
+
 ### Range Plugin
 You can specify vmid range with `(start id)-(end id)` format.
 ```sh
@@ -64,4 +75,21 @@ spec:
     metadata:
       annotations:
         node.qemu-scheduler/regex: node[0-9]+ # this annotation will be propagated to your ProxmoxMachine via MachineSet
+```
+
+## How to configure (or disable/enable) specific Plugins
+
+By default, all the plugins are enabled. You can disable specific plugins via plugin-config.
+```sh
+# example plugin-config.yaml
+
+# plugin type name (scores, filters, vmids)
+scores:
+  - Random: 
+      enable: false # disable
+filters:
+  - CPUOvercommit:
+      enable: false # disable
+  - MemoryOvercommit:
+      enable true   # enable (can be omitted)
 ```

cloud/scheduler/plugins/registry.go

@@ -21,8 +21,8 @@ type PluginConfigs struct {
 }
 
 type pluginConfig struct {
-	Disable bool                   `yaml:"disable,omitempty"`
-	Config  map[string]interface{} `yaml:"config,omitempty"`
+	Enable bool                   `yaml:"enable,omitempty"`
+	Config map[string]interface{} `yaml:"config,omitempty"`
 }
 
 type PluginRegistry struct {
@@ -62,7 +62,7 @@ func NewNodeFilterPlugins(config map[string]pluginConfig) []framework.NodeFilter
 	plugins := []framework.NodeFilterPlugin{}
 	for _, pl := range pls {
 		c, ok := config[pl.Name()]
-		if ok && c.Disable {
+		if ok && !c.Enable {
 			continue
 		}
 		plugins = append(plugins, pl)
@@ -78,7 +78,7 @@ func NewNodeScorePlugins(config map[string]pluginConfig) []framework.NodeScorePl
 	plugins := []framework.NodeScorePlugin{}
 	for _, pl := range pls {
 		c, ok := config[pl.Name()]
-		if ok && c.Disable {
+		if ok && !c.Enable {
 			continue
 		}
 		plugins = append(plugins, pl)
@@ -94,7 +94,7 @@ func NewVMIDPlugins(config map[string]pluginConfig) []framework.VMIDPlugin {
 	plugins := []framework.VMIDPlugin{}
 	for _, pl := range pls {
 		c, ok := config[pl.Name()]
-		if ok && c.Disable {
+		if ok && !c.Enable {
 			continue
 		}
 		plugins = append(plugins, pl)

config/manager/manager.yaml

@@ -129,9 +129,9 @@ data:
   plugin-config.yaml: | 
     scores:
       - Random:
-          disable: true
-    # filters:
-      # - CPUOvercommit:
-      #     disable: true
-      # - MemoryOvercommit:
-      #     disable: true
+          enable: false
+    filters:
+      - CPUOvercommit:
+          enable: false
+      - MemoryOvercommit:
+          enable: false