Initial MSD Support

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -76,12 +76,14 @@ body:
       label: Which section of the data model is this issue related to?
       multiple: false
       options:
+        - vxlan.fabric
         - vxlan.global
         - vxlan.topology
         - vxlan.underlay
-        - vxlan.overlay_services
+        - vxlan.overlay
         - vxlan.overlay_extensions
         - vxlan.policy
+        - vxlan.multisite
         - defaults.vxlan
         - other
     validations:

.github/ISSUE_TEMPLATE/documentation_report.yml

@@ -41,12 +41,14 @@ body:
       label: Which section of the data model is the documentation update related?
       multiple: false
       options:
+        - vxlan.fabric
         - vxlan.global
         - vxlan.topology
         - vxlan.underlay
-        - vxlan.overlay_services
+        - vxlan.overlay
         - vxlan.overlay_extensions
         - vxlan.policy
+        - vxlan.multisite
         - defaults.vxlan
         - other
     validations:

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -50,12 +50,14 @@ body:
       label: Which section of the data model is the new feature related?
       multiple: false
       options:
+        - vxlan.fabric
         - vxlan.global
         - vxlan.topology
         - vxlan.underlay
-        - vxlan.overlay_services
+        - vxlan.overlay
         - vxlan.overlay_extensions
         - vxlan.policy
+        - vxlan.multisite
         - defaults.vxlan
         - other
     validations:

.github/pull_request_template.md

@@ -16,12 +16,14 @@
 
 ## Related Data Model Element
 <!-- If a new element to the data model, please specify -->
+* [ ] vxlan.fabric
 * [ ] vxlan.global
 * [ ] vxlan.topology
 * [ ] vxlan.underlay
-* [ ] vxlan.overlay_services
+* [ ] vxlan.overlay
 * [ ] vxlan.overlay_extensions
 * [ ] vxlan.policy
+* [ ] vxlan.multisite
 * [ ] defaults.vxlan
 * [ ] other
 

README.md

@@ -50,10 +50,13 @@ Inside the [example repository](https://github.com/netascode/ansible-dc-vxlan-ex
 
 ```yaml
 # Control Parameters for 'Remove' role tasks
+child_fabric_delete_mode: false
 interface_delete_mode: false
 inventory_delete_mode: false
 link_fabric_delete_mode: false
 link_vpc_delete_mode: false
+multisite_network_delete_mode: false
+multisite_vrf_delete_mode: false
 network_delete_mode: false
 policy_delete_mode: false
 vpc_delete_mode: false
@@ -77,14 +80,17 @@ The following control variables are available in this collection.
 
 | Variable | Description | Default Value |
 | -------- | ------- | ------- |
+| `child_fabric_delete_mode` | Remove child fabric from MSD|MCF fabric as part of the remove role | `false` |
 | `force_run_all` | Force all roles in the collection to run | `false` | 
 | `interface_delete_mode` | Remove interface state as part of the remove role | `false` |
-| `network_delete_mode` | Remove network state as part of the remove role | `false` |
-| `vrf_delete_mode` | Remove vrf state as part of the remove role | `false` |
 | `inventory_delete_mode` | Remove inventory state as part of the remove role | `false` |
 | `link_vpc_delete_mode` | Remove vpc link state as part of the remove role | `false` |
-| `vpc_delete_mode` | Remove vpc pair state as part of the remove role | `false` |
+| `multisite_network_delete_mode` | Remove network state as part of the remove role for multisite (MSD and MCF) fabrics | `false` |
+| `multisite_vrf_delete_mode` | Remove vrf state as part of the remove role for multisite (MSD and MCF) fabrics | `false` |
+| `network_delete_mode` | Remove network state as part of the remove role | `false` |
 | `policy_delete_mode` | Remove policy state as part of the remove role | `false` |
+| `vrf_delete_mode` | Remove vrf state as part of the remove role | `false` |
+| `vpc_delete_mode` | Remove vpc pair state as part of the remove role | `false` |
 
 These variables are described in more detail in different sections of this document.
 

plugins/action/common/nac_dc_validate.py

@@ -29,15 +29,16 @@
 from ansible.errors import AnsibleError
 
 try:
-    import iac_validate.validator
     from iac_validate.yaml import load_yaml_files
+    import iac_validate.validator
     from iac_validate.cli.options import DEFAULT_SCHEMA
 except ImportError as imp_exc:
     IAC_VALIDATE_IMPORT_ERROR = imp_exc
 else:
     IAC_VALIDATE_IMPORT_ERROR = None
 
 import os
+from ...plugin_utils.helper_functions import data_model_key_check
 
 display = Display()
 
@@ -48,7 +49,6 @@ def run(self, tmp=None, task_vars=None):
         results = super(ActionModule, self).run(tmp, task_vars)
         results['failed'] = False
         results['msg'] = None
-        results['data'] = {}
 
         if IAC_VALIDATE_IMPORT_ERROR:
             raise AnsibleError('iac-validate not found and must be installed. Please pip install iac-validate.') from IAC_VALIDATE_IMPORT_ERROR
@@ -79,21 +79,72 @@ def run(self, tmp=None, task_vars=None):
         if schema == '':
             schema = DEFAULT_SCHEMA
 
-        validator = iac_validate.validator.Validator(schema, rules)
-        if schema:
-            validator.validate_syntax([mdata])
-        if rules:
-            validator.validate_semantics([mdata])
-
-        msg = ""
-        for error in validator.errors:
-            msg += error + "\n"
-
-        if msg:
-            results['failed'] = True
-            results['msg'] = msg
-
-        # Return Schema Validated Model Data
-        results['data'] = load_yaml_files([mdata])
+        rules_list = []
+        if rules and task_vars['role_path'] in rules:
+            # Load in-memory data model using iac-validate
+            # Perform the load in this if block to avoid loading the data model multiple times when custom enhanced rules are provided
+            results['data'] = load_yaml_files([mdata])
+
+            # Introduce common directory to the rules list by default once vrf and network rules are updated
+            # rules_to_run.append(f'{rules}common')
+            parent_keys = ['vxlan', 'fabric']
+            check = data_model_key_check(results['data'], parent_keys)
+            if 'fabric' in check['keys_found'] and 'fabric' in check['keys_data']:
+                if 'type' in results['data']['vxlan']['fabric']:
+                    if results['data']['vxlan']['fabric']['type'] in ('VXLAN_EVPN'):
+                        rules_list.append(f'{rules}vxlan/')
+                    elif results['data']['vxlan']['fabric']['type'] in ('MSD', 'MCF'):
+                        rules_list.append(f'{rules}multisite/')
+                    elif results['data']['vxlan']['fabric']['type'] in ('ISN', 'External'):
+                        rules_list.append(f'{rules}isn/')
+                    else:
+                        results['failed'] = True
+                        results['msg'] = f"vxlan.fabric.type {results['data']['vxlan']['fabric']['type']} is not a supported fabric type."
+                else:
+                    results['failed'] = True
+                    results['msg'] = "vxlan.fabric.type is not defined in the data model."
+            else:
+                # This else block is to be removed after the deprecation of vxlan.global.fabric_type
+                parent_keys = ['vxlan', 'global']
+                check = data_model_key_check(results['data'], parent_keys)
+                if 'global' in check['keys_found'] and 'global' in check['keys_data']:
+                    if 'fabric_type' in results['data']['vxlan']['global']:
+                        deprecated_msg = (
+                            "Attempting to use vxlan.global.fabric_type due to vxlan.fabric.type not being found. "
+                            "vxlan.global.fabric_type is being deprecated. Please use vxlan.fabric.type."
+                        )
+                        display.deprecated(msg=deprecated_msg, version='1.0.0', collection_name='cisco.nac_dc_vxlan')
+
+                        if results['data']['vxlan']['global']['fabric_type'] in ('VXLAN_EVPN'):
+                            rules_list.append(f'{rules}vxlan/')
+                        elif results['data']['vxlan']['global']['fabric_type'] in ('MSD', 'MCF'):
+                            rules_list.append(f'{rules}multisite/')
+                        elif results['data']['vxlan']['global']['fabric_type'] in ('ISN', 'External'):
+                            rules_list.append(f'{rules}isn/')
+                        else:
+                            results['failed'] = True
+                            results['msg'] = f"vxlan.fabric.type {results['data']['vxlan']['global']['fabric_type']} is not a supported fabric type."
+                    else:
+                        results['failed'] = True
+                        results['msg'] = "vxlan.fabric.type is not defined in the data model."
+        else:
+            # Else block to pickup custom enhanced rules provided by the user
+            rules_list.append(f'{rules}')
+
+        for rules_item in rules_list:
+            validator = iac_validate.validator.Validator(schema, rules_item)
+            if schema:
+                validator.validate_syntax([mdata])
+            if rules_item:
+                validator.validate_semantics([mdata])
+
+            msg = ""
+            for error in validator.errors:
+                msg += error + "\n"
+
+            if msg:
+                results['failed'] = True
+                results['msg'] = msg
+                break
 
         return results

plugins/action/common/prepare_plugins/prep_001_fabric.py

@@ -0,0 +1,142 @@
+# Copyright (c) 2024 Cisco Systems, Inc. and its affiliates
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy of
+# this software and associated documentation files (the "Software"), to deal in
+# the Software without restriction, including without limitation the rights to
+# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+# the Software, and to permit persons to whom the Software is furnished to do so,
+# subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+# SPDX-License-Identifier: MIT
+
+from ansible.utils.display import Display
+from ....plugin_utils.helper_functions import data_model_key_check
+
+display = Display()
+
+
+class PreparePlugin:
+    def __init__(self, **kwargs):
+        self.kwargs = kwargs
+        self.keys = []
+
+    def prepare(self):
+        model_data = self.kwargs['results']['model_extended']
+
+        # !!! WARNING !!!
+        # ------------------------------------------------------------------------------------------
+        # If you are debugging problems with the data model and sections are missing make sure
+        # you don't have any data files with only the toplevel vxlan: key.  This can cause problems
+        # where IaC validate removes sections of the model data, like the vxlan.underlay section
+        # ------------------------------------------------------------------------------------------
+
+        if not bool(model_data):
+            msg = 'Model data is empty! It is possible there is no data in host_vars or there'
+            msg += ' might be a bug in the model data.  Please check host_vars for this fabric.'
+            msg += ' Possible reasons: duplicate keys, unsupported keys, invalid yaml etc...'
+            self.kwargs['results']['failed'] = True
+            self.kwargs['results']['msg'] = msg
+            return self.kwargs['results']
+
+        # Checking for fabric key in the data model.
+        # This type of check should be done in a rule, but fabric.name and fabric.type are foundational for the collection so we need to ensure it is set.
+        # This prepare plugin also helps retain backwards compatibility with global.name and global.fabric_type keys previously used.
+        parent_keys = ['vxlan', 'fabric']
+        dm_check = data_model_key_check(model_data, parent_keys)
+        if 'fabric' in dm_check['keys_not_found'] or 'fabric' in dm_check['keys_no_data']:
+            deprecated_msg = (
+                "Attempting to use vxlan.global.name and vxlan.global.fabric_type due to "
+                "vxlan.fabric.name and vxlan.fabric.type not being defined. "
+                "vxlan.global.name and vxlan.global.fabric_type is being deprecated. Please use vxlan.fabric."
+            )
+            display.deprecated(msg=deprecated_msg, version="1.0.0", collection_name='cisco.nac_dc_vxlan')
+
+            parent_keys = ['vxlan', 'global']
+            dm_check = data_model_key_check(model_data, parent_keys)
+            if 'global' in dm_check['keys_found'] and 'global' in dm_check['keys_data']:
+                model_data['vxlan'].update({'fabric': {}})
+                parent_keys = ['vxlan', 'global', 'name']
+                dm_check = data_model_key_check(model_data, parent_keys)
+                if 'name' in dm_check['keys_found'] and 'name' in dm_check['keys_data']:
+                    model_data['vxlan']['fabric'].update({'name': model_data['vxlan']['global']['name']})
+                else:
+                    self.kwargs['results']['failed'] = True
+                    self.kwargs['results']['msg'] = "vxlan.global.name is not defined in the data model. Please set vxlan.fabric.name."
+
+                parent_keys = ['vxlan', 'global', 'fabric_type']
+                dm_check = data_model_key_check(model_data, parent_keys)
+                if 'fabric_type' in dm_check['keys_found'] and 'fabric_type' in dm_check['keys_data']:
+                    model_data['vxlan']['fabric'].update({'type': model_data['vxlan']['global']['fabric_type']})
+                else:
+                    self.kwargs['results']['failed'] = True
+                    self.kwargs['results']['msg'] = "vxlan.global.fabric_type is not defined in the data model. Please set vxlan.fabric.type."
+            else:
+                self.kwargs['results']['failed'] = True
+                self.kwargs['results']['msg'] = "vxlan.fabric is not set in the model data."
+
+        else:
+            # Prepare the data model to ensure vxlan.fabric.name is set
+            parent_keys = ['vxlan', 'fabric', 'name']
+            dm_check = data_model_key_check(model_data, parent_keys)
+            if 'name' in dm_check['keys_no_data'] or 'name' in dm_check['keys_not_found']:
+                deprecated_msg = (
+                    "Attempting to use vxlan.global.name due to vxlan.fabric.name not being defined. "
+                    "vxlan.global.name is being deprecated. Please use vxlan.fabric."
+                )
+                display.deprecated(msg=deprecated_msg, version="1.0.0", collection_name='cisco.nac_dc_vxlan')
+                parent_keys = ['vxlan', 'global', 'name']
+                dm_check = data_model_key_check(model_data, parent_keys)
+                if 'name' in dm_check['keys_data']:
+                    model_data['vxlan']['fabric'].update({'name': model_data['vxlan']['global']['name']})
+                else:
+                    self.kwargs['results']['failed'] = True
+                    self.kwargs['results']['msg'] = "vxlan.fabric.name is not defined in the data model."
+
+            # Prepare the data model to ensure vxlan.fabric.type is set
+            parent_keys = ['vxlan', 'fabric', 'type']
+            dm_check = data_model_key_check(model_data, parent_keys)
+            if 'type' in dm_check['keys_no_data'] or 'type' in dm_check['keys_not_found']:
+                deprecated_msg = (
+                    "Attempting to use vxlan.global.type due to vxlan.fabric.type not being defined. "
+                    "vxlan.global.type is being deprecated. Please use vxlan.fabric."
+                )
+                display.deprecated(msg=deprecated_msg, version="1.0.0", collection_name='cisco.nac_dc_vxlan')
+                parent_keys = ['vxlan', 'global', 'fabric_type']
+                dm_check = data_model_key_check(model_data, parent_keys)
+                if 'fabric_type' in dm_check['keys_data']:
+                    model_data['vxlan']['fabric'].update({'type': model_data['vxlan']['global']['fabric_type']})
+                else:
+                    self.kwargs['results']['failed'] = True
+                    self.kwargs['results']['msg'] = "vxlan.fabric.type is not defined in the data model."
+
+        # For backwards compatibility, replace 'overlay_services' key with 'overlay'
+        # NOTE: No prepare plugin, jinja2 template or ansible task should reference 'overlay_services' after this replacement.
+        # NOTE: Rules are different since rules run BEFORE prepare plugins
+        parent_keys = ['vxlan', 'overlay_services']
+        dm_check = data_model_key_check(model_data, parent_keys)
+        if 'overlay_services' in dm_check['keys_found']:
+            deprecated_msg = (
+                "vxlan.overlay_services is being deprecated. "
+                "Please use vxlan.overlay instead"
+            )
+            display.deprecated(msg=deprecated_msg, version="1.0.0", collection_name='cisco.nac_dc_vxlan')
+            model_data['vxlan']['overlay'] = model_data['vxlan']['overlay_services']
+            del model_data['vxlan']['overlay_services']
+
+        parent_keys = ['vxlan', 'multisite', 'overlay']
+        dm_check = data_model_key_check(model_data, parent_keys)
+        if 'multisite' in dm_check['keys_found'] and 'overlay' in dm_check['keys_found']:
+            model_data['vxlan']['overlay'] = model_data['vxlan']['multisite']['overlay']
+
+        self.kwargs['results']['model_extended'] = model_data
+        return self.kwargs['results']