Feat(eos_cli_config_gen): Adding new improved model for interface link tracking groups #4610

Vibhu-gslab · 2024-10-17T12:52:03Z

Change Summary

Introducing new model for link tracking group which supports only one direction for an interface

Related Issue(s)

Fixes #4584

Component(s) name

arista.avd.eos_cli_config_gen

Proposed changes

Adding a new model

How to test

Checklist

Repository Checklist

My code has been rebased from devel before I start
I have read the CONTRIBUTING document.
My change requires a change to the documentation and documentation have been updated accordingly.
I have updated molecule CI testing accordingly. (check the box if not applicable)

github-actions · 2024-10-17T12:52:19Z

Review docs on Read the Docs

To test this pull request:

# Create virtual environment for this testing below the current directory
python -m venv test-avd-pr-4610
# Activate the virtual environment
source test-avd-pr-4610/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/Vibhu-gslab/avd.git@4584#subdirectory=python-avd" --force
# Point Ansible collections path to the Python virtual environment
export ANSIBLE_COLLECTIONS_PATH=$VIRTUAL_ENV/ansible_collections
# Install Ansible collection
ansible-galaxy collection install git+https://github.com/Vibhu-gslab/avd.git#/ansible_collections/arista/avd/,4584 --force
# Optional: Install AVD examples
cd test-avd-pr-4610
ansible-playbook arista.avd.install_examples

python-avd/pyavd/_eos_cli_config_gen/schema/schema_fragments/ethernet_interfaces.schema.yml

ClausHolbechArista · 2024-10-18T05:50:50Z

...llections/arista/avd/molecule/eos_cli_config_gen/inventory/host_vars/ethernet-interfaces.yml

    link_tracking_groups:
-      - name: EVPN_MH_ES1
-        direction: upstream
+      direction: upstream
+      names: [EVPN_MH_ES1, EVPN_MH_ES2]


This would be a breaking change which cannot get merged until 6.0.0. Instead I think we could do:

link_tracking: direction: upstream groups: [EVPN_MH_ES1, EVPN_MH_ES2]

python-avd/pyavd/_eos_cli_config_gen/schema/schema_fragments/port_channel_interfaces.schema.yml

python-avd/pyavd/_eos_cli_config_gen/schema/schema_fragments/ethernet_interfaces.schema.yml

python-avd/pyavd/_eos_cli_config_gen/j2templates/eos/port-channel-interfaces.j2

python-avd/pyavd/_eos_cli_config_gen/j2templates/documentation/port-channel-interfaces.j2

MaheshGSLAB · 2024-10-18T09:11:37Z

python-avd/pyavd/_eos_cli_config_gen/j2templates/documentation/ethernet-interfaces.j2

@@ -334,6 +334,11 @@
 | {{ link_tracking_interface.name }} | {{ link_tracking_group.name }} | {{ link_tracking_group.direction }} |
 {%                 endif %}
 {%             endfor %}
+{%             if link_tracking_interface.link_tracking.direction is arista.avd.defined %}
+{%                 for group_name in link_tracking_interface.link_tracking.groups | arista.avd.natural_sort %}
+| {{ link_tracking_interface.name }} | {{ group_name }} | {{ link_tracking_interface.link_tracking.direction }} |


i think in new model we should join all group by comma and keep in one row only.
cc: @ClausHolbechArista

python-avd/pyavd/_eos_cli_config_gen/schema/schema_fragments/port_channel_interfaces.schema.yml

Shivani-gslab

LGTM!

ClausHolbechArista · 2024-11-06T09:53:38Z

python-avd/pyavd/_eos_cli_config_gen/j2templates/documentation/port-channel-interfaces.j2

+{%                 for group_name in link_tracking_interface.link_tracking.groups %}
+{%                     do link_tracking_group_name.append(group_name) %}
+| {{ link_tracking_interface.name }} | {{ link_tracking_group_name | join(', ') }} | {{ link_tracking_interface.link_tracking.direction }} |
+{%                 endfor %}


Suggested change

{% for group_name in link_tracking_interface.link_tracking.groups %}

{% do link_tracking_group_name.append(group_name) %}

| {{ link_tracking_interface.name }} | {{ link_tracking_group_name | join(', ') }} | {{ link_tracking_interface.link_tracking.direction }} |

{% endfor %}

| {{ link_tracking_interface.name }} | {{ link_tracking_interface.link_tracking.groups | join(', ') }} | {{ link_tracking_interface.link_tracking.direction }} |

ClausHolbechArista · 2024-11-06T09:54:31Z

python-avd/pyavd/_eos_cli_config_gen/j2templates/documentation/port-channel-interfaces.j2

 {%             for link_tracking_group in link_tracking_interface.link_tracking_groups | arista.avd.natural_sort('name') %}
 {%                 if link_tracking_group.name is arista.avd.defined and link_tracking_group.direction is arista.avd.defined %}
 | {{ link_tracking_interface.name }} | {{ link_tracking_group.name }} | {{ link_tracking_group.direction }} |
 {%                 endif %}
 {%             endfor %}
+{%             if link_tracking_interface.link_tracking.direction is arista.avd.defined %}


Suggested change

{% if link_tracking_interface.link_tracking.direction is arista.avd.defined %}

{% if link_tracking_interface.link_tracking.direction is arista.avd.defined and link_tracking_interface.link_tracking.group is arista.avd.defined %}

ClausHolbechArista · 2024-11-06T09:55:42Z

python-avd/pyavd/_eos_cli_config_gen/j2templates/documentation/ethernet-interfaces.j2

+{%             if link_tracking_interface.link_tracking.direction is arista.avd.defined %}
+{%                 for group_name in link_tracking_interface.link_tracking.groups | arista.avd.natural_sort('name') %}
+{%                     do link_tracking_group_name.append(group_name) %}
+| {{ link_tracking_interface.name }} | {{ link_tracking_group_name | join(', ') }} | {{ link_tracking_interface.link_tracking.direction }} |
+{%                 endfor %}
+{%             endif %}


Suggested change

{% if link_tracking_interface.link_tracking.direction is arista.avd.defined %}

{% for group_name in link_tracking_interface.link_tracking.groups | arista.avd.natural_sort('name') %}

{% do link_tracking_group_name.append(group_name) %}

| {{ link_tracking_interface.name }} | {{ link_tracking_group_name | join(', ') }} | {{ link_tracking_interface.link_tracking.direction }} |

{% endfor %}

{% endif %}

{% if link_tracking_interface.link_tracking.direction is arista.avd.defined and link_tracking_interface.link_tracking.groups is arista.avd.defined %}

| {{ link_tracking_interface.name }} | {{ link_tracking_interface.link_tracking.groups | join(', ') }} | {{ link_tracking_interface.link_tracking.direction }} |

{% endif %}

ClausHolbechArista · 2024-11-06T09:56:23Z

...lections/arista/avd/molecule/eos_cli_config_gen/documentation/devices/ethernet-interfaces.md

+| Ethernet1 | EVPN_MH_ES3 | upstream |
+| Ethernet1 | EVPN_MH_ES3, EVPN_MH_ES4 | upstream |


You can see duplicate entries here...

…irection in link tracking group for the same interface

sonarcloud · 2024-11-07T10:50:23Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

github-actions bot assigned Vibhu-gslab Oct 17, 2024

github-actions bot added role: eos_cli_config_gen issue related to eos_cli_config_gen role state: CI Updated CI scenario have been updated in the PR state: Documentation role Updated labels Oct 17, 2024

gmuloc reviewed Oct 17, 2024

View reviewed changes

python-avd/pyavd/_eos_cli_config_gen/schema/schema_fragments/ethernet_interfaces.schema.yml Outdated Show resolved Hide resolved

Vibhu-gslab force-pushed the 4584 branch from a3d5cbf to ce15958 Compare October 17, 2024 15:15

Vibhu-gslab changed the title ~~Refactor(eos_cli_config_gen, eos_designs): Change the data model to support only one direction in link tracking group for an interface~~ Refactor(eos_cli_config_gen, eos_designs): Link tracking group supports only one direction for an interface Oct 17, 2024

gmuloc added this to the v5.0.0 milestone Oct 17, 2024

ClausHolbechArista reviewed Oct 18, 2024

View reviewed changes

ClausHolbechArista removed this from the v5.0.0 milestone Oct 18, 2024

Shivani-gslab reviewed Oct 18, 2024

View reviewed changes

python-avd/pyavd/_eos_cli_config_gen/schema/schema_fragments/port_channel_interfaces.schema.yml Outdated Show resolved Hide resolved

Vibhu-gslab force-pushed the 4584 branch from ce15958 to 0d1ef8a Compare October 18, 2024 06:07

Vibhu-gslab changed the title ~~Refactor(eos_cli_config_gen, eos_designs): Link tracking group supports only one direction for an interface~~ Refactor(eos_cli_config_gen): Adding new model for link tracking group which supports only one direction for an interface Oct 18, 2024

MaheshGSLAB reviewed Oct 18, 2024

View reviewed changes

Shivani-gslab reviewed Oct 18, 2024

View reviewed changes

python-avd/pyavd/_eos_cli_config_gen/schema/schema_fragments/port_channel_interfaces.schema.yml Outdated Show resolved Hide resolved

Vibhu-gslab force-pushed the 4584 branch from d76483d to d84a7b5 Compare October 18, 2024 11:28

Vibhu-gslab marked this pull request as ready for review October 18, 2024 12:13

Vibhu-gslab requested review from a team as code owners October 18, 2024 12:13

Vibhu-gslab force-pushed the 4584 branch 4 times, most recently from 7931de7 to 8dcaeba Compare October 25, 2024 10:12

Vibhu-gslab force-pushed the 4584 branch 4 times, most recently from e8a709a to 389a713 Compare November 4, 2024 11:14

Shivani-gslab approved these changes Nov 4, 2024

View reviewed changes

Vibhu-gslab force-pushed the 4584 branch from 9574af8 to d39d597 Compare November 5, 2024 08:44

ClausHolbechArista requested changes Nov 6, 2024

View reviewed changes

ClausHolbechArista changed the title ~~Refactor(eos_cli_config_gen): Adding new model for link tracking group which supports only one direction for an interface~~ Feat(eos_cli_config_gen): Adding new improved model for interface link tracking groups Nov 6, 2024

Vibhu-gslab marked this pull request as draft November 6, 2024 11:20

Vibhu-gslab added 10 commits November 7, 2024 15:28

Refactore(eos_cli_config_gen): Change the model to support only one d…

50355a5

…irection in link tracking group for the same interface

fixing eos_designs code

dc985f2

reverting back the changes

42dcf86

adding new model for link tracking group

c6370cd

fixing errors

87bf6cd

addressing comments

5774461

removing min_length

be90176

adding items and fixing description

9b3c15e

addressing comment

653f52f

fixing doc comment

4beff5a

Vibhu-gslab force-pushed the 4584 branch from d39d597 to 4beff5a Compare November 7, 2024 09:58

addressing comments

7506a95

Vibhu-gslab marked this pull request as ready for review November 7, 2024 11:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat(eos_cli_config_gen): Adding new improved model for interface link tracking groups #4610

Feat(eos_cli_config_gen): Adding new improved model for interface link tracking groups #4610

Vibhu-gslab commented Oct 17, 2024 •

edited

Loading

github-actions bot commented Oct 17, 2024

ClausHolbechArista Oct 18, 2024

Vibhu-gslab Oct 18, 2024

MaheshGSLAB Oct 18, 2024

ClausHolbechArista Oct 29, 2024

Vibhu-gslab Nov 4, 2024

Shivani-gslab left a comment

ClausHolbechArista Nov 6, 2024

Vibhu-gslab Nov 7, 2024

ClausHolbechArista Nov 6, 2024

Vibhu-gslab Nov 7, 2024

ClausHolbechArista Nov 6, 2024

Vibhu-gslab Nov 7, 2024

ClausHolbechArista Nov 6, 2024

sonarcloud bot commented Nov 7, 2024

	{% if link_tracking_interface.link_tracking.direction is arista.avd.defined %}
	{% if link_tracking_interface.link_tracking.direction is arista.avd.defined and link_tracking_interface.link_tracking.group is arista.avd.defined %}

		\| Ethernet1 \| EVPN_MH_ES3 \| upstream \|
		\| Ethernet1 \| EVPN_MH_ES3, EVPN_MH_ES4 \| upstream \|

Feat(eos_cli_config_gen): Adding new improved model for interface link tracking groups #4610

Are you sure you want to change the base?

Feat(eos_cli_config_gen): Adding new improved model for interface link tracking groups #4610

Conversation

Vibhu-gslab commented Oct 17, 2024 • edited Loading

Change Summary

Related Issue(s)

Component(s) name

Proposed changes

How to test

Checklist

Repository Checklist

github-actions bot commented Oct 17, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Shivani-gslab left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarcloud bot commented Nov 7, 2024

Quality Gate passed

Vibhu-gslab commented Oct 17, 2024 •

edited

Loading