Clarify lifecycle of monitoring exporter integration (#2366)

rjeberhard · web-flow · commit 499304bc81e9 · 2021-05-19T15:43:56.000-04:00
* Clarify lifecycle of monitoring exporter integration
diff --git a/documentation/domains/Domain.json b/documentation/domains/Domain.json
@@ -268,7 +268,7 @@
       "type": "object",
       "properties": {
         "monitoringExporter": {
-          "description": "Configuration for the use of the WebLogic Monitoring Exporter as part of this domain.",
+          "description": "Automatic deployment and configuration of the WebLogic Monitoring Exporter. If specified, the operator will deploy a sidecar container alongside each WebLogic Server instance that runs the exporter. WebLogic Server instances that are already running when the `monitoringExporter` field is created or deleted, will not be affected until they are restarted. When any given server is restarted for another reason, such as a change to the `restartVersion`, then the newly created pod will have the exporter sidecar or not, as appropriate. See https://github.com/oracle/weblogic-monitoring-exporter.",
           "$ref": "#/definitions/MonitoringExporterSpecification"
         },
         "configuration": {
@@ -590,11 +590,11 @@
       "type": "object",
       "properties": {
         "image": {
-          "description": "The WebLogic Monitoring Exporter sidecar image name. Defaults to ghcr.io/oracle/weblogic-monitoring-exporter:2.0.2",
+          "description": "The WebLogic Monitoring Exporter sidecar container image name. Defaults to ghcr.io/oracle/weblogic-monitoring-exporter:2.0.2",
           "type": "string"
         },
         "imagePullPolicy": {
-          "description": "The image pull policy for the WebLogic Monitoring Exporter sidecar image. Legal values are Always, Never, and IfNotPresent. Defaults to Always if image ends in :latest; IfNotPresent, otherwise.",
+          "description": "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.",
           "type": "string",
           "enum": [
             "Always",
@@ -604,7 +604,7 @@
         },
         "configuration": {
           "x-kubernetes-preserve-unknown-fields": "true",
-          "description": "The configuration for the WebLogic Monitoring Exporter sidecar. If specified, the operator will deploy a sidecar alongside each server instance. See https://github.com/oracle/weblogic-monitoring-exporter",
+          "description": "The configuration for the WebLogic Monitoring Exporter. If WebLogic Server instances are already running and have the monitoring exporter sidecar container, then changes to this field will be propagated to the exporter without requiring the restart of the WebLogic Server instances.",
           "$ref": "#/definitions/Map"
         }
       }
diff --git a/documentation/domains/Domain.md b/documentation/domains/Domain.md
@@ -37,7 +37,7 @@ The specification of the operation of the WebLogic domain. Required.
 | `managedServers` | array of [Managed Server](#managed-server) | Lifecycle options for individual Managed Servers, including Java options, environment variables, additional Pod content, and the ability to explicitly start, stop, or restart a named server instance. The `serverName` field of each entry must match a Managed Server that already exists in the WebLogic domain configuration or that matches a dynamic cluster member based on the server template. |
 | `maxClusterConcurrentShutdown` | number | The default maximum number of WebLogic Server instances that a cluster will shut down in parallel when it is being partially shut down by lowering its replica count. You can override this default on a per cluster basis by setting the cluster's `maxConcurrentShutdown` field. A value of 0 means there is no limit. Defaults to 1. |
 | `maxClusterConcurrentStartup` | number | The maximum number of cluster member Managed Server instances that the operator will start in parallel for a given cluster, if `maxConcurrentStartup` is not specified for a specific cluster under the `clusters` field. A value of 0 means there is no configured limit. Defaults to 0. |
-| `monitoringExporter` | [Monitoring Exporter Specification](#monitoring-exporter-specification) | Configuration for the use of the WebLogic Monitoring Exporter as part of this domain. |
+| `monitoringExporter` | [Monitoring Exporter Specification](#monitoring-exporter-specification) | Automatic deployment and configuration of the WebLogic Monitoring Exporter. If specified, the operator will deploy a sidecar container alongside each WebLogic Server instance that runs the exporter. WebLogic Server instances that are already running when the `monitoringExporter` field is created or deleted, will not be affected until they are restarted. When any given server is restarted for another reason, such as a change to the `restartVersion`, then the newly created pod will have the exporter sidecar or not, as appropriate. See https://github.com/oracle/weblogic-monitoring-exporter. |
 | `replicas` | number | The default number of cluster member Managed Server instances to start for each WebLogic cluster in the domain configuration, unless `replicas` is specified for that cluster under the `clusters` field. For each cluster, the operator will sort cluster member Managed Server names from the WebLogic domain configuration by normalizing any numbers in the Managed Server name and then sorting alphabetically. This is done so that server names such as "managed-server10" come after "managed-server9". The operator will then start Managed Servers from the sorted list, up to the `replicas` count, unless specific Managed Servers are specified as starting in their entry under the `managedServers` field. In that case, the specified Managed Servers will be started and then additional cluster members will be started, up to the `replicas` count, by finding further cluster members in the sorted list that are not already started. If cluster members are started because of their entries under `managedServers`, then a cluster may have more cluster members running than its `replicas` count. Defaults to 0. |
 | `restartVersion` | string | Changes to this field cause the operator to restart WebLogic Server instances. More info: https://oracle.github.io/weblogic-kubernetes-operator/userguide/managing-domains/domain-lifecycle/startup/#restarting-servers. |
 | `serverPod` | [Server Pod](#server-pod) | Customization affecting the generation of Pods for WebLogic Server instances. |
@@ -116,9 +116,9 @@ The current status of the operation of the WebLogic domain. Updated automaticall
 
 | Name | Type | Description |
 | --- | --- | --- |
-| `configuration` | Map | The configuration for the WebLogic Monitoring Exporter sidecar. If specified, the operator will deploy a sidecar alongside each server instance. See https://github.com/oracle/weblogic-monitoring-exporter |
-| `image` | string | The WebLogic Monitoring Exporter sidecar image name. Defaults to ghcr.io/oracle/weblogic-monitoring-exporter:2.0.2 |
-| `imagePullPolicy` | string | The image pull policy for the WebLogic Monitoring Exporter sidecar image. Legal values are Always, Never, and IfNotPresent. Defaults to Always if image ends in :latest; IfNotPresent, otherwise. |
+| `configuration` | Map | The configuration for the WebLogic Monitoring Exporter. If WebLogic Server instances are already running and have the monitoring exporter sidecar container, then changes to this field will be propagated to the exporter without requiring the restart of the WebLogic Server instances. |
+| `image` | string | The WebLogic Monitoring Exporter sidecar container image name. Defaults to ghcr.io/oracle/weblogic-monitoring-exporter:2.0.2 |
+| `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. |
 
 ### Server Pod
 
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: 8baaf8061fb45bcf1035ef0c7c40ccd056229d662921ad3ba5f6258f2de04720
+    weblogic.sha256: 2c458de3536da4e8a31d375fc7375c55387080a19f260f687dd687ec4f61d67b
   name: domains.weblogic.oracle
 spec:
   group: weblogic.oracle
@@ -27,27 +27,36 @@ spec:
               Required.
             properties:
               monitoringExporter:
-                description: Configuration for the use of the WebLogic Monitoring
-                  Exporter as part of this domain.
+                description: Automatic deployment and configuration of the WebLogic
+                  Monitoring Exporter. If specified, the operator will deploy a sidecar
+                  container alongside each WebLogic Server instance that runs the
+                  exporter. WebLogic Server instances that are already running when
+                  the `monitoringExporter` field is created or deleted, will not be
+                  affected until they are restarted. When any given server is restarted
+                  for another reason, such as a change to the `restartVersion`, then
+                  the newly created pod will have the exporter sidecar or not, as
+                  appropriate. See https://github.com/oracle/weblogic-monitoring-exporter.
                 properties:
                   image:
-                    description: The WebLogic Monitoring Exporter sidecar image name.
-                      Defaults to ghcr.io/oracle/weblogic-monitoring-exporter:2.0.2
+                    description: The WebLogic Monitoring Exporter sidecar container
+                      image name. Defaults to ghcr.io/oracle/weblogic-monitoring-exporter:2.0.2
                     type: string
                   imagePullPolicy:
                     description: The image pull policy for the WebLogic Monitoring
-                      Exporter sidecar image. Legal values are Always, Never, and
-                      IfNotPresent. Defaults to Always if image ends in :latest; IfNotPresent,
-                      otherwise.
+                      Exporter sidecar container image. Legal values are Always, Never,
+                      and IfNotPresent. Defaults to Always if image ends in :latest;
+                      IfNotPresent, otherwise.
                     enum:
                     - Always
                     - Never
                     - IfNotPresent
                     type: string
                   configuration:
-                    description: The configuration for the WebLogic Monitoring Exporter
-                      sidecar. If specified, the operator will deploy a sidecar alongside
-                      each server instance. See https://github.com/oracle/weblogic-monitoring-exporter
+                    description: The configuration for the WebLogic Monitoring Exporter.
+                      If WebLogic Server instances are already running and have the
+                      monitoring exporter sidecar container, then changes to this
+                      field will be propagated to the exporter without requiring the
+                      restart of the WebLogic Server instances.
                     type: object
                     x-kubernetes-preserve-unknown-fields: true
                 type: object
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
@@ -305,7 +305,12 @@ public class DomainSpec extends BaseConfiguration {
    *
    * @since 3.2
    */
-  @Description("Configuration for the use of the WebLogic Monitoring Exporter as part of this domain.")
+  @Description("Automatic deployment and configuration of the WebLogic Monitoring Exporter. If specified, the operator "
+      + "will deploy a sidecar container alongside each WebLogic Server instance that runs the exporter. "
+      + "WebLogic Server instances that are already running when the `monitoringExporter` field is created or deleted, "
+      + "will not be affected until they are restarted. When any given server "
+      + "is restarted for another reason, such as a change to the `restartVersion`, then the newly created pod will "
+      + "have the exporter sidecar or not, as appropriate. See https://github.com/oracle/weblogic-monitoring-exporter.")
   private MonitoringExporterSpecification monitoringExporter;
 
   MonitoringExporterConfiguration getMonitoringExporterConfiguration() {
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
@@ -28,21 +28,22 @@
 public class MonitoringExporterSpecification {
 
   public static final String EXPORTER_PORT_NAME = "exporter";
-  @Description("The configuration for the WebLogic Monitoring Exporter sidecar. If specified, the operator will "
-        + "deploy a sidecar alongside each server instance. See https://github.com/oracle/weblogic-monitoring-exporter")
+  @Description("The configuration for the WebLogic Monitoring Exporter. If WebLogic Server instances "
+      + "are already running and have the monitoring exporter sidecar container, then changes to this field will "
+      + "be propagated to the exporter without requiring the restart of the WebLogic Server instances.")
   @PreserveUnknown
   private Map<String,Object> configuration;
 
   /**
    * The Monitoring Exporter sidecar image.
    */
   @Description(
-        "The WebLogic Monitoring Exporter sidecar image name. Defaults to "
+        "The WebLogic Monitoring Exporter sidecar container image name. Defaults to "
            + DEFAULT_EXPORTER_IMAGE)
   private String image;
   
   @Description(
-      "The image pull policy for the WebLogic Monitoring Exporter sidecar image. "
+      "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.")
   @EnumClass(ImagePullPolicy.class)
