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): Deprecate design.type and combine default node_type_keys #4340

Conversation

ClausHolbechArista
Copy link
Contributor

@ClausHolbechArista ClausHolbechArista commented Aug 9, 2024

Change Summary

Deprecate design.type? and combine default node_type_keys`

Component(s) name

arista.avd.eos_designs

Proposed changes

The variable design.type is used to select between different variants of default values for node_type_keys.
In AVD 5.0.0 the default values of node_type_keys for the default design.type l3ls-evpn has been updated to combine all the default node type from all designs.
This means it is no longer needed to set the design.type.

The default node_type_keys for the default design l3ls-evpn has been extended with the following node types:

  • l2spine copied from the spine type of the l2ls design.
  • l3spine copied from the l2ls design.
  • rr, p and pe copied from the mpls design.

The leaf type used by the l2ls design is already covered by the l2leaf type in the l3ls-evpn design.

To migrate an existing inventory using the l2ls design, the following changes are needed:

# Remove the design.type setting
- design:
-   type: l2ls

# Replace the type 'spine' with 'l2spine'
- type: spine
+ type: l2spine

- spine:
+ l2spine:
    ...

# Replace type the 'leaf' with 'l2leaf'
- type: leaf
+ type: l2leaf

- leaf:
+ l2leaf:
    ...

How to test

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

github-actions bot commented Aug 9, 2024

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-4340
# Activate the virtual environment
source test-avd-pr-4340/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/ClausHolbechArista/avd.git@refactor/eos_designs/deprecate-design.type-and-combine-default-node_type_keys#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/deprecate-design.type-and-combine-default-node_type_keys --force
# Optional: Install AVD examples
cd test-avd-pr-4340
ansible-playbook arista.avd.install_examples

@github-actions github-actions bot added type: documentation Improvements or additions to documentation state: Documentation role Updated role: eos_designs issue related to eos_designs role labels Aug 9, 2024
@ClausHolbechArista ClausHolbechArista changed the title Refactor(eos_designs): Deprecate design.type? and combine default node_type_keys` Refactor(eos_designs): Deprecate design.type and combine default node_type_keys Aug 9, 2024
@github-actions github-actions bot added the state: CI Updated CI scenario have been updated in the PR label Aug 12, 2024
@ClausHolbechArista ClausHolbechArista marked this pull request as ready for review August 12, 2024 07:49
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

@carlbuchmann carlbuchmann requested a review from a team August 12, 2024 15:35
@ClausHolbechArista ClausHolbechArista added the one approval This PR has one approval and is only missing one more. label Aug 12, 2024
Copy link

sonarcloud bot commented Aug 13, 2024

@ClausHolbechArista ClausHolbechArista merged commit 74c5422 into aristanetworks:devel Aug 13, 2024
40 checks passed
jrecchia1029 pushed a commit to jrecchia1029/ansible-avd that referenced this pull request Aug 14, 2024
@ClausHolbechArista ClausHolbechArista deleted the refactor/eos_designs/deprecate-design.type-and-combine-default-node_type_keys branch August 20, 2024 11:25
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.

2 participants