add pod metadata and annotations as part of the service discovery response

docs/src/main/asciidoc/discovery-client.adoc

@@ -116,6 +116,10 @@ By default all of the ports and their names will be added to the metadata of the
 
 As said before, if you want to get the list of `ServiceInstance` to also include the `ExternalName` type services, you need to enable that support via: `spring.cloud.kubernetes.discovery.include-external-name-services=true`. As such, when calling `DiscoveryClient::getInstances` those will be returned also. You can distinguish between `ExternalName` and any other types by inspecting `ServiceInstance::getMetadata` and lookup for a field called `type`. This will be the type of the service returned : `ExternalName`/`ClusterIP`, etc.
 
+`ServiceInstance` can include the labels and annotations of specific pods from the underlying service instance. To obtain such information, you need to also enable:
+
+`spring.cloud.kubernetes.discovery.metadata.add-pod-labels=true` and/or `spring.cloud.kubernetes.discovery.metadata.add-pod-annotations=true`. At the moment, such functionality is present only in the fabric8 client implementation, but will be added to the kubernetes native client in a later release.
+
 If, for any reason, you need to disable the `DiscoveryClient`, you can set the following property in `application.properties`:
 
 ====

spring-cloud-kubernetes-commons/src/main/java/org/springframework/cloud/kubernetes/commons/discovery/DefaultKubernetesServiceInstance.java

@@ -35,8 +35,8 @@
  * @param cluster the cluster the service resides in.
  */
 public record DefaultKubernetesServiceInstance(String instanceId, String serviceId, String host, int port,
-		Map<String, String> metadata, boolean secure, String namespace,
-		String cluster) implements KubernetesServiceInstance {
+		Map<String, String> metadata, boolean secure, String namespace, String cluster, Map<String, String> podLabels,
+		Map<String, String> podAnnotations) implements KubernetesServiceInstance {
 
 	/**
 	 * @param instanceId the id of the instance.
@@ -48,7 +48,12 @@ public record DefaultKubernetesServiceInstance(String instanceId, String service
 	 */
 	public DefaultKubernetesServiceInstance(String instanceId, String serviceId, String host, int port,
 			Map<String, String> metadata, boolean secure) {
-		this(instanceId, serviceId, host, port, metadata, secure, null, null);
+		this(instanceId, serviceId, host, port, metadata, secure, null, null, Map.of(), Map.of());
+	}
+
+	public DefaultKubernetesServiceInstance(String instanceId, String serviceId, String host, int port,
+			Map<String, String> metadata, boolean secure, String namespace, String cluster) {
+		this(instanceId, serviceId, host, port, metadata, secure, namespace, cluster, Map.of(), Map.of());
 	}
 
 	@Override
@@ -101,6 +106,16 @@ public String getCluster() {
 		return this.cluster;
 	}
 
+	@Override
+	public Map<String, String> podLabels() {
+		return podLabels;
+	}
+
+	@Override
+	public Map<String, String> podAnnotations() {
+		return podAnnotations;
+	}
+
 	private URI createUri(String scheme, String host, int port) {
 		// assume ExternalName type of service
 		if (port == -1) {

spring-cloud-kubernetes-commons/src/main/java/org/springframework/cloud/kubernetes/commons/discovery/KubernetesDiscoveryProperties.java

@@ -92,15 +92,30 @@ public KubernetesDiscoveryProperties(@DefaultValue("true") boolean enabled, bool
 	 * @param annotationsPrefix prefix for the annotations
 	 * @param addPorts include ports as metadata
 	 * @param portsPrefix prefix for the ports, by default it is "port."
+	 * @param addPodLabels add pod labels as part of the response.
+	 * @param addPodAnnotations add pod annotations as part of the response.
 	 */
 	public record Metadata(@DefaultValue("true") boolean addLabels, String labelsPrefix,
 			@DefaultValue("true") boolean addAnnotations, String annotationsPrefix,
-			@DefaultValue("true") boolean addPorts, @DefaultValue("port.") String portsPrefix) {
+			@DefaultValue("true") boolean addPorts, @DefaultValue("port.") String portsPrefix, boolean addPodLabels,
+			boolean addPodAnnotations) {
+
+		@ConstructorBinding
+		public Metadata {
+
+		}
+
+		public Metadata(@DefaultValue("true") boolean addLabels, String labelsPrefix,
+				@DefaultValue("true") boolean addAnnotations, String annotationsPrefix,
+				@DefaultValue("true") boolean addPorts, @DefaultValue("port.") String portsPrefix) {
+
+			this(addLabels, labelsPrefix, addAnnotations, annotationsPrefix, addPorts, portsPrefix, false, false);
+		}
 
 		/**
 		 * Default instance.
 		 */
-		public static final Metadata DEFAULT = new Metadata(true, null, true, null, true, "port.");
+		public static final Metadata DEFAULT = new Metadata(true, null, true, null, true, "port.", false, false);
 
 	}
 

spring-cloud-kubernetes-commons/src/main/java/org/springframework/cloud/kubernetes/commons/discovery/KubernetesServiceInstance.java

@@ -16,6 +16,8 @@
 
 package org.springframework.cloud.kubernetes.commons.discovery;
 
+import java.util.Map;
+
 import org.springframework.cloud.client.ServiceInstance;
 
 /**
@@ -29,4 +31,12 @@ sealed public interface KubernetesServiceInstance extends ServiceInstance permit
 
 	String getCluster();
 
+	default Map<String, String> podLabels() {
+		return Map.of();
+	}
+
+	default Map<String, String> podAnnotations() {
+		return Map.of();
+	}
+
 }

spring-cloud-kubernetes-commons/src/main/java/org/springframework/cloud/kubernetes/commons/discovery/PodMetadata.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2013-2023 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.cloud.kubernetes.commons.discovery;
+
+import java.util.Map;
+
+/**
+ * @author wind57
+ */
+public record PodMetadata(Map<String, String> podLabels, Map<String, String> podAnnotations) {
+
+	/**
+	 * pod labels and annotations are empty.
+	 */
+	public static PodMetadata EMPTY = new PodMetadata(Map.of(), Map.of());
+
+}

spring-cloud-kubernetes-commons/src/test/java/org/springframework/cloud/kubernetes/commons/discovery/KubernetesDiscoveryPropertiesMetadataTests.java

@@ -39,18 +39,24 @@ void testDefaultConstructor() {
 		assertThat(m.annotationsPrefix()).isNull();
 		assertThat(m.addPorts()).isTrue();
 		assertThat(m.portsPrefix()).isEqualTo("port.");
+		assertThat(m.addPodLabels()).isFalse();
+		assertThat(m.addPodAnnotations()).isFalse();
 	}
 
 	@Test
 	void testSpringBindingFields() {
 		new ApplicationContextRunner().withUserConfiguration(Config.class)
-				.withPropertyValues("spring.cloud.kubernetes.discovery.metadata.labelsPrefix=labelsPrefix")
+				.withPropertyValues("spring.cloud.kubernetes.discovery.metadata.labelsPrefix=labelsPrefix",
+						"spring.cloud.kubernetes.discovery.metadata.add-pod-annotations=true",
+						"spring.cloud.kubernetes.discovery.metadata.add-pod-labels=true")
 				.run(context -> {
 					KubernetesDiscoveryProperties props = context.getBean(KubernetesDiscoveryProperties.class);
 					assertThat(props).isNotNull();
 					assertThat(props.metadata().labelsPrefix()).isEqualTo("labelsPrefix");
 					assertThat(props.metadata().addPorts()).isTrue();
 					assertThat(props.metadata().portsPrefix()).isEqualTo("port.");
+					assertThat(props.metadata().addPodLabels()).isTrue();
+					assertThat(props.metadata().addPodAnnotations()).isTrue();
 				});
 	}
 

spring-cloud-kubernetes-commons/src/test/java/org/springframework/cloud/kubernetes/commons/discovery/KubernetesServiceInstanceTests.java

@@ -44,6 +44,8 @@ void testFirstConstructor() {
 		assertThat(instance.getScheme()).isEqualTo("https");
 		assertThat(instance.getNamespace()).isEqualTo("spring-k8s");
 		assertThat(instance.getCluster()).isNull();
+		assertThat(instance.podLabels()).isEqualTo(Map.of());
+		assertThat(instance.podAnnotations()).isEqualTo(Map.of());
 	}
 
 	@Test
@@ -61,6 +63,27 @@ void testSecondConstructor() {
 		assertThat(instance.getScheme()).isEqualTo("https");
 		assertThat(instance.getNamespace()).isEqualTo("spring-k8s");
 		assertThat(instance.getCluster()).isEqualTo("cluster");
+		assertThat(instance.podLabels()).isEqualTo(Map.of());
+		assertThat(instance.podAnnotations()).isEqualTo(Map.of());
+	}
+
+	@Test
+	void testThirdConstructor() {
+		DefaultKubernetesServiceInstance instance = new DefaultKubernetesServiceInstance("instanceId", "serviceId",
+				"host", 8080, Map.of("a", "b"), true, "spring-k8s", "cluster", Map.of("a", "b"), Map.of("c", "d"));
+
+		assertThat(instance.getInstanceId()).isEqualTo("instanceId");
+		assertThat(instance.getServiceId()).isEqualTo("serviceId");
+		assertThat(instance.getHost()).isEqualTo("host");
+		assertThat(instance.getPort()).isEqualTo(8080);
+		assertThat(instance.isSecure()).isTrue();
+		assertThat(instance.getUri()).isEqualTo(URI.create("https://host:8080"));
+		assertThat(instance.getMetadata()).isEqualTo(Map.of("a", "b"));
+		assertThat(instance.getScheme()).isEqualTo("https");
+		assertThat(instance.getNamespace()).isEqualTo("spring-k8s");
+		assertThat(instance.getCluster()).isEqualTo("cluster");
+		assertThat(instance.podLabels()).isEqualTo(Map.of("a", "b"));
+		assertThat(instance.podAnnotations()).isEqualTo(Map.of("c", "d"));
 	}
 
 	@Test

spring-cloud-kubernetes-fabric8-discovery/src/main/java/org/springframework/cloud/kubernetes/fabric8/discovery/KubernetesDiscoveryClient.java

@@ -121,7 +121,7 @@ public List<ServiceInstance> getInstances(String serviceId) {
 				Map<String, String> serviceMetadata = serviceMetadata(serviceId, service, properties, List.of(),
 						service.getMetadata().getNamespace());
 				ServiceInstance externalNameServiceInstance = serviceInstance(null, service, null, -1, serviceId,
-						serviceMetadata, service.getMetadata().getNamespace());
+						serviceMetadata, service.getMetadata().getNamespace(), properties, client);
 				instances.add(externalNameServiceInstance);
 			}
 		}
@@ -152,7 +152,7 @@ private List<ServiceInstance> getNamespaceServiceInstances(EndpointSubsetNS es,
 			List<EndpointAddress> addresses = addresses(endpointSubset, properties);
 			for (EndpointAddress endpointAddress : addresses) {
 				ServiceInstance serviceInstance = serviceInstance(servicePortSecureResolver, service, endpointAddress,
-						endpointPort, serviceId, serviceMetadata, namespace);
+						endpointPort, serviceId, serviceMetadata, namespace, properties, client);
 				instances.add(serviceInstance);
 			}
 		}

spring-cloud-kubernetes-fabric8-discovery/src/main/java/org/springframework/cloud/kubernetes/fabric8/discovery/KubernetesDiscoveryClientUtils.java

@@ -29,7 +29,9 @@
 import io.fabric8.kubernetes.api.model.EndpointSubset;
 import io.fabric8.kubernetes.api.model.Endpoints;
 import io.fabric8.kubernetes.api.model.EndpointsList;
+import io.fabric8.kubernetes.api.model.ObjectMeta;
 import io.fabric8.kubernetes.api.model.ObjectReference;
+import io.fabric8.kubernetes.api.model.Pod;
 import io.fabric8.kubernetes.api.model.Service;
 import io.fabric8.kubernetes.api.model.ServiceList;
 import io.fabric8.kubernetes.client.KubernetesClient;
@@ -44,13 +46,15 @@
 import org.springframework.cloud.kubernetes.commons.KubernetesNamespaceProvider;
 import org.springframework.cloud.kubernetes.commons.discovery.DefaultKubernetesServiceInstance;
 import org.springframework.cloud.kubernetes.commons.discovery.KubernetesDiscoveryProperties;
+import org.springframework.cloud.kubernetes.commons.discovery.PodMetadata;
 import org.springframework.cloud.kubernetes.fabric8.Fabric8Utils;
 import org.springframework.core.log.LogAccessor;
 import org.springframework.util.CollectionUtils;
 import org.springframework.util.StringUtils;
 
 import static java.util.stream.Collectors.toMap;
 import static org.springframework.cloud.kubernetes.commons.config.ConfigUtils.keysWithPrefix;
+import static org.springframework.cloud.kubernetes.commons.discovery.KubernetesDiscoveryConstants.EXTERNAL_NAME;
 import static org.springframework.cloud.kubernetes.commons.discovery.KubernetesDiscoveryConstants.HTTP;
 import static org.springframework.cloud.kubernetes.commons.discovery.KubernetesDiscoveryConstants.HTTPS;
 import static org.springframework.cloud.kubernetes.commons.discovery.KubernetesDiscoveryConstants.NAMESPACE_METADATA_KEY;
@@ -236,7 +240,8 @@ static List<EndpointAddress> addresses(EndpointSubset endpointSubset, Kubernetes
 
 	static ServiceInstance serviceInstance(@Nullable ServicePortSecureResolver servicePortSecureResolver,
 			Service service, @Nullable EndpointAddress endpointAddress, int endpointPort, String serviceId,
-			Map<String, String> serviceMetadata, String namespace) {
+			Map<String, String> serviceMetadata, String namespace, KubernetesDiscoveryProperties properties,
+			KubernetesClient client) {
 		// instanceId is usually the pod-uid as seen in the .metadata.uid
 		String instanceId = Optional.ofNullable(endpointAddress).map(EndpointAddress::getTargetRef)
 				.map(ObjectReference::getUid).orElseGet(() -> service.getMetadata().getUid());
@@ -254,8 +259,10 @@ static ServiceInstance serviceInstance(@Nullable ServicePortSecureResolver servi
 		String host = Optional.ofNullable(endpointAddress).map(EndpointAddress::getIp)
 				.orElseGet(() -> service.getSpec().getExternalName());
 
+		PodMetadata podMetadata = podMetadata(client, serviceMetadata, properties, endpointAddress, namespace);
+
 		return new DefaultKubernetesServiceInstance(instanceId, serviceId, host, endpointPort, serviceMetadata, secured,
-				namespace, null);
+				namespace, null, podMetadata.podLabels(), podMetadata.podAnnotations());
 	}
 
 	static List<Service> services(KubernetesDiscoveryProperties properties, KubernetesClient client,
@@ -287,6 +294,39 @@ else if (!properties.namespaces().isEmpty()) {
 		return services;
 	}
 
+	static PodMetadata podMetadata(KubernetesClient client, Map<String, String> serviceMetadata,
+			KubernetesDiscoveryProperties properties, EndpointAddress endpointAddress, String namespace) {
+		if (!EXTERNAL_NAME.equals(serviceMetadata.get(SERVICE_TYPE))) {
+			if (properties.metadata().addPodLabels() || properties.metadata().addPodAnnotations()) {
+				String podName = Optional.ofNullable(endpointAddress).map(EndpointAddress::getTargetRef)
+						.filter(objectReference -> "Pod".equals(objectReference.getKind()))
+						.map(ObjectReference::getName).orElse(null);
+
+				if (podName != null) {
+					ObjectMeta metadata = Optional
+							.ofNullable(client.pods().inNamespace(namespace).withName(podName).get())
+							.map(Pod::getMetadata).orElse(new ObjectMeta());
+					Map<String, String> podLabels = Map.of();
+					Map<String, String> podAnnotations = Map.of();
+					if (properties.metadata().addPodLabels()) {
+						podLabels = metadata.getLabels();
+					}
+
+					if (properties.metadata().addPodAnnotations()) {
+						podAnnotations = metadata.getAnnotations();
+					}
+
+					PodMetadata podMetadata = new PodMetadata(podLabels, podAnnotations);
+					LOG.debug(() -> "adding podMetadata : " + podMetadata + " from pod : " + podName);
+					return podMetadata;
+				}
+
+			}
+		}
+
+		return PodMetadata.EMPTY;
+	}
+
 	/**
 	 * serviceName can be null, in which case, such a filter will not be applied.
 	 */

spring-cloud-kubernetes-fabric8-discovery/src/test/java/org/springframework/cloud/kubernetes/fabric8/discovery/KubernetesDiscoveryClientTests.java

@@ -20,19 +20,22 @@
 import java.util.Map;
 import java.util.Set;
 
+import io.fabric8.kubernetes.api.model.EndpointAddressBuilder;
+import io.fabric8.kubernetes.api.model.EndpointPortBuilder;
+import io.fabric8.kubernetes.api.model.EndpointSubsetBuilder;
 import io.fabric8.kubernetes.api.model.Endpoints;
 import io.fabric8.kubernetes.api.model.EndpointsBuilder;
 import io.fabric8.kubernetes.api.model.ObjectMeta;
 import io.fabric8.kubernetes.api.model.ObjectMetaBuilder;
+import io.fabric8.kubernetes.api.model.ObjectReferenceBuilder;
+import io.fabric8.kubernetes.api.model.PodBuilder;
 import io.fabric8.kubernetes.api.model.Service;
 import io.fabric8.kubernetes.api.model.ServiceBuilder;
 import io.fabric8.kubernetes.api.model.ServiceSpecBuilder;
-import io.fabric8.kubernetes.client.Config;
 import io.fabric8.kubernetes.client.KubernetesClient;
 import io.fabric8.kubernetes.client.server.mock.EnableKubernetesMockClient;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Assertions;
-import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 
@@ -51,17 +54,6 @@ class KubernetesDiscoveryClientTests {
 
 	private static KubernetesClient client;
 
-	@BeforeAll
-	static void setUp() {
-		// Configure the kubernetes master url to point to the mock server
-		System.setProperty(Config.KUBERNETES_MASTER_SYSTEM_PROPERTY, client.getConfiguration().getMasterUrl());
-		System.setProperty(Config.KUBERNETES_TRUST_CERT_SYSTEM_PROPERTY, "true");
-		System.setProperty(Config.KUBERNETES_AUTH_TRYKUBECONFIG_SYSTEM_PROPERTY, "false");
-		System.setProperty(Config.KUBERNETES_AUTH_TRYSERVICEACCOUNT_SYSTEM_PROPERTY, "false");
-		System.setProperty(Config.KUBERNETES_NAMESPACE_SYSTEM_PROPERTY, "test");
-		System.setProperty(Config.KUBERNETES_HTTP2_DISABLE, "true");
-	}
-
 	@AfterEach
 	void afterEach() {
 		client.endpoints().inAnyNamespace().delete();
@@ -529,6 +521,44 @@ void testExternalNameService() {
 				"labels-prefix-label-key", "label-value", "annotations-prefix-abc", "def", "type", "ExternalName"));
 	}
 
+	@Test
+	void testPodMetadata() {
+		Service nonExternalNameService = new ServiceBuilder()
+				.withSpec(new ServiceSpecBuilder().withType("ClusterIP").build()).withNewMetadata()
+				.withName("blue-service").withNamespace("a").endMetadata().build();
+		client.services().inNamespace("a").resource(nonExternalNameService).create();
+
+		client.endpoints().inNamespace("a").resource(new EndpointsBuilder()
+				.withMetadata(new ObjectMetaBuilder().withName("blue-service").build())
+				.withSubsets(new EndpointSubsetBuilder().withPorts(new EndpointPortBuilder().withPort(8080).build())
+						.withAddresses(new EndpointAddressBuilder().withIp("127.0.0.1")
+								.withTargetRef(new ObjectReferenceBuilder().withKind("Pod").withName("my-pod").build())
+								.build())
+						.build())
+				.build()).create();
+
+		client.pods().inNamespace("a").resource(new PodBuilder().withMetadata(new ObjectMetaBuilder().withName("my-pod")
+				.withLabels(Map.of("a", "b")).withAnnotations(Map.of("c", "d")).build()).build()).create();
+
+		KubernetesDiscoveryProperties.Metadata metadata = new KubernetesDiscoveryProperties.Metadata(true,
+				"labels-prefix-", true, "annotations-prefix-", true, "ports-prefix", true, true);
+		KubernetesDiscoveryProperties properties = new KubernetesDiscoveryProperties(true, true, Set.of("a", "b"), true,
+				60L, false, "", Set.of(), Map.of(), "", metadata, 0, false, true);
+
+		KubernetesDiscoveryClient discoveryClient = new KubernetesDiscoveryClient(client, properties, null, null, null);
+		List<ServiceInstance> result = discoveryClient.getInstances("blue-service");
+		Assertions.assertEquals(result.size(), 1);
+		DefaultKubernetesServiceInstance serviceInstance = (DefaultKubernetesServiceInstance) result.get(0);
+		Assertions.assertEquals(serviceInstance.getServiceId(), "blue-service");
+		Assertions.assertEquals(serviceInstance.getHost(), "127.0.0.1");
+		Assertions.assertEquals(serviceInstance.getPort(), 8080);
+		Assertions.assertFalse(serviceInstance.isSecure());
+		Assertions.assertEquals(serviceInstance.getUri().toASCIIString(), "http://127.0.0.1:8080");
+		Assertions.assertEquals(serviceInstance.getMetadata(), Map.of("k8s_namespace", "a", "type", "ClusterIP"));
+		Assertions.assertEquals(serviceInstance.podLabels(), Map.of("a", "b"));
+		Assertions.assertEquals(serviceInstance.podAnnotations(), Map.of("c", "d"));
+	}
+
 	private void createEndpoints(String namespace, String name, Map<String, String> labels) {
 		client.endpoints().inNamespace(namespace)
 				.resource(new EndpointsBuilder()