Fix support bundle collection (#595)

Add common labels to worker, build and signing pods so that their logs are collected in the support bundle.
kubernetes-sigs · Oct 10, 2023 · 3f05a76 · 3f05a76
1 parent 95e7c76
commit 3f05a76
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 14 deletions.
diff --git a/.github/actions/collect-troubleshooting/action.yml b/.github/actions/collect-troubleshooting/action.yml
@@ -2,6 +2,11 @@ name: Collect troubleshooting data
 
 description: This action fetches some troubleshooting data for KMM
 
+inputs:
+  output-file:
+    description: Name of the archive file
+    required: true
+
 runs:
   using: composite
 
@@ -12,15 +17,11 @@ runs:
         echo "PATH=${KREW_ROOT:-$HOME/.krew}/bin:$PATH" >> "$GITHUB_ENV"
       shell: bash
 
-    - name: Set the output file
-      run: echo "OUTPUT_FILE=${{ github.job }}-support-bundle.tar.gz" >> "$GITHUB_ENV"
-      shell: bash
-
     - name: Collect a support bundle
-      run: kubectl support-bundle -o $OUTPUT_FILE ./support/kmm.spec.yaml
+      run: kubectl support-bundle -o ${{ inputs.output-file }} ./support/kmm.spec.yaml
       shell: bash
 
     - uses: actions/upload-artifact@v3
       with:
         name: support-bundle
-        path: ${{ env.OUTPUT_FILE }}
+        path: ${{ inputs.output-file }}
diff --git a/.github/workflows/e2e.yaml b/.github/workflows/e2e.yaml
@@ -181,3 +181,5 @@ jobs:
       - name: Collect troubleshooting data
         uses: ./.github/actions/collect-troubleshooting
         if: ${{ always() }}
+        with:
+          output-file: ${{ matrix.name }}-support-bundle.tar.gz
diff --git a/internal/controllers/nmc_reconciler.go b/internal/controllers/nmc_reconciler.go
@@ -887,7 +887,12 @@ func (p *podManagerImpl) baseWorkerPod(
 		ObjectMeta: metav1.ObjectMeta{
 			Namespace: item.Namespace,
 			Name:      workerPodName(nodeName, item.Name),
-			Labels:    map[string]string{constants.ModuleNameLabel: item.Name},
+			Labels: map[string]string{
+				"app.kubernetes.io/name":      "kmm",
+				"app.kubernetes.io/component": "worker",
+				"app.kubernetes.io/part-of":   "kmm",
+				constants.ModuleNameLabel:     item.Name,
+			},
 		},
 		Spec: v1.PodSpec{
 			Containers: []v1.Container{

diff --git a/internal/controllers/nmc_reconciler_test.go b/internal/controllers/nmc_reconciler_test.go
@@ -1432,12 +1432,16 @@ softdep b pre: c
 			Name:      workerPodName(nmcName, moduleName),
 			Namespace: namespace,
 			Labels: map[string]string{
-				actionLabelKey:            string(action),
-				constants.ModuleNameLabel: moduleName,
+				"app.kubernetes.io/component": "worker",
+				"app.kubernetes.io/name":      "kmm",
+				"app.kubernetes.io/part-of":   "kmm",
+				actionLabelKey:                string(action),
+				constants.ModuleNameLabel:     moduleName,
 			},
 			Annotations: map[string]string{
 				configAnnotationKey: configAnnotationValue,
-				modulesOrderKey:     modulesOrderValue},
+				modulesOrderKey:     modulesOrderValue,
+			},
 		},
 		Spec: v1.PodSpec{
 			Containers: []v1.Container{

diff --git a/internal/utils/podhelper.go b/internal/utils/podhelper.go
@@ -61,7 +61,13 @@ func (ph *podHelper) IsPodChanged(existingPod *v1.Pod, newPod *v1.Pod) (bool, er
 }
 
 func (ph *podHelper) PodLabels(modName string, targetKernel string, podType string) map[string]string {
-	return moduleKernelLabels(modName, targetKernel, podType)
+	labels := moduleKernelLabels(modName, targetKernel, podType)
+
+	labels["app.kubernetes.io/name"] = "kmm"
+	labels["app.kubernetes.io/component"] = podType
+	labels["app.kubernetes.io/part-of"] = "kmm"
+
+	return labels
 }
 
 func (ph *podHelper) GetModulePodByKernel(ctx context.Context, modName, namespace, targetKernel, podType string, owner metav1.Object) (*v1.Pod, error) {

diff --git a/internal/utils/podhelper_test.go b/internal/utils/podhelper_test.go
@@ -36,9 +36,16 @@ var _ = Describe("PodLabels", func() {
 		mgr := NewPodHelper(clnt)
 		labels := mgr.PodLabels(mod.Name, "targetKernel", "podType")
 
-		Expect(labels).To(HaveKeyWithValue(constants.ModuleNameLabel, "moduleName"))
-		Expect(labels).To(HaveKeyWithValue(constants.TargetKernelTarget, "targetKernel"))
-		Expect(labels).To(HaveKeyWithValue(constants.PodType, "podType"))
+		expected := map[string]string{
+			"app.kubernetes.io/name":      "kmm",
+			"app.kubernetes.io/component": "podType",
+			"app.kubernetes.io/part-of":   "kmm",
+			constants.ModuleNameLabel:     "moduleName",
+			constants.TargetKernelTarget:  "targetKernel",
+			constants.PodType:             "podType",
+		}
+
+		Expect(labels).To(Equal(expected))
 	})
 })