Add option to precreate server services

Author: rjeberhard

docs/domains/Domain.json

@@ -17,7 +17,7 @@
         },
         "serverService": {
           "description": "Customization affecting ClusterIP Kubernetes services for WebLogic server instances.",
-          "$ref": "#/definitions/KubernetesResource"
+          "$ref": "#/definitions/ServerService"
         },
         "serverPod": {
           "description": "Configuration affecting server pods",
@@ -93,7 +93,7 @@
         },
         "serverService": {
           "description": "Customization affecting ClusterIP Kubernetes services for WebLogic server instances.",
-          "$ref": "#/definitions/KubernetesResource"
+          "$ref": "#/definitions/ServerService"
         },
         "maxUnavailable": {
           "description": "The maximum number of cluster members that can be temporarily unavailable. Defaults to 1.",
@@ -244,7 +244,7 @@
         },
         "serverService": {
           "description": "Customization affecting ClusterIP Kubernetes services for WebLogic server instances.",
-          "$ref": "#/definitions/KubernetesResource"
+          "$ref": "#/definitions/ServerService"
         },
         "domainHome": {
           "description": "The folder for the WebLogic Domain. Not required. Defaults to /shared/domains/domains/domainUID if domainHomeInImage is false Defaults to /u01/oracle/user_projects/domains/ if domainHomeInImage is true",
@@ -354,7 +354,7 @@
         },
         "serverService": {
           "description": "Customization affecting ClusterIP Kubernetes services for WebLogic server instances.",
-          "$ref": "#/definitions/KubernetesResource"
+          "$ref": "#/definitions/ServerService"
         },
         "serverName": {
           "description": "The name of the server. Required",
@@ -500,6 +500,23 @@
         }
       }
     },
+    "ServerService": {
+      "type": "object",
+      "properties": {
+        "precreateService": {
+          "description": "If true, operator will create server services even for server instances without running pods.",
+          "type": "boolean"
+        },
+        "annotations": {
+          "description": "The annotations to be attached to generated resources.",
+          "$ref": "#/definitions/Map"
+        },
+        "labels": {
+          "description": "The labels to be attached to generated resources. The label names must not start with \u0027weblogic.\u0027.",
+          "$ref": "#/definitions/Map"
+        }
+      }
+    },
     "ServerStatus": {
       "type": "object",
       "properties": {

docs/domains/Domain.md

@@ -33,7 +33,7 @@ DomainSpec is a description of a domain.
 | `replicas` | number | The number of managed servers to run in any cluster that does not specify a replica count. |
 | `restartVersion` | string | If present, every time this value is updated the operator will restart the required servers. |
 | `serverPod` | [Server Pod](#server-pod) | Configuration affecting server pods |
-| `serverService` | [Kubernetes Resource](#kubernetes-resource) | Customization affecting ClusterIP Kubernetes services for WebLogic server instances. |
+| `serverService` | [Server Service](#server-service) | Customization affecting ClusterIP Kubernetes services for WebLogic server instances. |
 | `serverStartPolicy` | string | The strategy for deciding whether to start a server. Legal values are ADMIN_ONLY, NEVER, or IF_NEEDED. |
 | `serverStartState` | string | The state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING. |
 | `webLogicCredentialsSecret` | [Secret Reference](k8s1.13.5.md#secret-reference) | The name of a pre-created Kubernetes secret, in the domain's namepace, that holds the username and password needed to boot WebLogic Server under the 'username' and 'password' fields. |
@@ -60,7 +60,7 @@ AdminServer represents the operator configuration for the admin server.
 | `adminService` | [Admin Service](#admin-service) | Configures which of the admin server's WebLogic admin channels should be exposed outside the Kubernetes cluster via a node port service. |
 | `restartVersion` | string | If present, every time this value is updated the operator will restart the required servers. |
 | `serverPod` | [Server Pod](#server-pod) | Configuration affecting server pods |
-| `serverService` | [Kubernetes Resource](#kubernetes-resource) | Customization affecting ClusterIP Kubernetes services for WebLogic server instances. |
+| `serverService` | [Server Service](#server-service) | Customization affecting ClusterIP Kubernetes services for WebLogic server instances. |
 | `serverStartPolicy` | string | The strategy for deciding whether to start a server. Legal values are ALWAYS, NEVER, or IF_NEEDED. |
 | `serverStartState` | string | The state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING. |
 
@@ -76,7 +76,7 @@ An element representing a cluster in the domain configuration.
 | `replicas` | number | The number of managed servers to run in this cluster. |
 | `restartVersion` | string | If present, every time this value is updated the operator will restart the required servers. |
 | `serverPod` | [Server Pod](#server-pod) | Configuration affecting server pods |
-| `serverService` | [Kubernetes Resource](#kubernetes-resource) | Customization affecting ClusterIP Kubernetes services for WebLogic server instances. |
+| `serverService` | [Server Service](#server-service) | Customization affecting ClusterIP Kubernetes services for WebLogic server instances. |
 | `serverStartPolicy` | string | The strategy for deciding whether to start a server. Legal values are NEVER, or IF_NEEDED. |
 | `serverStartState` | string | The state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING. |
 
@@ -89,7 +89,7 @@ ManagedServer represents the operator configuration for a single managed server.
 | `restartVersion` | string | If present, every time this value is updated the operator will restart the required servers. |
 | `serverName` | string | The name of the server. Required |
 | `serverPod` | [Server Pod](#server-pod) | Configuration affecting server pods |
-| `serverService` | [Kubernetes Resource](#kubernetes-resource) | Customization affecting ClusterIP Kubernetes services for WebLogic server instances. |
+| `serverService` | [Server Service](#server-service) | Customization affecting ClusterIP Kubernetes services for WebLogic server instances. |
 | `serverStartPolicy` | string | The strategy for deciding whether to start a server. Legal values are ALWAYS, NEVER, or IF_NEEDED. |
 | `serverStartState` | string | The state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING. |
 
@@ -114,12 +114,13 @@ ServerPod describes the configuration for a Kubernetes pod for a server.
 | `volumeMounts` | array of [Volume Mount](k8s1.13.5.md#volume-mount) | Additional volume mounts for the server pod. |
 | `volumes` | array of [Volume](k8s1.13.5.md#volume) | Additional volumes to be created in the server pod. |
 
-### Kubernetes Resource
+### Server Service
 
 | Name | Type | Description |
 | --- | --- | --- |
 | `annotations` | Map | The annotations to be attached to generated resources. |
 | `labels` | Map | The labels to be attached to generated resources. The label names must not start with 'weblogic.'. |
+| `precreateService` | Boolean | If true, operator will create server services even for server instances without running pods. |
 
 ### Domain Condition
 
@@ -150,6 +151,13 @@ ServerPod describes the configuration for a Kubernetes pod for a server.
 | `channels` | array of [Channel](#channel) | Specifies which of the admin 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 not be created. |
 | `labels` | Map | Labels to associate with the external channel service |
 
+### Kubernetes Resource
+
+| Name | Type | Description |
+| --- | --- | --- |
+| `annotations` | Map | The annotations to be attached to generated resources. |
+| `labels` | Map | The labels to be attached to generated resources. The label names must not start with 'weblogic.'. |
+
 ### Probe Tuning
 
 | Name | Type | Description |

docs/domains/index.html

@@ -937,7 +937,7 @@
         },
         "serverService": {
           "description": "Customization affecting ClusterIP Kubernetes services for WebLogic server instances.",
-          "$ref": "#/definitions/KubernetesResource"
+          "$ref": "#/definitions/ServerService"
         },
         "serverPod": {
           "description": "Configuration affecting server pods",
@@ -1013,7 +1013,7 @@
         },
         "serverService": {
           "description": "Customization affecting ClusterIP Kubernetes services for WebLogic server instances.",
-          "$ref": "#/definitions/KubernetesResource"
+          "$ref": "#/definitions/ServerService"
         },
         "maxUnavailable": {
           "description": "The maximum number of cluster members that can be temporarily unavailable. Defaults to 1.",
@@ -1164,7 +1164,7 @@
         },
         "serverService": {
           "description": "Customization affecting ClusterIP Kubernetes services for WebLogic server instances.",
-          "$ref": "#/definitions/KubernetesResource"
+          "$ref": "#/definitions/ServerService"
         },
         "domainHome": {
           "description": "The folder for the WebLogic Domain. Not required. Defaults to /shared/domains/domains/domainUID if domainHomeInImage is false Defaults to /u01/oracle/user_projects/domains/ if domainHomeInImage is true",
@@ -1274,7 +1274,7 @@
         },
         "serverService": {
           "description": "Customization affecting ClusterIP Kubernetes services for WebLogic server instances.",
-          "$ref": "#/definitions/KubernetesResource"
+          "$ref": "#/definitions/ServerService"
         },
         "serverName": {
           "description": "The name of the server. Required",
@@ -1420,6 +1420,23 @@
         }
       }
     },
+    "ServerService": {
+      "type": "object",
+      "properties": {
+        "precreateService": {
+          "description": "If true, operator will create server services even for server instances without running pods.",
+          "type": "boolean"
+        },
+        "annotations": {
+          "description": "The annotations to be attached to generated resources.",
+          "$ref": "#/definitions/Map"
+        },
+        "labels": {
+          "description": "The labels to be attached to generated resources. The label names must not start with \u0027weblogic.\u0027.",
+          "$ref": "#/definitions/Map"
+        }
+      }
+    },
     "ServerStatus": {
       "type": "object",
       "properties": {

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

@@ -39,7 +39,7 @@ public abstract class BaseConfiguration {
       "Customization affecting ClusterIP Kubernetes services for WebLogic server instances.")
   @SerializedName("serverService")
   @Expose
-  private KubernetesResource serverService = new KubernetesResource();
+  private ServerService serverService = new ServerService();
 
   /** Desired startup state. Legal values are RUNNING or ADMIN. */
   @EnumClass(ServerStartState.class)
@@ -229,12 +229,8 @@ void addPodAnnotation(String name, String value) {
     serverPod.addAnnotations(name, value);
   }
 
-  public void setServerService(KubernetesResource serverService) {
-    this.serverService = serverService;
-  }
-
-  public KubernetesResource getServerService() {
-    return serverService;
+  public Boolean isPrecreateServerService() {
+    return serverService.isPrecreateService();
   }
 
   public Map<String, String> getServiceLabels() {

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

@@ -11,6 +11,14 @@
 import javax.annotation.Nonnull;
 
 public abstract class ClusterSpec {
+  /**
+   * Returns true if per-server instance services should be created for cluster member services even
+   * if pods are not running for these instances.
+   *
+   * @return true, if per-server instances services should be pre-created.
+   */
+  public abstract Boolean isPrecreateServerService();
+
   /**
    * Returns the labels applied to server instance services.
    *

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

@@ -20,6 +20,11 @@ private Cluster getBaseConfiguration(Cluster cluster) {
     return cluster != null ? cluster.getConfiguration() : new Cluster();
   }
 
+  @Override
+  public Boolean isPrecreateServerService() {
+    return cluster.isPrecreateServerService();
+  }
+
   @Override
   public Map<String, String> getServiceLabels() {
     return cluster.getServiceLabels();

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

@@ -0,0 +1,73 @@
+// 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.SerializedName;
+import java.util.Optional;
+import oracle.kubernetes.json.Description;
+import org.apache.commons.lang3.builder.EqualsBuilder;
+import org.apache.commons.lang3.builder.HashCodeBuilder;
+import org.apache.commons.lang3.builder.ToStringBuilder;
+
+public class ServerService extends KubernetesResource {
+
+  @SerializedName("precreateService")
+  @Description(
+      "If true, operator will create server services even for server instances without running pods.")
+  private Boolean isPrecreateService;
+
+  void fillInFrom(ServerService serverService1) {
+    super.fillInFrom(serverService1);
+    this.isPrecreateService =
+        Optional.ofNullable(isPrecreateService).orElse(serverService1.isPrecreateService);
+  }
+
+  public Boolean isPrecreateService() {
+    return Optional.ofNullable(isPrecreateService).orElse(Boolean.FALSE);
+  }
+
+  public void setIsPrecreateService(Boolean isPrecreateService) {
+    this.isPrecreateService = isPrecreateService;
+  }
+
+  public ServerService withIsPrecreateService(Boolean isPrecreateService) {
+    this.isPrecreateService = isPrecreateService;
+    return this;
+  }
+
+  @Override
+  public String toString() {
+    return new ToStringBuilder(this)
+        .appendSuper(super.toString())
+        .append("isPrecreateService", isPrecreateService)
+        .toString();
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) {
+      return true;
+    }
+
+    if (o == null || getClass() != o.getClass()) {
+      return false;
+    }
+
+    ServerService that = (ServerService) o;
+
+    return new EqualsBuilder()
+        .appendSuper(super.equals(o))
+        .append(isPrecreateService, that.isPrecreateService)
+        .isEquals();
+  }
+
+  @Override
+  public int hashCode() {
+    return new HashCodeBuilder(17, 37)
+        .appendSuper(super.hashCode())
+        .append(isPrecreateService)
+        .toHashCode();
+  }
+}

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

@@ -103,6 +103,14 @@ public interface ServerSpec {
   @Nonnull
   Map<String, String> getPodAnnotations();
 
+  /**
+   * Returns true if the per-server instance service should be created for this server instance even
+   * if the pod for this server instance is not running.
+   *
+   * @return true, if the per-server instance service should be pre-created
+   */
+  Boolean isPrecreateServerService();
+
   /**
    * Returns the labels applied to the service.
    *

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

@@ -75,6 +75,10 @@ public Map<String, String> getPodAnnotations() {
     return server.getPodAnnotations();
   }
 
+  public Boolean isPrecreateServerService() {
+    return server.isPrecreateServerService();
+  }
+
   @Override
   @Nonnull
   public Map<String, String> getServiceLabels() {

operator/src/main/java/oracle/kubernetes/operator/DomainStatusUpdater.java

@@ -181,7 +181,7 @@ private Stream<ServerStartupInfo> getServerStartupInfos() {
       }
 
       private boolean shouldBeRunning(ServerStartupInfo startupInfo) {
-        return RUNNING_STATE.equals(startupInfo.getDesiredState());
+        return !startupInfo.isServiceOnly() && RUNNING_STATE.equals(startupInfo.getDesiredState());
       }
 
       private boolean isNotRunning(@Nonnull String serverName) {