feat: optionally propagate node labels to application pod view (argoproj#15274) (argoproj#23260)

Signed-off-by: Marcus Söderberg <[email protected]>
Co-authored-by: Linghao Su <[email protected]>
Signed-off-by: enneitex <[email protected]>

Author: 2 people

assets/swagger.json

@@ -774,7 +774,16 @@ func (ctrl *ApplicationController) getAppHosts(destCluster *appv1.Cluster, a *ap
 		sort.Slice(resourcesInfo, func(i, j int) bool {
 			return resourcesInfo[i].ResourceName < resourcesInfo[j].ResourceName
 		})
-		hosts = append(hosts, appv1.HostInfo{Name: nodeName, SystemInfo: node.SystemInfo, ResourcesInfo: resourcesInfo})
+
+		allowedNodeLabels := ctrl.settingsMgr.GetAllowedNodeLabels()
+		nodeLabels := make(map[string]string)
+		for _, label := range allowedNodeLabels {
+			if val, ok := node.Labels[label]; ok {
+				nodeLabels[label] = val
+			}
+		}
+
+		hosts = append(hosts, appv1.HostInfo{Name: nodeName, SystemInfo: node.SystemInfo, ResourcesInfo: resourcesInfo, Labels: nodeLabels})
 	}
 	ts.AddCheckpoint("process_app_pods_by_node_ms")
 	return hosts, nil

controller/appcontroller.go

@@ -2203,6 +2203,9 @@ func TestGetAppHosts(t *testing.T) {
 			Server:    test.FakeClusterURL,
 			Revision:  "abc123",
 		},
+		configMapData: map[string]string{
+			"application.allowedNodeLabels": "label1,label2",
+		},
 	}
 	ctrl := newFakeController(data, nil)
 	mockStateCache := &mockstatecache.LiveStateCache{}
@@ -2214,6 +2217,7 @@ func TestGetAppHosts(t *testing.T) {
 			Name:       "minikube",
 			SystemInfo: corev1.NodeSystemInfo{OSImage: "debian"},
 			Capacity:   map[corev1.ResourceName]resource.Quantity{corev1.ResourceCPU: resource.MustParse("5")},
+			Labels:     map[string]string{"label1": "value1", "label2": "value2"},
 		}})
 
 		// app pod
@@ -2251,6 +2255,7 @@ func TestGetAppHosts(t *testing.T) {
 				ResourceName: corev1.ResourceCPU, Capacity: 5000, RequestedByApp: 1000, RequestedByNeighbors: 2000,
 			},
 		},
+		Labels: map[string]string{"label1": "value1", "label2": "value2"},
 	}}, hosts)
 }
 

controller/appcontroller_test.go

@@ -169,6 +169,7 @@ type NodeInfo struct {
 	Name       string
 	Capacity   corev1.ResourceList
 	SystemInfo corev1.NodeSystemInfo
+	Labels     map[string]string
 }
 
 type ResourceInfo struct {

controller/cache/cache.go

@@ -472,6 +472,7 @@ func populateHostNodeInfo(un *unstructured.Unstructured, res *ResourceInfo) {
 		Name:       node.Name,
 		Capacity:   node.Status.Capacity,
 		SystemInfo: node.Status.NodeInfo,
+		Labels:     node.Labels,
 	}
 }
 

controller/cache/info.go

@@ -890,6 +890,8 @@ apiVersion: v1
 kind: Node
 metadata:
   name: minikube
+  labels:
+    foo: bar
 spec: {}
 status:
   capacity:
@@ -907,6 +909,7 @@ status:
 		Name:       "minikube",
 		Capacity:   corev1.ResourceList{corev1.ResourceMemory: resource.MustParse("6091320Ki"), corev1.ResourceCPU: resource.MustParse("6")},
 		SystemInfo: corev1.NodeSystemInfo{Architecture: "amd64", OperatingSystem: "linux", OSImage: "Ubuntu 20.04 LTS"},
+		Labels:     map[string]string{"foo": "bar"},
 	}, info.NodeInfo)
 }
 

controller/cache/info_test.go

@@ -277,6 +277,9 @@ data:
   # If omitted, Argo CD injects the app name into the label: 'app.kubernetes.io/instance'
   application.instanceLabelKey: mycompany.com/appname
 
+  # An optional comma-separated list of node labels to propagate to the application pod view.
+  application.allowedNodeLabels: topology.kubernetes.io/zone,node.kubernetes.io/instance-type
+
   # You can change the resource tracking method Argo CD uses by changing the
   # setting application.resourceTrackingMethod to the desired method.
   # The following methods are available:

docs/assets/application-pod-view-node-labels.png

@@ -6,4 +6,15 @@ By default, the Application Details will show the `Tree` view.
 
 This can be configured on an Application basis, by setting the `pref.argocd.argoproj.io/default-view` annotation, accepting one of: `tree`, `pods`, `network`, `list` as values.
 
-For the Pods view, the default grouping mechanism can be configured using the `pref.argocd.argoproj.io/default-pod-sort` annotation, accepting one of: `node`, `parentResource`, `topLevelResource` as values.
+For the Pods view, the default grouping mechanism can be configured using the `pref.argocd.argoproj.io/default-pod-sort` annotation, accepting one of: `node`, `parentResource`, `topLevelResource` as values.
+
+## Node Labels in Pod View
+
+It's possible to propagate node labels to node information in the pod view by configuring `applications.allowedNodeLabels` in the [argocd-cm](argocd-cm-yaml.md) ConfigMap.
+
+The following configuration:
+```yaml
+application.allowedNodeLabels: topology.kubernetes.io/zone,karpenter.sh/capacity-type
+```
+Would result in:
+![Node Labels in Pod View](../assets/application-pod-view-node-labels.png)