Add base of benchmark operator dashboard (#2430) (#2453)

* 📈 Add base of benchmark operator dashboard * 💚 Fix build benchmark images trigger * 💚 Add info tag for info metrics * 📈 showing job image and tags * 📈 add bench job status * ♻️ Update dashboard and rename * ♻️ Fix * Update internal/observability/metrics/tools/benchmark/benchmark.go --------- Signed-off-by: vankichi <[email protected]> Signed-off-by: Kiichiro YUKAWA <[email protected]> Co-authored-by: Kiichiro YUKAWA <[email protected]> Co-authored-by: Hiroto Funakoshi <[email protected]>
vdaas · Mar 15, 2024 · 29a81fd · 29a81fd
1 parent 0a9cc79
commit 29a81fd
Show file tree

Hide file tree

Showing 15 changed files with 2,741 additions and 51 deletions.
diff --git a/.github/workflows/dockers-benchmark-job-image.yml b/.github/workflows/dockers-benchmark-job-image.yml
@@ -33,10 +33,10 @@ on:
       - "!internal/**/*_test.go"
       - "!internal/db/**"
       - "apis/grpc/**"
-      - "pkg/benchmark/operator/**"
-      - "cmd/benchmark/operator/**"
-      - "pkg/benchmark/job/**"
-      - "cmd/benchmark/job/**"
+      - "pkg/tools/benchmark/operator/**"
+      - "cmd/tools/benchmark/operator/**"
+      - "pkg/tools/benchmark/job/**"
+      - "cmd/tools/benchmark/job/**"
       - "dockers/tools/benchmark/job/Dockerfile"
       - "versions/GO_VERSION"
   pull_request:
@@ -50,10 +50,10 @@ on:
       - "!internal/**/*_test.go"
       - "!internal/db/**"
       - "apis/grpc/**"
-      - "pkg/benchmark/operator/**"
-      - "cmd/benchmark/operator/**"
-      - "pkg/benchmark/job/**"
-      - "cmd/benchmark/job/**"
+      - "pkg/tools/benchmark/operator/**"
+      - "cmd/tools/benchmark/operator/**"
+      - "pkg/tools/benchmark/job/**"
+      - "cmd/tools/benchmark/job/**"
       - "dockers/tools/benchmark/job/Dockerfile"
       - "versions/GO_VERSION"
   pull_request_target:
@@ -67,10 +67,10 @@ on:
       - "!internal/**/*_test.go"
       - "!internal/db/**"
       - "apis/grpc/**"
-      - "pkg/benchmark/operator/**"
-      - "cmd/benchmark/operator/**"
-      - "pkg/benchmark/job/**"
-      - "cmd/benchmark/job/**"
+      - "pkg/tools/benchmark/operator/**"
+      - "cmd/tools/benchmark/operator/**"
+      - "pkg/tools/benchmark/job/**"
+      - "cmd/tools/benchmark/job/**"
       - "dockers/tools/benchmark/job/Dockerfile"
       - "versions/GO_VERSION"
 jobs:

diff --git a/.github/workflows/dockers-benchmark-operator-image.yaml b/.github/workflows/dockers-benchmark-operator-image.yaml
@@ -33,10 +33,10 @@ on:
       - "!internal/**/*_test.go"
       - "!internal/db/**"
       - "apis/grpc/**"
-      - "pkg/benchmark/operator/**"
-      - "cmd/benchmark/operator/**"
-      - "pkg/benchmark/job/**"
-      - "cmd/benchmark/job/**"
+      - "pkg/tools/benchmark/operator/**"
+      - "cmd/tools/benchmark/operator/**"
+      - "pkg/tools/benchmark/job/**"
+      - "cmd/tools/benchmark/job/**"
       - "dockers/tools/benchmark/operator/Dockerfile"
       - "versions/GO_VERSION"
   pull_request:
@@ -50,10 +50,10 @@ on:
       - "!internal/**/*_test.go"
       - "!internal/db/**"
       - "apis/grpc/**"
-      - "pkg/benchmark/operator/**"
-      - "cmd/benchmark/operator/**"
-      - "pkg/benchmark/job/**"
-      - "cmd/benchmark/job/**"
+      - "pkg/tools/benchmark/operator/**"
+      - "cmd/tools/benchmark/operator/**"
+      - "pkg/tools/benchmark/job/**"
+      - "cmd/tools/benchmark/job/**"
       - "dockers/tools/benchmark/operator/Dockerfile"
       - "versions/GO_VERSION"
   pull_request_target:
@@ -67,10 +67,10 @@ on:
       - "!internal/**/*_test.go"
       - "!internal/db/**"
       - "apis/grpc/**"
-      - "pkg/benchmark/operator/**"
-      - "cmd/benchmark/operator/**"
-      - "pkg/benchmark/job/**"
-      - "cmd/benchmark/job/**"
+      - "pkg/tools/benchmark/operator/**"
+      - "cmd/tools/benchmark/operator/**"
+      - "pkg/tools/benchmark/job/**"
+      - "cmd/tools/benchmark/job/**"
       - "dockers/tools/benchmark/operator/Dockerfile"
       - "versions/GO_VERSION"
 jobs:

diff --git a/charts/vald-benchmark-operator/crds/valdbenchmarkoperatorrelease.yaml b/charts/vald-benchmark-operator/crds/valdbenchmarkoperatorrelease.yaml
@@ -40,7 +40,7 @@ spec:
           type: string
       schema:
         openAPIV3Schema:
-          description: ValdBenchmarkScenario is the Schema for the valdbenchmarkscenarios API
+          description: ValdBenchmarkOperator is the Schema for the valdbenchmarkoperator API
           type: object
           properties:
             apiVersion:
@@ -52,7 +52,7 @@ spec:
             metadata:
               type: object
             status:
-              description: ValdBenchmarkScenarioStatus defines the observed state of ValdBenchmarkScenario
+              description: ValdBenchmarkOperatorStatus defines the observed state of ValdBenchmarkOperator
               enum:
                 - NotReady
                 - Completed
@@ -68,6 +68,11 @@ spec:
                 annotations:
                   type: object
                   x-kubernetes-preserve-unknown-fields: true
+                env:
+                  type: array
+                  items:
+                    type: object
+                    x-kubernetes-preserve-unknown-fields: true
                 image:
                   type: object
                   properties:

diff --git a/charts/vald-benchmark-operator/templates/deployment.yaml b/charts/vald-benchmark-operator/templates/deployment.yaml
@@ -122,11 +122,10 @@ spec:
           volumeMounts:
             - name: {{ .Values.name }}-config
               mountPath: /etc/server
+          {{- if .Values.env }}
           env:
-            - name: JOB_NAMESPACE
-              valueFrom:
-                fieldRef:
-                  fieldPath: metadata.namespace
+            {{- toYaml .Values.env | nindent 12 }}
+          {{- end }}
           terminationMessagePath: /dev/termination-log
           terminationMessagePolicy: File
       restartPolicy: Always

diff --git a/charts/vald-benchmark-operator/values.yaml b/charts/vald-benchmark-operator/values.yaml
@@ -454,11 +454,11 @@ observability:
     # @schema {"name": "observability.otlp.attribute", "type": "object"}
     attribute:
       # @schema {"name": "observability.otlp.attribute.namespace", "type": "string"}
-      namespace: "_MY_POD_NAMESPACE_"
+      namespace: _MY_POD_NAMESPACE_
       # @schema {"name": "observability.otlp.attribute.pod_name", "type": "string"}
-      pod_name: "_MY_POD_NAME_"
+      pod_name: _MY_POD_NAME_
       # @schema {"name": "observability.otlp.attribute.node_name", "type": "string"}
-      node_name: "_MY_NODE_NAME_"
+      node_name: _MY_NODE_NAME_
       # @schema {"name": "observability.otlp.attribute.service_name", "type": "string"}
       service_name: "vald-benchmark-operator"
   # @schema {"name": "observability.otlp.attribute.metrics", "type": "object"}
@@ -487,3 +487,22 @@ observability:
     enabled: false
     # @schema {"name": "observability.trace.sampling_rate", "type": "integer"}
     sampling_rate: 1
+# @schema {"name": "env", "type": "array", "items": {"type": "object"}, "anchor": "env"}
+# env -- environment variables
+env:
+  - name: MY_NODE_NAME
+    valueFrom:
+      fieldRef:
+        fieldPath: spec.nodeName
+  - name: MY_POD_NAME
+    valueFrom:
+      fieldRef:
+        fieldPath: metadata.name
+  - name: MY_POD_NAMESPACE
+    valueFrom:
+      fieldRef:
+        fieldPath: metadata.namespace
+  - name: JOB_NAMESPACE
+    valueFrom:
+      fieldRef:
+        fieldPath: metadata.namespace
diff --git a/internal/config/benchmark.go b/internal/config/benchmark.go
@@ -234,8 +234,8 @@ func (b *BenchmarkScenario) Bind() *BenchmarkScenario {
 
 // BenchmarkJobImageInfo represents the docker image information for benchmark job.
 type BenchmarkJobImageInfo struct {
-	Image      string `json:"image,omitempty"       yaml:"image"`
-	PullPolicy string `json:"pull_policy,omitempty" yaml:"pull_policy"`
+	Image      string `info:"image"       json:"image,omitempty"       yaml:"image"`
+	PullPolicy string `info:"pull_policy" json:"pull_policy,omitempty" yaml:"pull_policy"`
 }
 
 // Bind binds the actual data from the BenchmarkJobImageInfo receiver fields.