Feat(eos_designs): Add platform match criteria for network_ports #4798
Conversation
|
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-4798
# Activate the virtual environment
source test-avd-pr-4798/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/kpbush30/avd.git@network_ports_4786#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/kpbush30/avd.git#/ansible_collections/arista/avd/,network_ports_4786 --force
# Optional: Install AVD examples
cd test-avd-pr-4798
ansible-playbook arista.avd.install_examples |
github-actions
bot
added
state: CI Updated
for more information, see https://pre-commit.ci
...ions/arista/avd/molecule/eos_designs_unit_tests/inventory/group_vars/NETWORK_PORTS_TESTS.yml
Show resolved
Hide resolved
python-avd/pyavd/_eos_designs/schema/schema_fragments/network_ports.schema.yml
Outdated
Show resolved
Hide resolved
...ions/arista/avd/molecule/eos_designs_unit_tests/inventory/group_vars/NETWORK_PORTS_TESTS.yml
Outdated
Show resolved
Hide resolved
| @@ -20,6 +20,18 @@ keys: | |||
| The regular expression must match the full hostname. | |||
| items: | |||
| type: str | |||
| platforms: | |||
There was a problem hiding this comment.
let's add a description on the network_ports stating that when switches and platforms are both set, then only devices matching both criteria will be configured.
There was a problem hiding this comment.
Added clarification in schema docs and in markdown above clarifying match criteria expectations.
| @@ -72,7 +72,9 @@ def _filtered_network_ports(self: AvdStructuredConfigConnectedEndpoints) -> list | |||
| for index, network_port in enumerate(self.inputs.network_ports): | |||
| network_port._context = f"network_ports[{index}]" | |||
| network_port_settings = self.shared_utils.get_merged_adapter_settings(network_port) | |||
| if not self._match_regexes(network_port_settings.switches, self.shared_utils.hostname): | |||
| if network_port_settings.switches and not self._match_regexes(network_port_settings.switches, self.shared_utils.hostname): | |||
There was a problem hiding this comment.
this change is changing the behavior. In the current implementation, if switches is not set, then no network_port are configured on any device. The change, if neither switches, nor platforms are set would configure the network_ports on ALL devices.
you would need an extra if to make sure that either switches or platforms are set + add a test case with network_ports without switches not platforms set to validate the behavior
There was a problem hiding this comment.
Fixed behavior to ensure match criteria is required, added test to ensure configuration is not generated if missing both switch hostname and platform match criteria.
...ions/arista/avd/molecule/eos_designs_unit_tests/inventory/group_vars/NETWORK_PORTS_TESTS.yml
Outdated
Show resolved
Hide resolved
python-avd/pyavd/_eos_designs/schema/schema_fragments/network_ports.schema.yml
Show resolved
Hide resolved
|
This pull request has conflicts, please resolve those before we can evaluate the pull request. |
Change Summary
Add platform match criteria for network_ports
Related Issue(s)
Fixes #4786
Component(s) name
arista.avd.eos_designsProposed changes
Add platform key to match to filter devices for
network_portsHow to test
Run molecule scenario for
eos_designs_uni_testsforNETWORK_PORTS_TESTSmolecule converge -s eos_designs_unit_tests -- --limit NETWORK_PORTS_TESTSChecklist
Repository Checklist