Make domainUID optional and remove unneeded values from samples

Author: rjeberhard

kubernetes/samples/scripts/create-weblogic-domain/domain-home-in-image/create-domain.sh

@@ -285,11 +285,6 @@ function createFiles {
   echo Generating ${domainPropertiesOutput}
 
   cp ${domainPropertiesInput} ${domainPropertiesOutput}
-  sed -i -e "s:%DOMAIN_NAME%:${domainName}:g" ${domainPropertiesOutput}
-  sed -i -e "s:%ADMIN_PORT%:${adminPort}:g" ${domainPropertiesOutput}
-  sed -i -e "s:%ADMIN_SERVER_NAME%:${adminServerName}:g" ${domainPropertiesOutput}
-  sed -i -e "s:%MANAGED_SERVER_PORT%:${managedServerPort}:g" ${domainPropertiesOutput}
-  sed -i -e "s:%MANAGED_SERVER_NAME_BASE%:${managedServerNameBase}:g" ${domainPropertiesOutput}
   sed -i -e "s:%CONFIGURED_MANAGED_SERVER_COUNT%:${configuredManagedServerCount}:g" ${domainPropertiesOutput}
   sed -i -e "s:%CLUSTER_NAME%:${clusterName}:g" ${domainPropertiesOutput}
   sed -i -e "s:%PRODUCTION_MODE_ENABLED%:${productionModeEnabled}:g" ${domainPropertiesOutput}

kubernetes/samples/scripts/create-weblogic-domain/domain-home-in-image/domain-template.yaml

@@ -11,15 +11,7 @@ metadata:
   labels:
     weblogic.resourceVersion: domain-v2
     weblogic.domainUID: %DOMAIN_UID%
-    weblogic.domainName: %DOMAIN_NAME%
 spec:
-  # The domainUID must be unique across the entire Kubernetes Cluster.   Each WebLogic Domain must
-  # have its own unique domainUID.  This does not have to be the same as the Domain Name.  It is allowed
-  # to have multiple Domains with the same Domain Name, but they MUST have different domainUID's.
-  # The domainUID is also used to identify the Persistent Volume that belongs to/with this Domain.
-  domainUID: %DOMAIN_UID%
-  # The WebLogic Domain Name
-  domainName: %DOMAIN_NAME%
   # The WebLogic Domain Home
   domainHome: %DOMAIN_HOME%
   # If the domain home is in the image
@@ -32,10 +24,6 @@ spec:
   # how to create that Secret at the end of this file)
   adminSecret: 
     name: %WEBLOGIC_CREDENTIALS_SECRET_NAME%
-  # The name of the Admin Server
-  asName: "%ADMIN_SERVER_NAME%"
-  # The Admin Server's ListenPort
-  asPort: %ADMIN_PORT%
   # Whether to include the server out file into the pod's stdout, default is true
   includeServerOutInPodLog: %INCLUDE_SERVER_OUT_IN_POD_LOG%
   # serverStartPolicy legal values are "NEVER", "ALWAYS", "IF_NEEDED", or "ADMIN_ONLY"

kubernetes/samples/scripts/create-weblogic-domain/domain-home-on-pv/create-domain.sh

@@ -390,13 +390,10 @@ function createYamlFiles {
   sed -i -e "s:%WEBLOGIC_CREDENTIALS_SECRET_NAME%:${weblogicCredentialsSecretName}:g" ${dcrOutput}
   sed -i -e "s:%WEBLOGIC_IMAGE_PULL_SECRET_PREFIX%:${imagePullSecretPrefix}:g" ${dcrOutput}
   sed -i -e "s:%DOMAIN_UID%:${domainUID}:g" ${dcrOutput}
-  sed -i -e "s:%DOMAIN_NAME%:${domainName}:g" ${dcrOutput}
   sed -i -e "s:%DOMAIN_HOME%:${domainHome}:g" ${dcrOutput}
-  sed -i -e "s:%ADMIN_SERVER_NAME%:${adminServerName}:g" ${dcrOutput}
   sed -i -e "s:%WEBLOGIC_IMAGE%:${image}:g" ${dcrOutput}
   sed -i -e "s:%WEBLOGIC_IMAGE_PULL_POLICY%:${imagePullPolicy}:g" ${dcrOutput}
   sed -i -e "s:%WEBLOGIC_IMAGE_PULL_SECRET_NAME%:${imagePullSecretName}:g" ${dcrOutput}
-  sed -i -e "s:%ADMIN_PORT%:${adminPort}:g" ${dcrOutput}
   sed -i -e "s:%INITIAL_MANAGED_SERVER_REPLICAS%:${initialManagedServerReplicas}:g" ${dcrOutput}
   sed -i -e "s:%EXPOSE_T3_CHANNEL_PREFIX%:${exposeAdminT3ChannelPrefix}:g" ${dcrOutput}
   sed -i -e "s:%CLUSTER_NAME%:${clusterName}:g" ${dcrOutput}

kubernetes/samples/scripts/create-weblogic-domain/domain-home-on-pv/domain-template.yaml

@@ -12,15 +12,7 @@ metadata:
   labels:
     weblogic.resourceVersion: domain-v2
     weblogic.domainUID: %DOMAIN_UID%
-    weblogic.domainName: %DOMAIN_NAME%
 spec:
-  # The domainUID must be unique across the entire Kubernetes Cluster.   Each WebLogic Domain must
-  # have its own unique domainUID.  This does not have to be the same as the Domain Name.  It is allowed
-  # to have multiple Domains with the same Domain Name, but they MUST have different domainUID's.
-  # The domainUID is also used to identify the Persistent Volume that belongs to/with this Domain.
-  domainUID: %DOMAIN_UID%
-  # The WebLogic Domain Name
-  domainName: %DOMAIN_NAME%
   # The WebLogic Domain Home
   domainHome: %DOMAIN_HOME%
   # If the domain home is in the image
@@ -36,10 +28,6 @@ spec:
   # how to create that Secret at the end of this file)
   adminSecret: 
     name: %WEBLOGIC_CREDENTIALS_SECRET_NAME%
-  # The name of the Admin Server
-  asName: "%ADMIN_SERVER_NAME%"
-  # The Admin Server's ListenPort
-  asPort: %ADMIN_PORT%
   # Whether to include the server out file into the pod's stdout, default is true
   includeServerOutInPodLog: %INCLUDE_SERVER_OUT_IN_POD_LOG%
   # The in-pod name of the directory to store the domain, node manager, server logs, and server .out

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

@@ -12,6 +12,7 @@
 import io.kubernetes.client.models.V1SecretReference;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import javax.annotation.Nonnull;
 import javax.validation.Valid;
 import oracle.kubernetes.json.Description;
@@ -25,6 +26,11 @@
 /** Domain represents a WebLogic domain and how it will be realized in the Kubernetes cluster. */
 @SuppressWarnings("deprecation")
 public class Domain {
+  /** 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";
 
   /**
    * APIVersion defines the versioned schema of this representation of an object. Servers should
@@ -277,11 +283,12 @@ public V1SecretReference getAdminSecret() {
    * @return domain UID
    */
   public String getDomainUID() {
-    return spec.getDomainUID();
+    return spec.getDomainUID() != null ? spec.getDomainUID() : getMetadata().getName();
   }
 
   public String getLogHome() {
-    return spec.getLogHome();
+    return Optional.ofNullable(spec.getLogHome())
+        .orElse(String.format(LOG_HOME_DEFAULT_PATTERN, getDomainUID()));
   }
 
   public boolean isIncludeServerOutInPodLog() {
@@ -332,7 +339,12 @@ public Map<String, String> getChannelServiceAnnotations(String channel) {
    * @return volume claim
    */
   public String getPersistentVolumeClaimName() {
-    return spec.getPersistentVolumeClaimName();
+    return spec.getStorage() == null ? null : getConfiguredClaimName(spec.getStorage());
+  }
+
+  private String getConfiguredClaimName(@Nonnull DomainStorage storage) {
+    return Optional.ofNullable(storage.getPersistentVolumeClaimName())
+        .orElse(String.format(PVC_NAME_PATTERN, getDomainUID()));
   }
 
   /**

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

@@ -9,7 +9,6 @@
 import io.kubernetes.client.models.V1LocalObjectReference;
 import io.kubernetes.client.models.V1SecretReference;
 import java.util.*;
-import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import javax.validation.Valid;
 import javax.validation.constraints.NotNull;
@@ -27,14 +26,10 @@
 /** DomainSpec is a description of a domain. */
 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) */
-  @NotNull
+  /** Domain unique identifier. Must be unique across the Kubernetes cluster. */
+  @Description(
+      "Domain unique identifier. Must be unique across the Kubernetes cluster. (Not required)"
+          + "Defaults to the value of metadata.name")
   @Pattern("^[a-z0-9_.]{1,253}$")
   private String domainUID;
 
@@ -208,7 +203,8 @@ EffectiveConfigurationFactory getEffectiveConfigurationFactory(String resourceVe
   }
 
   /**
-   * Domain unique identifier. Must be unique across the Kubernetes cluster. (Required)
+   * Domain unique identifier. Must be unique across the Kubernetes cluster. (Not required) Defaults
+   * to the value of metadata.name
    *
    * @return domain UID
    */
@@ -217,7 +213,8 @@ public String getDomainUID() {
   }
 
   /**
-   * Domain unique identifier. Must be unique across the Kubernetes cluster. (Required)
+   * Domain unique identifier. Must be unique across the Kubernetes cluster. (Not required) Defaults
+   * to the value of metadata.name
    *
    * @param domainUID domain UID
    */
@@ -331,7 +328,7 @@ public void setImagePullSecrets(@Nullable List<V1LocalObjectReference> imagePull
    *     server .out files in.
    */
   String getLogHome() {
-    return Optional.ofNullable(logHome).orElse(String.format(LOG_HOME_DEFAULT_PATTERN, domainUID));
+    return logHome;
   }
 
   public void setLogHome(String logHome) {
@@ -466,20 +463,6 @@ public void setConfigOverrideSecrets(@Nullable List<String> overridesSecretNames
     this.configOverrideSecrets = overridesSecretNames;
   }
 
-  /**
-   * Returns the name of the persistent volume claim for the logs and PV-based domain.
-   *
-   * @return volume claim
-   */
-  String getPersistentVolumeClaimName() {
-    return storage == null ? null : getConfiguredClaimName(storage);
-  }
-
-  private String getConfiguredClaimName(@Nonnull DomainStorage storage) {
-    return Optional.ofNullable(storage.getPersistentVolumeClaimName())
-        .orElse(String.format(PVC_NAME_PATTERN, domainUID));
-  }
-
   @Nullable
   @Override
   protected String getServerStartPolicy() {

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

@@ -1343,14 +1343,14 @@ public void whenDomainHomeInImageSpecified_useValue() {
   public void whenLogHomeNotSet_useDefault() {
     configureDomain(domain);
 
-    assertThat(domain.getSpec().getLogHome(), equalTo("/shared/logs/uid1"));
+    assertThat(domain.getLogHome(), equalTo("/shared/logs/uid1"));
   }
 
   @Test
   public void whenLogHomeSet_useValue() {
     configureDomain(domain).withLogHome("/custom/logs");
 
-    assertThat(domain.getSpec().getLogHome(), equalTo("/custom/logs"));
+    assertThat(domain.getLogHome(), equalTo("/custom/logs"));
   }
 
   @Test

operator/src/main/java/oracle/kubernetes/operator/DomainProcessorImpl.java

@@ -482,19 +482,19 @@ public void dispatchDomainWatch(Watch.Response<Domain> item) {
     switch (item.type) {
       case "ADDED":
         d = item.object;
-        domainUID = d.getSpec().getDomainUID();
+        domainUID = d.getDomainUID();
         LOGGER.info(MessageKeys.WATCH_DOMAIN, domainUID);
         makeRightDomainPresence(new DomainPresenceInfo(d), true, false, true);
         break;
       case "MODIFIED":
         d = item.object;
-        domainUID = d.getSpec().getDomainUID();
+        domainUID = d.getDomainUID();
         LOGGER.info(MessageKeys.WATCH_DOMAIN, domainUID);
         makeRightDomainPresence(new DomainPresenceInfo(d), false, false, true);
         break;
       case "DELETED":
         d = item.object;
-        domainUID = d.getSpec().getDomainUID();
+        domainUID = d.getDomainUID();
         LOGGER.info(MessageKeys.WATCH_DOMAIN_DELETED, domainUID);
         makeRightDomainPresence(new DomainPresenceInfo(d), true, true, true);
         break;

operator/src/main/java/oracle/kubernetes/operator/DomainStatusUpdater.java

@@ -442,7 +442,7 @@ public NextAction apply(Packet packet) {
         madeChange = true;
       }
 
-      LOGGER.info(MessageKeys.DOMAIN_STATUS, dom.getSpec().getDomainUID(), status);
+      LOGGER.info(MessageKeys.DOMAIN_STATUS, dom.getDomainUID(), status);
       LOGGER.exiting();
 
       return madeChange == true
@@ -510,7 +510,7 @@ public NextAction apply(Packet packet) {
         }
       }
 
-      LOGGER.info(MessageKeys.DOMAIN_STATUS, dom.getSpec().getDomainUID(), status);
+      LOGGER.info(MessageKeys.DOMAIN_STATUS, dom.getDomainUID(), status);
       LOGGER.exiting();
 
       return madeChange == true
@@ -627,7 +627,7 @@ public NextAction apply(Packet packet) {
         madeChange = true;
       }
 
-      LOGGER.info(MessageKeys.DOMAIN_STATUS, dom.getSpec().getDomainUID(), status);
+      LOGGER.info(MessageKeys.DOMAIN_STATUS, dom.getDomainUID(), status);
       LOGGER.exiting();
       return madeChange == true
           ? doDomainUpdate(dom, info, packet, AvailableStep.this, getNext())
@@ -795,7 +795,7 @@ public NextAction apply(Packet packet) {
         madeChange = true;
       }
 
-      LOGGER.info(MessageKeys.DOMAIN_STATUS, dom.getSpec().getDomainUID(), status);
+      LOGGER.info(MessageKeys.DOMAIN_STATUS, dom.getDomainUID(), status);
       LOGGER.exiting();
 
       return madeChange == true

operator/src/main/java/oracle/kubernetes/operator/Main.java

@@ -534,7 +534,7 @@ public NextAction onSuccess(Packet packet, CallResponse<DomainList> callResponse
       Set<String> domainUIDs = new HashSet<>();
       if (callResponse.getResult() != null) {
         for (Domain dom : callResponse.getResult().getItems()) {
-          String domainUID = dom.getSpec().getDomainUID();
+          String domainUID = dom.getDomainUID();
           domainUIDs.add(domainUID);
           DomainPresenceInfo info =
               dpis.compute(