Doc(eos_designs,eos_cli_config_gen): Fix incorrect schemas #4691
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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-4691
# Activate the virtual environment
source test-avd-pr-4691/bin/activate
# Install all requirements including PyAVD
pip install "pyavd[ansible] @ git+https://github.com/ClausHolbechArista/avd.git@fix/eos_designs/schema-default-values#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/,fix/eos_designs/schema-default-values --force
# Optional: Install AVD examples
cd test-avd-pr-4691
ansible-playbook arista.avd.install_examples |
github-actions
bot
added
role: eos_cli_config_gen
...pyavd/_eos_cli_config_gen/schema/schema_fragments/application_traffic_recognition.schema.yml
Outdated
Show resolved
Hide resolved
gmuloc
reviewed
Nov 6, 2024
ansible_collections/arista/avd/roles/eos_designs/docs/input-variables.md
Show resolved
Hide resolved
python-avd/pyavd/_eos_designs/schema/schema_fragments/defs_network_services.schema.yml
Show resolved
Hide resolved
python-avd/pyavd/_eos_designs/schema/schema_fragments/defs_network_services.schema.yml
Outdated
Show resolved
Hide resolved
python-avd/pyavd/_eos_designs/schema/schema_fragments/defs_p2p_links.schema.yml
Show resolved
Hide resolved
python-avd/pyavd/_eos_designs/schema/schema_fragments/defs_node_type.schema.yml
Show resolved
Hide resolved
Comment on lines
+172
to
+176
| valid_values: | ||
| - p2p | ||
| - port-channel | ||
| - p2p-vrfs | ||
| - lan |
There was a problem hiding this comment.
so we end up maintaining this in two places - would it not be better to have the other one refer to here and augment it with default?
There was a problem hiding this comment.
It would be counterintuitive to ref towards the child that inherits from the parent. I think we can live with maintaining this in two places.
There was a problem hiding this comment.
or a defs without default somewhere and both reference it and add default where needed?
There was a problem hiding this comment.
A bit much to not maintain 4 strings.
...pyavd/_eos_cli_config_gen/schema/schema_fragments/application_traffic_recognition.schema.yml
Outdated
Show resolved
Hide resolved
github-actions
bot
added
the
state: CI Updated
carlbuchmann
reviewed
Nov 7, 2024
...le_collections/arista/avd/roles/eos_designs/docs/tables/network-services-l2vlans-settings.md
Show resolved
Hide resolved
carlbuchmann
reviewed
Nov 7, 2024
ansible_collections/arista/avd/roles/eos_designs/docs/tables/network-services-vrfs-settings.md
Show resolved
Hide resolved
...pyavd/_eos_cli_config_gen/schema/schema_fragments/application_traffic_recognition.schema.yml
Outdated
Show resolved
Hide resolved
…pplication_traffic_recognition.schema.yml
carlbuchmann
reviewed
Nov 7, 2024
ansible_collections/arista/avd/roles/eos_designs/docs/tables/node-type-keys.md
Show resolved
Hide resolved
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change Summary
Fix incorrect schemas
Proposed changes
During development of Python classes and refactoring we hit conflicts between the code and the schema. This PR updates the schemas to conform to the implementation in the code.
How to test
No changes to inputs or behavior. This is only to reflect the correct defaults / schemas in the documentation.
Checklist
User Checklist
Repository Checklist