Skip to content

Commit

Permalink
docs: updated CHANGELOG.rst and README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
viniarck committed Jun 7, 2024
1 parent 286d566 commit e843518
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ 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

Changed
=======
Expand Down
67 changes: 67 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,73 @@ Event published when an EVC active state changes due to a UNI going up or down
"uni_z": evc.uni_z.as_dict()}
}
kytos/mef_eline.failover_deployed
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Event published when an EVC failover_path gets deployed. ``flows`` are the new deployed flows, and ``removed_flows`` are the removed ones.

.. code-block:: python3
{
evc.id: {
"id", evc.id,
"evc_id": evc.id,
"name": evc.name,
"metadata": evc.metadata,
"active": evc._active,
"enabled": evc._enabled,
"uni_a": evc.uni_a.as_dict(),
"uni_z": evc.uni_z.as_dict(),
"flows": [],
"removed_flows": [],
"error_reason": string,
"current_path": evc.current_path.as_dict(),
}
}
kytos/mef_eline.failover_link_down
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Event published when an EVC failover_path switches over. ``flows`` are the new deployed flows.

.. code-block:: python3
{
evc.id: {
"id", evc.id,
"evc_id": evc.id,
"name": evc.name,
"metadata": evc.metadata,
"active": evc._active,
"enabled": evc._enabled,
"uni_a": evc.uni_a.as_dict(),
"uni_z": evc.uni_z.as_dict(),
"flows": [],
}
}
kytos/mef_eline.failover_old_path
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Event published when an EVC failover related old path gets removed (cleaned up). ``removed_flows`` are the removed flows.

.. code-block:: python3
{
evc.id: {
"id", evc.id,
"evc_id": evc.id,
"name": evc.name,
"metadata": evc.metadata,
"active": evc._active,
"enabled": evc._enabled,
"uni_a": evc.uni_a.as_dict(),
"uni_z": evc.uni_z.as_dict(),
"removed_flows": [],
"current_path": evc.current_path.as_dict(),
}
}
.. TAGs
Expand Down

0 comments on commit e843518

Please sign in to comment.