feat: add support to not scale GitHub runner on default runner labels

Signed-off-by: Leevi Lehtonen <[email protected]>
kedacore · Oct 26, 2024 · 10968f1 · 10968f1
1 parent b2ce95d
commit 10968f1
Show file tree

Hide file tree

Showing 3 changed files with 139 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -77,6 +77,7 @@ Here is an overview of all new **experimental** features:
 - **Elasticsearch Scaler**: Support Query at the Elasticsearch scaler ([#6216](https://github.com/kedacore/keda/issues/6216))
 - **Etcd Scaler**: Add username and password support for etcd ([#6199](https://github.com/kedacore/keda/pull/6199))
 - **GCP Scalers**: Added custom time horizon in GCP scalers ([#5778](https://github.com/kedacore/keda/issues/5778))
+- **GitHub Scaler**: Add support to not scale on default runner labels ([#6127](https://github.com/kedacore/keda/issues/6127))
 - **GitHub Scaler**: Fixed pagination, fetching repository list ([#5738](https://github.com/kedacore/keda/issues/5738))
 - **Grafana dashboard**: Fix dashboard to handle wildcard scaledObject variables ([#6214](https://github.com/kedacore/keda/issues/6214))
 - **Kafka**: Allow disabling FAST negotation when using Kerberos ([#6188](https://github.com/kedacore/keda/issues/6188))

diff --git a/pkg/scalers/github_runner_scaler.go b/pkg/scalers/github_runner_scaler.go
@@ -43,6 +43,7 @@ type githubRunnerMetadata struct {
 	personalAccessToken       *string
 	repos                     []string
 	labels                    []string
+	noDefaultLabels           bool
 	targetWorkflowQueueLength int64
 	triggerIndex              int
 	applicationID             *int64
@@ -372,8 +373,8 @@ func getValueFromMetaOrEnv(key string, metadata map[string]string, env map[strin
 }
 
 // getInt64ValueFromMetaOrEnv returns the value of the given key from the metadata or the environment variables
-func getInt64ValueFromMetaOrEnv(key string, config *scalersconfig.ScalerConfig) (int64, error) {
-	sInt, err := getValueFromMetaOrEnv(key, config.TriggerMetadata, config.ResolvedEnv)
+func getInt64ValueFromMetaOrEnv(key string, metadata map[string]string, env map[string]string) (int64, error) {
+	sInt, err := getValueFromMetaOrEnv(key, metadata, env)
 	if err != nil {
 		return -1, fmt.Errorf("error parsing %s: %w", key, err)
 	}
@@ -385,6 +386,20 @@ func getInt64ValueFromMetaOrEnv(key string, config *scalersconfig.ScalerConfig)
 	return goodInt, nil
 }
 
+// getInt64ValueFromMetaOrEnv returns the value of the given key from the metadata or the environment variables
+func getBoolValueFromMetaOrEnv(key string, metadata map[string]string, env map[string]string) (bool, error) {
+	sBool, err := getValueFromMetaOrEnv(key, metadata, env)
+	if err != nil {
+		return false, fmt.Errorf("error parsing %s: %w", key, err)
+	}
+
+	goodBool, err := strconv.ParseBool(sBool)
+	if err != nil {
+		return false, fmt.Errorf("error parsing %s: %w", key, err)
+	}
+	return goodBool, nil
+}
+
 func parseGitHubRunnerMetadata(config *scalersconfig.ScalerConfig) (*githubRunnerMetadata, error) {
 	meta := &githubRunnerMetadata{}
 	meta.targetWorkflowQueueLength = defaultTargetWorkflowQueueLength
@@ -401,7 +416,7 @@ func parseGitHubRunnerMetadata(config *scalersconfig.ScalerConfig) (*githubRunne
 		return nil, err
 	}
 
-	if val, err := getInt64ValueFromMetaOrEnv("targetWorkflowQueueLength", config); err == nil && val != -1 {
+	if val, err := getInt64ValueFromMetaOrEnv("targetWorkflowQueueLength", config.TriggerMetadata, config.ResolvedEnv); err == nil && val != -1 {
 		meta.targetWorkflowQueueLength = val
 	} else {
 		meta.targetWorkflowQueueLength = defaultTargetWorkflowQueueLength
@@ -411,6 +426,12 @@ func parseGitHubRunnerMetadata(config *scalersconfig.ScalerConfig) (*githubRunne
 		meta.labels = strings.Split(val, ",")
 	}
 
+	if val, err := getBoolValueFromMetaOrEnv("noDefaultLabels", config.TriggerMetadata, config.ResolvedEnv); err == nil {
+		meta.noDefaultLabels = val
+	} else {
+		meta.noDefaultLabels = false
+	}
+
 	if val, err := getValueFromMetaOrEnv("repos", config.TriggerMetadata, config.ResolvedEnv); err == nil && val != "" {
 		meta.repos = strings.Split(val, ",")
 	}
@@ -448,12 +469,12 @@ func setupGitHubApp(config *scalersconfig.ScalerConfig) (*int64, *int64, *string
 	var instID *int64
 	var appKey *string
 
-	appIDVal, appIDErr := getInt64ValueFromMetaOrEnv("applicationID", config)
+	appIDVal, appIDErr := getInt64ValueFromMetaOrEnv("applicationID", config.TriggerMetadata, config.ResolvedEnv)
 	if appIDErr == nil && appIDVal != -1 {
 		appID = &appIDVal
 	}
 
-	instIDVal, instIDErr := getInt64ValueFromMetaOrEnv("installationID", config)
+	instIDVal, instIDErr := getInt64ValueFromMetaOrEnv("installationID", config.TriggerMetadata, config.ResolvedEnv)
 	if instIDErr == nil && instIDVal != -1 {
 		instID = &instIDVal
 	}
@@ -625,9 +646,13 @@ func contains(s []string, e string) bool {
 }
 
 // canRunnerMatchLabels check Agent Label array will match runner label array
-func canRunnerMatchLabels(jobLabels []string, runnerLabels []string) bool {
+func canRunnerMatchLabels(jobLabels []string, runnerLabels []string, noDefaultLabels bool) bool {
+	allLabels := runnerLabels
+	if !noDefaultLabels {
+		allLabels = append(allLabels, reservedLabels...)
+	}
 	for _, jobLabel := range jobLabels {
-		if !contains(runnerLabels, jobLabel) && !contains(reservedLabels, jobLabel) {
+		if !contains(allLabels, jobLabel) {
 			return false
 		}
 	}
@@ -665,7 +690,7 @@ func (s *githubRunnerScaler) GetWorkflowQueueLength(ctx context.Context) (int64,
 			return -1, err
 		}
 		for _, job := range jobs {
-			if (job.Status == "queued" || job.Status == "in_progress") && canRunnerMatchLabels(job.Labels, s.metadata.labels) {
+			if (job.Status == "queued" || job.Status == "in_progress") && canRunnerMatchLabels(job.Labels, s.metadata.labels, s.metadata.noDefaultLabels) {
 				queueCount++
 			}
 		}