Owls 105610 - Provide ability to specify the resources and java options for the introspector pod (#3914)

* Provide the ability to configure introspector server pod attributes.

Author: ankedia

common/src/main/java/oracle/kubernetes/common/logging/MessageKeys.java

@@ -276,6 +276,7 @@ public class MessageKeys {
   public static final String DOMAIN_REPLICAS_CANNOT_BE_HONORED_MULTIPLE_CLUSTERS = "WLSWH-0020";
   public static final String DOMAIN_REPLICAS_TOO_HIGH_MULTIPLE_CLUSTERS = "WLSWH-0021";
   public static final String CLUSTER_SCALE_REPLICAS_TOO_HIGH = "WLSWH-0022";
+  public static final String UNSUPPORTED_INTRO_ENV_VARIABLES = "WLSWH-0023";
 
   private MessageKeys() {
   }

common/src/main/resources/Operator.properties

@@ -325,4 +325,7 @@ WLSWH-0020=Change request to domain resource ''{0}'' cannot be honored because t
 WLSWH-0021=Change request to domain resource ''{0}'' causes the replica count of each cluster in ''{1}'' to exceed its cluster \
   size ''{2}'' respectively
 WLSWH-0022=Scale request to cluster resource ''{0}'' cannot be honored because the replica count would exceed the \
-  cluster size ''{1}''
+  cluster size ''{1}''
+WLSWH-0023=Unsupported introspector environment variable(s) {0} defined in ''introspector.serverPod.env'', \
+  supported values are {1}
+

documentation/domains/Cluster.json

@@ -364,6 +364,10 @@
           "description": "Specifies whether the server .out file will be included in the Pod\u0027s log. Defaults to true.",
           "type": "boolean"
         },
+        "introspector": {
+          "description": "Lifecycle options for the Introspector Job Pod, including Java options, environment variables, and resources.",
+          "$ref": "#/definitions/Introspector"
+        },
         "clusters": {
           "description": "References to Cluster resources that describe the lifecycle options for all of the Managed Server members of a WebLogic cluster, including Java options, environment variables, additional Pod content, and the ability to explicitly start, stop, or restart cluster members. The Cluster resource must describe a cluster that already exists in the WebLogic domain configuration.",
           "type": "array",
@@ -564,6 +568,31 @@
         }
       }
     },
+    "Introspector": {
+      "type": "object",
+      "properties": {
+        "serverPod": {
+          "description": "Customization affecting the generation of the Introspector Job Pod.",
+          "$ref": "#/definitions/IntrospectorJobPod"
+        }
+      }
+    },
+    "IntrospectorJobPod": {
+      "type": "object",
+      "properties": {
+        "resources": {
+          "description": "Memory and CPU minimum requirements and limits for the Introspector Job Pod. See `kubectl explain pods.spec.containers.resources`.",
+          "$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.13.5/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements"
+        },
+        "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",
+          "items": {
+            "$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.13.5/_definitions.json#/definitions/io.k8s.api.core.v1.EnvVar"
+          }
+        }
+      }
+    },
     "ManagedServer": {
       "type": "object",
       "properties": {

documentation/domains/Domain.json

@@ -31,6 +31,7 @@ The specification of the operation of the WebLogic domain. Required.
 | `imagePullPolicy` | string | The image pull policy for the WebLogic Server image. Legal values are Always, Never, and IfNotPresent. Defaults to Always if image ends in :latest; IfNotPresent, otherwise. |
 | `imagePullSecrets` | Array of [Local Object Reference](k8s1.13.5.md#local-object-reference) | A list of image pull Secrets for the WebLogic Server image. |
 | `includeServerOutInPodLog` | Boolean | Specifies whether the server .out file will be included in the Pod's log. Defaults to true. |
+| `introspector` | [Introspector](#introspector) | Lifecycle options for the Introspector Job Pod, including Java options, environment variables, and resources. |
 | `introspectVersion` | string | Changes to this field cause the operator to repeat its introspection of the WebLogic domain configuration. Repeating introspection is required for the operator to recognize changes to the domain configuration, such as adding a new WebLogic cluster or Managed Server instance, to regenerate configuration overrides, or to regenerate the WebLogic domain home when the `domainHomeSourceType` is `FromModel`. Introspection occurs automatically, without requiring change to this field, when servers are first started or restarted after a full domain shut down. For the `FromModel` `domainHomeSourceType`, introspection also occurs when a running server must be restarted because of changes to any of the fields listed here: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle/startup/#properties-that-cause-servers-to-be-restarted. The introspectVersion value must be a valid label value in Kubernetes. See also `domains.spec.configuration.overrideDistributionStrategy`. |
 | `livenessProbeCustomScript` | string | Full path of an optional liveness probe custom script for WebLogic Server instance pods. The existing liveness probe script `livenessProbe.sh` will invoke this custom script after the existing script performs its own checks. This element is optional and is for advanced usage only. Its value is not set by default. If the custom script fails with non-zero exit status, then pod will fail the liveness probe and Kubernetes will restart the container. If the script specified by this element value is not found, then it is ignored. |
 | `logHome` | string | The directory in a server's container in which to store the domain, Node Manager, server logs, server *.out, introspector .out, and optionally HTTP access log files if `httpAccessLogInLogHome` is true. Default is `/shared/logs/DOMAIN-UID`. Ignored if `logHomeEnabled` is false.See also `domains.spec.logHomeLayout`. |
@@ -104,6 +105,12 @@ The current status of the operation of the WebLogic domain. Updated automaticall
 | `volumeMounts` | Array of [Volume Mount](k8s1.13.5.md#volume-mount) | Volume mounts for fluentd container |
 | `watchIntrospectorLogs` | Boolean | Fluentd will watch introspector logs |
 
+### Introspector
+
+| Name | Type | Description |
+| --- | --- | --- |
+| `serverPod` | [Introspector Job Pod](#introspector-job-pod) | Customization affecting the generation of the Introspector Job Pod. |
+
 ### Managed Server
 
 | Name | Type | Description |
@@ -231,6 +238,13 @@ The current status of the operation of the WebLogic domain. Updated automaticall
 | `walletFileSecret` | string | Name of a Secret containing the OPSS key wallet file, which must be in a field named `walletFile`. Use this to allow a JRF domain to reuse its entries in the RCU database. This allows you to specify a wallet file that was obtained from the domain home after the domain was booted for the first time. |
 | `walletPasswordSecret` | string | Name of a Secret containing the OPSS key passphrase, which must be in a field named `walletPassword`. Used to encrypt and decrypt the wallet that is used for accessing the domain's entries in its RCU database. |
 
+### Introspector Job Pod
+
+| Name | Type | Description |
+| --- | --- | --- |
+| `env` | Array of [Env Var](k8s1.13.5.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`. |
+| `resources` | [Resource Requirements](k8s1.13.5.md#resource-requirements) | Memory and CPU minimum requirements and limits for the Introspector Job Pod. See `kubectl explain pods.spec.containers.resources`. |
+
 ### Probe Tuning
 
 | Name | Type | Description |

documentation/domains/Domain.md

@@ -1,4 +1,4 @@
-// Copyright (c) 2018, 2022, Oracle and/or its affiliates.
+// Copyright (c) 2018, 2023, Oracle and/or its affiliates.
 // Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 package oracle.kubernetes.json;
@@ -57,7 +57,7 @@ public class SchemaGenerator {
   private final Map<Class<?>, String> references = new HashMap<>();
 
   // A map of found classes to their definitions or the constant EXTERNAL_CLASS.
-  private final Map<Class<?>, Object> definedObjects = new HashMap<>();
+  private Map<Class<?>, Object> definedObjects = new HashMap<>();
 
   // a map of external class names to the external schema that defines them
   private final Map<String, String> schemaUrls = new HashMap<>();
@@ -175,6 +175,10 @@ public void addPackageToSuppressDescriptions(String packageName) {
     this.suppressDescriptionForPackages.add(packageName);
   }
 
+  public void initializeDefinedObjects() {
+    definedObjects = new HashMap<>();
+  }
+
   /**
    * Generates an object representing a JSON schema for the specified class.
    *

json-schema-generator/src/main/java/oracle/kubernetes/json/SchemaGenerator.java

@@ -1,4 +1,4 @@
-// Copyright (c) 2018, 2022, Oracle and/or its affiliates.
+// Copyright (c) 2018, 2023, Oracle and/or its affiliates.
 // Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 package oracle.kubernetes.json;

json-schema-generator/src/test/java/oracle/kubernetes/json/SchemaGeneratorTest.java

@@ -1,4 +1,4 @@
-// Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+// Copyright (c) 2018, 2023, Oracle and/or its affiliates.
 // Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 package oracle.kubernetes.json;

json-schema-generator/src/test/java/oracle/kubernetes/json/SimpleObject.java

@@ -5,7 +5,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    weblogic.sha256: 800688be11eb480e3abcda813ac991a970e6b55273bb8403f1f6c3b6684a9676
+    weblogic.sha256: 5613ace711131620c27c324b75c8994cc7036312a4c9a386492ced0a9b0fb38f
   name: domains.weblogic.oracle
 spec:
   group: weblogic.oracle
@@ -3484,6 +3484,97 @@ spec:
                 description: Specifies whether the server .out file will be included
                   in the Pod's log. Defaults to true.
                 type: boolean
+              introspector:
+                description: Lifecycle options for the Introspector Job Pod, including
+                  Java options, environment variables, and resources.
+                properties:
+                  serverPod:
+                    description: Customization affecting the generation of the Introspector
+                      Job Pod.
+                    properties:
+                      resources:
+                        description: Memory and CPU minimum requirements and limits
+                          for the Introspector Job Pod. See `kubectl explain pods.spec.containers.resources`.
+                        properties:
+                          requests:
+                            additionalProperties:
+                              type: string
+                            type: object
+                          limits:
+                            additionalProperties:
+                              type: string
+                            type: object
+                        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.
+                          See `kubectl explain pods.spec.containers.env`.'
+                        items:
+                          type: object
+                          properties:
+                            name:
+                              type: string
+                            value:
+                              type: string
+                            valueFrom:
+                              type: object
+                              properties:
+                                secretKeyRef:
+                                  type: object
+                                  properties:
+                                    name:
+                                      type: string
+                                    optional:
+                                      type: boolean
+                                    key:
+                                      type: string
+                                  required:
+                                  - key
+                                resourceFieldRef:
+                                  type: object
+                                  properties:
+                                    divisor:
+                                      type: object
+                                      properties:
+                                        number:
+                                          type: integer
+                                        format:
+                                          type: string
+                                          enum:
+                                          - DECIMAL_EXPONENT
+                                          - DECIMAL_SI
+                                          - BINARY_SI
+                                    resource:
+                                      type: string
+                                    containerName:
+                                      type: string
+                                  required:
+                                  - resource
+                                configMapKeyRef:
+                                  type: object
+                                  properties:
+                                    name:
+                                      type: string
+                                    optional:
+                                      type: boolean
+                                    key:
+                                      type: string
+                                  required:
+                                  - key
+                                fieldRef:
+                                  type: object
+                                  properties:
+                                    apiVersion:
+                                      type: string
+                                    fieldPath:
+                                      type: string
+                                  required:
+                                  - fieldPath
+                          required:
+                          - name
+                        type: array
+                    type: object
+                type: object
               clusters:
                 description: References to Cluster resources that describe the lifecycle
                   options for all of the Managed Server members of a WebLogic cluster,

kubernetes/crd/domain-crd.yaml

@@ -1,4 +1,4 @@
-// Copyright (c) 2018, 2021, Oracle and/or its affiliates.
+// Copyright (c) 2018, 2023, Oracle and/or its affiliates.
 // Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 
 package oracle.kubernetes.json.mojo;
@@ -55,6 +55,7 @@ public void defineSchemaUrlAndContents(URL schemaUrl, URL cacheUrl) throws IOExc
   public Map<String, Object> generateSchema(String className, File outputFile)
       throws MojoExecutionException {
     outputFile.getParentFile().mkdirs();
+    generator.initializeDefinedObjects();
     try (FileWriter writer = new FileWriter(outputFile)) {
       Class<?> theClass = classLoader.loadClass(className);
       Map<String, Object> schema = generator.generate(theClass);