Merge pull request #550 from oracle/owls-69919-domain-resource-properties

Owls 69919 domain resource properties

Author: rjeberhard

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

@@ -37,7 +37,7 @@ protected DomainConfigurator(Domain domain) {
   /**
    * Sets the home for the domain.
    *
-   * @param home the home of the domain
+   * @param domainHome the home of the domain
    * @return this object
    */
   public DomainConfigurator withDomainHome(String domainHome) {
@@ -46,7 +46,7 @@ public DomainConfigurator withDomainHome(String domainHome) {
   }
 
   /**
-   * @param homeInImage
+   * @param domainHomeInImage
    * @return
    */
   public DomainConfigurator withDomainHomeInImage(boolean domainHomeInImage) {
@@ -110,6 +110,28 @@ public DomainConfigurator withDefaultImagePullSecrets(
     return this;
   }
 
+  /**
+   * Sets the log home value
+   *
+   * @param logHome the log home value
+   * @return this object
+   */
+  public DomainConfigurator withLogHome(String logHome) {
+    getDomainSpec().setLogHome(logHome);
+    return this;
+  }
+
+  /**
+   * Sets the log home enabled flag
+   *
+   * @param logHomeEnabled true if log home is enabled, false otherwise
+   * @return this object
+   */
+  public DomainConfigurator withLogHomeEnabled(boolean logHomeEnabled) {
+    getDomainSpec().setLogHomeEnabled(logHomeEnabled);
+    return this;
+  }
+
   /**
    * Configures the domain to use a persistent volume claim defined before the domain is created.
    *

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

@@ -34,6 +34,9 @@ public class DomainSpec extends BaseConfiguration {
   /** The pattern for computing the default persistent volume claim name. */
   private static final String PVC_NAME_PATTERN = "%s-weblogic-domain-pvc";
 
+  /** The pattern for computing the default shared logs directory. */
+  private static final String LOG_HOME_DEFAULT_PATTERN = "/shared/logs/%s";
+
   /** Domain unique identifier. Must be unique across the Kubernetes cluster. (Required) */
   @SerializedName("domainUID")
   @Expose
@@ -95,6 +98,19 @@ public class DomainSpec extends BaseConfiguration {
   @Expose
   private String logHome;
 
+  /**
+   * Whether the log home is enabled.
+   *
+   * @since 2.0
+   */
+  @SerializedName("logHomeEnabled")
+  @Expose
+  @Description(
+      "Specified whether the log home folder is enabled (Not required). "
+          + "Defaults to true if domainHomeInImage is false. "
+          + "Defaults to false if domainHomeInImage is true. ")
+  private Boolean logHomeEnabled; // Boolean object, null if unspecified
+
   /** Whether to include the server .out file to the pod's stdout. Default is true. */
   @SerializedName("includeServerOutInPodLog")
   @Expose
@@ -157,7 +173,9 @@ public class DomainSpec extends BaseConfiguration {
    */
   @SerializedName("domainHomeInImage")
   @Expose
-  private boolean domainHomeInImage;
+  @Description(
+      "Flag indicating whether the domain home is part of the image. Default value is true. ")
+  private boolean domainHomeInImage = true;
 
   /** The definition of the storage used for this domain. */
   @SerializedName("storage")
@@ -461,7 +479,7 @@ public void setImagePullSecrets(@Nullable List<V1LocalObjectReference> imagePull
    *     server .out files in.
    */
   public String getLogHome() {
-    return logHome;
+    return Optional.ofNullable(logHome).orElse(String.format(LOG_HOME_DEFAULT_PATTERN, domainUID));
   }
 
   public void setLogHome(String logHome) {
@@ -473,6 +491,29 @@ public DomainSpec withLogHome(String logHome) {
     return this;
   }
 
+  /**
+   * Log home enabled
+   *
+   * @since 2.0
+   * @return log home enabled
+   */
+  public boolean getLogHomeEnabled() {
+    if (logHomeEnabled == null) {
+      return !isDomainHomeInImage();
+    }
+    return logHomeEnabled.booleanValue();
+  }
+
+  /**
+   * Log home enabled
+   *
+   * @since 2.0
+   * @param logHomeEnabled log home enabled
+   */
+  public void setLogHomeEnabled(boolean logHomeEnabled) {
+    this.logHomeEnabled = new Boolean(logHomeEnabled);
+  }
+
   /**
    * Whether to include server .out to the pod's stdout
    *
@@ -641,6 +682,7 @@ public String toString() {
             .append("clusters", clusters)
             .append("replicas", replicas)
             .append("logHome", logHome)
+            .append("logHomeEnabled", logHomeEnabled)
             .append("includeServerOutInPodLog", includeServerOutInPodLog)
             .append("configOverrides", configOverrides)
             .append("configOverrideSecrets", configOverrideSecrets);
@@ -669,6 +711,7 @@ public int hashCode() {
             .append(clusters)
             .append(replicas)
             .append(logHome)
+            .append(logHomeEnabled)
             .append(includeServerOutInPodLog)
             .append(configOverrides)
             .append(configOverrideSecrets);
@@ -701,6 +744,7 @@ public boolean equals(Object other) {
             .append(clusters, rhs.clusters)
             .append(replicas, rhs.replicas)
             .append(logHome, rhs.logHome)
+            .append(logHomeEnabled, rhs.logHomeEnabled)
             .append(includeServerOutInPodLog, rhs.includeServerOutInPodLog)
             .append(configOverrides, rhs.configOverrides)
             .append(configOverrideSecrets, rhs.configOverrideSecrets);

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

@@ -1237,6 +1237,55 @@ public void whenDuplicateVolumeMountsConfiguredOnMultipleLevels_useCombination()
             volumeMount("name3", "/server-test1")));
   }
 
+  @Test
+  public void whenDefaultConfiguration_domainHomeInImage() {
+    configureDomain(domain);
+
+    assertThat(domain.getSpec().isDomainHomeInImage(), is(true));
+  }
+
+  @Test
+  public void whenDomainHomeInImageSpecified_useValue() {
+    configureDomain(domain).withDomainHomeInImage(false);
+
+    assertThat(domain.getSpec().isDomainHomeInImage(), is(false));
+  }
+
+  @Test
+  public void whenLogHomeNotSet_useDefault() {
+    configureDomain(domain);
+
+    assertThat(domain.getSpec().getLogHome(), equalTo("/shared/logs/uid1"));
+  }
+
+  @Test
+  public void whenLogHomeSet_useValue() {
+    configureDomain(domain).withLogHome("/custom/logs");
+
+    assertThat(domain.getSpec().getLogHome(), equalTo("/custom/logs"));
+  }
+
+  @Test
+  public void whenDomainHomeInImage_logHomeNotEnabled() {
+    configureDomain(domain).withDomainHomeInImage(true);
+
+    assertThat(domain.getSpec().getLogHomeEnabled(), is(false));
+  }
+
+  @Test
+  public void whenDomainHomeNotInImage_logHomeEnabled() {
+    configureDomain(domain).withDomainHomeInImage(false);
+
+    assertThat(domain.getSpec().getLogHomeEnabled(), is(true));
+  }
+
+  @Test
+  public void whenLogHomeEnabledSet_useValue() {
+    configureDomain(domain).withLogHomeEnabled(true);
+
+    assertThat(domain.getSpec().getLogHomeEnabled(), is(true));
+  }
+
   @Test
   public void domainHomeTest_standardHome2() {
     configureDomain(domain).withDomainHomeInImage(false);

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

@@ -254,7 +254,7 @@ public void whenDomainHasEnvironmentItemsWithVariables_createAdminPodStartupWith
     assertThat(
         getCreatedPodSpecContainer().getEnv(),
         allOf(
-            hasEnvVar("item1", "find uid1 at /shared/domains/uid1"),
+            hasEnvVar("item1", "find uid1 at /shared/domain"),
             hasEnvVar("item2", "ADMIN_SERVER is ADMIN_SERVER:7001")));
   }
 

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

@@ -46,7 +46,7 @@ public class ManagedPodHelperTest extends PodHelperTestBase {
   private static final String VALUE1 = "value1";
   private static final String VALUE2 = "value2";
   private static final String RAW_VALUE_1 = "find uid1 at $(DOMAIN_HOME)";
-  private static final String END_VALUE_1 = "find uid1 at /shared/domains/uid1";
+  private static final String END_VALUE_1 = "find uid1 at /shared/domain";
   private static final String RAW_VALUE_2 = "$(SERVER_NAME) is not $(ADMIN_NAME):$(ADMIN_PORT)";
   private static final String END_VALUE_2 = "ms1 is not ADMIN_SERVER:7001";
   private static final String CLUSTER_NAME = "test-cluster";

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

@@ -348,7 +348,7 @@ public void whenPodCreated_hasPredefinedEnvVariables() {
         getCreatedPodSpecContainer().getEnv(),
         allOf(
             hasEnvVar("DOMAIN_NAME", DOMAIN_NAME),
-            hasEnvVar("DOMAIN_HOME", "/shared/domains/" + UID),
+            hasEnvVar("DOMAIN_HOME", "/shared/domain"),
             hasEnvVar("ADMIN_NAME", ADMIN_SERVER),
             hasEnvVar("ADMIN_PORT", Integer.toString(ADMIN_PORT)),
             hasEnvVar("SERVER_NAME", getServerName()),
@@ -586,7 +586,7 @@ V1ObjectMeta createPodMetadata() {
         .putLabelsItem(RESOURCE_VERSION_LABEL, VersionConstants.DEFAULT_DOMAIN_VERSION)
         .putLabelsItem(LabelConstants.DOMAINUID_LABEL, UID)
         .putLabelsItem(LabelConstants.DOMAINNAME_LABEL, DOMAIN_NAME)
-        .putLabelsItem(LabelConstants.DOMAINHOME_LABEL, "/shared/domains/" + UID)
+        .putLabelsItem(LabelConstants.DOMAINHOME_LABEL, "/shared/domain")
         .putLabelsItem(LabelConstants.SERVERNAME_LABEL, getServerName())
         .putLabelsItem(LabelConstants.CREATEDBYOPERATOR_LABEL, "true");
   }
@@ -612,7 +612,7 @@ V1Container createPodSpecContainer() {
                 .readOnly(true))
         .command(createStartCommand())
         .addEnvItem(envItem("DOMAIN_NAME", DOMAIN_NAME))
-        .addEnvItem(envItem("DOMAIN_HOME", "/shared/domains/" + UID))
+        .addEnvItem(envItem("DOMAIN_HOME", "/shared/domain"))
         .addEnvItem(envItem("ADMIN_NAME", ADMIN_SERVER))
         .addEnvItem(envItem("ADMIN_PORT", Integer.toString(ADMIN_PORT)))
         .addEnvItem(envItem("SERVER_NAME", getServerName()))