add failBootOnSituationalError to domain spec

Author: alai8

docs/domains/Domain.json

@@ -270,6 +270,10 @@
           "description": "The in-pod name of the directory in which to store the domain, node manager, server logs, and server  *.out files",
           "type": "string"
         },
+        "failBootOnSituationalError": {
+          "description": "If true (the default), the WebLogic server boot would fail if any errors occur  when applying situational configuration files during server startup. If false, WebLogic server would start if there are errors in the situational configuration files, and some configuration overrides may not be applied.",
+          "type": "boolean"
+        },
         "includeServerOutInPodLog": {
           "description": "If true (the default), the server .out file will be included in the pod\u0027s stdout.",
           "type": "boolean"

docs/domains/Domain.md

@@ -23,6 +23,7 @@ DomainSpec is a description of a domain.
 | `domainHome` | string | 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 |
 | `domainHomeInImage` | Boolean | True if this domain's home is defined in the docker image for the domain. Defaults to true. |
 | `domainUID` | string | Domain unique identifier. Must be unique across the Kubernetes cluster. Not required. Defaults to the value of metadata.name |
+| `failBootOnSituationalError` | Boolean | If true (the default), the WebLogic server boot would fail if any errors occur  when applying situational configuration files during server startup. If false, WebLogic server would start if there are errors in the situational configuration files, and some configuration overrides may not be applied. |
 | `image` | string | The WebLogic Docker image; required when domainHomeInImage is true; otherwise, defaults to container-registry.oracle.com/middleware/weblogic:12.2.1.3. |
 | `imagePullPolicy` | string | The image pull policy for the WebLogic Docker image. Legal values are Always, Never and IfNotPresent. Defaults to Always if image ends in :latest, IfNotPresent otherwise. |
 | `imagePullSecrets` | array of [Local Object Reference](k8s1.13.5.md#local-object-reference) | A list of image pull secrets for the WebLogic Docker image. |

docs/domains/index.html

@@ -1190,6 +1190,10 @@
           "description": "The in-pod name of the directory in which to store the domain, node manager, server logs, and server  *.out files",
           "type": "string"
         },
+        "failBootOnSituationalError": {
+          "description": "If true (the default), the WebLogic server boot would fail if any errors occur  when applying situational configuration files during server startup. If false, WebLogic server would start if there are errors in the situational configuration files, and some configuration overrides may not be applied.",
+          "type": "boolean"
+        },
         "includeServerOutInPodLog": {
           "description": "If true (the default), the server .out file will be included in the pod\u0027s stdout.",
           "type": "boolean"

model/src/main/java/oracle/kubernetes/operator/KubernetesConstants.java

@@ -26,6 +26,7 @@ public interface KubernetesConstants {
   String[] DOMAIN_ALTERNATE_VERSIONS = {"v2", "v3"};
 
   boolean DEFAULT_INCLUDE_SERVER_OUT_IN_POD_LOG = true;
+  boolean DEFAULT_FAIL_BOOT_ON_SITUATIONAL_ERROR = true;
 
   String CONTAINER_NAME = "weblogic-server";
 

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

@@ -345,6 +345,10 @@ public boolean isIncludeServerOutInPodLog() {
     return spec.getIncludeServerOutInPodLog();
   }
 
+  public boolean isFailBootOnSituationalError() {
+    return spec.getFailBootOnSituationalError();
+  }
+
   public boolean isDomainHomeInImage() {
     return spec.isDomainHomeInImage();
   }

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

@@ -99,6 +99,20 @@ public class DomainSpec extends BaseConfiguration {
   @Description("If true (the default), the server .out file will be included in the pod's stdout.")
   private Boolean includeServerOutInPodLog;
 
+  /**
+   * Whether to fail to WebLogic server boot if any situational configuration error occurs during
+   * server startup. Default is true.
+   *
+   * @since 2.3.0
+   */
+  @Description(
+      "If true (the default), the WebLogic server boot would fail if any errors occur "
+          + " when applying situational configuration files during server startup."
+          + " If false, WebLogic server would start if there are errors in the"
+          + " situational configuration files, and some configuration overrides may"
+          + " not be applied.")
+  private Boolean failBootOnSituationalError;
+
   /**
    * The WebLogic Docker image.
    *
@@ -412,6 +426,21 @@ public DomainSpec withIncludeServerOutInPodLog(boolean includeServerOutInPodLog)
     return this;
   }
 
+  /**
+   * @return whether to fail WebLogic server boot if any error occurs when applying situational
+   *     configuration files during server startup.
+   * @since 2.3.0
+   */
+  boolean getFailBootOnSituationalError() {
+    return Optional.ofNullable(failBootOnSituationalError)
+        .orElse(KubernetesConstants.DEFAULT_FAIL_BOOT_ON_SITUATIONAL_ERROR);
+  }
+
+  public DomainSpec withFailBootOnSituationalError(boolean failBootOnSituationalError) {
+    this.failBootOnSituationalError = failBootOnSituationalError;
+    return this;
+  }
+
   /**
    * Returns true if this domain's home is defined in the default docker image for the domain.
    *
@@ -519,6 +548,7 @@ public String toString() {
             .append("logHome", logHome)
             .append("logHomeEnabled", logHomeEnabled)
             .append("includeServerOutInPodLog", includeServerOutInPodLog)
+            .append("failBootOnSituationalError", failBootOnSituationalError)
             .append("configOverrides", configOverrides)
             .append("configOverrideSecrets", configOverrideSecrets);
 

operator/src/main/java/oracle/kubernetes/operator/helpers/PodStepContext.java

@@ -207,6 +207,10 @@ private String getIncludeServerOutInPodLog() {
     return Boolean.toString(getDomain().isIncludeServerOutInPodLog());
   }
 
+  private boolean getFailBootOnSituationalError() {
+    return getDomain().isFailBootOnSituationalError();
+  }
+
   private List<V1ContainerPort> getContainerPorts() {
     if (scan != null) {
       List<V1ContainerPort> ports = new ArrayList<>();
@@ -814,6 +818,9 @@ void overrideContainerWeblogicEnvVars(List<V1EnvVar> vars) {
     addEnvVar(
         vars, "SERVICE_NAME", LegalNames.toServerServiceName(getDomainUID(), getServerName()));
     addEnvVar(vars, "AS_SERVICE_NAME", LegalNames.toServerServiceName(getDomainUID(), getAsName()));
+    if (!getFailBootOnSituationalError()) {
+      addEnvVar(vars, "FAIL_BOOT_ON_SITUATIONAL_ERROR", "false");
+    }
     if (mockWLS()) {
       addEnvVar(vars, "MOCK_WLS", "true");
     }

operator/src/main/resources/scripts/startNodeManager.sh

@@ -26,7 +26,9 @@
 #                          ${DOMAIN_UID}/${SERVER_NAME}_nodemanager.out
 #                       Default:
 #                          Use LOG_HOME.  If LOG_HOME not set, use NODEMGR_HOME.
-#   ADMIN_PORT_SECURE = "true" if the admin protocol is secure. Default is false
+#   ADMIN_PORT_SECURE = "true" if the admin protocol is secure. Default is false#   FAIL_BOOT_ON_SITUATIONAL_ERROR = "true" if WebLogic server should fail to 
+#                       boot if situational configuration related errors are 
+#                       found. Default to "true" if unspecified.
 #
 # If SERVER_NAME is set, then this NM is for a WL Server and these must also be set:
 # 
@@ -113,12 +115,14 @@ export NODEMGR_HOME=${NODEMGR_HOME}/${DOMAIN_UID}/${SERVER_NAME}
 createFolder ${NODEMGR_HOME} 
 
 NODEMGR_LOG_HOME=${NODEMGR_LOG_HOME:-${LOG_HOME:-${NODEMGR_HOME}/${DOMAIN_UID}}}
+FAIL_BOOT_ON_SITUATIONAL_ERROR=${FAIL_BOOT_ON_SITUATIONAL_ERROR:-true}
 
 trace "Info: NODEMGR_HOME='${NODEMGR_HOME}'"
 trace "Info: LOG_HOME='${LOG_HOME}'"
 trace "Info: SERVER_NAME='${SERVER_NAME}'"
 trace "Info: DOMAIN_UID='${DOMAIN_UID}'"
 trace "Info: NODEMGR_LOG_HOME='${NODEMGR_LOG_HOME}'"
+trace "Info: FAIL_BOOT_ON_SITUATIONAL_ERROR='${FAIL_BOOT_ON_SITUATIONAL_ERROR}'"
 
 createFolder ${NODEMGR_LOG_HOME}
 
@@ -239,7 +243,7 @@ RestartInterval=3600
 NumberOfFilesLimited=true
 FileTimeSpan=24
 NMHostName=${SERVICE_NAME}
-Arguments=${USER_MEM_ARGS} -XX\\:+UnlockExperimentalVMOptions -XX\\:+UseCGroupMemoryLimitForHeap -Dweblogic.SituationalConfig.failBootOnError=true ${serverOutOption} ${JAVA_OPTIONS}
+Arguments=${USER_MEM_ARGS} -XX\\:+UnlockExperimentalVMOptions -XX\\:+UseCGroupMemoryLimitForHeap -Dweblogic.SituationalConfig.failBootOnError=${FAIL_BOOT_ON_SITUATIONAL_ERROR} ${serverOutOption} ${JAVA_OPTIONS}
 
 EOF
 

operator/src/main/resources/scripts/startServer.sh

@@ -110,7 +110,12 @@ function waitForShutdownMarker() {
   # Wait forever.   Kubernetes will monitor this pod via liveness and readyness probes.
   #
   trace "Wait indefinitely so that the Kubernetes pod does not exit and try to restart"
+  logged=false
   while true; do
+    if [ "$logged" != 'true' ] && grep -q "BEA-141335" ${SERVER_OUT_FILE} ; then
+      trace "WebLogic server failed to start due to missing or invalid situational configuration files. Please check ${SERVER_OUT_FILE} for details"
+      logged=true
+    fi
     if [ -e /weblogic-operator/doShutdown ] ; then
       exit 0
     fi
@@ -137,6 +142,9 @@ function copySitCfg() {
   if [ $? = 0 ]; then
     for local_fname in ${src_dir}/${fil_prefix}*.xml ; do
       copyIfChanged $local_fname $tgt_dir/`basename ${local_fname/${fil_prefix}//}`
+      trace "Printing contents of situational configuration file $local_fname:"
+      file_content=`cat $local_fname`
+      echo "$file_content"
     done
   fi
 

operator/src/test/java/oracle/kubernetes/operator/helpers/PodHelperTestBase.java

@@ -473,6 +473,14 @@ public void whenPodCreated_withoutLogHomeSpecified_hasDefaultLogHomeEnvVariable(
         getCreatedPodSpecContainer().getEnv(), allOf(hasEnvVar("LOG_HOME", LOG_HOME + "/" + UID)));
   }
 
+  @Test
+  public void whenPodCreated_withFalseFailBootOnSituationalError_hasEnvVariable() {
+    domainPresenceInfo.getDomain().getSpec().withFailBootOnSituationalError(false);
+    assertThat(
+        getCreatedPodSpecContainer().getEnv(),
+        allOf(hasEnvVar("FAIL_BOOT_ON_SITUATIONAL_ERROR", "false")));
+  }
+
   static Matcher<Iterable<? super V1EnvVar>> hasEnvVar(String name, String value) {
     return hasItem(new V1EnvVar().name(name).value(value));
   }