Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor(eos_designs)!: Change default descriptions for connected endpoints and network ports #4457

Conversation

ClausHolbechArista
Copy link
Contributor

@ClausHolbechArista ClausHolbechArista commented Sep 12, 2024

Change Summary

Change default descriptions for connected endpoints and network ports

Component(s) name

arista.avd.eos_designs

Proposed changes

  • Adding new consistent default descriptions for connected endpoints where the type is added first in upper case. Like SERVER_<server_name>_<server_port>
  • Add templating support for the description key under connected endpoints and network ports
  • Add templating support for the descriptions[] key under connected endpoints
  • Add keys with default templates:
    • default_connected_endpoints_description
    • default_connected_endpoints_port_channel_description
    • default_network_ports_description
    • default_network_ports__port_channel_description
  • Add endpoint key to network_ports
  • Add endpoint_port_channel under port_channel for both network_ports and connected endpoints.
  • Updated porting guide

How to test

  • Update molecule scenarios and examples
  • Verified that custom description logic still works in unit tests for templates and python module
  • Verified that custom description logic still works in evpn_underlay_ebgp_overlay_ebgp for python module

Checklist

User Checklist

  • N/A

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)

Copy link

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-4457
# Activate the virtual environment
source test-avd-pr-4457/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/ClausHolbechArista/avd.git@refactor/eos_designs/connected-endpoints-descriptions#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/ClausHolbechArista/avd.git#/ansible_collections/arista/avd/,refactor/eos_designs/connected-endpoints-descriptions --force
# Optional: Install AVD examples
cd test-avd-pr-4457
ansible-playbook arista.avd.install_examples

@github-actions github-actions bot added type: documentation Improvements or additions to documentation state: CI Updated CI scenario have been updated in the PR state: Documentation role Updated role: eos_designs issue related to eos_designs role state: conflict PR with conflict labels Sep 12, 2024
Copy link

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@ClausHolbechArista ClausHolbechArista force-pushed the refactor/eos_designs/connected-endpoints-descriptions branch from d7d1fdf to fc03c97 Compare September 17, 2024 06:04
@ClausHolbechArista ClausHolbechArista marked this pull request as ready for review September 17, 2024 06:04
@ClausHolbechArista ClausHolbechArista requested review from a team as code owners September 17, 2024 06:04
Copy link

Conflicts have been resolved. A maintainer will review the pull request shortly.

@github-actions github-actions bot removed the state: conflict PR with conflict label Sep 17, 2024
Copy link
Contributor

@gmuloc gmuloc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

quick comments - will review the rest afterwards

@ClausHolbechArista ClausHolbechArista added this to the v5.0.0 milestone Sep 18, 2024
Copy link
Contributor

@gmuloc gmuloc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For network ports the fact that we use endpoints instead of description make some change for the peer key and hence the fabric doc that could have an impact on users relying upon it in AVD 4.x though I think the change makes sense.

@github-actions github-actions bot added the state: conflict PR with conflict label Sep 18, 2024
Copy link

This pull request has conflicts, please resolve those before we can evaluate the pull request.

Copy link
Contributor

@gmuloc gmuloc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM once conflicts are resolved (by regenerating the files)

@github-actions github-actions bot removed the state: conflict PR with conflict label Sep 19, 2024
Copy link

Conflicts have been resolved. A maintainer will review the pull request shortly.

@ClausHolbechArista ClausHolbechArista requested a review from a team September 19, 2024 12:25
@ClausHolbechArista ClausHolbechArista added the one approval This PR has one approval and is only missing one more. label Sep 19, 2024
@github-actions github-actions bot added the state: conflict PR with conflict label Sep 20, 2024
Copy link

This pull request has conflicts, please resolve those before we can evaluate the pull request.

Copy link

Conflicts have been resolved. A maintainer will review the pull request shortly.

@github-actions github-actions bot removed the state: conflict PR with conflict label Sep 20, 2024
Copy link

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@github-actions github-actions bot added the state: conflict PR with conflict label Sep 20, 2024
@ClausHolbechArista ClausHolbechArista force-pushed the refactor/eos_designs/connected-endpoints-descriptions branch from 1df6790 to accdb1e Compare September 20, 2024 15:00
Copy link

Conflicts have been resolved. A maintainer will review the pull request shortly.

@github-actions github-actions bot removed the state: conflict PR with conflict label Sep 20, 2024
@philippebureau philippebureau self-requested a review September 20, 2024 19:18
@github-actions github-actions bot added the state: conflict PR with conflict label Sep 23, 2024
Copy link

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@carlbuchmann carlbuchmann force-pushed the refactor/eos_designs/connected-endpoints-descriptions branch from 0715fe4 to 06af788 Compare September 23, 2024 20:02
Copy link

Conflicts have been resolved. A maintainer will review the pull request shortly.

@github-actions github-actions bot removed the state: conflict PR with conflict label Sep 23, 2024
Copy link
Member

@carlbuchmann carlbuchmann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, please review updates to documentation before merging

Copy link

@ClausHolbechArista ClausHolbechArista merged commit 999801f into aristanetworks:devel Sep 24, 2024
40 checks passed
@ClausHolbechArista ClausHolbechArista deleted the refactor/eos_designs/connected-endpoints-descriptions branch September 27, 2024 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
one approval This PR has one approval and is only missing one more. rn: Refactor(eos_designs)! role: eos_designs issue related to eos_designs role state: CI Updated CI scenario have been updated in the PR state: Documentation role Updated type: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants