Add new target environments wko-dii, wko-pv, vz-dii, vz-pv (#1076)

* Change exposed filters for existing targets to internal filters

* Add new target environments wko-dii, wko-pv, vz-dii, vz-pv

* Update unit test for additional filters

* Removed typos from model constants

* Corrected copyright

* Added volume information to PV templates for wko and vz

Author: rakillen

core/src/main/python/wlsdeploy/aliases/model_constants.py

@@ -338,10 +338,14 @@
 ACTION = 'Action'
 ACTIVE_TYPE = 'ActiveType'
 ARGUMENTS = 'Arguments'
+AUTO_MIGRATION_ENABLED = 'AutoMigrationEnabled'
+CANDIDATE_MACHINE = 'CandidateMachine'
+CANDIDATE_MACHINES_FOR_MIGRATABLE_SERVER = 'CandidateMachinesForMigratableServer'
 COMPONENT_TYPE = 'ComponentType'
 CONSTRAINED_CANDIDATE_SERVER = 'ConstrainedCandidateServer'
 CUSTOM_IDENTITY_KEYSTORE_FILE = 'CustomIdentityKeyStoreFileName'
 CUSTOM_TRUST_KEYSTORE_FILE = 'CustomTrustKeyStoreFileName'
+DATABASE_LESS_LEASING_BASIS = 'DatabaseLessLeasingBasis'
 DEPLOYMENT_ORDER = 'DeploymentOrder'
 DESTINATION_SERVER = 'DestinationServer'
 DRIVER_NAME = 'DriverName'
@@ -366,6 +370,7 @@
 LISTEN_ADDRESS = 'ListenAddress'
 LISTEN_PORT = 'ListenPort'
 MASKED_PASSWORD = '<Masked>'
+MIGRATION_BASIS = 'MigrationBasis'
 MIME_MAPPING_FILE = 'MimeMappingFile'
 NAME = 'Name'
 NOTIFICATION = 'Notification'

core/src/main/python/wlsdeploy/tool/util/filter_helper.py

@@ -1,5 +1,5 @@
 """
-Copyright (c) 2017, 2022, Oracle Corporation and/or its affiliates.  All rights reserved.
+Copyright (c) 2017, 2022, Oracle and/or its affiliates.
 Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl.
 """
 import imp
@@ -18,9 +18,16 @@
 TARGET_CONFIG_TOKEN = '@@TARGET_CONFIG_DIR@@'
 
 __id_filter_map = {
+    # groups that execute multiple filters
     'k8s_filter': wko_filter.filter_model,
-    'vz_filter': wko_filter.filter_model,
-    'wko_filter': wko_filter.filter_model
+    'vz_filter': wko_filter.filter_model_for_vz,
+    'wko_filter': wko_filter.filter_model_for_wko,
+
+    # individual filters for custom target environments
+    'online_attributes_filter': wko_filter.filter_online_attributes,
+    'resources_filter': wko_filter.filter_resources,
+    'topology_filter': wko_filter.filter_topology,
+    'server_ports_filter': wko_filter.check_clustered_server_ports
 }
 
 

core/src/main/python/wlsdeploy/tool/util/filters/wko_filter.py

@@ -4,16 +4,39 @@
 # ------------
 # Description:
 # ------------
-# WDT filters to prepare a model for use with WKO, using the createDomain or prepareModel tools.
+# WDT filters to prepare a model for use a target environment, using the createDomain or prepareModel tools.
 # These operations can be invoked as a single call, or independently of each other.
 from oracle.weblogic.deploy.util import PyRealBoolean
 from wlsdeploy.aliases import alias_utils
+from wlsdeploy.aliases.model_constants import AUTO_MIGRATION_ENABLED
 from wlsdeploy.aliases.model_constants import CALCULATED_LISTEN_PORTS
+from wlsdeploy.aliases.model_constants import CANDIDATE_MACHINE
+from wlsdeploy.aliases.model_constants import CANDIDATE_MACHINES_FOR_MIGRATABLE_SERVER
 from wlsdeploy.aliases.model_constants import CLUSTER
+from wlsdeploy.aliases.model_constants import CLUSTER_MESSAGING_MODE
+from wlsdeploy.aliases.model_constants import DATABASE_LESS_LEASING_BASIS
 from wlsdeploy.aliases.model_constants import DYNAMIC_SERVERS
 from wlsdeploy.aliases.model_constants import LISTEN_PORT
+from wlsdeploy.aliases.model_constants import MACHINE
+from wlsdeploy.aliases.model_constants import MIGRATION_BASIS
+from wlsdeploy.aliases.model_constants import NM_PROPERTIES
+from wlsdeploy.aliases.model_constants import NODE_MANAGER_PW_ENCRYPTED
+from wlsdeploy.aliases.model_constants import NODE_MANAGER_USER_NAME
+from wlsdeploy.aliases.model_constants import PARTITION
+from wlsdeploy.aliases.model_constants import PARTITION_WORK_MANAGER
+from wlsdeploy.aliases.model_constants import RESOURCES
+from wlsdeploy.aliases.model_constants import RESOURCE_GROUP
+from wlsdeploy.aliases.model_constants import RESOURCE_GROUP_TEMPLATE
+from wlsdeploy.aliases.model_constants import RESOURCE_MANAGEMENT
+from wlsdeploy.aliases.model_constants import RESOURCE_MANAGER
+from wlsdeploy.aliases.model_constants import SECURITY_CONFIGURATION
 from wlsdeploy.aliases.model_constants import SERVER
+from wlsdeploy.aliases.model_constants import SERVER_START
+from wlsdeploy.aliases.model_constants import SERVER_TEMPLATE
 from wlsdeploy.aliases.model_constants import TOPOLOGY
+from wlsdeploy.aliases.model_constants import UNIX_MACHINE
+from wlsdeploy.aliases.model_constants import VIRTUAL_HOST
+from wlsdeploy.aliases.model_constants import VIRTUAL_TARGET
 from wlsdeploy.aliases.validation_codes import ValidationCodes
 from wlsdeploy.aliases.wlst_modes import WlstModes
 from wlsdeploy.exception.expection_types import ExceptionType
@@ -33,10 +56,32 @@ def filter_model(model, model_context):
     :param model: the model to be filtered
     :param model_context: used by nested filters
     """
+    filter_topology(model, model_context)
+    filter_resources(model, model_context)
     filter_online_attributes(model, model_context)
     check_clustered_server_ports(model, model_context)
 
 
+def filter_model_for_wko(model, model_context):
+    """
+    Perform filtering operations on the specified model to prepare for WKO deployment.
+    Currently matches the general k8s target filtering.
+    :param model: the model to be filtered
+    :param model_context: used by nested filters
+    """
+    filter_model(model, model_context)
+
+
+def filter_model_for_vz(model, model_context):
+    """
+    Perform filtering operations on the specified model to prepare for Verrazzano deployment.
+    Currently matches the general k8s target filtering.
+    :param model: the model to be filtered
+    :param model_context: used by nested filters
+    """
+    filter_model(model, model_context)
+
+
 def filter_online_attributes(model, model_context):
     """
     Remove any online-only attributes from the specified model.
@@ -97,6 +142,64 @@ def check_clustered_server_ports(model, _model_context):
                 server_port_map[server_cluster] = {"firstServer": server_name, "serverPort": server_port_text}
 
 
+def filter_topology(model, _model_context):
+    """
+    Remove elements from the topology section of the model that are not relevant in a Kubernetes environment.
+    This includes references to machine and node manager elements.
+    :param model: the model to be updated
+    :param _model_context: unused, passed by filter_helper if called independently
+    """
+    topology = dictionary_utils.get_dictionary_element(model, TOPOLOGY)
+    for delete_key in [NM_PROPERTIES, VIRTUAL_TARGET, MACHINE, UNIX_MACHINE]:
+        if delete_key in topology:
+            del topology[delete_key]
+
+    clusters = dictionary_utils.get_dictionary_element(topology, CLUSTER)
+    for cluster in clusters:
+        for delete_key in [MIGRATION_BASIS, CANDIDATE_MACHINES_FOR_MIGRATABLE_SERVER, DATABASE_LESS_LEASING_BASIS,
+                           CLUSTER_MESSAGING_MODE]:
+            if delete_key in clusters[cluster]:
+                del clusters[cluster][delete_key]
+
+    servers = dictionary_utils.get_dictionary_element(topology, SERVER)
+    for server in servers:
+        for delete_key in [MACHINE, CANDIDATE_MACHINE, AUTO_MIGRATION_ENABLED, SERVER_START]:
+            if delete_key in servers[server]:
+                del servers[server][delete_key]
+
+    security_configuration = dictionary_utils.get_dictionary_element(topology, SECURITY_CONFIGURATION)
+    for delete_key in [NODE_MANAGER_USER_NAME, NODE_MANAGER_PW_ENCRYPTED]:
+        if delete_key in security_configuration:
+            del security_configuration[delete_key]
+
+    if (SECURITY_CONFIGURATION in topology) and not security_configuration:
+        del topology[SECURITY_CONFIGURATION]
+
+    server_templates = dictionary_utils.get_dictionary_element(topology, SERVER_TEMPLATE)
+    for key in server_templates:
+        server_template = server_templates[key]
+        auto_migration_enabled = server_template[AUTO_MIGRATION_ENABLED]
+        if auto_migration_enabled is None or alias_utils.convert_boolean(auto_migration_enabled):
+            server_template[AUTO_MIGRATION_ENABLED] = PyRealBoolean(False)
+        for delete_key in [SERVER_START]:
+            if delete_key in server_template:
+                del server_template[delete_key]
+
+
+def filter_resources(model, _model_context):
+    """
+    Remove elements from the resources section of the model that are not relevant in a Kubernetes environment.
+    This includes references to partitions and resource groups.
+    :param model: the model to be updated
+    :param _model_context: unused, passed by filter_helper if called independently
+    """
+    resources = dictionary_utils.get_dictionary_element(model, RESOURCES)
+    for delete_key in [PARTITION, PARTITION_WORK_MANAGER, RESOURCE_GROUP, RESOURCE_GROUP_TEMPLATE,
+                       RESOURCE_MANAGEMENT, RESOURCE_MANAGER, VIRTUAL_HOST]:
+        if delete_key in resources:
+            del resources[delete_key]
+
+
 class OnlineAttributeFilter(ModelTraverse):
     """
     Traverse the model and remove any online-only attributes.

core/src/main/targetconfigs/k8s/k8s_operator_filter.py

@@ -4,61 +4,11 @@
 # ------------
 # Description:
 # ------------
-#  This is a WDT filter for primordial domain creation. It filters out all resources and
-#  apps deployments, leaving only the domainInfo and admin server in topology.
-#
-from oracle.weblogic.deploy.util import PyRealBoolean
-from wlsdeploy.aliases import alias_utils
+#  This filter can be extended to prepare a model for deployment to a Kubernetes environment,
+#  using the the createDomain or prepareModel tools.
+#  For information about extending the filter, see the WebLogic Deployment Tooling documentation:
+#  https://oracle.github.io/weblogic-deploy-tooling/userguide/tools-config/model_filters/
 
 
 def filter_model(model):
-    __cleanup_topology(model)
-    __cleanup_resources(model)
-
-def __cleanup_resources(model):
-    if model and 'resources' in model:
-        resources = model['resources']
-
-        for delthis in [ 'PartitionWorkManager', 'Partition', 'ResourceGroup', 'ResourceGroupTemplate', 'VirtualHost',
-                     'ResourceManager', 'ResourceManagement' ]:
-            if resources.has_key(delthis):
-                del resources[delthis]
-
-def __cleanup_topology(model):
-    if model and 'topology' in model:
-        topology = model['topology']
-        for delthis in [ 'NMProperties', 'VirtualTarget', 'Machine', 'UnixMachine']:
-            if topology.has_key(delthis):
-                del topology[delthis]
-
-        if topology.has_key('Cluster'):
-            clusters = topology['Cluster']
-            for cluster in clusters:
-                for delthis in ['MigrationBasis', 'CandidateMachinesForMigratableServer', 'DatabaseLessLeasingBasis',
-                                'ClusterMessagingMode']:
-                    if clusters[cluster].has_key(delthis):
-                        del clusters[cluster][delthis]
-
-        if topology.has_key('Server'):
-            servers = topology['Server']
-            for server in servers:
-                for delthis in ['Machine', 'CandidateMachine', 'AutoMigrationEnabled', 'ServerStart']:
-                    if servers[server].has_key(delthis):
-                        del servers[server][delthis]
-
-        if topology.has_key('SecurityConfiguration'):
-            for delthis in ['NodeManagerPasswordEncrypted', 'NodeManagerUsername' ]:
-                if topology['SecurityConfiguration'].has_key(delthis):
-                    del topology['SecurityConfiguration'][delthis]
-            if len(topology['SecurityConfiguration'].keys()) == 0:
-                del topology['SecurityConfiguration']
-
-        if topology.has_key('ServerTemplate'):
-            server_templates = topology['ServerTemplate']
-            for server_template in server_templates:
-                auto_migration_enabled = server_templates[server_template]['AutoMigrationEnabled']
-                if auto_migration_enabled is None or alias_utils.convert_boolean(auto_migration_enabled):
-                    server_templates[server_template]['AutoMigrationEnabled'] = PyRealBoolean(False)
-                for delthis in ['ServerStart']:
-                    if server_templates[server_template].has_key(delthis):
-                        del server_templates[server_template][delthis]
+    pass

core/src/main/targetconfigs/vz-dii/target.json

@@ -0,0 +1,13 @@
+{
+    "model_filters" : {
+        "discover": [
+            { "id": "vz_filter" }
+        ]
+    },
+    "variable_injectors" : {"PORT": {},"HOST": {},"URL": {}},
+    "validation_method" : "lax",
+    "credentials_output_method" : "script",
+    "exclude_domain_bin_contents": true,
+    "additional_secrets": "runtime-encryption-secret",
+    "additional_output" : "vz-application.yaml"
+}