Merge pull request #1142 from oracle/introspect-status

Improve domain status to include all servers in the domain and to give status of clusters

Author: rjeberhard

docs/domains/Domain.json

@@ -13,17 +13,17 @@
 import java.util.Map;
 import java.util.logging.Level;
 
-import org.junit.AfterClass;
-import org.junit.BeforeClass;
-import org.junit.FixMethodOrder;
-import org.junit.Test;
-import org.junit.Assume;
-import org.junit.runners.MethodSorters;
 import oracle.kubernetes.operator.utils.Domain;
 import oracle.kubernetes.operator.utils.DomainCrd;
 import oracle.kubernetes.operator.utils.ExecResult;
 import oracle.kubernetes.operator.utils.Operator;
 import oracle.kubernetes.operator.utils.TestUtils;
+import org.junit.AfterClass;
+import org.junit.Assume;
+import org.junit.BeforeClass;
+import org.junit.FixMethodOrder;
+import org.junit.Test;
+import org.junit.runners.MethodSorters;
 
 /**
  * Simple JUnit test file used for testing domain pod templates.

docs/domains/Domain.md

@@ -13,11 +13,11 @@
 import org.apache.commons.lang3.builder.HashCodeBuilder;
 import org.apache.commons.lang3.builder.ToStringBuilder;
 
-@Description("AdminServer represents the operator configuration for the admin server.")
+@Description("AdminServer represents the operator configuration for the Administration Server.")
 public class AdminServer extends Server {
 
   @Description(
-      "Configures which of the admin server's WebLogic admin channels should be exposed outside"
+      "Configures which of the Administration Server's WebLogic admin channels should be exposed outside"
           + " the Kubernetes cluster via a node port service.")
   private AdminService adminService;
 

docs/domains/index.html

@@ -20,16 +20,16 @@
 public class AdminService implements ServiceConfigurator {
   @SerializedName("channels")
   @Description(
-      "Specifies which of the admin server's WebLogic channels should be exposed outside "
+      "Specifies which of the Administration Server's WebLogic channels should be exposed outside "
           + "the Kubernetes cluster via a node port service, along with the node port for "
-          + "each channel. If not specified, the admin server's node port service will "
+          + "each channel. If not specified, the Administration Server's node port service will "
           + "not be created.")
   private List<Channel> channels = new ArrayList<>();
 
-  @Description("Labels to associate with the external channel service")
+  @Description("Labels to associate with the external channel service.")
   private Map<String, String> labels = new HashMap<>();
 
-  @Description("Annotations to associate with the external channel service")
+  @Description("Annotations to associate with the external channel service.")
   private Map<String, String> annotations = new HashMap<>();
 
   /**

integration-tests/src/test/java/oracle/kubernetes/operator/ItPodTemplates.java

@@ -33,11 +33,11 @@
  */
 public abstract class BaseConfiguration {
 
-  @Description("Configuration affecting server pods")
+  @Description("Configuration affecting server pods.")
   private ServerPod serverPod = new ServerPod();
 
   @Description(
-      "Customization affecting ClusterIP Kubernetes services for WebLogic server instances.")
+      "Customization affecting ClusterIP Kubernetes services for WebLogic Server instances.")
   @SerializedName("serverService")
   @Expose
   private ServerService serverService = new ServerService();

model/src/main/java/oracle/kubernetes/weblogic/domain/model/AdminServer.java

@@ -12,17 +12,17 @@
 import org.apache.commons.lang3.builder.HashCodeBuilder;
 import org.apache.commons.lang3.builder.ToStringBuilder;
 
-@Description("Describes a single channel used by the admin server.")
+@Description("Describes a single channel used by the Administration Server.")
 public class Channel implements Comparable<Channel> {
   @SerializedName("channelName")
   @Description(
-      "Name of channel.\n'default' refers to the admin server's default channel (configured "
+      "Name of channel.\n'default' refers to the Administration Server's default channel (configured "
           + "via the ServerMBean's ListenPort) "
-          + "\n'default-secure' refers to the admin server's default secure channel "
+          + "\n'default-secure' refers to the Administration Server's default secure channel "
           + "(configured via the ServerMBean's SSLMBean's ListenPort) "
-          + "\n'default-admin' refers to the admin server's default administrative channel "
+          + "\n'default-admin' refers to the Administration Server's default administrative channel "
           + "(configured via the DomainMBean's AdministrationPort) "
-          + "\nOtherwise, the name is the name of one of the admin server's network access points "
+          + "\nOtherwise, the name is the name of one of the Administration Server's network access points "
           + "(configured via the ServerMBean's NetworkAccessMBeans).")
   @Nonnull
   private String channelName;

model/src/main/java/oracle/kubernetes/weblogic/domain/model/AdminService.java

@@ -31,7 +31,7 @@ public class Cluster extends BaseConfiguration implements Comparable<Cluster> {
   private String clusterName;
 
   /** The number of replicas to run in the cluster, if specified. */
-  @Description("The number of managed servers to run in this cluster.")
+  @Description("The number of cluster members to run.")
   @Range(minimum = 0)
   private Integer replicas;
 
@@ -53,7 +53,7 @@ public class Cluster extends BaseConfiguration implements Comparable<Cluster> {
   @Range(minimum = 1)
   private Integer maxUnavailable;
 
-  @Description("Customization affecting ClusterIP Kubernetes services for WebLogic cluster.")
+  @Description("Customization affecting ClusterIP Kubernetes services for the WebLogic cluster.")
   @SerializedName("clusterService")
   @Expose
   private KubernetesResource clusterService = new KubernetesResource();

model/src/main/java/oracle/kubernetes/weblogic/domain/model/BaseConfiguration.java

@@ -0,0 +1,147 @@
+// Copyright 2019, Oracle Corporation and/or its affiliates.  All rights reserved.
+// Licensed under the Universal Permissive License v 1.0 as shown at
+// http://oss.oracle.com/licenses/upl.
+
+package oracle.kubernetes.weblogic.domain.model;
+
+import com.google.gson.annotations.Expose;
+import com.google.gson.annotations.SerializedName;
+import oracle.kubernetes.json.Description;
+import oracle.kubernetes.json.Range;
+import org.apache.commons.lang3.builder.EqualsBuilder;
+import org.apache.commons.lang3.builder.HashCodeBuilder;
+import org.apache.commons.lang3.builder.ToStringBuilder;
+
+/** ServerStatus describes the current status of a specific WebLogic Server. */
+public class ClusterStatus implements Comparable<ClusterStatus> {
+
+  @Description("WebLogic cluster name. Required.")
+  @SerializedName("clusterName")
+  @Expose
+  private String clusterName;
+
+  /** The number of intended cluster members. Required. */
+  @Description("The number of intended cluster members. Required.")
+  @Range(minimum = 0)
+  private Integer replicas;
+
+  /** The number of ready cluster members. Required. */
+  @Description("The number of ready cluster members. Required.")
+  @Range(minimum = 0)
+  private Integer readyReplicas;
+
+  /** The maximum number of cluster members. Required. */
+  @Description("The maximum number of cluster members. Required.")
+  @Range(minimum = 0)
+  private Integer maximumReplicas;
+
+  /**
+   * WebLogic cluster name. Required.
+   *
+   * @return cluster name
+   */
+  public String getClusterName() {
+    return clusterName;
+  }
+
+  /**
+   * WebLogic cluster name. Required.
+   *
+   * @param clusterName cluster name
+   */
+  public void setClusterName(String clusterName) {
+    this.clusterName = clusterName;
+  }
+
+  /**
+   * WebLogic cluster name. Required.
+   *
+   * @param clusterName cluster name
+   * @return this
+   */
+  public ClusterStatus withClusterName(String clusterName) {
+    this.clusterName = clusterName;
+    return this;
+  }
+
+  public Integer getReplicas() {
+    return replicas;
+  }
+
+  public void setReplicas(Integer replicas) {
+    this.replicas = replicas;
+  }
+
+  public ClusterStatus withReplicas(Integer replicas) {
+    this.replicas = replicas;
+    return this;
+  }
+
+  public Integer getReadyReplicas() {
+    return readyReplicas;
+  }
+
+  public void setReadyReplicas(Integer readyReplicas) {
+    this.readyReplicas = readyReplicas;
+  }
+
+  public ClusterStatus withReadyReplicas(Integer readyReplicas) {
+    this.readyReplicas = readyReplicas;
+    return this;
+  }
+
+  public Integer getMaximumReplicas() {
+    return maximumReplicas;
+  }
+
+  public void setMaximumReplicas(Integer maximumReplicas) {
+    this.maximumReplicas = maximumReplicas;
+  }
+
+  public ClusterStatus withMaximumReplicas(Integer maximumReplicas) {
+    this.maximumReplicas = maximumReplicas;
+    return this;
+  }
+
+  @Override
+  public String toString() {
+    return new ToStringBuilder(this)
+        .append("clusterName", clusterName)
+        .append("replicas", replicas)
+        .append("readyReplicas", readyReplicas)
+        .append("maximumReplicas", maximumReplicas)
+        .toString();
+  }
+
+  @Override
+  public int hashCode() {
+    return new HashCodeBuilder()
+        .append(clusterName)
+        .append(replicas)
+        .append(readyReplicas)
+        .append(maximumReplicas)
+        .toHashCode();
+  }
+
+  @Override
+  public boolean equals(Object other) {
+    if (other == this) {
+      return true;
+    }
+    if (!(other instanceof ClusterStatus)) {
+      return false;
+    }
+    ClusterStatus rhs = ((ClusterStatus) other);
+    return new EqualsBuilder()
+        .append(clusterName, rhs.clusterName)
+        .append(replicas, rhs.replicas)
+        .append(readyReplicas, rhs.readyReplicas)
+        .append(maximumReplicas, rhs.maximumReplicas)
+        .isEquals();
+  }
+
+  @Override
+  public int compareTo(ClusterStatus o) {
+    return clusterName.compareTo(o.clusterName);
+  }
+}