Added PEAKS plugin code changes

Signed-off-by: Felix George <felixpv007@gmail.com>

Author: fali007

apis/config/register.go

@@ -44,6 +44,7 @@ func addKnownTypes(scheme *runtime.Scheme) error {
 		&TopologicalSortArgs{},
 		&NetworkOverheadArgs{},
 		&SySchedArgs{},
+		&PeaksArgs{},
 	)
 	return nil
 }

apis/config/types.go

@@ -279,3 +279,22 @@ type SySchedArgs struct {
 	// CR name of the default profile for all system calls
 	DefaultProfileName string
 }
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// PeaksArgs holds arguments used to configure the Peaks plugin
+type PeaksArgs struct {
+	metav1.TypeMeta
+
+	// Address of load watcher service
+	WatcherAddress string
+	NodePowerModel map[string]PowerModel // Node power model where key is node name and value is power model
+}
+
+type PowerModel struct {
+	K0 float64 `json:"k0"`
+	K1 float64 `json:"k1"`
+	K2 float64 `json:"k2"`
+	// Power = K0 + K1 * e ^(K2 * x) : where x is utilisation
+	// Idle power of node will be K0 + K1
+}

apis/config/v1/register.go

@@ -46,6 +46,7 @@ func addKnownTypes(scheme *runtime.Scheme) error {
 		&TopologicalSortArgs{},
 		&NetworkOverheadArgs{},
 		&SySchedArgs{},
+		&PeaksArgs{},
 	)
 	return nil
 }

apis/config/v1/types.go

@@ -277,3 +277,23 @@ type SySchedArgs struct {
 	// CR name of the default profile for all system calls
 	DefaultProfileName *string `json:"defaultProfileName,omitempty"`
 }
+
+// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
+
+// PeaksArgs holds arguments used to configure the Peaks plugin
+type PeaksArgs struct {
+	metav1.TypeMeta `json:",inline"`
+
+	// Address of load watcher service
+	WatcherAddress string `json:watcherAddress",inline"`
+	// Associating power models to nodes using node labels will be added as a functionality in a future PR.
+	NodePowerModel map[string]PowerModel `json:nodePowerModel",inline"`
+}
+
+type PowerModel struct {
+	K0 float64 `json:"k0"`
+	K1 float64 `json:"k1"`
+	K2 float64 `json:"k2"`
+	// Power = K0 + K1 * e ^(K2 * x) : where x is utilisation
+	// Idle power of node will be K0 + K1
+}

apis/config/v1/zz_generated.conversion.go

@@ -36,6 +36,7 @@ import (
 	"sigs.k8s.io/scheduler-plugins/pkg/sysched"
 	"sigs.k8s.io/scheduler-plugins/pkg/trimaran/loadvariationriskbalancing"
 	"sigs.k8s.io/scheduler-plugins/pkg/trimaran/lowriskovercommitment"
+	"sigs.k8s.io/scheduler-plugins/pkg/trimaran/peaks"
 	"sigs.k8s.io/scheduler-plugins/pkg/trimaran/targetloadpacking"
 
 	// Ensure scheme package is initialized.
@@ -58,6 +59,7 @@ func main() {
 		app.WithPlugin(targetloadpacking.Name, targetloadpacking.New),
 		app.WithPlugin(lowriskovercommitment.Name, lowriskovercommitment.New),
 		app.WithPlugin(sysched.Name, sysched.New),
+		app.WithPlugin(peaks.Name, peaks.New),
 		// Sample plugins below.
 		// app.WithPlugin(crossnodepreemption.Name, crossnodepreemption.New),
 		app.WithPlugin(podstate.Name, podstate.New),

apis/config/v1/zz_generated.deepcopy.go

@@ -0,0 +1,65 @@
+# Getting Started
+
+## Configuring load-watcher on a Kubernetes cluster
+
+#### Clone repository.
+
+We use the available manifest file to create load-watcher pod and service.
+
+```bash
+git clone https://github.com/paypal/load-watcher.git
+```
+
+Building image
+
+```bash
+docker build -t load-watcher:local .
+docker tag load-watcher:local <replace_with_image_registry>/loadwatcher:latest
+docker push <replace_with_image_registry>/loadwatcher:latest
+```
+
+Deploy load-watcher
+Follow https://github.com/paypal/load-watcher?tab=readme-ov-file#deploy-load-watcher-as-a-service
+
+## Configure PEAKS scheduler plugin
+
+Building image
+
+```bash
+make release-image.amd64
+docker tag <image tag> <new image tag>
+docker push <new image tag>
+```
+
+Configuring power model
+
+```bash
+kubectl create configmap peaks-node-power-model --from-file=peaks-power-model-config.json -n kube-system
+```
+
+Deploy peaks RBAC configurations
+
+```bash
+kubectl apply -f peaks.yaml
+```
+
+Deploy peaks plugin
+
+```bash
+kubectl apply -f deployment.yaml
+```
+
+Test peaks plugin
+
+```bash
+kubectl apply -f test-po.yaml
+```
+
+## Running the unit test cases
+To run the `go` unit test cases, set the environment variable `NODE_POWER_MODEL` appropriately, as below example.
+```bash
+export NODE_POWER_MODEL=./power_model/node_power_model
+```
+
+## Peaks Power Model JSON schema
+The power model typically is a mathematical expression (e.g., `NodePower = K0 + K1 * e^(K2 * x)`, where `x` is node utilisation and each `K` is a constant)

apis/config/zz_generated.deepcopy.go

@@ -0,0 +1,36 @@
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  labels:
+    component: scheduler
+    tier: control-plane
+  name: peaks
+  namespace: kube-system
+spec:
+  selector:
+    matchLabels:
+      component: scheduler
+      tier: control-plane
+  replicas: 1
+  template:
+    metadata:
+      labels:
+        component: scheduler
+        tier: control-plane
+        version: second
+    spec:
+      serviceAccountName: peaks
+      hostNetwork: true
+      containers:
+      - name: peaks
+        command:
+        - /bin/kube-scheduler
+        - --bind-address=0.0.0.0
+        - --leader-elect=false
+        - --config=/home/scheduler-config.yaml
+        - -v=6
+        image: <REPLACE_ME_WITH_PEAKS_IMAGE>
+        imagePullPolicy: Always
+        resources:
+          requests:
+            cpu: '0.1'

cmd/scheduler/main.go

@@ -0,0 +1 @@
+{"node_1":{"k0":"<replace with node 1 k0>","k1":"<replace with node 1 k1>","k2":"<replace with node 1 k2>"},"node_2":{"k0":"<replace with node 2 k0>","k1":"<replace with node 2 k1>","k2":"<replace with node 2 k2>"}}