Merge branch 'support-annotation-label-for-introspector' into 'main'

rjeberhard · rjeberhard · commit 06aca81698f7 · 2025-11-04T20:00:25.000Z
Support annotation label for introspector and correct reading the correct jobpod container

See merge request weblogic-cloud/weblogic-kubernetes-operator!5049
diff --git a/documentation/domains/Domain.json b/documentation/domains/Domain.json
@@ -773,6 +773,13 @@
           "description": "Memory and CPU minimum requirements and limits for the Introspector Job Pod. See `kubectl explain pods.spec.containers.resources`.",
           "$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.28.2/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements"
         },
+        "annotations": {
+          "description": "The annotations to be added to generated resources.",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "$ref": "#/definitions/Map"
+        },
         "env": {
           "description": "A list of environment variables to set in the Introspector Job Pod container. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-resource/#jvm-memory-and-java-option-environment-variables. See `kubectl explain pods.spec.containers.env`.",
           "type": "array",
@@ -793,6 +800,13 @@
           "items": {
             "$ref": "https://raw.githubusercontent.com/yannh/kubernetes-json-schema/master/v1.28.2/_definitions.json#/definitions/io.k8s.api.core.v1.Container"
           }
+        },
+        "labels": {
+          "description": "The labels to be added to generated resources. The label names must not start with \"weblogic.\".",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "$ref": "#/definitions/Map"
         }
       }
     },
diff --git a/documentation/domains/Domain.md b/documentation/domains/Domain.md
@@ -278,9 +278,11 @@ The current status of the operation of the WebLogic domain. Updated automaticall
 
 | Name | Type | Description |
 | --- | --- | --- |
+| `annotations` | Map | The annotations to be added to generated resources. |
 | `env` | Array of [Env Var](k8s1.28.2.md#env-var) | A list of environment variables to set in the Introspector Job Pod container. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-resource/#jvm-memory-and-java-option-environment-variables. See `kubectl explain pods.spec.containers.env`. |
 | `envFrom` | Array of [Env From Source](k8s1.28.2.md#env-from-source) | List of sources to populate environment variables in the Introspector Job Pod container. The sources include either a config map or a secret. The operator will not expand the dependent variables in the 'envFrom' source. More details: https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/#define-an-environment-variable-for-a-container. Also see: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-resource/#jvm-memory-and-java-option-environment-variables. |
 | `initContainers` | Array of [Container](k8s1.28.2.md#container) | List of init containers for the introspector Job Pod. These containers run after the auxiliary image init container. See `kubectl explain pods.spec.initContainers`. |
+| `labels` | Map | The labels to be added to generated resources. The label names must not start with "weblogic.". |
 | `podSecurityContext` | [Pod Security Context](k8s1.28.2.md#pod-security-context) | Pod-level security attributes. See `kubectl explain pods.spec.securityContext`. If no value is specified for this field, the operator will use default content for the pod-level `securityContext`. More info: https://oracle.github.io/weblogic-kubernetes-operator/security/domain-security/pod-and-container/. |
 | `resources` | [Resource Requirements](k8s1.28.2.md#resource-requirements) | Memory and CPU minimum requirements and limits for the Introspector Job Pod. See `kubectl explain pods.spec.containers.resources`. |
 
diff --git a/kubernetes/crd/domain-crd.yaml b/kubernetes/crd/domain-crd.yaml
@@ -5,7 +5,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    weblogic.sha256: 68317b3e7f2cc05c004dcf48eb7f2b83a8c6747f54d7a6929d6ba664df0594db
+    weblogic.sha256: 6e58fa19cc5aff28cc719869a8b6172feb024bbc30d1586ee33f61e1b9fffe9a
   name: domains.weblogic.oracle
 spec:
   group: weblogic.oracle
@@ -4413,6 +4413,11 @@ spec:
                               type: string
                             type: object
                         type: object
+                      annotations:
+                        additionalProperties:
+                          type: string
+                        description: The annotations to be added to generated resources.
+                        type: object
                       env:
                         description: 'A list of environment variables to set in the
                           Introspector Job Pod container. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-resource/#jvm-memory-and-java-option-environment-variables.
@@ -5069,6 +5074,12 @@ spec:
                           required:
                           - name
                         type: array
+                      labels:
+                        additionalProperties:
+                          type: string
+                        description: The labels to be added to generated resources.
+                          The label names must not start with "weblogic.".
+                        type: object
                     type: object
                 type: object
               clusters:
diff --git a/operator/src/main/java/oracle/kubernetes/operator/helpers/JobHelper.java b/operator/src/main/java/oracle/kubernetes/operator/helpers/JobHelper.java
@@ -526,7 +526,14 @@ private class ReadPodLogStep extends Step {
       }
 
       private V1ContainerStatus getJobPodContainerStatus(V1Pod jobPod) {
-        return Optional.ofNullable(getContainerStatuses(jobPod)).flatMap(cs -> cs.stream().findFirst()).orElse(null);
+        String targetContainerName = getContainerName(); // Get the actual job container name
+
+        return Optional.ofNullable(getContainerStatuses(jobPod))
+                .flatMap(cs -> cs.stream()
+                        .filter(status -> targetContainerName.equals(status.getName()))
+                        .findFirst())
+                .orElse(null);
+
       }
 
       private List<V1ContainerStatus> getContainerStatuses(V1Pod jobPod) {
diff --git a/operator/src/main/java/oracle/kubernetes/operator/helpers/JobStepContext.java b/operator/src/main/java/oracle/kubernetes/operator/helpers/JobStepContext.java
@@ -7,6 +7,7 @@
 import java.security.NoSuchAlgorithmException;
 import java.util.ArrayList;
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
@@ -199,6 +200,16 @@ private List<V1Container> getIntrospectorInitContainers() {
             .map(EffectiveIntrospectorJobPodSpec::getInitContainers).orElse(new ArrayList<>());
   }
 
+  private Map<String, String> getIntrospectorLabels() {
+    return Optional.ofNullable(getDomain().getIntrospectorSpec())
+            .map(EffectiveIntrospectorJobPodSpec::getLabels).orElse(new HashMap<>());
+  }
+
+  private Map<String, String> getIntrospectorAnnotations() {
+    return Optional.ofNullable(getDomain().getIntrospectorSpec())
+            .map(EffectiveIntrospectorJobPodSpec::getAnnotations).orElse(new HashMap<>());
+  }
+
   private List<V1EnvVar> getAdminServerEnvVariables() {
     return Optional.ofNullable(getDomain().getAdminServerSpec()).map(EffectiveServerSpec::getEnvironmentVariables)
         .orElse(new ArrayList<>());
@@ -463,8 +474,13 @@ private List<DomainCreationImage> getDomainCreationImages() {
   }
 
   private V1ObjectMeta createPodTemplateMetadata() {
+    Map<String, String> labels = getIntrospectorLabels();
+    Map<String, String> annotations = getIntrospectorAnnotations();
+
     return new V1ObjectMeta()
           .name(getJobName())
+          .labels(labels)
+          .annotations(annotations)
           .putLabelsItem(LabelConstants.CREATEDBYOPERATOR_LABEL, "true")
           .putLabelsItem(LabelConstants.DOMAINUID_LABEL, getDomainUid())
           .putLabelsItem(LabelConstants.JOBNAME_LABEL, createJobName(getDomainUid()));
diff --git a/operator/src/main/java/oracle/kubernetes/operator/processing/EffectiveIntrospectorJobPodSpec.java b/operator/src/main/java/oracle/kubernetes/operator/processing/EffectiveIntrospectorJobPodSpec.java
@@ -4,6 +4,7 @@
 package oracle.kubernetes.operator.processing;
 
 import java.util.List;
+import java.util.Map;
 
 import io.kubernetes.client.openapi.models.V1Container;
 import io.kubernetes.client.openapi.models.V1EnvFromSource;
@@ -31,4 +32,9 @@ public interface EffectiveIntrospectorJobPodSpec {
   V1PodSecurityContext getPodSecurityContext();
 
   List<V1Container> getInitContainers();
+
+  Map<String, String> getLabels();
+
+  Map<String, String> getAnnotations();
+
 }
diff --git a/operator/src/main/java/oracle/kubernetes/weblogic/domain/model/EffectiveIntrospectorJobPodSpecCommonImpl.java b/operator/src/main/java/oracle/kubernetes/weblogic/domain/model/EffectiveIntrospectorJobPodSpecCommonImpl.java
@@ -4,6 +4,7 @@
 package oracle.kubernetes.weblogic.domain.model;
 
 import java.util.List;
+import java.util.Map;
 
 import io.kubernetes.client.openapi.models.V1Container;
 import io.kubernetes.client.openapi.models.V1EnvFromSource;
@@ -55,4 +56,14 @@ public List<V1Container> getInitContainers() {
     return introspector.getInitContainers();
   }
 
+  @Override
+  public Map<String, String> getLabels() {
+    return introspector.getLabels();
+  }
+
+  @Override
+  public Map<String, String> getAnnotations() {
+    return introspector.getAnnotations();
+  }
+
 }
diff --git a/operator/src/main/java/oracle/kubernetes/weblogic/domain/model/IntrospectorJobPod.java b/operator/src/main/java/oracle/kubernetes/weblogic/domain/model/IntrospectorJobPod.java
@@ -24,7 +24,7 @@
 
 import static java.util.Collections.emptyList;
 
-class IntrospectorJobPod {
+class IntrospectorJobPod extends KubernetesResource {
 
   private static final Comparator<V1EnvVar> ENV_VAR_COMPARATOR =
       Comparator.comparing(V1EnvVar::getName);
@@ -159,6 +159,7 @@ void fillInFrom(IntrospectorJobPod serverPod1) {
       }
       initContainers.addAll(serverPod1.initContainers);
     }
+    fillInFrom((KubernetesResource) serverPod1);
     copyValues(resources, serverPod1.resources);
     copyValues(serverPod1.podSecurityContext);
   }
diff --git a/operator/src/main/java/oracle/kubernetes/weblogic/domain/model/IntrospectorJobPodConfiguration.java b/operator/src/main/java/oracle/kubernetes/weblogic/domain/model/IntrospectorJobPodConfiguration.java
@@ -4,6 +4,7 @@
 package oracle.kubernetes.weblogic.domain.model;
 
 import java.util.List;
+import java.util.Map;
 import javax.annotation.Nullable;
 
 import io.kubernetes.client.openapi.models.V1Container;
@@ -53,6 +54,14 @@ public List<V1Container> getInitContainers() {
     return serverPod.getInitContainers();
   }
 
+  public Map<String, String> getLabels() {
+    return serverPod.getLabels();
+  }
+
+  public Map<String, String> getAnnotations() {
+    return serverPod.getAnnotations();
+  }
+
   void addEnvironmentVariable(String name, String value) {
     serverPod.addEnvVar(new V1EnvVar().name(name).value(value));
   }
diff --git a/operator/src/test/java/oracle/kubernetes/operator/helpers/DomainIntrospectorJobTest.java b/operator/src/test/java/oracle/kubernetes/operator/helpers/DomainIntrospectorJobTest.java
@@ -145,6 +145,7 @@
 import static org.hamcrest.CoreMatchers.containsString;
 import static org.hamcrest.CoreMatchers.equalTo;
 import static org.hamcrest.CoreMatchers.nullValue;
+import static org.hamcrest.Matchers.hasEntry;
 import static org.hamcrest.Matchers.hasItem;
 import static org.hamcrest.Matchers.hasSize;
 import static org.hamcrest.Matchers.is;
@@ -153,6 +154,7 @@
 import static org.hamcrest.Matchers.stringContainsInOrder;
 import static org.hamcrest.core.AllOf.allOf;
 import static org.hamcrest.junit.MatcherAssert.assertThat;
+import static org.junit.Assert.assertNotNull;
 
 @SuppressWarnings({"SameParameterValue"})
 class DomainIntrospectorJobTest extends DomainTestUtils {
@@ -505,6 +507,37 @@ void whenJobCreatedWithInitDomainOnPVWithModelEncryption_hasSecretsVolumeAndMoun
 
   }
 
+  @Test
+  void whenJobCreatedWithAnnotationsAndLabelsThePodHastheMetaData() {
+    Map<String, String> annotations = new HashMap<>();
+    annotations.put("annotation1", "value1");
+    annotations.put("annotation2", "value2");
+    Map<String, String> labels = new HashMap<>();
+    labels.put("label1", "value1");
+    labels.put("label2", "value2");
+
+    getConfigurator()
+            .withIntrospectorAnnotations(annotations)
+            .withIntrospectorLabels(labels)
+            .withDomainHomeSourceType(DomainSourceType.FROM_MODEL)
+            .withAuxiliaryImages(Collections.singletonList(getAuxiliaryImage("wdt-image:v1")));
+
+    List<V1Job> jobs = runStepsAndGetJobs();
+    V1Job job = jobs.get(0);
+
+    assertNotNull(job.getSpec().getTemplate().getMetadata());
+    assertNotNull(job.getSpec().getTemplate().getMetadata().getAnnotations());
+    assertNotNull(job.getSpec().getTemplate().getMetadata().getLabels());
+
+    annotations.forEach((key, value) ->
+            assertThat(job.getSpec().getTemplate().getMetadata().getAnnotations(), hasEntry(key, value))
+    );
+    labels.forEach((key, value) ->
+            assertThat(job.getSpec().getTemplate().getMetadata().getLabels(), hasEntry(key, value))
+    );
+
+  }
+
 
   private V1Secret createSecret(String name) {
     return new V1Secret().metadata(new V1ObjectMeta().name(name).namespace(NS));
diff --git a/operator/src/test/java/oracle/kubernetes/weblogic/domain/DomainConfigurator.java b/operator/src/test/java/oracle/kubernetes/weblogic/domain/DomainConfigurator.java
@@ -5,6 +5,7 @@
 
 import java.util.Arrays;
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 import javax.annotation.Nonnull;
 
@@ -31,6 +32,7 @@
 import oracle.kubernetes.weblogic.domain.model.DomainResource;
 import oracle.kubernetes.weblogic.domain.model.DomainSpec;
 import oracle.kubernetes.weblogic.domain.model.InitializeDomainOnPV;
+import oracle.kubernetes.weblogic.domain.model.Introspector;
 import oracle.kubernetes.weblogic.domain.model.Model;
 import oracle.kubernetes.weblogic.domain.model.Shutdown;
 
@@ -97,6 +99,28 @@ public DomainConfigurator withWDTInstallationHome(String wdtInstallationHome) {
     return this;
   }
 
+  /**
+   * Add annotations to the domain introspector.
+   * @param introspectorAnnotations map of annotations
+   * @return DomainConfigurator
+   */
+  public DomainConfigurator withIntrospectorAnnotations(Map<String, String> introspectorAnnotations) {
+    Introspector introspector = getDomainSpec().getOrCreateIntrospector();
+    introspector.getAnnotations().putAll(introspectorAnnotations);
+    return this;
+  }
+
+  /**
+   * Add labels to the domain introspector.
+   * @param introspectorLabels map of labels
+   * @return DomainConfigurator
+   */
+  public DomainConfigurator withIntrospectorLabels(Map<String, String> introspectorLabels) {
+    Introspector introspector = getDomainSpec().getOrCreateIntrospector();
+    introspector.getLabels().putAll(introspectorLabels);
+    return this;
+  }
+
   public DomainConfigurator withModelHome(String modelHome) {
     getDomainSpec().setModelHome(modelHome);
     return this;

Original file line number	Diff line number	Diff line change
`@@ -526,7 +526,14 @@ private class ReadPodLogStep extends Step {`
`526`	`526`	`}`
`527`	`527`
`528`	`528`	`private V1ContainerStatus getJobPodContainerStatus(V1Pod jobPod) {`
`529`		`- return Optional.ofNullable(getContainerStatuses(jobPod)).flatMap(cs -> cs.stream().findFirst()).orElse(null);`
	`529`	`+ String targetContainerName = getContainerName(); // Get the actual job container name`
	`530`	`+`
	`531`	`+ return Optional.ofNullable(getContainerStatuses(jobPod))`
	`532`	`+ .flatMap(cs -> cs.stream()`
	`533`	`+ .filter(status -> targetContainerName.equals(status.getName()))`
	`534`	`+ .findFirst())`
	`535`	`+ .orElse(null);`
	`536`	`+`
`530`	`537`	`}`
`531`	`538`
`532`	`539`	`private List<V1ContainerStatus> getContainerStatuses(V1Pod jobPod) {`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`
`25`	`25`	`import static java.util.Collections.emptyList;`
`26`	`26`
`27`		`-class IntrospectorJobPod {`
	`27`	`+class IntrospectorJobPod extends KubernetesResource {`
`28`	`28`
`29`	`29`	`private static final Comparator<V1EnvVar> ENV_VAR_COMPARATOR =`
`30`	`30`	`Comparator.comparing(V1EnvVar::getName);`
`@@ -159,6 +159,7 @@ void fillInFrom(IntrospectorJobPod serverPod1) {`
`159`	`159`	`}`
`160`	`160`	`initContainers.addAll(serverPod1.initContainers);`
`161`	`161`	`}`
	`162`	`+ fillInFrom((KubernetesResource) serverPod1);`
`162`	`163`	`copyValues(resources, serverPod1.resources);`
`163`	`164`	`copyValues(serverPod1.podSecurityContext);`
`164`	`165`	`}`