OWLS-101705 Support resource limits on the monitoring exporter container (#3441)

russgold · web-flow · commit 352daebbc84b · 2022-09-23T13:06:31.000-04:00
* OWLS-101705 Support resource limits on the monitoring exporter container
diff --git a/documentation/domains/Domain.json b/documentation/domains/Domain.json
@@ -744,6 +744,10 @@
         "port": {
           "description": "The port exposed by the WebLogic Monitoring Exporter running in the sidecar container. Defaults to 8080. The port value must not conflict with a port used by any WebLogic Server instance, including the ports of built-in channels or network access points (NAPs).",
           "type": "number"
+        },
+        "resources": {
+          "description": "Memory and CPU minimum requirements and limits for the Monitoring Exporter sidecar. 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"
         }
       }
     },
diff --git a/documentation/domains/Domain.md b/documentation/domains/Domain.md
@@ -146,6 +146,7 @@ The current status of the operation of the WebLogic domain. Updated automaticall
 | `image` | string | The WebLogic Monitoring Exporter sidecar container image name. Defaults to ghcr.io/oracle/weblogic-monitoring-exporter:2.0.7 |
 | `imagePullPolicy` | string | The image pull policy for the WebLogic Monitoring Exporter sidecar container image. Legal values are Always, Never, and IfNotPresent. Defaults to Always if image ends in :latest; IfNotPresent, otherwise. |
 | `port` | number | The port exposed by the WebLogic Monitoring Exporter running in the sidecar container. Defaults to 8080. The port value must not conflict with a port used by any WebLogic Server instance, including the ports of built-in channels or network access points (NAPs). |
+| `resources` | [Resource Requirements](k8s1.13.5.md#resource-requirements) | Memory and CPU minimum requirements and limits for the Monitoring Exporter sidecar. See `kubectl explain pods.spec.containers.resources`. |
 
 ### Server Pod
 
diff --git a/documentation/domains/index.html b/documentation/domains/index.html
@@ -1665,6 +1665,10 @@
         "port": {
           "description": "The port exposed by the WebLogic Monitoring Exporter running in the sidecar container. Defaults to 8080. The port value must not conflict with a port used by any WebLogic Server instance, including the ports of built-in channels or network access points (NAPs).",
           "type": "number"
+        },
+        "resources": {
+          "description": "Memory and CPU minimum requirements and limits for the Monitoring Exporter sidecar. 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"
         }
       }
     },
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: bbd63d4e4cdbf643e599cdb9d28490c2692cf192fba2d2b69185742343d451b1
+    weblogic.sha256: 1641aa9f4ae5186be388438aef308f41280e72198f1a1318e3a8078af876fe7d
   name: domains.weblogic.oracle
 spec:
   group: weblogic.oracle
@@ -66,6 +66,19 @@ spec:
                       instance, including the ports of built-in channels or network
                       access points (NAPs).
                     type: number
+                  resources:
+                    description: Memory and CPU minimum requirements and limits for
+                      the Monitoring Exporter sidecar. See `kubectl explain pods.spec.containers.resources`.
+                    properties:
+                      requests:
+                        additionalProperties:
+                          type: string
+                        type: object
+                      limits:
+                        additionalProperties:
+                          type: string
+                        type: object
+                    type: object
                 type: object
               configuration:
                 description: Models and overrides affecting the WebLogic domain configuration.
diff --git a/operator/src/main/java/oracle/kubernetes/operator/helpers/PodStepContext.java b/operator/src/main/java/oracle/kubernetes/operator/helpers/PodStepContext.java
@@ -1441,6 +1441,7 @@ private V1Container createMonitoringExporterContainer() {
             .name(EXPORTER_CONTAINER_NAME)
             .image(getDomain().getMonitoringExporterImage())
             .imagePullPolicy(getDomain().getMonitoringExporterImagePullPolicy())
+            .resources(getDomain().getMonitoringExporterResources())
             .addEnvItem(new V1EnvVar().name("JAVA_OPTS").value(createJavaOptions()))
             .addPortsItem(new V1ContainerPort()
                 .name(getMetricsPortName()).protocol("TCP").containerPort(getPort()));
diff --git a/operator/src/main/java/oracle/kubernetes/weblogic/domain/DomainConfigurator.java b/operator/src/main/java/oracle/kubernetes/weblogic/domain/DomainConfigurator.java
@@ -15,6 +15,7 @@
 import io.kubernetes.client.openapi.models.V1LocalObjectReference;
 import io.kubernetes.client.openapi.models.V1PodReadinessGate;
 import io.kubernetes.client.openapi.models.V1PodSecurityContext;
+import io.kubernetes.client.openapi.models.V1ResourceRequirements;
 import io.kubernetes.client.openapi.models.V1SecurityContext;
 import io.kubernetes.client.openapi.models.V1Toleration;
 import oracle.kubernetes.operator.DomainSourceType;
@@ -34,7 +35,7 @@ public abstract class DomainConfigurator {
 
   private Domain domain;
 
-  public DomainConfigurator() {
+  protected DomainConfigurator() {
   }
 
   protected DomainConfigurator(Domain domain) {
@@ -335,6 +336,8 @@ protected DomainSpec getDomainSpec() {
 
   public abstract DomainConfigurator withMonitoringExporterConfiguration(String configuration);
 
+  public abstract DomainConfigurator withMonitoringExporterResources(V1ResourceRequirements resourceRequirements);
+
   public abstract DomainConfigurator withMonitoringExporterImage(String imageName);
 
   public abstract DomainConfigurator withMonitoringExporterPort(Integer port);
diff --git a/operator/src/main/java/oracle/kubernetes/weblogic/domain/model/Domain.java b/operator/src/main/java/oracle/kubernetes/weblogic/domain/model/Domain.java
@@ -25,6 +25,7 @@
 import io.kubernetes.client.openapi.models.V1EnvVar;
 import io.kubernetes.client.openapi.models.V1ObjectMeta;
 import io.kubernetes.client.openapi.models.V1PodSpec;
+import io.kubernetes.client.openapi.models.V1ResourceRequirements;
 import io.kubernetes.client.openapi.models.V1SecretReference;
 import io.kubernetes.client.openapi.models.V1VolumeMount;
 import jakarta.validation.Valid;
@@ -281,6 +282,10 @@ public MonitoringExporterSpecification getMonitoringExporterSpecification() {
     return spec.getMonitoringExporterSpecification();
   }
 
+  public V1ResourceRequirements getMonitoringExporterResources() {
+    return spec.getMonitoringExporterResourceRequirements();
+  }
+
   public String getMonitoringExporterImage() {
     return spec.getMonitoringExporterImage();
   }
diff --git a/operator/src/main/java/oracle/kubernetes/weblogic/domain/model/DomainCommonConfigurator.java b/operator/src/main/java/oracle/kubernetes/weblogic/domain/model/DomainCommonConfigurator.java
@@ -12,6 +12,7 @@
 import io.kubernetes.client.openapi.models.V1EnvVar;
 import io.kubernetes.client.openapi.models.V1PodReadinessGate;
 import io.kubernetes.client.openapi.models.V1PodSecurityContext;
+import io.kubernetes.client.openapi.models.V1ResourceRequirements;
 import io.kubernetes.client.openapi.models.V1SecretReference;
 import io.kubernetes.client.openapi.models.V1SecurityContext;
 import io.kubernetes.client.openapi.models.V1Toleration;
@@ -174,6 +175,12 @@ public DomainConfigurator withMonitoringExporterConfiguration(String configurati
     return this;
   }
 
+  @Override
+  public DomainConfigurator withMonitoringExporterResources(V1ResourceRequirements resourceRequirements) {
+    getDomainSpec().setMonitoringExporterResources(resourceRequirements);
+    return this;
+  }
+
   @Override
   public DomainConfigurator withMonitoringExporterImage(String imageName) {
     getDomainSpec().setMonitoringExporterImage(imageName);
diff --git a/operator/src/main/java/oracle/kubernetes/weblogic/domain/model/DomainSpec.java b/operator/src/main/java/oracle/kubernetes/weblogic/domain/model/DomainSpec.java
@@ -13,6 +13,7 @@
 
 import com.google.gson.annotations.SerializedName;
 import io.kubernetes.client.openapi.models.V1LocalObjectReference;
+import io.kubernetes.client.openapi.models.V1ResourceRequirements;
 import io.kubernetes.client.openapi.models.V1SecretReference;
 import jakarta.validation.Valid;
 import jakarta.validation.constraints.NotNull;
@@ -348,6 +349,20 @@ public Integer getMonitoringExporterPort() {
     return monitoringExporter == null ? null : monitoringExporter.getPort();
   }
 
+  V1ResourceRequirements getMonitoringExporterResourceRequirements() {
+    return Optional.ofNullable(monitoringExporter).map(MonitoringExporterSpecification::getResources).orElse(null);
+  }
+
+  /**
+   * Specifies the image for the monitoring exporter sidecar.
+   * @param resourceRequirements the name of the docker image
+   */
+  public void setMonitoringExporterResources(V1ResourceRequirements resourceRequirements) {
+    assert monitoringExporter != null : "May not set resources without configuration";
+
+    monitoringExporter.setResources(resourceRequirements);
+  }
+
   /**
    * Specifies the image for the monitoring exporter sidecar.
    * @param imageName the name of the docker image
diff --git a/operator/src/main/java/oracle/kubernetes/weblogic/domain/model/MonitoringExporterSpecification.java b/operator/src/main/java/oracle/kubernetes/weblogic/domain/model/MonitoringExporterSpecification.java
@@ -8,6 +8,7 @@
 import javax.annotation.Nullable;
 
 import com.google.gson.Gson;
+import io.kubernetes.client.openapi.models.V1ResourceRequirements;
 import oracle.kubernetes.json.Description;
 import oracle.kubernetes.json.EnumClass;
 import oracle.kubernetes.json.PreserveUnknown;
@@ -44,6 +45,14 @@ public class MonitoringExporterSpecification {
   @EnumClass(ImagePullPolicy.class)
   private String imagePullPolicy;
 
+  /**
+   * Defines the requirements and limits for the monitoring exporter sidecar.
+   *
+   */
+  @Description("Memory and CPU minimum requirements and limits for the Monitoring Exporter sidecar. "
+      + "See `kubectl explain pods.spec.containers.resources`.")
+  private V1ResourceRequirements resources;
+
   @Description(
       "The port exposed by the WebLogic Monitoring Exporter running in the sidecar container. "
           + "Defaults to 8080. The port value must not conflict with a port used by any WebLogic Server "
@@ -78,6 +87,14 @@ private Map<String, Object> parse(String yaml) {
     return new Yaml().load(yaml);
   }
 
+  public V1ResourceRequirements getResources() {
+    return resources;
+  }
+
+  public void setResources(V1ResourceRequirements resources) {
+    this.resources = resources;
+  }
+
   String getImage() {
     return Optional.ofNullable(image).orElse(DEFAULT_EXPORTER_IMAGE);
   }
@@ -106,6 +123,7 @@ void setPort(Integer port) {
   public String toString() {
     return new ToStringBuilder(this)
           .append("configuration", configuration)
+          .append("resources", resources)
           .append("image", image)
           .append("imagePullPolicy", imagePullPolicy)
           .append("port", port)
@@ -121,6 +139,7 @@ public boolean equals(Object o) {
   private boolean equals(MonitoringExporterSpecification that) {
     return new EqualsBuilder()
           .append(configuration, that.configuration)
+          .append(resources, that.resources)
           .append(image, that.image)
           .append(imagePullPolicy, that.imagePullPolicy)
           .append(port, that.port)
@@ -131,6 +150,7 @@ private boolean equals(MonitoringExporterSpecification that) {
   public int hashCode() {
     return new HashCodeBuilder(17, 37)
           .append(configuration)
+          .append(resources)
           .append(image)
           .append(imagePullPolicy)
           .append(port)
diff --git a/operator/src/test/java/oracle/kubernetes/operator/helpers/PodHelperTestBase.java b/operator/src/test/java/oracle/kubernetes/operator/helpers/PodHelperTestBase.java
@@ -431,6 +431,12 @@ protected DomainConfigurator defineExporterConfiguration() {
           .withMonitoringExporterImage(EXPORTER_IMAGE);
   }
 
+  protected void defineExporterConfigurationWithResourceRequirements() {
+    defineExporterConfiguration()
+        .withMonitoringExporterResources(
+            new V1ResourceRequirements().limits(Map.of("cpu", new Quantity("0.25"))));
+  }
+
   protected DomainConfigurator defineFluentdConfiguration(boolean watchIntrospectorLog) {
     return configureDomain()
             .withFluentdConfiguration(watchIntrospectorLog, "fluentd-cred",
@@ -492,6 +498,14 @@ void monitoringExporterContainer_hasInferredPullPolicy() {
 
     assertThat(getExporterContainer().getImagePullPolicy(), equalTo(ALWAYS_IMAGEPULLPOLICY));
   }
+  
+  @Test
+  void monitoringExporterContainer_SpecifiedCpuLimit() {
+    defineExporterConfigurationWithResourceRequirements();
+
+    assertThat(getExporterContainer().getResources().getLimits(), hasEntry("cpu", new Quantity("0.25")));
+  }
+
 
   @Test
   void whenExporterContainerCreated_hasMetricsPortsItem() {
diff --git a/operator/src/test/java/oracle/kubernetes/weblogic/domain/model/DomainV2Test.java b/operator/src/test/java/oracle/kubernetes/weblogic/domain/model/DomainV2Test.java
@@ -45,6 +45,7 @@
 import static org.hamcrest.Matchers.nullValue;
 import static org.hamcrest.core.Is.is;
 import static org.hamcrest.junit.MatcherAssert.assertThat;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 
 class DomainV2Test extends DomainTestBase {
 
@@ -1679,4 +1680,23 @@ void whenDistributionStrategyConfigured_returnIt() {
 
     assertThat(domain.getOverrideDistributionStrategy(), equalTo(OverrideDistributionStrategy.ON_RESTART));
   }
+
+  @Test
+  void whenReadFromYaml_MonitoringExporterSpecificationSupportsBasicOperations() throws IOException {
+    Domain domain = readDomain(DOMAIN_V2_SAMPLE_YAML_3);
+
+    final MonitoringExporterSpecification specification = domain.getSpec().getMonitoringExporterSpecification();
+    assertThat(specification.toString(), containsString("monexp:latest"));
+    assertThat(specification, not(equalTo(new MonitoringExporterSpecification())));
+    assertThat(specification.hashCode(), not(equalTo(new MonitoringExporterSpecification().hashCode())));
+  }
+
+  @Test
+  void whenNoMonitoringExporterConfigurationDefined_refuseAttemptToSetResourceRequirements() {
+    final DomainConfigurator domainConfigurator = configureDomain(domain);
+    final V1ResourceRequirements resourceRequirements = new V1ResourceRequirements();
+    
+    assertThrows(AssertionError.class,
+        () -> domainConfigurator.withMonitoringExporterResources(resourceRequirements));
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -744,6 +744,10 @@`
`744`	`744`	`"port": {`
`745`	`745`	`"description": "The port exposed by the WebLogic Monitoring Exporter running in the sidecar container. Defaults to 8080. The port value must not conflict with a port used by any WebLogic Server instance, including the ports of built-in channels or network access points (NAPs).",`
`746`	`746`	`"type": "number"`
	`747`	`+ },`
	`748`	`+ "resources": {`
	`749`	+ "description": "Memory and CPU minimum requirements and limits for the Monitoring Exporter sidecar. See `kubectl explain pods.spec.containers.resources`.",
	`750`	`+ "$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.13.5/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements"`
`747`	`751`	`}`
`748`	`752`	`}`
`749`	`753`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1665,6 +1665,10 @@`
`1665`	`1665`	`"port": {`
`1666`	`1666`	`"description": "The port exposed by the WebLogic Monitoring Exporter running in the sidecar container. Defaults to 8080. The port value must not conflict with a port used by any WebLogic Server instance, including the ports of built-in channels or network access points (NAPs).",`
`1667`	`1667`	`"type": "number"`
	`1668`	`+ },`
	`1669`	`+ "resources": {`
	`1670`	+ "description": "Memory and CPU minimum requirements and limits for the Monitoring Exporter sidecar. See `kubectl explain pods.spec.containers.resources`.",
	`1671`	`+ "$ref": "https://github.com/garethr/kubernetes-json-schema/blob/master/v1.13.5/_definitions.json#/definitions/io.k8s.api.core.v1.ResourceRequirements"`
`1668`	`1672`	`}`
`1669`	`1673`	`}`
`1670`	`1674`	`},`