Remove cluster replica count from domain resource file by default (#1147)

* Remove cluster replica count by default, provide target switch to enable

* Add comment for adding cluster replica count to domain resource file

* Revised unit test to set and test cluster replica count

Author: rakillen

core/src/main/python/wlsdeploy/tool/util/targets/additional_output_helper.py

@@ -54,6 +54,7 @@
 NAMESPACE = 'namespace'
 REPLICAS = 'replicas'
 RUNTIME_ENCRYPTION_SECRET = "runtimeEncryptionSecret"
+SET_CLUSTER_REPLICAS = "setClusterReplicas"
 USE_PERSISTENT_VOLUME = "usePersistentVolume"
 WEBLOGIC_CREDENTIALS_SECRET = 'webLogicCredentialsSecret'
 
@@ -195,6 +196,7 @@ def _build_template_hash(model, model_context, aliases, credential_injector):
         cluster_values = dictionary_utils.get_dictionary_element(cluster_list, cluster_name)
         server_count = k8s_helper.get_server_count(cluster_name, cluster_values, model.get_model())
         cluster_hash[REPLICAS] = str(server_count)
+        cluster_hash[SET_CLUSTER_REPLICAS] = target_configuration.sets_cluster_replicas()
         clusters.append(cluster_hash)
 
     template_hash[CLUSTERS] = clusters

core/src/main/python/wlsdeploy/tool/util/targets/output_file_helper.py

@@ -28,8 +28,10 @@
 SPEC = 'spec'
 
 WKO_DOMAIN_KIND = 'Domain'
+CLUSTERS = 'clusters'
 DOMAIN_HOME = 'domainHome'
 IMAGE_PULL_SECRETS = 'imagePullSecrets'
+REPLICAS = 'replicas'
 
 # specific to Verrazzano
 COMPONENT_KIND = 'Component'
@@ -264,12 +266,19 @@ def _add_comments(wko_dictionary):
     Add relevant comments to the output dictionary to provide additional information.
     :param wko_dictionary: the top-level WKO dictionary containing metadata, spec, etc.
     """
-    spec = dictionary_utils.get_element(wko_dictionary, SPEC)
-    if spec:
-        image_pull_secrets = dictionary_utils.get_element(spec, IMAGE_PULL_SECRETS)
-        if image_pull_secrets is not None and not len(image_pull_secrets):
-            message = exception_helper.get_message('WLSDPLY-01679')
-            spec.addComment(IMAGE_PULL_SECRETS, message)
+    spec = dictionary_utils.get_dictionary_element(wko_dictionary, SPEC)
+    image_pull_secrets = dictionary_utils.get_element(spec, IMAGE_PULL_SECRETS)
+    if image_pull_secrets is not None and not len(image_pull_secrets):
+        message = exception_helper.get_message('WLSDPLY-01679')
+        spec.addComment(IMAGE_PULL_SECRETS, message)
+
+    clusters = dictionary_utils.get_dictionary_element(spec, CLUSTERS)
+    for cluster in clusters:
+        cluster_replicas = dictionary_utils.get_element(cluster, REPLICAS)
+        if cluster_replicas is None and len(cluster):
+            last_key = cluster.keys()[-1]
+            message = exception_helper.get_message('WLSDPLY-01680')
+            cluster.addComment(last_key, REPLICAS + ': 99  # ' + message)
 
 
 def _get_or_create_dictionary(dictionary, key):

core/src/main/python/wlsdeploy/util/target_configuration.py

@@ -26,6 +26,9 @@
 # Determines the type of domain used
 DOMAIN_HOME_SOURCE_TYPE = "domain_home_source_type"
 
+# Determines if replica count is applied at the cluster level
+SET_CLUSTER_REPLICAS = "set_cluster_replicas"
+
 # put secret tokens in the model, and build a script to create the secrets.
 SECRETS_METHOD = 'secrets'
 
@@ -197,6 +200,14 @@ def get_domain_home_source_name(self):
         source_type = self._get_domain_home_source_type()
         return SOURCE_TYPE_NAMES[source_type]
 
+    def sets_cluster_replicas(self):
+        """
+        Return True if this configuration will calculate and apply replica counts at the cluster level.
+        :return: True if a replica counts are applied, False otherwise
+        """
+        result = dictionary_utils.get_element(self.config_dictionary, SET_CLUSTER_REPLICAS)
+        return result or False
+
     def validate_configuration(self, exit_code, target_configuration_file):
         validation_method = self.get_validation_method()
         self._validate_enumerated_field(VALIDATION_METHOD, validation_method, VALIDATION_METHODS, exit_code,

core/src/main/resources/oracle/weblogic/deploy/messages/wlsdeploy_rb.properties

@@ -321,6 +321,7 @@ WLSDPLY-01676=Unable to find section for update in target output file "{0}"
 WLSDPLY-01677=Expected a map value for {0} in the target output file {1}, skipping update
 WLSDPLY-01678=Expected a list value for {0} in the target output file {1}, skipping update
 WLSDPLY-01679=Add any credential secrets that are required to pull the image
+WLSDPLY-01680=Set a specific replica count for this cluster
 
 # wlsdeploy/util/enum.py
 WLSDPLY-01700=The value {0} is not a valid value of the Enum type {1}

core/src/main/targetconfigs/templates/vz-application.yaml

@@ -102,7 +102,9 @@ spec:
                                 values:
                                   - $(CLUSTER_NAME)
                           topologyKey: "kubernetes.io/hostname"
+{{#setClusterReplicas}}
               replicas: {{{replicas}}}
+{{/setClusterReplicas}}
 {{/clusters}}
 
           serverPod:

core/src/main/targetconfigs/templates/wko-domain.yaml

@@ -67,9 +67,11 @@ spec:
                       values:
                         - $(CLUSTER_NAME)
                 topologyKey: "kubernetes.io/hostname"
+{{#setClusterReplicas}}
 
     # The number of cluster member Managed Server instances to start for this WebLogic cluster
     replicas: {{{replicas}}}
+{{/setClusterReplicas}}
 {{/clusters}}
 
   configuration:

core/src/test/python/wlsdeploy/tool/extract/extract_test.py

@@ -8,6 +8,8 @@
 from base_test import BaseTestCase
 from wlsdeploy.aliases.aliases import Aliases
 from wlsdeploy.aliases.wlst_modes import WlstModes
+from wlsdeploy.json.json_translator import JsonToPython
+from wlsdeploy.json.json_translator import PythonToJson
 from wlsdeploy.logging.platform_logger import PlatformLogger
 from wlsdeploy.tool.extract.domain_resource_extractor import DomainResourceExtractor
 from wlsdeploy.util.model import Model
@@ -61,6 +63,12 @@ def testDefaultModel(self):
         Test that default values and information from the model
         are incorporated into the resulting domain resource file.
         """
+        # Configure the target to set cluster replicas
+        target_path = os.path.join(self.TEST_OUTPUT_DIR, 'config', 'targets', 'wko', 'target.json')
+        config = JsonToPython(target_path).parse()
+        config['set_cluster_replicas'] = True
+        PythonToJson(config).write_to_json_file(target_path)
+
         resource = self._extract_domain_resource('1')
 
         # clusters from topology should be in the domain resource file