Add domain.spec.maxClusterUnavailable (#3649)

doxiao · web-flow · commit a6c5cc1b6747 · 2022-11-10T15:02:04.000-05:00
* Add domain.spec.maxClusterUnavailable
diff --git a/documentation/domains/Cluster.json b/documentation/domains/Cluster.json
@@ -157,7 +157,7 @@
           "$ref": "#/definitions/ServerService"
         },
         "maxUnavailable": {
-          "description": "The maximum number of cluster members that can be temporarily unavailable. Defaults to 1.",
+          "description": "The maximum number of cluster members that can be temporarily unavailable. Defaults to `domain.spec.maxClusterUnavailable`, which defaults to 1.",
           "type": "integer",
           "minimum": 1
         },
@@ -387,6 +387,12 @@
           "description": "The directory containing the WebLogic domain configuration inside the container. Defaults to /shared/domains/\u003cdomainUID\u003e if `domainHomeSourceType` is PersistentVolume. Defaults to /u01/oracle/user_projects/domains/ if `domainHomeSourceType` is Image. Defaults to /u01/domains/\u003cdomainUID\u003e if `domainHomeSourceType` is FromModel.",
           "type": "string"
         },
+        "maxClusterUnavailable": {
+          "default": 1,
+          "description": "The maximum number of cluster members that can be temporarily unavailable. You can override this default on a per cluster basis by setting the cluster\u0027s `maxUnavailable` field. Defaults to 1.",
+          "type": "integer",
+          "minimum": 1
+        },
         "logHomeLayout": {
           "default": "ByServers",
           "description": "Control how log files under `logHome` are organized when logHome is set and `logHomeEnabled` is true. `Flat` specifies that all files are kept directly in the `logHome` root directory. `ByServers` specifies that domain log files and `introspector.out` are at the `logHome` root level, all other files are organized under the respective server name logs directory  `logHome/servers/\u003cserver name\u003e/logs`. Defaults to `ByServers`.",
diff --git a/documentation/domains/Cluster.md b/documentation/domains/Cluster.md
@@ -20,7 +20,7 @@ The specification of the operation of the WebLogic cluster. Required.
 | `clusterService` | [Cluster Service](#cluster-service) | Customization affecting Kubernetes Service generated for this WebLogic cluster. |
 | `maxConcurrentShutdown` | integer | The maximum number of WebLogic Server instances that will shut down in parallel for this cluster when it is being partially shut down by lowering its replica count. A value of 0 means there is no limit. Defaults to `spec.maxClusterConcurrentShutdown`, which defaults to 1. |
 | `maxConcurrentStartup` | integer | The maximum number of Managed Servers instances that the operator will start in parallel for this cluster in response to a change in the `replicas` count. If more Managed Server instances must be started, the operator will wait until a Managed Server Pod is in the `Ready` state before starting the next Managed Server instance. A value of 0 means all Managed Server instances will start in parallel. Defaults to `domain.spec.maxClusterConcurrentStartup`, which defaults to 0. |
-| `maxUnavailable` | integer | The maximum number of cluster members that can be temporarily unavailable. Defaults to 1. |
+| `maxUnavailable` | integer | The maximum number of cluster members that can be temporarily unavailable. Defaults to `domain.spec.maxClusterUnavailable`, which defaults to 1. |
 | `replicas` | integer | The number of cluster member Managed Server instances to start for this WebLogic 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 Server instances 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 Server instances 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 related entries under `managedServers`, then this cluster may have more cluster members running than its `replicas` count. Defaults to `domain.spec.replicas`, which defaults 1. |
 | `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. |
diff --git a/documentation/domains/Domain.json b/documentation/domains/Domain.json
@@ -306,6 +306,12 @@
           "description": "The directory containing the WebLogic domain configuration inside the container. Defaults to /shared/domains/\u003cdomainUID\u003e if `domainHomeSourceType` is PersistentVolume. Defaults to /u01/oracle/user_projects/domains/ if `domainHomeSourceType` is Image. Defaults to /u01/domains/\u003cdomainUID\u003e if `domainHomeSourceType` is FromModel.",
           "type": "string"
         },
+        "maxClusterUnavailable": {
+          "default": 1,
+          "description": "The maximum number of cluster members that can be temporarily unavailable. You can override this default on a per cluster basis by setting the cluster\u0027s `maxUnavailable` field. Defaults to 1.",
+          "type": "integer",
+          "minimum": 1
+        },
         "logHomeLayout": {
           "default": "ByServers",
           "description": "Control how log files under `logHome` are organized when logHome is set and `logHomeEnabled` is true. `Flat` specifies that all files are kept directly in the `logHome` root directory. `ByServers` specifies that domain log files and `introspector.out` are at the `logHome` root level, all other files are organized under the respective server name logs directory  `logHome/servers/\u003cserver name\u003e/logs`. Defaults to `ByServers`.",
diff --git a/documentation/domains/Domain.md b/documentation/domains/Domain.md
@@ -39,6 +39,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` | integer | 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` | integer | 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. |
+| `maxClusterUnavailable` | integer | The maximum number of cluster members that can be temporarily unavailable. You can override this default on a per cluster basis by setting the cluster's `maxUnavailable` field. Defaults to 1. |
 | `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` | integer | 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 1. |
 | `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. |
diff --git a/documentation/domains/index.html b/documentation/domains/index.html
@@ -1222,6 +1222,12 @@
           "description": "The directory containing the WebLogic domain configuration inside the container. Defaults to /shared/domains/\u003cdomainUID\u003e if `domainHomeSourceType` is PersistentVolume. Defaults to /u01/oracle/user_projects/domains/ if `domainHomeSourceType` is Image. Defaults to /u01/domains/\u003cdomainUID\u003e if `domainHomeSourceType` is FromModel.",
           "type": "string"
         },
+        "maxClusterUnavailable": {
+          "default": 1.0,
+          "description": "The maximum number of cluster members that can be temporarily unavailable. You can override this default on a per cluster basis by setting the cluster\u0027s `maxUnavailable` field. Defaults to 1.",
+          "type": "integer",
+          "minimum": 1.0
+        },
         "logHomeLayout": {
           "default": "ByServers",
           "description": "Control how log files under `logHome` are organized when logHome is set and `logHomeEnabled` is true. `Flat` specifies that all files are kept directly in the `logHome` root directory. `ByServers` specifies that domain log files and `introspector.out` are at the `logHome` root level, all other files are organized under the respective server name logs directory  `logHome/servers/\u003cserver name\u003e/logs`. Defaults to `ByServers`.",
diff --git a/kubernetes/crd/cluster-crd.yaml b/kubernetes/crd/cluster-crd.yaml
@@ -5,7 +5,7 @@ apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
   annotations:
-    weblogic.sha256: 53299f8b85e950b6c69b5fabd130221c735761f914d2b7fa46882cdee8da6715
+    weblogic.sha256: 6b6e7832ef6cdeef81d2c704a38636f9d1eb3b9c5fa76be64391d1939943003b
   name: clusters.weblogic.oracle
 spec:
   group: weblogic.oracle
@@ -57,7 +57,8 @@ spec:
                 type: object
               maxUnavailable:
                 description: The maximum number of cluster members that can be temporarily
-                  unavailable. Defaults to 1.
+                  unavailable. Defaults to `domain.spec.maxClusterUnavailable`, which
+                  defaults to 1.
                 minimum: 1
                 type: integer
               replicas:
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: 57dd4476255aa691791bccf16629c0cc5a5aceb1da44c5fefac307ac3428734b
+    weblogic.sha256: 3a81ece5d88c85957a5d5e4a1b6c068cdca4355afd80a5a6598cbfade313871f
   name: domains.weblogic.oracle
 spec:
   group: weblogic.oracle
@@ -502,6 +502,13 @@ spec:
                   if `domainHomeSourceType` is Image. Defaults to /u01/domains/<domainUID>
                   if `domainHomeSourceType` is FromModel.
                 type: string
+              maxClusterUnavailable:
+                default: 1
+                description: The maximum number of cluster members that can be temporarily
+                  unavailable. You can override this default on a per cluster basis
+                  by setting the cluster's `maxUnavailable` field. Defaults to 1.
+                minimum: 1
+                type: integer
               logHomeLayout:
                 default: ByServers
                 description: Control how log files under `logHome` are organized when
diff --git a/operator/src/main/java/oracle/kubernetes/operator/KubernetesConstants.java b/operator/src/main/java/oracle/kubernetes/operator/KubernetesConstants.java
@@ -37,6 +37,7 @@ public interface KubernetesConstants {
   boolean DEFAULT_INCLUDE_SERVER_OUT_IN_POD_LOG = true;
   int DEFAULT_MAX_CLUSTER_CONCURRENT_START_UP = 0;
   int DEFAULT_MAX_CLUSTER_CONCURRENT_SHUTDOWN = 1;
+  int DEFAULT_MAX_CLUSTER_UNAVAILABLE = 1;
   int MINIMUM_CLUSTER_COUNT = 0;
 
   String WLS_CONTAINER_NAME = "weblogic-server";
diff --git a/operator/src/main/java/oracle/kubernetes/weblogic/domain/model/ClusterSpec.java b/operator/src/main/java/oracle/kubernetes/weblogic/domain/model/ClusterSpec.java
@@ -61,8 +61,8 @@ public class ClusterSpec extends BaseConfiguration implements Comparable<Cluster
       + "domain-lifecycle/startup/#starting-and-stopping-servers.")
   private ServerStartPolicy serverStartPolicy;
 
-  @Description(
-      "The maximum number of cluster members that can be temporarily unavailable. Defaults to 1.")
+  @Description("The maximum number of cluster members that can be temporarily unavailable. "
+      + "Defaults to `domain.spec.maxClusterUnavailable`, which defaults to 1.")
   @Range(minimum = 1)
   private Integer maxUnavailable;
 
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
@@ -40,6 +40,7 @@
 import static oracle.kubernetes.operator.KubernetesConstants.DEFAULT_IMAGE;
 import static oracle.kubernetes.operator.KubernetesConstants.DEFAULT_MAX_CLUSTER_CONCURRENT_SHUTDOWN;
 import static oracle.kubernetes.operator.KubernetesConstants.DEFAULT_MAX_CLUSTER_CONCURRENT_START_UP;
+import static oracle.kubernetes.operator.KubernetesConstants.DEFAULT_MAX_CLUSTER_UNAVAILABLE;
 import static oracle.kubernetes.weblogic.domain.model.Model.DEFAULT_WDT_INSTALL_HOME;
 import static oracle.kubernetes.weblogic.domain.model.Model.DEFAULT_WDT_MODEL_HOME;
 
@@ -258,6 +259,14 @@ public class DomainSpec extends BaseConfiguration {
   @Default(intDefault = 1)
   private Integer maxClusterConcurrentShutdown;
 
+  @Description(
+      "The maximum number of cluster members that can be temporarily unavailable. You can override this default "
+      + "on a per cluster basis by setting the cluster's `maxUnavailable` field. Defaults to 1."
+  )
+  @Range(minimum = 1)
+  @Default(intDefault = 1)
+  private Integer maxClusterUnavailable;
+
   @Description("The wait time in seconds before the start of the next retry after a Severe failure. Defaults to 120.")
   @Range(minimum = 0)
   @Default(intDefault = 120)
@@ -799,6 +808,11 @@ public Integer getMaxClusterConcurrentShutdown() {
         .orElse(DEFAULT_MAX_CLUSTER_CONCURRENT_SHUTDOWN);
   }
 
+  public Integer getMaxClusterUnavailable() {
+    return Optional.ofNullable(maxClusterUnavailable)
+        .orElse(DEFAULT_MAX_CLUSTER_UNAVAILABLE);
+  }
+
   @Nullable
   String getConfigOverrides() {
     return Optional.ofNullable(configuration).map(Configuration::getOverridesConfigMap).orElse(null);
@@ -970,8 +984,9 @@ public String toString() {
             .append("logHomeLayout", logHomeLayout)
             .append("logHomeEnabled", logHomeEnabled)
             .append("managedServers", managedServers)
-            .append("maxClusterConcurrentShutdown",maxClusterConcurrentShutdown)
-            .append("maxClusterConcurrentStartup",maxClusterConcurrentStartup)
+            .append("maxClusterConcurrentShutdown", maxClusterConcurrentShutdown)
+            .append("maxClusterConcurrentStartup", maxClusterConcurrentStartup)
+            .append("maxClusterUnavailable", maxClusterUnavailable)
             .append("monitoringExporter", monitoringExporter)
             .append("replicas", replicas)
             .append("serverStartPolicy", serverStartPolicy)
@@ -1003,6 +1018,7 @@ public int hashCode() {
             .append(managedServers)
             .append(maxClusterConcurrentShutdown)
             .append(maxClusterConcurrentStartup)
+            .append(maxClusterUnavailable)
             .append(monitoringExporter)
             .append(replicas)
             .append(serverStartPolicy)
@@ -1046,6 +1062,7 @@ public boolean equals(Object other) {
             .append(includeServerOutInPodLog, rhs.includeServerOutInPodLog)
             .append(getMaxClusterConcurrentStartup(), rhs.getMaxClusterConcurrentStartup())
             .append(getMaxClusterConcurrentShutdown(), rhs.getMaxClusterConcurrentShutdown())
+            .append(getMaxClusterUnavailable(), rhs.getMaxClusterUnavailable())
             .append(fluentdSpecification, rhs.getFluentdSpecification());
     return builder.isEquals();
   }
@@ -1074,6 +1091,10 @@ public void setMaxClusterConcurrentShutdown(Integer maxClusterConcurrentShutdown
     this.maxClusterConcurrentShutdown = maxClusterConcurrentShutdown;
   }
 
+  public void setMaxClusterUnavailable(Integer maxClusterUnavailable) {
+    this.maxClusterUnavailable = maxClusterUnavailable;
+  }
+
   public AdminServer getAdminServer() {
     return adminServer;
   }
@@ -1142,7 +1163,7 @@ private int getMaxConcurrentStartupFor(ClusterSpec clusterSpec) {
     }
 
     private int getMaxUnavailableFor(ClusterSpec clusterSpec) {
-      return hasMaxUnavailable(clusterSpec) ? clusterSpec.getMaxUnavailable() : 1;
+      return hasMaxUnavailable(clusterSpec) ? clusterSpec.getMaxUnavailable() : getMaxClusterUnavailable();
     }
 
     private int getReplicaCountFor(ClusterSpec clusterSpec) {
diff --git a/operator/src/test/java/oracle/kubernetes/weblogic/domain/DomainConfigurator.java b/operator/src/test/java/oracle/kubernetes/weblogic/domain/DomainConfigurator.java
@@ -243,6 +243,11 @@ public DomainConfigurator withMaxConcurrentShutdown(Integer maxConcurrentShutdow
     return this;
   }
 
+  public DomainConfigurator withMaxUnavailable(Integer maxUnavailable) {
+    getDomainSpec().setMaxClusterUnavailable(maxUnavailable);
+    return this;
+  }
+
   public DomainConfigurator withClusterReference(String clusterResourceName) {
     getDomainSpec().getClusters().add(new V1LocalObjectReference().name(clusterResourceName));
     return this;
diff --git a/operator/src/test/java/oracle/kubernetes/weblogic/domain/model/DomainResourceBasicTest.java b/operator/src/test/java/oracle/kubernetes/weblogic/domain/model/DomainResourceBasicTest.java
