Merge branch 'develop' into owls-70659

Author: alai8

README.md

@@ -18,7 +18,7 @@ Oracle is finding ways for organizations using WebLogic Server to run important
 * Scale WebLogic domains by starting and stopping Managed Servers on demand, or by integrating with a REST API to initiate scaling based on WLDF, Prometheus, Grafana, or other rules.
 * Publish operator and WebLogic Server logs into Elasticsearch and interact with them in Kibana.
 
-The fastest way to experience the operator is to follow the [Quick start guide](site/quickstart.md), or you can peruse our [documentation](site), read our blogs, or try out the [samples](kubernetes/samples/README.md).
+The fastest way to experience the operator is to follow the [Quick start guide](site/quickstart.md), or you can peruse our [documentation](site), read our [blogs](https://blogs.oracle.com/weblogicserver/how-to-weblogic-server-on-kubernetes), or try out the [samples](kubernetes/samples/README.md).
 
 # About this documentation
 
@@ -54,6 +54,14 @@ The [User guide](site/user-guide.md) provides detailed information about all asp
 
 Please refer to our [samples](kubernetes/samples/README.md) for information about the available sample code we provide.
 
+# Need more help?
+
+We have a public Slack channel where you can get in touch with us to ask questions about using the operator.  To join our channel, please [visit this site to get an invitation](https://weblogic-slack-inviter.herokuapp.com/).  The invitation email will include details of how to access our Slack workspace.  After you are logged in, please come to #operator and say, "hello!"
+
+# Recent changes
+
+See [Recent changes](site/recent-changes.md) for changes to the operator, including any backward incompatible changes.
+
 # Developer guide
 
 Developers interested in this project are encouraged to read the [Developer guide](site/developer.md) to learn how to build the project, run tests, and so on.  The Developer guide also provides details about the structure of the code, coding standards, and the Asynchronous Call facility used in the code to manage calls to the Kubernetes API.
@@ -70,15 +78,6 @@ Documentation for APIs is provided here:
 
 * [Javadoc](https://oracle.github.io/weblogic-kubernetes-operator/apidocs/index.html) for the operator.
 
-## Need more help?
-
-We have a public Slack channel where you can get in touch with us to ask questions about using the operator.  To join our channel, please [visit this site to get an invitation](https://weblogic-slack-inviter.herokuapp.com/).  The invitation email will include details of how to access our Slack workspace.  After you are logged in, please come to #operator and say, "hello!"
-
-## Recent changes
-
-See [Recent changes](site/recent-changes.md) for changes to the operator, including any backward incompatible changes.
-
-
 # Contributing to the operator
 
 Oracle welcomes contributions to this project from anyone.  Contributions may be reporting an issue with the operator or submitting a pull request.  Before embarking on significant development that may result in a large pull request, it is recommended that you create an issue and discuss the proposed changes with the existing developers first.

integration-tests/README.md

@@ -48,7 +48,12 @@ Full test use cases
 * shutdown and delete domain7
 * create domain domain8 and test that create domain fails when its pv is already populated by a shutdown domain
 * create another domain domain9 with APACHE load balancer and access admin console via LB port. shutdown domain.
-* create another domain domain10 with mostly default values from sample domain inputs, mainly exposeAdminT3Channel and exposeAdminNodePort which are false by default and verify domain startup and cluster scaling using operator rest endpoint works. 
+* create another domain domain10 with mostly default values from sample domain inputs, mainly exposeAdminT3Channel and exposeAdminNodePort which are false by default and verify domain startup and cluster scaling using operator rest endpoint works.
+* create another domain domain11 with listen address not set for admin server and t3 channel and incorrect file for admin server log
+* verify automatic situational config override works by bringing up the domain and by doing checks 2 - 5 listed in quick test
+* create another domain domain12 with some junk value for t3 channel public address and using custom situational config override replace with valid public address
+* verify the domain by doing checks 2 - 5 listed in quick test
+ 
 
 
 # Directory Configuration and Structure

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

@@ -91,7 +91,7 @@ public static void staticPrepare() throws Exception {
   }
 
   /**
-   * Releases k8s cluster lease
+   * Releases k8s cluster lease, archives result, pv directories
    *
    * @throws Exception
    */
@@ -124,6 +124,19 @@ public static void staticUnPrepare() throws Exception {
     logger.info("SUCCESS");
   }
 
+  /**
+   * Create operator and verify its deployed successfully. Create domain and verify domain is
+   * started. Verify admin external service by accessing admin REST endpoint with nodeport in URL
+   * Verify admin t3 channel port by exec into the admin pod and deploying webapp using the channel
+   * port for WLST Verify web app load balancing by accessing the webapp using loadBalancerWebPort
+   * Verify domain life cycle(destroy and create) should not any impact on Operator Cluster scale
+   * up/down using Operator REST endpoint, webapp load balancing should adjust accordingly. Operator
+   * life cycle(destroy and create) should not impact the running domain Verify liveness probe by
+   * killing managed server 1 process 3 times to kick pod auto-restart shutdown the domain by
+   * changing domain serverStartPolicy to NEVER
+   *
+   * @throws Exception
+   */
   @Test
   public void test1CreateFirstOperatorAndDomain() throws Exception {
 
@@ -148,7 +161,15 @@ public void test1CreateFirstOperatorAndDomain() throws Exception {
 
     logger.info("SUCCESS - test1CreateFirstOperatorAndDomain");
   }
-
+  /**
+   * Create operator if its not running and create domain and verify domain in started successfully.
+   * Verify admin external service by accessing admin REST endpoint with nodeport in URL Verify
+   * admin t3 channel port by exec into the admin pod and deploying webapp using the channel port
+   * for WLST Verify web app load balancing by accessing the webapp using loadBalancerWebPort
+   * shutdown by deleting domain CRD using yaml
+   *
+   * @throws Exception
+   */
   @Test
   public void test2CreateAnotherDomainInDefaultNS() throws Exception {
     Assume.assumeFalse(QUICKTEST);
@@ -174,7 +195,13 @@ public void test2CreateAnotherDomainInDefaultNS() throws Exception {
     }
     logger.info("SUCCESS - test2CreateAnotherDomainInDefaultNS");
   }
-
+  /**
+   * Create operator if its not running. Create domain with dynamic cluster using WDT and verify the
+   * domain is started successfully. Verify cluster scaling by doing scale up for domain3 using WLDF
+   * scaling shutdown by deleting domain CRD using yaml
+   *
+   * @throws Exception
+   */
   @Test
   public void test3CreateDomainInTest1NS() throws Exception {
     Assume.assumeFalse(QUICKTEST);
@@ -201,7 +228,11 @@ public void test3CreateDomainInTest1NS() throws Exception {
 
     logger.info("SUCCESS - test3CreateDomainInTest1NS");
   }
-
+  /**
+   * Create operator managing test2 namespace
+   *
+   * @throws Exception
+   */
   @Test
   public void test4CreateAnotherOperatorManagingTest2NS() throws Exception {
     Assume.assumeFalse(QUICKTEST);
@@ -213,6 +244,15 @@ public void test4CreateAnotherOperatorManagingTest2NS() throws Exception {
     logger.info("SUCCESS - test4CreateAnotherOperatorManagingTest2NS");
   }
 
+  /**
+   * Create two operators if they are not running. Create domain domain4 with dynamic cluster in
+   * default namespace, managed by operator1 Create domain domain5 with Configured cluster using WDT
+   * in test2 namespace, managed by operator2 Verify scaling for domain5 cluster from 2 to 3 servers
+   * and back to 2, plus verify no impact on domain4 Cycle domain4 down and back up, plus verify no
+   * impact on domain5 shutdown by deleting both domain4 and domain5 CRD's
+   *
+   * @throws Exception
+   */
   @Test
   public void test5CreateConfiguredDomainInTest2NS() throws Exception {
     Assume.assumeFalse(QUICKTEST);
@@ -265,7 +305,13 @@ public void test5CreateConfiguredDomainInTest2NS() throws Exception {
     }
     logger.info("SUCCESS - test5CreateConfiguredDomainInTest2NS");
   }
-
+  /**
+   * Create operator if its not running and create domain with serverStartPolicy="ADMIN_ONLY" Verify
+   * only admin server is created. on Jenkins, this domain will also test NFS instead of HOSTPATH PV
+   * storage shutdown by deleting domain CRD
+   *
+   * @throws Exception
+   */
   @Test
   public void test6CreateDomainWithStartPolicyAdminOnly() throws Exception {
     Assume.assumeFalse(QUICKTEST);
@@ -289,7 +335,12 @@ public void test6CreateDomainWithStartPolicyAdminOnly() throws Exception {
 
     logger.info("SUCCESS - test6CreateDomainWithStartPolicyAdminOnly");
   }
-
+  /**
+   * Create operator and create domain with pvReclaimPolicy="Recycle" Verify that the PV is deleted
+   * once the domain and PVC are deleted
+   *
+   * @throws Exception
+   */
   @Test
   public void test7CreateDomainPVReclaimPolicyRecycle() throws Exception {
     Assume.assumeFalse(QUICKTEST);
@@ -312,7 +363,12 @@ public void test7CreateDomainPVReclaimPolicyRecycle() throws Exception {
     domain7.deletePVCAndCheckPVReleased();
     logger.info("SUCCESS - test7CreateDomainPVReclaimPolicyRecycle");
   }
-
+  /**
+   * Create operator and create domain and verify that create domain fails when its pv is already
+   * populated by a shutdown domain
+   *
+   * @throws Exception
+   */
   @Test
   public void test8CreateDomainOnExistingDir() throws Exception {
     Assume.assumeFalse(QUICKTEST);
@@ -338,6 +394,12 @@ public void test8CreateDomainOnExistingDir() throws Exception {
     logger.info("SUCCESS - test8CreateDomainOnExistingDir");
   }
 
+  /**
+   * Create operator and create domain with APACHE load balancer and verify domain is started
+   * successfully and access admin console via LB port. shutdown domain.
+   *
+   * @throws Exception
+   */
   // @Test
   public void testACreateDomainApacheLB() throws Exception {
     Assume.assumeFalse(QUICKTEST);
@@ -360,7 +422,13 @@ public void testACreateDomainApacheLB() throws Exception {
     }
     logger.info("SUCCESS - testACreateDomainApacheLB");
   }
-
+  /**
+   * Create operator and create domain with mostly default values from sample domain inputs, mainly
+   * exposeAdminT3Channel and exposeAdminNodePort which are false by default and verify domain
+   * startup and cluster scaling using operator rest endpoint works.
+   *
+   * @throws Exception
+   */
   @Test
   public void testBCreateDomainWithDefaultValuesInSampleInputs() throws Exception {
     Assume.assumeFalse(QUICKTEST);
@@ -462,7 +530,14 @@ public void testDeleteTwoDomains() throws Exception {
     TestUtils.verifyAfterDeletion(domainDel2);
     logger.info("SUCCESS - testDeleteTwoDomains");
   }
-
+  /**
+   * Create Operator and create domain with listen address not set for admin server, t3 channel and
+   * incorrect file for admin server log location Verify automatic situational config override works
+   * by bringing up the domain and by verifying domain is started successfully and web application
+   * can be deployed and accessed.
+   *
+   * @throws Exception
+   */
   @Test
   public void testAutoSitConfigOverrides() throws Exception {
     Assume.assumeFalse(QUICKTEST);
@@ -492,7 +567,7 @@ public void testAutoSitConfigOverrides() throws Exception {
       testBasicUseCases(domain11);
       // testAdvancedUseCasesForADomain(operator1, domain11);
       testCompletedSuccessfully = true;
-      logger.info("SUCCESS - testAutoSitConfigOverrides");
+
     } finally {
       Files.copy(
           new File(createDomainScriptDir + "/create-domain.py.bak").toPath(),
@@ -502,9 +577,16 @@ public void testAutoSitConfigOverrides() throws Exception {
         domain11.destroy();
       }
     }
+    logger.info("SUCCESS - testAutoSitConfigOverrides");
   }
-
-  // @Test
+  /**
+   * Create Operator and create domain with some junk value for t3 channel public address and using
+   * custom situational config override replace with valid public address using secret Verify the
+   * domain is started successfully and web application can be deployed and accessed.
+   *
+   * @throws Exception
+   */
+  @Test
   public void testCustomSitConfigOverrides() throws Exception {
     Assume.assumeFalse(QUICKTEST);
     logTestBegin("testCustomSitConfigOverrides");
@@ -533,7 +615,7 @@ public void testCustomSitConfigOverrides() throws Exception {
       testBasicUseCases(domain12);
       // testAdvancedUseCasesForADomain(operator1, domain11);
       testCompletedSuccessfully = true;
-      logger.info("SUCCESS - testCustomSitConfigOverrides");
+
     } finally {
       Files.copy(
           new File(createDomainScriptDir + "/create-domain.py.bak").toPath(),
@@ -543,6 +625,7 @@ public void testCustomSitConfigOverrides() throws Exception {
         domain12.destroy();
       }
     }
+    logger.info("SUCCESS - testCustomSitConfigOverrides");
   }
 
   private Domain testAdvancedUseCasesForADomain(Operator operator, Domain domain) throws Exception {

integration-tests/src/test/java/oracle/kubernetes/operator/utils/Domain.java

@@ -322,7 +322,13 @@ public void verifyWebAppLoadBalancing(String webappName) throws Exception {
           "webapp is not deployed as exposeAdminT3Channel is false, can not verify loadbalancing");
     }
   }
-
+  /**
+   * call webapp and verify load balancing by checking server name in the response
+   *
+   * @param webappName
+   * @param verifyLoadBalance
+   * @throws Exception
+   */
   public void callWebAppAndVerifyLoadBalancing(String webappName, boolean verifyLoadBalance)
       throws Exception {
     if (!loadBalancer.equals("NONE")) {
@@ -362,7 +368,7 @@ public void callWebAppAndVerifyLoadBalancing(String webappName, boolean verifyLo
   }
 
   /**
-   * startup the domain
+   * create domain crd
    *
    * @throws Exception
    */
@@ -390,7 +396,7 @@ public void create() throws Exception {
   }
 
   /**
-   * shutdown the domain
+   * delete domain crd using yaml
    *
    * @throws Exception
    */
@@ -411,6 +417,11 @@ public void destroy() throws Exception {
     verifyDomainDeleted(replicas);
   }
 
+  /**
+   * delete domain using domain name
+   *
+   * @throws Exception
+   */
   public void shutdown() throws Exception {
     int replicas = TestUtils.getClusterReplicas(domainUid, clusterName, domainNS);
     String cmd = "kubectl delete domain " + domainUid + " -n " + domainNS;
@@ -424,6 +435,11 @@ public void shutdown() throws Exception {
     verifyDomainDeleted(replicas);
   }
 
+  /**
+   * shutdown domain by setting serverStartPolicy to NEVER
+   *
+   * @throws Exception
+   */
   public void shutdownUsingServerStartPolicy() throws Exception {
     int replicas = TestUtils.getClusterReplicas(domainUid, clusterName, domainNS);
     String cmd =
@@ -454,6 +470,12 @@ public void verifyDomainDeleted(int replicas) throws Exception {
     verifyServerPodsDeleted(replicas);
   }
 
+  /**
+   * verify server pods are deleted
+   *
+   * @param replicas
+   * @throws Exception
+   */
   public void verifyServerPodsDeleted(int replicas) throws Exception {
     TestUtils.checkPodDeleted(domainUid + "-" + adminServerName, domainNS);
     for (int i = 1; i <= replicas; i++) {
@@ -465,6 +487,11 @@ public Map<String, Object> getDomainMap() {
     return domainMap;
   }
 
+  /**
+   * delete PVC and check PV status released when weblogicDomainStorageReclaimPolicy is Recycle
+   *
+   * @throws Exception
+   */
   public void deletePVCAndCheckPVReleased() throws Exception {
     StringBuffer cmd = new StringBuffer("kubectl get pv ");
     String pvBaseName = (String) pvMap.get("baseName");
@@ -485,7 +512,11 @@ public void deletePVCAndCheckPVReleased() throws Exception {
       logger.info("PV is released when PVC is deleted");
     }
   }
-
+  /**
+   * create domain on existing directory
+   *
+   * @throws Exception
+   */
   public void createDomainOnExistingDirectory() throws Exception {
     String domainStoragePath = domainMap.get("weblogicDomainStoragePath").toString();
     String domainDir = domainStoragePath + "/domains/" + domainMap.get("domainUID").toString();
@@ -507,7 +538,11 @@ public void createDomainOnExistingDirectory() throws Exception {
     }
     throw new RuntimeException("FAIL: unexpected result, create domain job did not report error");
   }
-
+  /**
+   * access admin console using load balancer web port for Apache load balancer
+   *
+   * @throws Exception
+   */
   public void verifyAdminConsoleViaLB() throws Exception {
     if (!loadBalancer.equals("APACHE")) {
       logger.info("This check is done only for APACHE load balancer");
@@ -554,7 +589,11 @@ public void verifyAdminConsoleViaLB() throws Exception {
   public String getDomainUid() {
     return domainUid;
   }
-
+  /**
+   * test liveness probe for managed server 1
+   *
+   * @throws Exception
+   */
   public void testWlsLivenessProbe() throws Exception {
 
     // test managed server1 pod auto restart