Merge pull request #1061 from oracle/admin-running

Correct and clarify use of serverStartState

Author: rjeberhard

docs-source/content/recent-changes.md

@@ -10,7 +10,7 @@ This document tracks recent changes to the operator, especially ones that introd
 
 | Date | Version | Introduces backward incompatibilities | Change |
 | --- | --- | --- | --- |
-| April 30, 2019 | v2.2 | no  | Added support for FMW Infrastructure domains. WebLogic server instances are now gracefully shutdown by default and shutdown options are configurable. Operator is now built and runs on JDK 11. 
+| May 6, 2019 | v2.2 | no  | Added support for FMW Infrastructure domains. WebLogic Server instances are now gracefully shut down by default and shutdown options are configurable. Operator is now built and runs on JDK 11. 
 | April 4, 2019 | v2.1 | no  | Customers can add init and sidecar containers to generated pods.  
 | March 4, 2019 | v2.0.1 | no  | OpenShift support is now certified.  Many bug fixes, including fixes for configuration overrides, cluster services, and domain status processing.  
 | January 24, 2019 | v2.0 | yes; not compatible with 1.x releases, but is compatible with 2.0-rc2. | Final version numbers and documentation updates.  

docs-source/content/release-notes.md

@@ -8,7 +8,7 @@ draft: false
 
 | Date | Version | Introduces backward incompatibilities | Change |
 | --- | --- | --- | --- |
-| April 30, 2019 | v2.2 | no  | Added support for FMW Infrastructure domains. WebLogic Server instances are now gracefully shutdown by default and shutdown options are configurable. Operator is now built and runs on JDK 11. 
+| May 6, 2019 | v2.2 | no  | Added support for FMW Infrastructure domains. WebLogic Server instances are now gracefully shut down by default and shutdown options are configurable. Operator is now built and runs on JDK 11. 
 | April 4, 2019 | v2.1 | no  | Customers can add init and sidecar containers to generated pods.  
 | March 4, 2019 | v2.0.1 | no  | OpenShift support is now certified.  Many bug fixes, including fixes for configuration overrides, cluster services, and domain status processing.  
 | January 24, 2019 | v2.0 | yes; not compatible with 1.x releases, but is compatible with 2.0-rc2. | Final version numbers and documentation updates.  

docs-source/content/userguide/managing-domains/domain-lifecycle/startup.md

@@ -16,8 +16,8 @@ and which servers should be restarted. To start, stop, or restart servers, modif
     * [Rolling restarts](#rolling-restarts)
     * [Common restarting scenarios](#common-restarting-scenarios)
 
-There are properties on the domain resource that specify which servers should be running
-and which servers should be restarted. To start, stop, or restart servers, modify these properties on the domain resource
+There are properties on the domain resource that specify which servers should be running,
+which servers should be restarted and the desired initial state. To start, stop, or restart servers, modify these properties on the domain resource
 (for example, by using `kubectl` or the Kubernetes REST API).  The operator will notice the changes and apply them.  Beginning,
 with operator version 2.2, there are now properties to control server shutdown handling, such as whether the shutdown
 will be graceful, the timeout, and if in-flight sessions are given the opportunity to complete.
@@ -69,6 +69,16 @@ Servers configured as `ALWAYS` count toward the cluster's `replicas` count.
 If more servers are configured as `ALWAYS` than the cluster's `replicas` count, they will all be started and the `replicas` count will be ignored.
 {{% /notice %}}
 
+### Server start state
+
+For some use cases, such as an externally managed zero downtime patching (ZDP), it may be necessary to start WebLogic Server
+so that at the end of its startup process, the server is in an administrative state.  This can be achieved using the `serverStartState`
+property, which is available at domain, cluster, and server levels.  When `serverStartState` is set to `ADMIN`, then servers will
+progress only to the administrative state.  You could then use the WebLogic console, REST API, or a WLST script to make any necessary
+updates before advancing the server to the running state.
+
+Changes to the `serverStartState` property do not affect already started servers.
+
 ### Common starting and stopping scenarios
 
 #### Normal running state
@@ -240,7 +250,6 @@ The operator will restart servers when any of the follow properties on the domai
 * `readinessProbe`
 * `resources`
 * `restartVersion`
-* `serverStartState`
 * `volumes`
 * `volumeMounts`
 
@@ -251,6 +260,11 @@ the domain resource will cause neither a restart nor a patch. It is possible to
 such a label or annotation by modifying the `restartVersion`.
 {{% /notice %}}
 
+{{% notice note %}}
+Prior to version 2.2, the operator incorrectly restarted servers when the `serverStartState` property was changed.  Now, 
+this property has no affect on already running servers.
+{{% /notice %}}
+
 ### Rolling restarts
 
 Clustered servers that need to be restarted are gradually restarted (for example, `rolling restarted`) so that the cluster is not taken out of service and in-flight work can be migrated to other servers in the cluster.

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

@@ -184,6 +184,14 @@ public abstract void withDefaultLivenessProbeSettings(
    */
   public abstract DomainConfigurator withDefaultServerStartPolicy(String startPolicy);
 
+  /**
+   * Sets the server start state ("RUNNING" or "ADMIN") for the domain.
+   *
+   * @param startState the server start state
+   * @return this object
+   */
+  public abstract DomainConfigurator withServerStartState(String startState);
+
   /**
    * Add an environment variable to the domain.
    *

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

@@ -63,6 +63,12 @@ public DomainConfigurator withDefaultServerStartPolicy(String startPolicy) {
     return this;
   }
 
+  @Override
+  public DomainConfigurator withServerStartState(String startState) {
+    ((BaseConfiguration) getDomainSpec()).setServerStartState(startState);
+    return this;
+  }
+
   @Override
   public DomainConfigurator withEnvironmentVariable(String name, String value) {
     ((BaseConfiguration) getDomainSpec()).addEnvironmentVariable(name, value);

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

@@ -8,12 +8,10 @@
 import static oracle.kubernetes.operator.KubernetesConstants.DEFAULT_IMAGE;
 import static oracle.kubernetes.operator.KubernetesConstants.IFNOTPRESENT_IMAGEPULLPOLICY;
 
-import io.kubernetes.client.models.V1EnvVar;
 import io.kubernetes.client.models.V1LocalObjectReference;
 import io.kubernetes.client.models.V1PodSecurityContext;
 import io.kubernetes.client.models.V1ResourceRequirements;
 import io.kubernetes.client.models.V1SecurityContext;
-import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
@@ -28,7 +26,6 @@
 @SuppressWarnings("WeakerAccess")
 public abstract class ServerSpecBase implements ServerSpec {
 
-  private static final String ADMIN_MODE_FLAG = "-Dweblogic.management.startupMode=ADMIN";
   protected DomainSpec domainSpec;
 
   public ServerSpecBase(DomainSpec domainSpec) {
@@ -62,17 +59,6 @@ public List<V1LocalObjectReference> getImagePullSecrets() {
     return domainSpec.getImagePullSecrets();
   }
 
-  protected List<V1EnvVar> withStateAdjustments(List<V1EnvVar> env) {
-    if (!getDesiredState().equals("ADMIN")) {
-      return env;
-    } else {
-      List<V1EnvVar> adjustedEnv = new ArrayList<>(env);
-      V1EnvVar var = getOrCreateVar(adjustedEnv, "JAVA_OPTIONS");
-      var.setValue(prepend(var.getValue(), ADMIN_MODE_FLAG));
-      return adjustedEnv;
-    }
-  }
-
   @Override
   public String getConfigOverrides() {
     return domainSpec.getConfigOverrides();
@@ -83,23 +69,6 @@ public List<String> getConfigOverrideSecrets() {
     return domainSpec.getConfigOverrideSecrets();
   }
 
-  @SuppressWarnings("SameParameterValue")
-  private V1EnvVar getOrCreateVar(List<V1EnvVar> env, String name) {
-    for (V1EnvVar var : env) {
-      if (var.getName().equals(name)) {
-        return var;
-      }
-    }
-    V1EnvVar var = new V1EnvVar().name(name);
-    env.add(var);
-    return var;
-  }
-
-  @SuppressWarnings("SameParameterValue")
-  private String prepend(String value, String prefix) {
-    return value == null ? prefix : value.contains(prefix) ? value : prefix + ' ' + value;
-  }
-
   @Override
   @Nonnull
   public ProbeTuning getLivenessProbe() {

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

@@ -50,7 +50,7 @@ private Server getBaseConfiguration(Server server) {
 
   @Override
   public List<V1EnvVar> getEnvironmentVariables() {
-    return withStateAdjustments(server.getEnv());
+    return server.getEnv();
   }
 
   @Override

model/src/test/java/oracle/kubernetes/weblogic/domain/DomainTestBase.java

@@ -337,20 +337,6 @@ public void whenSpecifiedOnServer_managedServerHasEnvironmentVariables() {
     assertThat(spec.getEnvironmentVariables(), containsInAnyOrder(createEnvironment()));
   }
 
-  @Test
-  public void whenDesiredStateAdminAndSpecifiedOnServer_managedServerHasJavaOption() {
-    configureServer(SERVER1)
-        .withDesiredState("ADMIN")
-        .withEnvironmentVariable(NAME1, VALUE1)
-        .withEnvironmentVariable(NAME2, VALUE2);
-
-    ServerSpec spec = domain.getServer(SERVER1, CLUSTER_NAME);
-
-    assertThat(
-        spec.getEnvironmentVariables(),
-        hasItem(envVar("JAVA_OPTIONS", "-Dweblogic.management.startupMode=ADMIN")));
-  }
-
   @Test
   public void whenSpecifiedOnCluster_managedServerHasEnvironmentVariables() {
     configureCluster(CLUSTER_NAME)
@@ -370,9 +356,7 @@ public void whenDesiredStateAdminAndSpecifiedOnCluster_managedServerHasEnvironme
 
     ServerSpec spec = domain.getServer(SERVER1, CLUSTER_NAME);
 
-    assertThat(
-        spec.getEnvironmentVariables(),
-        hasItem(envVar("JAVA_OPTIONS", "-Dweblogic.management.startupMode=ADMIN value")));
+    assertThat(spec.getEnvironmentVariables(), hasItem(envVar("JAVA_OPTIONS", "value")));
   }
 
   @Test
@@ -408,9 +392,6 @@ public void whenDomainReadFromYaml_Server2OverridesDefaults() throws IOException
     Domain domain = readDomain(DOMAIN_V2_SAMPLE_YAML);
     ServerSpec serverSpec = domain.getServer("server2", null);
 
-    assertThat(
-        serverSpec.getEnvironmentVariables(),
-        hasItem(envVar("JAVA_OPTIONS", "-Dweblogic.management.startupMode=ADMIN")));
     assertThat(serverSpec.getDesiredState(), equalTo("ADMIN"));
   }
 

model/src/test/java/oracle/kubernetes/weblogic/domain/model/DomainV2Test.java

@@ -726,7 +726,7 @@ public void whenDomainReadFromYaml_cluster2OverridesDefaults() throws IOExceptio
     assertThat(
         serverSpec.getEnvironmentVariables(),
         containsInAnyOrder(
-            envVar("JAVA_OPTIONS", "-Dweblogic.management.startupMode=ADMIN -verbose"),
+            envVar("JAVA_OPTIONS", "-verbose"),
             envVar("USER_MEM_ARGS", "-Xms64m -Xmx256m "),
             envVar("var1", "value0")));
     assertThat(serverSpec.getConfigOverrides(), equalTo("overrides-config-map"));

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

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