OWLS-83537 - Update domain home in image samples to use WIT instead of docker-images samples

documentation/staging/content/quickstart/cleanup.md

@@ -73,3 +73,20 @@ weight: 7
     ```shell
     $ kubectl delete namespace traefik
     ```
+
+#### Delete the generated image.
+
+1.  When no longer needed, delete the generated image by using the `docker rmi` command.
+    Use the following command to delete an image tagged with `domain-home-in-image:12.2.1.4`:
+
+    ```shell
+    $ docker rmi domain-home-in-image:12.2.1.4
+    ```
+
+#### Delete the tools directory.
+
+1.  When no longer needed, delete the directory where WebLogic Deploy Tool and WebLogic Image Tool are installed.
+
+    ```shell
+    $ rm -rf /tmp/dhii-sample/tools/
+    ```

documentation/staging/content/quickstart/create-domain.md

@@ -44,6 +44,9 @@ weight: 6
     respectively, as you provided when creating the Kubernetes Secret in Step 2.
     {{% /notice %}}
 
+    For the detailed steps that the `create-domain.sh` script performs, see [Domain Home In Image]({{< relref "/samples/simple/domains/domain-home-in-image/_index.md" >}}).
+
+
 1.	Confirm that the operator started the servers for the domain:
 
     a. Use `kubectl` to show that the Domain was created:

documentation/staging/content/samples/simple/domains/fmw-domain/_index.md

@@ -1,5 +1,5 @@
 ---
-title: "FMW Infrastructure domain"
+title: "FMW Infrastructure domain on a PV"
 date: 2019-04-18T07:32:31-05:00
 weight: 5
 description: "Sample for creating an FMW Infrastructure domain home on an existing PV or
@@ -20,7 +20,9 @@ Before you begin, read this document, [Domain resource]({{< relref "/userguide/m
 The following prerequisites must be met prior to running the create domain script:
 
 * Make sure the WebLogic Kubernetes Operator is running.
-* The operator requires FMW Infrastructure 12.2.1.3.0 with patch 29135930 applied or FMW Infrastructure 12.2.1.4.0. For details on how to obtain or create the image, refer to [FMW Infrastructure domains]({{< relref "/userguide/managing-domains/fmw-infra/_index.md#obtaining-the-fmw-infrastructure-docker-image" >}}).
+* The operator requires FMW Infrastructure 12.2.1.3.0 with patch 29135930 applied or FMW Infrastructure 12.2.1.4.0. 
+  For details on how to obtain or create the image, refer to 
+  [FMW Infrastructure domains]({{< relref "/userguide/managing-fmw-domains/fmw-infra/#obtaining-the-fmw-infrastructure-image" >}}).
 * Create a Kubernetes Namespace for the domain unless you intend to use the default namespace.
 * In the same Kubernetes Namespace, create the Kubernetes PersistentVolume (PV) where the domain
   home will be hosted, and the Kubernetes PersistentVolumeClaim (PVC) for the domain. For samples
@@ -32,12 +34,18 @@ The following prerequisites must be met prior to running the create domain scrip
   with an inputs file that has the `domainUID` set to `domain1`.
 * Create the Kubernetes Secrets `username` and `password` of the administrative account in the same Kubernetes
   namespace as the domain.
-* Configure access to your database. For details, see [here]({{< relref "/userguide/managing-fmw-domains/fmw-infra/_index.md#configuring-access-to-your-database" >}}).  
-* Create a Kubernetes Secret with the RCU credentials. For details, refer to this [document](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/scripts/create-rcu-credentials/README.md).
-
+* Unless you are creating a Restricted-JRF domain, you also need to:  
+  * Configure access to your database. For details, see [here]({{< relref "/userguide/managing-fmw-domains/fmw-infra/_index.md#configuring-access-to-your-database" >}}).  
+  * Create a Kubernetes Secret with the RCU credentials. For details, refer to this [document](https://github.com/oracle/weblogic-kubernetes-operator/blob/main/kubernetes/samples/scripts/create-rcu-credentials/README.md).
+
 #### Use the script to create a domain
 
-Make a copy of the `create-domain-inputs.yaml` file, and run the create script, pointing it at
+The sample for creating domains is in this directory:
+
+```shell
+$ cd kubernetes/samples/scripts/create-fmw-infrastructure-domain/domain-home-on-pv
+```
+Make a copy of the `create-domain-inputs.yaml` file, update it with the correct values, and run the create script, pointing it at
 your inputs file and an output directory:
 
 ```shell
@@ -116,8 +124,9 @@ The following parameters can be provided in the inputs file.
 | `domainUID` | Unique ID that will be used to identify this particular domain. Used as the name of the generated WebLogic domain as well as the name of the Domain. This ID must be unique across all domains in a Kubernetes cluster. This ID cannot contain any character that is not valid in a Kubernetes Service name. | `domain1` |
 | `exposeAdminNodePort` | Boolean indicating if the Administration Server is exposed outside of the Kubernetes cluster. | `false` |
 | `exposeAdminT3Channel` | Boolean indicating if the T3 administrative channel is exposed outside the Kubernetes cluster. | `false` |
+| `fmwDomainType` | FMW Infrastructure Domain Type. Legal values are `JRF` or `RestrictedJRF`. | `JRF` |
 | `httpAccessLogInLogHome` | Boolean indicating if server HTTP access log files should be written to the same directory as `logHome`. Otherwise, server HTTP access log files will be written to the directory specified in the WebLogic domain home configuration. | `true` |
-| `image` | WebLogic Server image. The operator requires FMW Infrastructure 12.2.1.3.0 with patch 29135930 applied or FMW Infrastructure 12.2.1.4.0. For details on how to obtain or create the image, see [FMW Infrastructure domains]({{< relref "/userguide/managing-fmw-domains/fmw-infra/_index.md#obtaining-the-fmw-infrastructure-docker-image" >}}). | `container-registry.oracle.com/middleware/fmw-infrastructure:12.2.1.4` |
+| `image` | FMW Infrastructure image. The operator requires FMW Infrastructure 12.2.1.3.0 with patch 29135930 applied or FMW Infrastructure 12.2.1.4.0. For details on how to obtain or create the image, see [FMW Infrastructure domains]({{< relref "/userguide/managing-fmw-domains/fmw-infra/#obtaining-the-fmw-infrastructure-image" >}}). | `container-registry.oracle.com/middleware/fmw-infrastructure:12.2.1.4` |
 | `imagePullPolicy` | WebLogic Server image pull policy. Legal values are `IfNotPresent`, `Always`, or `Never`. | `IfNotPresent` |
 | `imagePullSecretName` | Name of the Kubernetes Secret to access the container registry to pull the WebLogic Server image. The presence of the secret will be validated when this parameter is specified. |  |
 | `includeServerOutInPodLog` | Boolean indicating whether to include the server `.out` in the pod's `stdout`. | `true` |
@@ -140,7 +149,7 @@ The following parameters can be provided in the inputs file.
 
 Note that the names of the Kubernetes resources in the generated YAML files may be formed with the
 value of some of the properties specified in the `create-inputs.yaml` file. Those properties include
-the `adminServerName`, `clusterName` and `managedServerNameBase`. If those values contain any
+the `adminServerName`, `clusterName`, and `managedServerNameBase`. If those values contain any
 characters that are invalid in a Kubernetes Service name, those characters are converted to
 valid values in the generated YAML files. For example, an uppercase letter is converted to a
 lowercase letter and an underscore `("_")` is converted to a hyphen `("-")`.

integration-tests/src/test/java/oracle/weblogic/kubernetes/ItFmwSample.java

@@ -6,7 +6,9 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.Arrays;
 import java.util.List;
+import java.util.stream.Stream;
 
 import io.kubernetes.client.openapi.ApiException;
 import oracle.weblogic.kubernetes.actions.impl.primitive.Command;
@@ -17,7 +19,8 @@
 import org.awaitility.core.ConditionFactory;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.DisplayName;
-import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.MethodSource;
 
 import static java.util.concurrent.TimeUnit.MINUTES;
 import static java.util.concurrent.TimeUnit.SECONDS;
@@ -57,7 +60,7 @@
 /**
  * Tests related to FMW domain samples.
  */
-@DisplayName("Verify the JRF domain on pv sample using wlst")
+@DisplayName("Verify the JRF domain on pv sample using wlst and wdt")
 @IntegrationTest
 public class ItFmwSample {
 
@@ -66,20 +69,14 @@ public class ItFmwSample {
 
   private static final Path samplePath = Paths.get(ITTESTS_DIR, "../kubernetes/samples");
   private static final Path tempSamplePath = Paths.get(WORK_DIR, "fmw-sample-testing");
-  private final String domainUid = "fmwsamplepv";
 
-  private static final String RCUSCHEMAPREFIX = "fmwsamplepv";
   private static final String ORACLEDBURLPREFIX = "oracle-db.";
   private static final String ORACLEDBSUFFIX = ".svc.cluster.local:1521/devpdb.k8s";
   private static final String RCUSYSUSERNAME = "sys";
   private static final String RCUSYSPASSWORD = "Oradoc_db1";
   private static final String RCUSCHEMAUSERNAME = "myrcuuser";
   private static final String RCUSCHEMAPASSWORD = "Oradoc_db1";
   private static String dbUrl = null;
-  // in general the node port range has to be between 30,100 to 32,767
-  // to avoid port conflict because of the delay in using it, the port here
-  // starts with 30172
-  final int t3ChannelPort = getNextFreePort(30172, 32767);
 
   // create standard, reusable retry/backoff policy
   private static final ConditionFactory withStandardRetryPolicy
@@ -89,6 +86,13 @@ public class ItFmwSample {
 
   private static LoggingFacade logger = null;
 
+  private static final String[] params = { "wdt:fmwsamplepv", "wlst:fmwsamplepv2"};
+
+  // generates the stream of objects used by parametrized test.
+  private static Stream<String> paramProvider() {
+    return Arrays.stream(params);
+  }
+
   /**
    * Start DB service and create RCU schema.
    * Assigns unique namespaces for operator and domains.
@@ -115,13 +119,24 @@ public static void initAll(@Namespaces(3) List<String> namespaces) {
     domainNamespace = namespaces.get(2);
 
     int dbPort = 30011 + getNewSuffixCount();
-    logger.info("Start DB and create RCU schema for namespace: {0}, RCU prefix: {1}, "
-        + "dbUrl: {2}, dbImage: {3},  fmwImage: {4}, dbPort: {5} ", dbNamespace, RCUSCHEMAPREFIX, dbUrl,
+    logger.info("Start DB and for namespace: {0}, "
+            + "dbImage: {2},  fmwImage: {3}, dbPort: {4} ", dbNamespace,
         DB_IMAGE_TO_USE_IN_SPEC, FMWINFRA_IMAGE_TO_USE_IN_SPEC, dbPort);
-    assertDoesNotThrow(() -> setupDBandRCUschemaBySample(DB_IMAGE_TO_USE_IN_SPEC, FMWINFRA_IMAGE_TO_USE_IN_SPEC,
-        RCUSCHEMAPREFIX, dbNamespace, dbPort, dbUrl),
-        String.format("Failed to create RCU schema for prefix %s in the namespace %s with "
-        + "dbUrl %s", RCUSCHEMAPREFIX, dbNamespace, dbUrl));
+    assertDoesNotThrow(() -> setupDBBySample(DB_IMAGE_TO_USE_IN_SPEC, FMWINFRA_IMAGE_TO_USE_IN_SPEC,
+        dbNamespace, dbPort),
+        String.format("Failed to create DB in the namespace %s with dbPort %d ",
+            dbNamespace, dbPort));
+
+    for (String param: params) {
+      String rcuSchemaPrefix = param.split(":")[1];
+
+      logger.info("Create RCU schema with fmwImage: {0}, rcuSchemaPrefix: {1}, dbUrl: {2}, "
+          + " dbNamespace: {3}:", FMWINFRA_IMAGE_TO_USE_IN_SPEC, rcuSchemaPrefix, dbUrl, dbNamespace);
+      assertDoesNotThrow(() -> createRcuSchema(FMWINFRA_IMAGE_TO_USE_IN_SPEC, rcuSchemaPrefix, dbUrl, dbNamespace),
+          String.format("Failed to create RCU schema for prefix %s in the namespace %s with dbUrl %s",
+              rcuSchemaPrefix, dbNamespace, dbUrl));
+    }
+
 
 
     // create pull secrets for WebLogic image when running in non Kind Kubernetes cluster
@@ -133,14 +148,21 @@ public static void initAll(@Namespaces(3) List<String> namespaces) {
   }
 
   /**
-   * Test JRF domain on pv samples using domains created by wlst.
-   * Verify Pod is ready and service exists for both admin server and managed servers.
-   * Verify EM console is accessible.
+   * Test JRF domain on pv samples using domains created by wlst and wdt. Verify Pod is ready and
+   * service exists for both admin server and managed servers. Verify EM console is accessible.
+   *
+   * @param model domain name and script type to create domain. Acceptable values of format String:wlst|wdt
    */
-  @Test
-  @DisplayName("Test FMW Sample domain on PV")
-  public void testFmwSampleDomainInPvUsingWlst() {
+  @ParameterizedTest
+  @MethodSource("paramProvider")
+  @DisplayName("Test FMW domain on PV sample")
+  public void testFmwDomainInPv(String model) {
+
+    String domainUid = model.split(":")[1];
+    String script = model.split(":")[0];
+
     setupSample();
+
     // create persistent volume and persistent volume claims used by the samples
     createPvPvc(domainUid);
 
@@ -159,6 +181,8 @@ public void testFmwSampleDomainInPvUsingWlst() {
 
     // change image name
     assertDoesNotThrow(() -> {
+      replaceStringInFile(Paths.get(sampleBase.toString(), "create-domain-inputs.yaml").toString(),
+          "createDomainFilesDir: wlst", "createDomainFilesDir: " + script);
       replaceStringInFile(Paths.get(sampleBase.toString(), "create-domain-inputs.yaml").toString(),
               "image: container-registry.oracle.com/middleware/fmw-infrastructure:12.2.1.4",
               "image: " + FMWINFRA_IMAGE_TO_USE_IN_SPEC);
@@ -323,14 +347,20 @@ private static void setupSample() {
     });
 
     String command = "chmod -R 755 " + tempSamplePath;
-    logger.info("The command to be executed: " + command); 
+    logger.info("The command to be executed: " + command);
     assertTrue(new Command()
         .withParams(new CommandParams()
             .command(command))
         .execute(), "Failed to chmod tempSamplePath");
   }
 
   private void updateDomainInputsFile(String domainUid, Path sampleBase) {
+    // in general the node port range has to be between 30,100 to 32,767
+    // to avoid port conflict because of the delay in using it, the port here
+    // starts with 30172
+    final int t3ChannelPort = getNextFreePort(30172, 32767);
+    final int adminNodePort = getNextFreePort(30701, 32767);
+
     // change namespace from default to custom, domain name, and t3PublicAddress
     assertDoesNotThrow(() -> {
       replaceStringInFile(Paths.get(sampleBase.toString(), "create-domain-inputs.yaml").toString(),
@@ -345,6 +375,8 @@ private void updateDomainInputsFile(String domainUid, Path sampleBase) {
               "exposeAdminT3Channel: false", "exposeAdminT3Channel: true");
       replaceStringInFile(Paths.get(sampleBase.toString(), "create-domain-inputs.yaml").toString(),
               "exposeAdminNodePort: false", "exposeAdminNodePort: true");
+      replaceStringInFile(Paths.get(sampleBase.toString(), "create-domain-inputs.yaml").toString(),
+          "adminNodePort: 30701", "adminNodePort: " + adminNodePort);
       replaceStringInFile(Paths.get(sampleBase.toString(), "create-domain-inputs.yaml").toString(),
               "#imagePullSecretName:", "imagePullSecretName: " + BASE_IMAGES_REPO_SECRET);
       replaceStringInFile(Paths.get(sampleBase.toString(), "create-domain-inputs.yaml").toString(),
@@ -357,15 +389,13 @@ private void updateDomainInputsFile(String domainUid, Path sampleBase) {
    *
    * @param dbImage image name of database
    * @param fmwImage image name of FMW
-   * @param rcuSchemaPrefix rcu SchemaPrefix
-   * @param dbNamespace namespace where DB and RCU schema are going to start
+]   * @param dbNamespace namespace where DB and RCU schema are going to start
    * @param dbPort NodePort of DB
-   * @param dbUrl URL of DB
    * @throws Exception if any error occurs when setting up RCU database
    */
 
-  private static void setupDBandRCUschemaBySample(String dbImage, String fmwImage,
-       String rcuSchemaPrefix, String dbNamespace, int dbPort, String dbUrl) throws ApiException {
+  private static void setupDBBySample(String dbImage, String fmwImage,
+       String dbNamespace, int dbPort) throws ApiException {
     LoggingFacade logger = getLogger();
 
     setupSample();
@@ -376,10 +406,6 @@ private static void setupDBandRCUschemaBySample(String dbImage, String fmwImage,
     logger.info("Start Oracle DB with dbImage: {0}, dbPort: {1}, dbNamespace: {2}",
         dbImage, dbPort, dbNamespace);
     startOracleDB(dbImage, dbPort, dbNamespace);
-    logger.info("Create RCU schema with fmwImage: {0}, rcuSchemaPrefix: {1}, dbUrl: {2}, "
-        + " dbNamespace: {3}:", fmwImage, rcuSchemaPrefix, dbUrl, dbNamespace);
-    createRcuSchema(fmwImage, rcuSchemaPrefix, dbUrl, dbNamespace);
-
   }
 
   /**

integration-tests/src/test/java/oracle/weblogic/kubernetes/ItWlsSamples.java

@@ -41,6 +41,7 @@
 import static oracle.weblogic.kubernetes.assertions.TestAssertions.domainExists;
 import static oracle.weblogic.kubernetes.assertions.TestAssertions.pvExists;
 import static oracle.weblogic.kubernetes.assertions.TestAssertions.pvcExists;
+import static oracle.weblogic.kubernetes.assertions.TestAssertions.secretExists;
 import static oracle.weblogic.kubernetes.utils.CommonTestUtils.checkClusterReplicaCountMatches;
 import static oracle.weblogic.kubernetes.utils.CommonTestUtils.checkPodDoesNotExist;
 import static oracle.weblogic.kubernetes.utils.CommonTestUtils.checkPodExists;
@@ -125,9 +126,8 @@ public static void initAll(@Namespaces(2) List<String> namespaces) {
   }
 
   /**
-   * Test domain in image samples using domains created by wlst and wdt.
+   * Test domain in image samples using domains created by image tool using wlst and wdt.
    *
-   * @param model domain name and script type to create domain. Acceptable values of format String:wlst|wdt
    */
   @Order(1)
   @ParameterizedTest
@@ -158,20 +158,23 @@ public void testSampleDomainInImage(String model) {
       replaceStringInFile(Paths.get(sampleBase.toString(), "create-domain-inputs.yaml").toString(),
               "#image:",
               "image: " + imageName);
+    });
 
-      if (script.equalsIgnoreCase("wdt")) {
+    if (script.equals("wlst")) {
+      assertDoesNotThrow(() -> {
         replaceStringInFile(Paths.get(sampleBase.toString(), "create-domain-inputs.yaml").toString(),
-                "domainHomeImageBuildPath: ./docker-images/OracleWebLogic/samples/12213-domain-home-in-image",
-                "domainHomeImageBuildPath: ./docker-images/OracleWebLogic/samples/12213-domain-home-in-image-wdt");
-      }
-    });
+            "mode: wdt",
+            "mode: wlst");
+      });
+    }
 
     // build the command to run create-domain.sh
     String additonalOptions = " -u "
             + ADMIN_USERNAME_DEFAULT
             + " -p "
             + ADMIN_PASSWORD_DEFAULT;
 
+
     String[] additonalStr = {additonalOptions, imageName};
 
     // run create-domain.sh to create domain.yaml file, run kubectl to create the domain and verify
@@ -197,6 +200,14 @@ public void testSampleDomainInPv(String model) {
 
     //copy the samples directory to a temporary location
     setupSample();
+    String secretName = domainName + "-weblogic-credentials";
+    if (!secretExists(secretName, domainNamespace)) {
+      createSecretWithUsernamePassword(
+          secretName,
+          domainNamespace,
+          ADMIN_USERNAME_DEFAULT,
+          ADMIN_PASSWORD_DEFAULT);
+    }
     //create PV and PVC used by the domain
     createPvPvc(domainName);