Merge pull request #22 from tmetsch/main

Release 0.4.0

Author: davecremins

.github/workflows/test-build.yml

@@ -29,6 +29,8 @@ jobs:
         uses: actions/setup-go@v5
         with:
           go-version-file: 'go.mod'
+      - name: List open ports and processes
+        run: sudo lsof -i -P -n | grep LISTEN
       - name: Unit test
         run: make utest
   race:
@@ -42,4 +44,4 @@ jobs:
         with:
           go-version-file: 'go.mod'
       - name: Test race
-        run: go test -count=1 -parallel 1 -race ./...
+        run: go test -count=1 -parallel 1 -race -skip 'TestTracesForSanity/rdt_trace|TestPowerForSanity/power_efficiency' ./...

Dockerfile

@@ -1,7 +1,7 @@
 # Copyright (c) 2022 Intel Corporation
 # SPDX-License-Identifier: Apache-2.0
 
-FROM golang:1.24.2 AS build
+FROM golang:1.24.6 AS build
 
 WORKDIR /app
 

Makefile

@@ -3,8 +3,9 @@ SCALEOUT_PLUGIN=scale_out
 RMPOD_PLUGIN=rm_pod
 RDT_PLUGIN=rdt
 CPU_PLUGIN=cpu_scale
+ENERGY_PLUGIN=energy
 GO_CILINT_CHECKERS=errcheck,goimports,gosec,gosimple,govet,ineffassign,nilerr,revive,staticcheck,unused
-DOCKER_IMAGE_VERSION=0.3.0
+DOCKER_IMAGE_VERSION=0.4.0
 
 api:
 	hack/generate_code.sh
@@ -32,7 +33,10 @@ build-plugin-rdt:
 build-plugin-cpu:
 	CGO_ENABLED=0 go build -o bin/plugins/${CPU_PLUGIN} plugins/${CPU_PLUGIN}/cmd/${CPU_PLUGIN}.go
 
-build-plugins: build-plugin-scaleout build-plugin-rmpod build-plugin-rdt build-plugin-cpu
+build-plugin-energy:
+	CGO_ENABLED=0 go build -o bin/plugins/${ENERGY_PLUGIN} plugins/${ENERGY_PLUGIN}/cmd/${ENERGY_PLUGIN}.go
+
+build-plugins: build-plugin-scaleout build-plugin-rmpod build-plugin-rdt build-plugin-cpu build-plugin-energy
 
 controller-images:
 	docker build -t planner:${DOCKER_IMAGE_VERSION} . --no-cache --pull
@@ -42,6 +46,7 @@ plugin-images:
 	docker build -t rmpod:${DOCKER_IMAGE_VERSION} -f plugins/rm_pod/Dockerfile . --no-cache --pull
 	docker build -t rdt:${DOCKER_IMAGE_VERSION} -f plugins/rdt/Dockerfile . --no-cache --pull
 	docker build -t cpuscale:${DOCKER_IMAGE_VERSION} -f plugins/cpu_scale/Dockerfile . --no-cache --pull
+	docker build -t energy:${DOCKER_IMAGE_VERSION} -f plugins/energy/Dockerfile . --no-cache --pull
 
 all-images: controller-images plugin-images
 
@@ -57,7 +62,8 @@ prepare-build:
 	go mod tidy
 
 utest:
-	go test -count=1 -parallel 1 -v ./...
+	# Skipping certain trace tests, as they cannot be run safely on public runners.
+	go test -count=1 -parallel 1 -v -skip 'TestTracesForSanity/rdt_trace|TestPowerForSanity/power_efficiency' ./...
 
 test:
 	hack/run_test.sh

README.md

@@ -1,5 +1,4 @@
 
-
 # Intent Driven Orchestration Planner
 
 ![planner.png](planner.png)

artefacts/deploy/manifest.yaml

@@ -199,7 +199,7 @@ spec:
   serviceAccountName: planner-service-account
   containers:
     - name: planner
-      image: 127.0.0.1:5000/planner:0.3.0
+      image: 127.0.0.1:5000/planner:0.4.0
       ports:
         - containerPort: 33333
       imagePullPolicy: Always

artefacts/examples/default_profiles.yaml

@@ -5,35 +5,37 @@ metadata:
   name: p50latency
 spec:
   type: "latency"
-  description: "Measures P50 latency in ms over a 30ms time window as reported by Linkerd service mesh."
+  description: "Measures P50 latency in ms over a 30s time window as reported by Linkerd service mesh."
 ---
 apiVersion: "ido.intel.com/v1alpha1"
 kind: KPIProfile
 metadata:
   name: p95latency
 spec:
   type: "latency"
-  description: "Measures P95 latency in ms over a 30ms time window as reported by Linkerd service mesh."
+  description: "Measures P95 latency in ms over a 30s time window as reported by Linkerd service mesh."
 ---
 apiVersion: "ido.intel.com/v1alpha1"
 kind: KPIProfile
 metadata:
   name: p99latency
 spec:
   type: "latency"
-  description: "Measures P99 latency in ms over a 30ms time window as reported by Linkerd service mesh."
+  description: "Measures P99 latency in ms over a 30s time window as reported by Linkerd service mesh."
 ---
 apiVersion: "ido.intel.com/v1alpha1"
 kind: KPIProfile
 metadata:
   name: throughput
 spec:
   type: "throughput"
-  description: "Measures requests per second aggregated over a 30ms time window as reported by Linkerd service mesh."
+  minimize: False
+  description: "Measures requests per second aggregated over a 30s time window as reported by Linkerd service mesh."
 ---
 apiVersion: "ido.intel.com/v1alpha1"
 kind: KPIProfile
 metadata:
   name: availability
 spec:
-  type: "availability"
+  type: "availability"
+  minimize: False

artefacts/examples/example_deployment.yaml

@@ -16,7 +16,7 @@ spec:
     spec:
       containers:
         - name: sample-function
-          image: testfunction/rust_function:0.1
+          image: testfunction/rust_function:0.2
           ports:
             - containerPort: 8080
           env:

artefacts/intents_crds_v1alpha1.yaml

@@ -20,7 +20,7 @@ spec:
                   type: object
                   properties:
                     kind:
-                      description: 'Kind of the owner.'
+                      description: 'Kind of the owner (defaults to Deployment kind).'
                       type: string
                       enum:
                         - Deployment
@@ -33,11 +33,15 @@ spec:
                     - name
                 priority:
                   type: number
-                  description: "Priority for a set of PODs"
+                  description: "Priority for a set of PODs (defaults to 0.01)."
                   format: float
                   minimum: 0.01  # prevents any div 0!
                   maximum: 1.0
                   default: 0.01
+                active:
+                  type: boolean
+                  description: "Indicates if the planner should actively managed this intent (defaults to true)."
+                  default: true
                 objectives:
                   type: array
                   description: "Objectives for a set of PODs."
@@ -54,6 +58,12 @@ spec:
                       measuredBy:
                         type: string
                         description: "Defines what kind of an objective this is. Also defines if the objective is an upper or lower bound objective."
+                      tolerance:
+                        type: number
+                        description: "Indicates a tolerance as percentage in context of the specified target value for the objective (defaults to 0.0) - e.g. 0.1 & target 10ms ==> 11ms."
+                        format: float
+                        minimum: 0.0
+                        default: 0.0
                     required:
                       - name
                       - value
@@ -108,13 +118,16 @@ spec:
             spec:
               type: object
               properties:
-                # TODO: add weight.
                 query:
                   type: string
                   description: "This is an optional parameter - if defined, the user needs to provide a query string defining how to capture the objective's KPI. Optional parameters - in accordance with the provide documentation - can be detailed under props."
                 description:
                   type: string
                   description: "Ideally includes a description on what is measured by the query - including e.g. information on units etc."
+                minimize:
+                  type: boolean
+                  description: "Indicates whether the planner should try to minimize this or not (defaults to true)."
+                  default: true
                 type:
                   type: string
                   description: "Defines the type of the KPI."

cmd/main.go

@@ -2,6 +2,8 @@ package main
 
 import (
 	"flag"
+	"io"
+	"os"
 	"time"
 
 	"github.com/intel/intent-driven-orchestration/pkg/controller"
@@ -38,7 +40,32 @@ func main() {
 	}
 	cfg, err := common.ParseConfig(config)
 	if err != nil {
-		klog.Fatalf("Error loading planner config: %s", err)
+		klog.Fatalf("Error loading planner config: %v", err)
+	}
+
+	// set logFile
+	if cfg.Generic.LogFile != "" {
+		err := flag.Set("logtostderr", "false")
+		if err != nil {
+			klog.Fatalf("Error setting flag logtostderr: %v", err)
+		}
+		err = flag.Set("alsologtostderr", "true")
+		if err != nil {
+			klog.Fatalf("Error setting flag alsologtostderr: %v", err)
+		}
+
+		logFile, err := os.OpenFile(cfg.Generic.LogFile, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0600)
+		if err != nil {
+			klog.Fatalf("Failed to open log file: %v", err)
+		}
+		defer logFile.Close()
+
+		multiWriter := io.MultiWriter(os.Stdout, logFile)
+		klog.SetOutput(multiWriter)
+		defer func() {
+			klog.Flush()
+		}()
+		klog.Infof("Successfuly added to klog output the log file: %s", cfg.Generic.LogFile)
 	}
 
 	// K8s genClient setup
@@ -65,7 +92,7 @@ func main() {
 	planner := astar.NewAPlanner(actuatorList, cfg)
 	defer planner.Stop()
 
-	// This is main controller.
+	// This is the main controller.
 	tracer := controller.NewMongoTracer(cfg.Generic.MongoEndpoint)
 	c := controller.NewController(cfg, tracer, k8sClient, podInformerFactory.Core().V1().Pods())
 	c.SetPlanner(planner)

docs/actuators.md

@@ -68,6 +68,10 @@ functions in the next section to better understand how the system selects what t
 Furthermore, the implementation of ***NextState()*** can support the opportunistic planning capabilities, by adding new
 states, that although they do not satisfy the desired still at least move the system in the right direction.
 
+Note that the parameters of the actions are defined by **interface{}**. Ideally a map is used to represent the 
+parameters. For example, they can be represented as a _map[string]int64_ or _map[string]string_. Other
+types of values in the map will be cast to string to support the GRPC plugin mechanism. 
+
 #### Utility/Cost functions
 
 Utilities are used to steer the planner. Planners will deem an action to be favorable if the actuator returns a low