osism 0.20250616.0__py3-none-any.whl → 0.20250621.0__py3-none-any.whl

osism/tasks/conductor/sonic/sync.py

@@ -0,0 +1,190 @@
+# SPDX-License-Identifier: Apache-2.0
+
+"""Main SONiC synchronization function."""
+
+from loguru import logger
+
+from osism import utils
+from osism.tasks.conductor.netbox import get_nb_device_query_list_sonic
+from .bgp import calculate_minimum_as_for_group
+from .connections import find_interconnected_devices
+from .config_generator import generate_sonic_config, clear_all_caches
+from .constants import DEFAULT_SONIC_ROLES, SUPPORTED_HWSKUS
+from .exporter import save_config_to_netbox, export_config_to_file
+from .cache import clear_interface_cache, get_interface_cache_stats
+
+
+def sync_sonic(device_name=None, task_id=None, show_diff=True):
+    """Sync SONiC configurations for eligible devices.
+
+    Args:
+        device_name (str, optional): Name of specific device to sync. If None, sync all eligible devices.
+        task_id (str, optional): Task ID for output logging.
+        show_diff (bool, optional): Whether to show diffs when changes are detected. Defaults to True.
+
+    Returns:
+        dict: Dictionary with device names as keys and their SONiC configs as values
+    """
+    if device_name:
+        logger.info(f"Preparing SONIC configuration for device: {device_name}")
+    else:
+        logger.info("Preparing SONIC configuration files")
+
+    # Clear all caches at start of sync
+    clear_interface_cache()
+    clear_all_caches()
+    logger.debug("Initialized all caches for sync_sonic task")
+
+    # Dictionary to store configurations for all devices
+    device_configs = {}
+
+    logger.debug(f"Supported HWSKUs: {', '.join(SUPPORTED_HWSKUS)}")
+
+    devices = []
+
+    if device_name:
+        # When specific device is requested, fetch it directly
+        try:
+            device = utils.nb.dcim.devices.get(name=device_name)
+            if device:
+                # Check if device role matches allowed roles
+                if device.role and device.role.slug in DEFAULT_SONIC_ROLES:
+                    devices.append(device)
+                    logger.debug(
+                        f"Found device: {device.name} with role: {device.role.slug}"
+                    )
+                else:
+                    logger.warning(
+                        f"Device {device_name} has role '{device.role.slug if device.role else 'None'}' "
+                        f"which is not in allowed SONiC roles: {', '.join(DEFAULT_SONIC_ROLES)}"
+                    )
+                    return device_configs
+            else:
+                logger.error(f"Device {device_name} not found in NetBox")
+                return device_configs
+        except Exception as e:
+            logger.error(f"Error fetching device {device_name}: {e}")
+            return device_configs
+    else:
+        # Get device query list from NETBOX_FILTER_CONDUCTOR_SONIC
+        nb_device_query_list = get_nb_device_query_list_sonic()
+
+        for nb_device_query in nb_device_query_list:
+            # Query devices with the NETBOX_FILTER_CONDUCTOR_SONIC criteria
+            for device in utils.nb.dcim.devices.filter(**nb_device_query):
+                # Check if device role matches allowed roles
+                if device.role and device.role.slug in DEFAULT_SONIC_ROLES:
+                    devices.append(device)
+                    logger.debug(
+                        f"Found device: {device.name} with role: {device.role.slug}"
+                    )
+
+    logger.info(f"Found {len(devices)} devices matching criteria")
+
+    # Find interconnected spine/superspine groups for special AS calculation
+    spine_groups = find_interconnected_devices(devices, ["spine", "superspine"])
+    logger.info(f"Found {len(spine_groups)} interconnected spine/superspine groups")
+
+    # Create mapping from device ID to its assigned AS number
+    device_as_mapping = {}
+
+    # Calculate AS numbers for spine/superspine groups
+    for group in spine_groups:
+        min_as = calculate_minimum_as_for_group(group)
+        if min_as:
+            for device in group:
+                device_as_mapping[device.id] = min_as
+            logger.debug(
+                f"Assigned AS {min_as} to {len(group)} devices in spine/superspine group"
+            )
+
+    # Generate SONIC configuration for each device
+    for device in devices:
+        # Get HWSKU from sonic_parameters custom field, default to None
+        hwsku = None
+        if (
+            hasattr(device, "custom_fields")
+            and "sonic_parameters" in device.custom_fields
+            and device.custom_fields["sonic_parameters"]
+            and "hwsku" in device.custom_fields["sonic_parameters"]
+        ):
+            hwsku = device.custom_fields["sonic_parameters"]["hwsku"]
+
+        # Skip devices without HWSKU
+        if not hwsku:
+            logger.debug(f"Skipping device {device.name}: no HWSKU configured")
+            continue
+
+        logger.debug(f"Processing device: {device.name} with HWSKU: {hwsku}")
+
+        # Output current device being processed if task_id is available
+        if task_id:
+            utils.push_task_output(task_id, f"Processing device: {device.name}\n")
+
+        # Validate that HWSKU is supported
+        if hwsku not in SUPPORTED_HWSKUS:
+            logger.warning(
+                f"Device {device.name} has unsupported HWSKU: {hwsku}. Supported HWSKUs: {', '.join(SUPPORTED_HWSKUS)}"
+            )
+            continue
+
+        # Generate SONIC configuration based on device HWSKU
+        sonic_config = generate_sonic_config(device, hwsku, device_as_mapping)
+
+        # Store configuration in the dictionary
+        device_configs[device.name] = sonic_config
+
+        # Save the generated configuration to NetBox config context (only if changed)
+        if show_diff:
+            netbox_changed, diff_output = save_config_to_netbox(
+                device, sonic_config, return_diff=True
+            )
+
+            # Output diff to task if available and there are changes
+            if task_id and netbox_changed and diff_output:
+                utils.push_task_output(task_id, f"\n{'='*60}\n")
+                utils.push_task_output(
+                    task_id, f"Configuration diff for {device.name}:\n"
+                )
+                utils.push_task_output(task_id, f"{'='*60}\n")
+                utils.push_task_output(task_id, f"{diff_output}\n")
+                utils.push_task_output(task_id, f"{'='*60}\n\n")
+            elif task_id and netbox_changed and not diff_output:
+                # First-time configuration (no diff available)
+                utils.push_task_output(
+                    task_id, f"First-time configuration created for {device.name}\n"
+                )
+        else:
+            netbox_changed = save_config_to_netbox(device, sonic_config)
+
+        # Export the generated configuration to local file (only if changed)
+        file_changed = export_config_to_file(device, sonic_config)
+
+        if netbox_changed or file_changed:
+            logger.info(f"Configuration updated for device {device.name}")
+        else:
+            logger.info(f"No configuration changes for device {device.name}")
+
+        logger.info(
+            f"Generated SONiC config for device {device.name} with {len(sonic_config['PORT'])} ports"
+        )
+
+    logger.info(f"Generated SONiC configurations for {len(device_configs)} devices")
+
+    # Log cache statistics and cleanup
+    cache_stats = get_interface_cache_stats()
+    if cache_stats:
+        logger.debug(
+            f"Interface cache stats: {cache_stats['cached_devices']} devices, {cache_stats['total_interfaces']} interfaces"
+        )
+
+    clear_interface_cache()
+    clear_all_caches()
+    logger.debug("Cleared all caches after sync_sonic task completion")
+
+    # Finish task output if task_id is available
+    if task_id:
+        utils.finish_task_output(task_id, rc=0)
+
+    # Return the dictionary with all device configurations
+    return device_configs

{osism-0.20250616.0.dist-info → osism-0.20250621.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: osism
-Version: 0.20250616.0
+Version: 0.20250621.0
 Summary: OSISM manager interface
 Home-page: https://github.com/osism/python-osism
 Author: OSISM GmbH
@@ -32,7 +32,7 @@ Requires-Dist: cliff==4.10.0
 Requires-Dist: deepdiff==8.5.0
 Requires-Dist: docker==7.1.0
 Requires-Dist: dtrack-auditor==1.5.0
-Requires-Dist: fastapi==0.115.12
+Requires-Dist: fastapi==0.115.13
 Requires-Dist: flower==2.0.1
 Requires-Dist: hiredis==3.2.1
 Requires-Dist: jc==1.25.5

{osism-0.20250616.0.dist-info → osism-0.20250621.0.dist-info}/RECORD

@@ -2,11 +2,11 @@ osism/__init__.py,sha256=1UiNTBus0V0f2AbZQzAtVtu6zkfCCrw0OTq--NwFAqY,341
 osism/__main__.py,sha256=ILe4gu61xEISiBsxanqTQIdSkV-YhpZXTRlguCYyssk,141
 osism/api.py,sha256=t3HebSzk6fyY7bLJD9P95oEL1qWYXzpX6Yk1o_nVkMo,4356
 osism/main.py,sha256=Dt2-9sLXcS-Ny4DAz7hrha-KRc7zd7BFUTRdfs_X8z4,893
-osism/settings.py,sha256=mm94E4FZtyhkA4G7m6BVfl56UOdzRAUUMvgRH-YPdIU,1706
+osism/settings.py,sha256=bebPBT6Hd1-KhJfwZdFR-s8eMwV4B1IFr-WrQBkOrWw,1786
 osism/actions/__init__.py,sha256=bG7Ffen4LvQtgnYPFEpFccsWs81t4zqqeqn9ZeirH6E,38
 osism/commands/__init__.py,sha256=Ag4wX_DCgXRdoLn6t069jqb3DdRylsX2nyYkiyCx4uk,456
 osism/commands/apply.py,sha256=q645f4qxmOAaUjVD7npzM2aNuOqfptVAkCLfE6x5IV8,16833
-osism/commands/baremetal.py,sha256=trIZA-NNylP_PHGr_YtyzoMYTZ9YlJGNY14HObR6oZY,9635
+osism/commands/baremetal.py,sha256=w1LyZDms-DtULsF_76JsauOYHc2tcvoMRP6F9dYby9E,10688
 osism/commands/compose.py,sha256=iqzG7mS9E1VWaLNN6yQowjOqiHn3BMdj-yfXb3Dc4Ok,1200
 osism/commands/compute.py,sha256=cgqXWJa5wAvn-7e3FWCgX6hie_aK0yrKRkcNzjLXwDY,25799
 osism/commands/configuration.py,sha256=sPe8b0dVKFRbr30xoeVdAnHbGwCwgUh0xa_Vzv5pSQQ,954
@@ -14,7 +14,7 @@ osism/commands/console.py,sha256=8BPz1hio5Wi6kONVAWFuSqkDRrMcLEYeFIY8dbtN6e4,321
 osism/commands/container.py,sha256=Fku2GaCM3Idq_FxExUtNqjrEM0XYjpVvXmueSVO8S_c,1601
 osism/commands/get.py,sha256=ryytjtXWmlMV0NucP5tGkMZu0nIlC4xVtjRk4iMZ06c,8967
 osism/commands/log.py,sha256=2IpYuosC7FZwwLvM8HmKSU1NRNIelVVYzqjjVMCrOJk,4072
-osism/commands/manage.py,sha256=WxUZEhylZj2IhydAe3BAr3S5ED6opG243skfSq5q41s,11971
+osism/commands/manage.py,sha256=FaO9dbYjNHYanS98-zC498bx26oU8E3loxCczH9mfKI,12751
 osism/commands/netbox.py,sha256=e65P0kWrjTLw2T9HZthxjDTIRa-KAHgSSJAlvVef7n4,7345
 osism/commands/noset.py,sha256=7zDFuFMyNpo7DUOKcNiYV8nodtdMOYFp5LDPcuJhlZ8,1481
 osism/commands/reconciler.py,sha256=jy07Qbl219e-WCtWbtV9zh49qHHCjDMm6oVTJM61k1A,1958
@@ -22,7 +22,7 @@ osism/commands/server.py,sha256=avmoOv5rjOi-fN2A-27cPwOtiy2Q2j6UFtCh3QrfWAI,7512
 osism/commands/service.py,sha256=A1lgAlGeCJpbFFqF55DRWPcCirIgpU0dzjzVLZ0mz3k,2649
 osism/commands/set.py,sha256=xLBi2DzbVQo2jb3-cOIE9In5UB3vFxquQJkDN-EsfhM,1425
 osism/commands/status.py,sha256=X-Rcj-XuNPDBoxsGkf96NswwpmTognxz1V6E2NX2ZgY,1997
-osism/commands/sync.py,sha256=GpOi45emZmAMZC8cDqHSBH2NmnWSBt5Z1M1g9ufE5rE,1316
+osism/commands/sync.py,sha256=jOg-g8NmVOkXBI6rOuiOx2WgUJc1PplLAAAwc0VuIfw,1919
 osism/commands/task.py,sha256=mwJJ7a71Lw3o_FX7j3rR0-NbPdPwMDOjbOAiiXE4uGc,543
 osism/commands/validate.py,sha256=E1n1kEo6h8J5c7Ns5OHpr0R7i4IU6uj08LE_gt3kBCg,3262
 osism/commands/vault.py,sha256=llaqNN8UH8t8cCu2KmdaURvprA4zeG6izCen_W7ulPs,2029
@@ -45,18 +45,27 @@ osism/tasks/kubernetes.py,sha256=VzXq_VrYU_CLm4cOruqnE3Kq2ydfO9glZ3p0bp3OYoc,625
 osism/tasks/netbox.py,sha256=g0gL5QImiRTHqixRxze7LfNqPth7cXqLzVWQDUJLDjE,5928
 osism/tasks/openstack.py,sha256=g15tCll5vP1pC6ysxRCTZxplsdGmXbxaCH3k1Qdv5Xg,6367
 osism/tasks/reconciler.py,sha256=6iC0EYxeGvitzU2NsRqQzUEDZWW6Il3jgq_IRTN0sZg,1855
-osism/tasks/conductor/__init__.py,sha256=EdMVbZgz6VgUDyPBuyBNvAYcyOnyPqOB9w0RCnBkB1M,1527
+osism/tasks/conductor/__init__.py,sha256=eBkisjRj0YRT0AArvuvpIHGNEqEijsNvR_55BuVX62I,1600
 osism/tasks/conductor/config.py,sha256=tvfuYNgvw0F_ZbvrjqnyHfrj3vF6z0zhsRtGNu-Lgvo,3410
-osism/tasks/conductor/ironic.py,sha256=A3eE-rUTvZYVyDbWxH44IWb1grpMuHyqx401NTbgY2o,16111
+osism/tasks/conductor/ironic.py,sha256=tIhKH5EWvqzjVtZr32du8_jiVDP_9mFgTkxBjmtEm6g,16487
 osism/tasks/conductor/netbox.py,sha256=5Nc7wrriDOtSuru1KDLt9QpA54vC7tXDPB2J0JP9GKo,11393
-osism/tasks/conductor/sonic.py,sha256=i-BsYSjjSTSqjuHJJX-ReX3qpGhCW-K7AXMivmPT9g4,56743
 osism/tasks/conductor/utils.py,sha256=-a0-pRuhV4Fjj0SgdgBqtRJtAdGdqck5pzfi6NYBApU,2338
+osism/tasks/conductor/sonic/__init__.py,sha256=oxTTl_MGK4iWK9uNDRNlULtGrDGCQHrlJZ04weh_Lh8,777
+osism/tasks/conductor/sonic/bgp.py,sha256=PC6gGI5bCj2PCXcNGyMV9-EdlJWDsYaodzxigmYSZvw,3088
+osism/tasks/conductor/sonic/cache.py,sha256=Asv2k3nLJejuq7iB0a_LyK8dEmJzypP9v3OHkNY3GwI,3438
+osism/tasks/conductor/sonic/config_generator.py,sha256=Z2i6SvKp27EI-dK9fkSDo51ghbIIqTgM7qK0-xJtVwU,35098
+osism/tasks/conductor/sonic/connections.py,sha256=NvRjwJv3NF3ry5Xe9qHzk7pQbfDQHYx_j3ATRMUs7gA,14244
+osism/tasks/conductor/sonic/constants.py,sha256=nfsiKV1I5iiXPAUzkZgnFPWuSB_oy8xg3gNEZjn1Hb4,2194
+osism/tasks/conductor/sonic/device.py,sha256=ZYJA0bQ8waKWStzWUPxbcwNWa2Z_hMB3pqs8aA_nxXA,2458
+osism/tasks/conductor/sonic/exporter.py,sha256=25L1vbi84ZQD0xNHNTWk-anTz5QRkGJskCECBkeGQw4,8882
+osism/tasks/conductor/sonic/interface.py,sha256=MM-HrYlVdh_5fYSKto_38DC4RcfzoqBGEYFxk-Tz760,32233
+osism/tasks/conductor/sonic/sync.py,sha256=Jh2xbBv_yyrEJZZZkZRIk7vH0WV-IS4CA-4qQp56I2U,7823
 osism/utils/__init__.py,sha256=gN5VtLJfrvyn6_snuTte7YR-vDygkpbORopIV8qSEsA,6064
-osism-0.20250616.0.dist-info/licenses/AUTHORS,sha256=DJIRsjyrFxKjFvmpUNDRDBS04nRiJ5B6FpKcDcfnoGM,36
-osism-0.20250616.0.dist-info/licenses/LICENSE,sha256=tAkwu8-AdEyGxGoSvJ2gVmQdcicWw3j1ZZueVV74M-E,11357
-osism-0.20250616.0.dist-info/METADATA,sha256=DmbIbFQ1sEtgTSaJLXHL4LJT-Ct5xG6RilqVfI86hOc,2903
-osism-0.20250616.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-osism-0.20250616.0.dist-info/entry_points.txt,sha256=76Aau13zOcw6oxx4Et4zKNgizjYFfk6yVmgKkLMUZJM,3291
-osism-0.20250616.0.dist-info/pbr.json,sha256=rbKigzydU2eCQu7Pxyea_Ov3W2Hweqk2_GOrTjdFnJA,47
-osism-0.20250616.0.dist-info/top_level.txt,sha256=8L8dsI9hcaGHsdnR4k_LN9EM78EhwrXRFHyAryPXZtY,6
-osism-0.20250616.0.dist-info/RECORD,,
+osism-0.20250621.0.dist-info/licenses/AUTHORS,sha256=oWotd63qsnNR945QLJP9mEXaXNtCMaesfo8ZNuLjwpU,39
+osism-0.20250621.0.dist-info/licenses/LICENSE,sha256=tAkwu8-AdEyGxGoSvJ2gVmQdcicWw3j1ZZueVV74M-E,11357
+osism-0.20250621.0.dist-info/METADATA,sha256=0nTzEqeDkHWwUyPJftfn6_Az0MP26rQjhMQNPffXkdM,2903
+osism-0.20250621.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+osism-0.20250621.0.dist-info/entry_points.txt,sha256=X1KbMeQim23k_lGGDFz8ldQIrdCrq8mKnFWgYrrEZI0,3469
+osism-0.20250621.0.dist-info/pbr.json,sha256=nvF1nN4eUUNsct1PT2Fq9FvN3QNGbPvpeeWGR0BjJjU,47
+osism-0.20250621.0.dist-info/top_level.txt,sha256=8L8dsI9hcaGHsdnR4k_LN9EM78EhwrXRFHyAryPXZtY,6
+osism-0.20250621.0.dist-info/RECORD,,

{osism-0.20250616.0.dist-info → osism-0.20250621.0.dist-info}/entry_points.txt

@@ -37,13 +37,16 @@ manage compute migrate = osism.commands.compute:ComputeMigrate
 manage compute migration list = osism.commands.compute:ComputeMigrationList
 manage compute start = osism.commands.compute:ComputeStart
 manage compute stop = osism.commands.compute:ComputeStop
+manage dnsmasq = osism.commands.manage:Dnsmasq
 manage flavors = osism.commands.manage:Flavors
 manage image clusterapi = osism.commands.manage:ImageClusterapi
 manage image octavia = osism.commands.manage:ImageOctavia
 manage images = osism.commands.manage:Images
+manage ironic = osism.commands.netbox:Ironic
 manage netbox = osism.commands.netbox:Manage
 manage server list = osism.commands.server:ServerList
 manage server migrate = osism.commands.server:ServerMigrate
+manage sonic = osism.commands.sync:Sonic
 manage volume list = osism.commands.volume:VolumeList
 netbox = osism.commands.netbox:Console
 noset bootstrap = osism.commands.noset:NoBootstrap
@@ -56,6 +59,7 @@ set bootstrap = osism.commands.set:Bootstrap
 set maintenance = osism.commands.set:Maintenance
 set vault password = osism.commands.vault:SetPassword
 sync configuration = osism.commands.configuration:Sync
+sync dnsmasq = osism.commands.manage:Dnsmasq
 sync facts = osism.commands.sync:Facts
 sync inventory = osism.commands.reconciler:Sync
 sync ironic = osism.commands.netbox:Ironic

osism-0.20250621.0.dist-info/licenses/AUTHORS

@@ -0,0 +1 @@
+Christian Berendt <berendt@osism.tech>

osism-0.20250621.0.dist-info/pbr.json

@@ -0,0 +1 @@
+{"git_version": "ed0a34c", "is_release": false}