CHANGELOG.rst

Changelog

All notable changes to the MEF_ELine NApp will be documented in this file.

[UNRELEASED] - Under development

[2025.2.0] - 2026-02-02

Fixed

• set_queue action is now set before output
• Path tables now display link_name if available instead of ID
• UI: k-toolbar primary and secondary constraints are now collapsed again
• UI: Autocomplete no longer throws an error when typing in spaces
• Fixed undeploy EVC flows procedure, now it will remove all expected flows. It was leaving UNI flows behind if the link failure affected both current_path and failover_path
• Consistency check setting up failover paths is now distributed across multiple threads through the event bus.
• primary_path was not verified when only the UNIs were patched in an EVC.
• Patching an EVC no longer uses VLANs if the patch failed with invalid paths.
• Patching an EVC is no longer prone to errors if said EVC was being modified in another process at the same time.

Changed

• Internal refactoring updating UI components to use pinia and axios
• The redeploy button within the Circuit Details Menu was moved to the top of the menu for easier accessibility
• In EVCs flows where VLAN translation (numeric VLAN to untagged and different numeric VLANs) is performed, there is not longer qinq encapsulation applied. The translation will happen in the egress switch.
• UI: Table from View Connections has now sticky property. This means that the title of every column will always be on sight when scrolling vertically.
• UI: Table columns from View Connections are resizeable now. The cursor will change when hovering over the title of the column edges.
• UI: Path tables from Circuit Details now have accordion tables. At first only shows the links for each path which are collapsible to show details of the clicked link.
• UI: Changed matching system in the table from View Connections. Now every row will be displayed if it matches any filter entered specified.
• UI: Added strict matching in the table from View Connections. If a filter is checked, then only the rows that match the checked filters are going to be displayed.
• mef_eline now listens to kytos/topology.interface.(enabled|up|disabled|down) events to update affected EVCs.
• UI: Disabled unused inputs of UNI table.
• UI: Changed UNI table DPID row to ID.
• If a key from EVC_DEFAULT is not allowed, mef_eline will fail setup.

Added

• Filters can now search for multiple values at a time by using commas or spaces. If you type Switch1, Switch2, Switch3 or Switch1 Switch2 Switch3 or Switch1, Switch2, Switch3 into the filter/search-bar, then your search will include all 3 options, Switch1, Switch2, and Switch3.
• UI: integrated a dropdown to set INT proxy_port_enabled metadata option
• Added default values to EVCs from settings. They will be applied to created EVC if the key is not present in the request body. Allowed default keys are primary_constraints and secondary_constraints.

Fixed

• The "Back To List" button in the Circuit Details Menu will no longer delete saved EVC filters

Added

• Added a new dropdown to choose EVC endpoints by name

Added

• Circuit Details Menu now has a table for EVC metadata

[2025.1.0] - 2025-04-14

Fixed

• Try to handle uni interface up as link up for inter-EVCs
• EVCs activation now take into account UNIs statuses before trying to activate
• EVC.remove_current_flows() had its parameter current_path used when evc.current_path fails to install flows.
• evc.current_path is deleted when an error with TAG type is raised.
• Link up from UNI will deploy correctly an EVC when it does not have a path.
• Fixed Path choose_vlans to be all or nothing, if a path link fails to allocate a vlan, it'll release the allocated vlans.
• Validate paths from pathfinder with interface couples, in and out interfaces.
• DB controller now retries for ExecutionTimeout and ConnectionFailure instead of just AutoReconnect

Added

• Added migration script for updating the default queue_id from None to -1
• Added added paramenter support for redeployment, PATCH v2/evc/{evc_id}/redeploy?try_avoid_same_s_vlan=true. By default it will try to avoid s_vlan from current_path links.
• Added option to opt out from trying to avoid previous s_vlan when redeploying EVCs.
• Added option to analyze more paths when EVCs tries to find a valid path. This option is in a new patchable field in EVC document called max_paths.
• Added option to UI to set max_paths when creating and modifying an EVC.

Fixed

• UI: fixed issue where non-JSON data was being parsed as JSON data.
• UI: fixed issue were port numbers were not displaying within the Circuit Details info panel.
• Fixed inconsistencies with link down behaviour. Flows and vlan reservations should now be properly cleared on link down.

Changed

• UI: Removed the use of this.$set() since it was deprecated
• UI: changed variable name which was the reserved keyword interface to k_interface
• UI: changed the interface variable for k_interface since it was a reserved keyword
• UI: the mef_eline modal now uses the modal component
• UI: fixed premature submit when pressing Enter during autocomplete on inputs
• UI: fixed path constraints fields to be collabsed by default when creating EVC to better usability for listing EVCs
• primary_path, backup_path, primary_links and backup_links now only accept endpoint IDs in the API request content.
• Now when installing or deleting a path, a single request to flow_manager will be sent per path.
• UI: Added column Path Types to View Connections component to indicate if the EVC has a dynamic_backup_path, static_primary or static_backup value.
• When a link flap happens, now mef_eline will check on EVC attributes to decide whether to acquire an EVC lock.
• UI: The method onblur_dpid was changed to a computed property.
• Log now will notify if all paths for a current_path are invalid and suggest to increase max_paths.

[2024.1.4] - 2024-09-09

Fixed

• Catching error when searching for failover_path at kytos start.

[2024.1.3] - 2024-09-03

Fixed

• Fixed extra removed flows that were being published on event "failover_old_path"
• Fixed evc.old_path clean up

[2024.1.2] - 2024-08-26

Fixed

• Flows sent through an event are deep copies, meaning these can be modified from a subscriber NApp without affecting other subscribers.
• Added exception handler when getting path for disjointed paths.

[2024.1.1] - 2024-08-23

Fixed

• Fixed flow mods when deleting old_path

[2024.1.0] - 2024-07-23

Added

• EVC list now utilizes localStorage to store search_cols and make them persistent throughout EVC list usage.
• Added kytos/mef_eline.uni_active_updated event
• Included "id" on EVC mapped content to normalize it with the other models
• Introduced failover_old_path, failover_deployed, and failover_link_down events, which will be primarily consumed by telemetry_int NApp
• UI checkbox to request that In-band Network Telemetry (INT) gets enabled
• Added {"deployed": false} to request response for EVC creation. It indicates if the created EVC has been able to deployed.
• Added {'redeployed': false} to request response for PATCH v2/evc/{{circuit_id}}. It indicates if the modified EVC has been redeployed.

Changed

• Updated python environment installation from 3.9 to 3.11
• Optimized Path.status not to depend on a HTTP request
• Upgraded UI framework to Vue3
• enable is not longer accepted when patching/updating an EVC, using enabled instead.

Removed

• Removed client side batching with BATCH_INTERVAL and BATCH_SIZE, now replaced with pacing in flow_manager

Fixed

• Only redeploy when handling kytos/topology.link_up if a dynamic EVC isn't active
• Fixed possible EVCs duplication when constant delete requests are sent.
• Improved log when path was not deployed due to TAG availability. Also, in this case, the log was change to error instead of warning.
• Fixed node_name not showing in the EVC list and EVC details on the web interface.

Deprecated

• Deleted method from EVC class deploy_to() which was outdated and not used.
• Deleted unused method from Path class get_best_path().

[2023.2.0] - 2024-02-16

Added

• Added a UI button for redeploying an EVC.
• UNI tag_type are now accepted as string.
• Event kytos/mef_eline.evcs_loaded gets published during NApp setup
• EVCs now listen to switch.interface.(link_up|link_down|created|deleted) events for activation/deactivation
• Circuits with a vlan range are supported now. The ranges follows list[list[int]] format and both UNIs vlan should have the same ranges.
• Usage of special vlans "untagged" and "any" now send an event to each Interface.
• Added UNI_STATE_CHANGE_DELAY which configures the time for mef_eline to wait on link state flaps and update EVCs with last updated event.
• Added support for not_ownership to dynamic path constraints.
• Added support for not_ownership on main UI interface.

Changed

• EVCs will try to maintain their current_path on link status changes
• UNIs now will use and free tags from Interface.available_tags.
• UNI tag_type is changed to string from 1, 2 and 3 values to "vlan", "vlan_qinq" and "mpls" respectively.
• Add set_vlan only if UNI A vlan and UNI z vlan are different.
• Updated openapi.yml, Tag now can accept array as value.
• Updated UI interface to support list of ranges of VLANs.
• Improved log for invalid traces by adding From EVC(evc_id) named 'evc_name'
• An inactive and enabled EVC will be redeploy if an attribute from attributes_requiring_redeploy is updated.
• If a KytosEvent can't be put on buffers.app during setup(), it'll make the NApp to fail to start
• Disjointedness algorithm now takes into account switches, excepting the UNIs switches. Unwanted switches have the same value as the unwanted links.
• Archived EVCs are not longer kept in memory. They can only be found in the database.

Deprecated

• Deleted emition of kytos/.*.link_available_tags event. kytos/core.interface_tags event through Interface takes its place.

General Information

• scripts/vlan_type_string.py can be used to update the collection evcs by changing tag_type from integer to string.
• scripts/redeploy_evpls_same_vlans.py can be used to redeploy symmetric (same UNI vlans) EVPLs in batch.

Fixed

• required at least one circuit_id on POST v2/evc/metadata
• fixed race condition in failover_path when handling simultaneous Link Down events leading to inconsistencies on some EVC
• fixed sdntrace_cp check_trace current_path comparison with the expected UNI order
• fixed DynamicPathManager.get_paths return value when pathfinder returns a request error
• failover_path will get removed if it exists during a redeploy

[2023.1.0] - 2023-06-27

Added

• Added more content keys evc_id, name, metadata, active, enabled, uni_a, uni_z to events from mef_eline
• Added uni_a and uni_z to attributes_requiring_redeploy
• Added metadata to EVC schema
• Allow the creation of any and untagged EVC.
• Added API request POST /v2/evc/metadata to add metadata to EVCs
• Added API request DELETE /v2/evc/metadata/<key> to delete metadata from EVCs
• Subscribed to new event kytos/of_multi_table.enable_table as well as publishing kytos/mef_eline.enable_table required to set a different table_id to flows.
• Added settings.TABLE_GROUP_ALLOWED set containning the allowed table groups, for now 'evpl', 'epl' are supported.
• Added ui support for primary and secondary constraints
• Added QUEUE_ID to settings.py to be the default value for EVCs "queue_id"
• Exposed default SPF_ATTRIBUTE on settings.py, the default value is still "hop". This value will be parametrized whenever primary_constraints.spf_attribute or secondary_constraints.spf_attribute isn't set

Changed

• Moved request circuit k-button out of k-accordion-item since it's mandatory
• The traces being check rely on type: last to be considered valid.
• dl_vlan value is mapped to an integer in range [1, 4095] for the /traces requests to sdntrace_cp
• Augmented GET /v2/evc/ to accept parameters metadata.key=item
• Upgraded openapi-core to 0.16.6 from 0.14.5.
• Changed openapi.yml to be used as validation spec for request related methods updated(), create_schedule() and update_schedule().
• mef_eline now supports table group settings from of_multi_table
• Changed increasing amount of flows being sent, now it is fixed. Amount can be changed on settings.BATCH_SIZE
• Changed UI constraints default values to pass the spec validation
• Changed intra-switch EVC with a disabled switch or interface is not longer allowed to be created
• Adapted mef_eline to ordered endpoints in a link. Endpoints for flow creation are compared with switch ids to overcome ordered endpoint.
• EVCs UNI will be checked for disabled interfaces so the EVC is disabled as well.
• primary_constraints.spf_attribute and secondary_constraints.spf_attribute will only be set in the database if they've been set in the request.
• Changed UI spf_attribute to allow it to be default, meaning an unset value

General Information

• ./scripts/002_unset_spf_attribute.py is a script to unset both primary_constraints.spf_attribute and secondary_constraints.spf_attribute. On version 2022.3, this value was explicitly set, so you can use this script to unset this value if you want that spf_attribute follows the default settings.SPF_ATTRIBUTE value.
• @rest endpoints are now run by starlette/uvicorn instead of flask/werkzeug.
• Replaced @validate with @validate_openapi from kytos core

Fixed

• fixed minimum_flexible_hits EVC attribute to be persistent
• fixed attribute list for path constraints to include reliability
• fixed unnecessary redeploy of an intra-switch EVC on link up events
• fixed check_list_traces to work with the new version of SDN traces
• fixed updating EVC to be an intra-switch with invalid switch or interface
• fixed EVC UI list to sort VLAN A and VLAN Z fields to acts as number
• fixed non-redeployment of circuit when patching with {"queue_id":null}

[2022.3.1] - 2023-02-14

Added

• Added uni_a and uni_z to attributes_requiring_redeploy

Fixed

• fixed minimum_flexible_hits EVC attribute to be persistent
• fixed attribute list for path constraints to include reliability
• fixed unnecessary redeploy of an intra-switch EVC on link up events

[2022.3.0] - 2023-01-23

Added

• Added service_level EVC attribute to set the service network convergence level, the higher the better
• EVCs with higher service level priority will be handled first during network convergence, including when running sdntrace_cp consistency checks.
• Added support for constrained paths for primary dynamic paths and failover paths, primary_constraints and secondary_constraints can be set via API.
• Added service_level UI component on k-toolbar and made it editable.
• Added sb_priority UI component on k-toolbar.
• Added queue_id UI component on k-toolbar.
• Documented GET /v2/evc?archived query arg on openapi.yml
• Added flow_removed_at and updated_at parameters in EVC.
• Added execution_rounds in EVC to be used by the consistency check.
• Added logging message for link_up events.

Changed

• priority has been renamed to sb_priority (southbound priority), ./scripts/001_rename_priority.py can be used to update EVC documents accordingly
• GET /v2/evc?archived=true will only return archived EVCs
• k-toolbar UI component won't expose UNI tag type anymore, if a tag value is set, it'll assume it's tag type vlan.
• Consistency check uses the new PUT /traces endpoint from sdntrace_cp for bulk requests.
• Changed validation of EVCs. Will no longer check for disabled components on intra-switch EVCs.

Removed

• priority is no longer supported in the API spec

Fixed

• Removed the failover path after removing flows
• Removed failover flows when an EVC gets deleted
• Validated queue_id on POST /v2/evc
• Fixed found but unloaded message log attempt for archived EVCs
• Fixed EVC validation to catch nonexistent links interfaces
• Allowed primary_path to be empty on update when dynamic_backup_path is true and backup_path to be empty too
• Fixed bug with updates to intra-switch EVCs failing into an inconsistent state due to disabled components.

[2022.2.0] - 2022-08-12

Added

• Reintroduced Q-in-Q when creating the flows for an EVC.
• Optimize list of circuits filters
• Migrated persistency from kytos/storehouse to MongoDB (integration with pymongo)
• ELineController and DB models
• Retries to handle database AutoReconnect exception.
• DynamicPathManager.get_disjoint_paths to calculates the maximum disjoint paths from a given "unwanted_path" (typically the currently in use path) using the approach described in blueprint EP029
• Fully dynamic EVCs can now benefit from Failover Paths (failover_path), which improves significantly the convergence performance when facing link down
• Refactored Link Down handler to dispatch Kytos Events to handle traditional EVCs (EVCs that are not eligible for failover) more efficiently.

Changed

• DynamicPathManager.get_paths to also supports max_paths parameter and then request more paths from pathfinder (default to 2, which is also the default on pathfinder)

General Information

• scripts/storehouse_to_mongo.py can be used to migrate data from storehouse to MongoDB

[2022.1.5] - 2022-02-11

Fixed

• Adjust default value for settings.WAIT_FOR_OLD_PATH since now it measured in execution rounds instead of seconds

[2022.1.4] - 2022-02-11

Fixed

• Fix UI to keep kytos panel width with default value

[2022.1.3] - 2022-02-11

Fixed

• Fix UI to display the scrollbar in the autocomplete results list

[2022.1.2] - 2022-02-03

Fixed

• Fix UI to make tag fields optional and editable

[2022.1.1] - 2022-02-03

Fixed

• Fix UI list button not re-rendering the content

[2022.1.0] - 2022-01-31

Added

• Added utils notify_link_available_tags` function
• Publish kytos/mef_eline.link.available_tags event
• Hooked notify_link_available_tags when choosing or making vlans available

[2.6.0] - 2021-11-30

Added

• Parametrized force option as True when removing flows for reliability

[2.5.1] - 2021-05-28

Fixed

• Fixed UI to list and create EVCs
• Added locks to avoid race conditions

[2.5] - 2021-03-31

Added

• Queue ID can be defined when creating an EVC.
• Method to handle flow mod errors.
• Method to check if two EVCs have a common UNI.
• 2-byte prefix in cookie field.

Changed

• Deployment of EVCs loaded on startup delayed.
• Required versions of python packages updated.
• Removed user VLAN encapsulation.
• EVC id reduced from 16 to 14 bytes.

Fixed

• Thread locks when saving to the storehouse, avoiding race conditions.

[2.4] - 2020-07-23

Added

• Added EVC status check when deploying using schedule.
• Serialize circuit scheduler for storehouse.
• Fix VLAN availability on interfaces after using them.
• Documentation about delete method.
• Added '.travis.yml' to enable Travis CI.
• Added tags decorator to run tests by type and size.
• Install flows when UNIs are in the same switch.

Changed

• Updated HTTP return messages and codes when an error happens.
• Accept EVCs where UNI has no tag.
• Path status now return disabled state if any of its links is disabled.
• Updated method to get the shortest path, now it returns more paths.
• Changed enable/enabled to update _enabled attribute and activate/active to update _active attribute.
• Updated OpenApi Models description and documentation.

Deprecated

• Do not create a job when action is not create or remove.

Removed

• Removed dependencies.

Fixed

• Fixed enable on update EVCs.

[2.3.1] - 2019-03-15

Added

• Scrutinizer running after every push to GitHub repository.
• Linter checking all python code.

Fixed

• Fixed link up/down events from kytos/topology (#99 and #100).
• Load VLANs from storehouse (#101).
• Check path status using kytos/topology (#102).
• Fixed tests to mock call to get links from kytos/topology (#118).

[2.3.0] - 2018-12-14

Added

• Added more API documentation.
• Added EVC flow removal based on cookies.
• Added EVC deletion API method.

Fixed

• Fixed circuit not being deployed.
• Fixed current_path changes not being saved on storehouse (#85).
• Fixed storehouse always creating a new box (#91).
• Fixed handling of link up/down events.

[2.2.2] - 2018-10-15

Fixed

• Fixed error when creating a circuit with scheduling and without start_date

  (#79 and #80)

[2.2.1] - 2018-09-06

Added

• Added endpoint to allow update circuit informations.

• Added structure to support ci integration: unittests, linter, tox and scrutinizer.

• Added some tests for the class already created.

• Added some LinkProtection features: - Added method to handle when links goes up or end_maintenance. - Added method to handle when links goes down or under_maintenance. - When primary_path and backup_path goes down or under_maintenance and

  dynamic_backup_path is setted as True a dynamic path is choosed using the PathFinder NApp when the primary and backup path is both down or not setted.

  • When the primary_path is down and backup_path exists and is UP the circuit will change from primary_path to backup_path.
  • When the primary_path change from DOWN to UP the circuits will change to the primary_path.
  • When the circuit is disabled the circuit will not be deployed.
  • Added method to looking for links affected was created using the python set class to be more fast to find the links affected.

Changed

• Change deploy to use primary_path, backup_path or a dynamic_path.
• Improved the Schedule to use advanced python scheduler (APScheduler) library.

Thanks @ajoaoff for recommends this library. - The attribute circuit_scheduler in the EVC class should have some instances of CircuitScheduler, this instances will have the information about the scheduler informations.

Fixed

• Fixed the create circuit method when sending a invalid request
• Fixed some linter warnings.

[2.2.0] - 2018-06-15

Added

• Added EVC class to represent a circuit.
• Added Schedule class to schedule the circuit deploy.
• Added persistence with the NApp kytos/storehouse.

Changed

• Refactor main.py and models.py

Fixed

• Removed duplicated key in openapi.yml

[2.1.0] - 2018-04-20

Added

• Add Schedule class
• Add Mef-Eline component

Changed

• Update openapi.yml
• Update README.rst

[2.0.0] - 2018-03-09

Added

• New /evc endpoint.
• Future endpoint URLs.
• EPL and EVPL support, with VLANs in both endpoints.

Changed

• Method to install flows to the switches.
• List of links now represented by Link objects.

Removed

• Old /circuit endpoints.