add chain.link labels to new k8s test runner

Author: Tofel

book/src/k8s-test-runner/k8s-test-runner.md

@@ -45,6 +45,7 @@ The TOML config should specify the test runner configuration as follows:
 ```
 namespace = "e2e-tests"
 rbac_role_name = "" # RBAC role name for the chart
+rbac_service_account_name = "" # RBAC service account name for the chart
 image_registry_url = "" # URL to the ECR containing the test binary image, e.g., staging ECR URL
 image_name = "k8s-test-runner"
 image_tag = ""  # The image tag to use, like "mercury-load-tests" (see readme above)
@@ -61,8 +62,16 @@ resources_limits_memory = "1024Mi"
 WASP_LOG_LEVEL = "info"
 TEST_LOG_LEVEL = "info"
 MERCURY_TEST_LOG_LEVEL = "info"
+[metadata.labels]
+"chain.link/component" = "k8s-test-runner"
+"chain.link/product" = "<your-product-name>"
+"chain.link/team" = "<name–of-the-team-you're-running-the-test-for>"
+"chain.link/cost-center" = "<sensible-identifier:eg: product-testType-test>"
 ```
 
+> [NOTE]
+> Make sure to quote labels with "/" as otherwise parsing them will fail.
+
 Where:
 
 - `test_name` is the name of the test to run (must be included in the test binary).
@@ -113,6 +122,7 @@ Then:
         cat << EOF > config.toml
         namespace = "e2e-tests"
         rbac_role_name = "" # RBAC role name for the chart
+        rbac_service_account_name = "" # RBAC service account name for the chart
         image_registry_url = "${{ secrets.AWS_ACCOUNT_ID_STAGING }}.dkr.ecr.${{ secrets.AWS_REGION }}.amazonaws.com"
         image_name = "k8s-test-runner"
         image_tag = "mercury-load-test"
@@ -130,6 +140,11 @@ Then:
         WASP_LOG_LEVEL = "info"
         TEST_LOG_LEVEL = "info"
         MERCURY_TEST_LOG_LEVEL = "info"
+        [metadata.labels]
+        "chain.link/component" = "k8s-test-runner"
+        "chain.link/product" = "data-streamsv0.3"
+        "chain.link/team" = "Data Streams"
+        "chain.link/cost-center" = "data-streamsv0.3-load-test"
         EOF
 
         ./k8s-test-runner-linux-amd64 run -c config.toml

k8s-test-runner/chart/templates/job.yaml

@@ -6,6 +6,9 @@ metadata:
   namespace: {{ $.Release.Namespace }}
   labels:
     sync: "{{ $.Values.sync }}"
+    {{- range $key, $val :=  $.Values.metadata.labels }}
+    {{- $e.key }}: "{{ $e.value }}"
+    {{- end }}
 spec:
   backoffLimit: 0
   ttlSecondsAfterFinished: {{ $.Values.ttlSecondsAfterFinished }}

k8s-test-runner/chart/values.yaml

@@ -15,6 +15,9 @@ labels:
 annotations: {}
 env:
   # TEST_LOG_LEVEL: ''
+metadata:
+  labels:
+    # label: value
 resources:
   requests:
     cpu: 1000m

k8s-test-runner/cmd/internal/run.go

@@ -85,6 +85,11 @@ func getChartOverrides(c config.Runner) map[string]interface{} {
 	}
 	envMap[c.TestConfigBase64EnvName] = c.TestConfigBase64
 
+	labelsMap := c.Metadata.Labels
+	if labelsMap == nil {
+		labelsMap = make(map[string]string)
+	}
+
 	return map[string]interface{}{
 		"namespace": c.Namespace,
 		"rbac": map[string]interface{}{
@@ -102,7 +107,10 @@ func getChartOverrides(c config.Runner) map[string]interface{} {
 		"imagePullPolicy": "Always",
 		"labels":          map[string]interface{}{},
 		"annotations":     map[string]interface{}{}, // Add specific annotations if needed
-		"env":             envMap,
+		"metadata": map[string]interface{}{
+			"labels": labelsMap,
+		},
+		"env": envMap,
 		"resources": map[string]interface{}{
 			"requests": map[string]interface{}{
 				"cpu":    c.ResourcesRequestsCPU,

k8s-test-runner/config/config.go

@@ -34,6 +34,11 @@ type Runner struct {
 	DetachedMode            bool              `toml:"detached_mode"`
 	Debug                   bool              `toml:"debug"`
 	Envs                    map[string]string `toml:"envs"`
+	Metadata                Metadata          `toml:"metadata"`
+}
+
+type Metadata struct {
+	Labels map[string]string `toml:"labels"`
 }
 
 // Read initializes the configuration by sequentially loading from a TOML file,

lib/k8s/environment/runner.go

@@ -52,7 +52,7 @@ func (m Chart) ExportData(e *Environment) error {
 
 func (m Chart) GetLabels() map[string]string {
 	return map[string]string{
-		"chain.link/component": "k8s-legacy-test-runner",
+		"chain.link/component": "k8s-test-runner-legacy",
 	}
 }