fixes docs related to failing WebLogic boot with configOverrides errros

Author: alai8

docs-source/content/userguide/managing-domains/configoverrides/_index.md

@@ -338,9 +338,9 @@ spec:
 
 Incorrectly formatted override files may be accepted without warnings or errors and will not prevent WebLogic pods from booting. So, it is important to make sure that the template files are correct in a QA environment, otherwise your WebLogic Servers may start even though critically required overrides are failing to take effect.
 
-On WebLogic Servers that support the `weblogic.SituationalConfig.failBootOnError` system property ( Note: It is not supported in WebLogic Server 12.2.1.3 ), 
+On WebLogic Servers that support the `weblogic.SituationalConfig.failBootOnError` system property ( Note: It is not supported in WebLogic Server 12.2.1.3.0 ), 
 by default the WebLogic server will fail to boot if any situational configuration files are invalid.
-This can be configured by using the `failBootOnSituationalError` attribute in the Domain spec to `false` to start up the WebLogic servers even with 
+By setting the `failBootOnSituationalError` attribute in the Domain spec to `false`, you can start up the WebLogic Servers even with 
 incorrectly formatted override files.
 
 * Make sure you've followed each step in the [Step-by-step guide](#step-by-step-guide).
@@ -371,10 +371,10 @@ incorrectly formatted override files.
       * This directory, or a subdirectory within this directory, should contain each of your custom situational configuration files.
       * If it doesn't, then this likely indicates your domain resource `configOverrides` was not set to match your custom override configuration map name, or that your custom override configuration map does not contain your override files.
 
-* If the Administration Server pod do start but fails to reach ready state:
-  * Check if there is a message ` WebLogic server failed to start due to missing or invalid situational configuration files` in the Administration Server pod's `kubectl log`
-    * This suggests that the Administration Server failed to start may be caused by errors found in the a configuration override file.
-      * Lines containing the String `<Warning>` may be found in the Administration Server pod log to provide more hints. 
+* If the Administration Server pod does start but fails to reach ready state:
+  * Check for this message ` WebLogic server failed to start due to missing or invalid situational configuration files` in the Administration Server pod's `kubectl log`
+    * This suggests that the Administration Server failure to start may have been caused by errors found in a configuration override file.
+      * Lines containing the String `situational` may be found in the Administration Server pod log to provide more hints. 
       * For example:
         * `<Jun 20, 2019 3:48:45 AM GMT> <Warning> <Management> <BEA-141323> <The situational config file has an invalid format, it is being ignored: XMLSituationalConfigFile[/shared/domains/domain1/optconfig/jdbc/testDS-0527-jdbc-situational-config.xml] because org.xml.sax.SAXParseException; lineNumber: 8; columnNumber: 3; The element type "jdbc:jdbc-driver-params" must be terminated by the matching end-tag "</jdbc:jdbc-driver-params>".`
       * The warning message suggests a syntax error is found in the provided configuration override file for the testDS JDBC datasource.

docs/domains/Domain.json

@@ -271,7 +271,7 @@
           "type": "string"
         },
         "failBootOnSituationalError": {
-          "description": "If true (the default), on WebLogic server that supports this feature, the WebLogic server  boot would fail if any errors occur when applying situational configuration  during server startup. If false, WebLogic server would start if there are errors in the situational configuration files, but some configuration overrides may be skipped.",
+          "description": "In WebLogic Server versions that support this feature (greater than 12.2.1.3.0):  \u003cli\u003eIf true (the default) the WebLogic Server would fail to boot if it encounters an error while loading situational configuration files during server startup, or if any situational configuration file has an invalid format, \u003c/li\u003e \u003cli\u003eIf false, and if there are errors in the situational configuration files, then WebLogic Server would start but some configuration overrides may be skipped.\u003c/li\u003e",
           "type": "boolean"
         },
         "includeServerOutInPodLog": {

docs/domains/Domain.md

@@ -23,7 +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), on WebLogic server that supports this feature, the WebLogic server  boot would fail if any errors occur when applying situational configuration  during server startup. If false, WebLogic server would start if there are errors in the situational configuration files, but some configuration overrides may be skipped. |
+| `failBootOnSituationalError` | Boolean | In WebLogic Server versions that support this feature (greater than 12.2.1.3.0):  <li>If true (the default) the WebLogic Server would fail to boot if it encounters an error while loading situational configuration files during server startup, or if any situational configuration file has an invalid format, </li> <li>If false, and if there are errors in the situational configuration files, then WebLogic Server would start but some configuration overrides may be skipped.</li> |
 | `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

@@ -1191,7 +1191,7 @@
           "type": "string"
         },
         "failBootOnSituationalError": {
-          "description": "If true (the default), on WebLogic server that supports this feature, the WebLogic server  boot would fail if any errors occur when applying situational configuration  during server startup. If false, WebLogic server would start if there are errors in the situational configuration files, but some configuration overrides may be skipped.",
+          "description": "In WebLogic Server versions that support this feature (greater than 12.2.1.3.0):  \u003cli\u003eIf true (the default) the WebLogic Server would fail to boot if it encounters an error while loading situational configuration files during server startup, or if any situational configuration file has an invalid format, \u003c/li\u003e \u003cli\u003eIf false, and if there are errors in the situational configuration files, then WebLogic Server would start but some configuration overrides may be skipped.\u003c/li\u003e",
           "type": "boolean"
         },
         "includeServerOutInPodLog": {

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

@@ -106,12 +106,14 @@ public class DomainSpec extends BaseConfiguration {
    * @since 2.3.0
    */
   @Description(
-      "If true (the default), on WebLogic server that supports this feature, the WebLogic server "
-          + " boot would fail if any errors occur when applying situational configuration "
-          + " during server startup."
-          + " If false, WebLogic server would start if there are errors in the"
-          + " situational configuration files, but some configuration overrides may"
-          + " be skipped.")
+      "In WebLogic Server versions that support this feature (greater than 12.2.1.3.0): "
+          + " <li>If true (the default) the WebLogic Server would fail to boot"
+          + " if it encounters an error while loading situational configuration files"
+          + " during server startup, or if any situational configuration file has an invalid format,"
+          + " </li>"
+          + " <li>If false, and if there are errors in the situational configuration "
+          + "files, then WebLogic Server would start but some configuration overrides may"
+          + " be skipped.</li>")
   private Boolean failBootOnSituationalError;
 
   /**

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

@@ -113,7 +113,14 @@ function waitForShutdownMarker() {
   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"
+      msg=("WebLogic server failed to start due to missing or invalid"
+           "situational configuration files, which may be due to invalid"
+           "configOverride templates (these are specified via the"
+           "configOverride attribute in the Domain custom resource)."
+           "For details, please search your pod log or"
+           "${SERVER_OUT_FILE} for the keyword 'situational'."
+          )
+      trace "${msg[*]}"
       logged=true
     fi
     if [ -e /weblogic-operator/doShutdown ] ; then