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 fabric documentation #655

Conversation

ClausHolbechArista
Copy link
Contributor

@ClausHolbechArista ClausHolbechArista commented Jan 26, 2021

Change Summary

Complete rewrite of the fabric documentation for eos_l3ls_evpn

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes)
  • Documentation content changes
  • Other (please describe):

Related Issue(s)

Fixes issue #552
Fixes issue #475

Component(s) name

arista.avd.eos_l3ls_evpn
arista.avd.build_output_folders

Proposed changes

  • Move fabric documentation to documentation/fabric/
  • Change Markdown filename to <fabric_name>-documentation.md
  • Change directory and documentation tasks to run_once
  • Document fabric_name, dc_name and pod_name variables
  • Include POD Name in fabric documentation
  • Only include L3 links between inventory devices in p2p CSV files
  • Include all links of all types in topology CSV files
  • Support 5-stage CLOS and multiple PODs in single fabric documentation file
  • Support for super-spine, overlay-controller device types
  • Updated molecule folders
  • Update molecule makefile to support cleanup (needed when changing folder structure)

How to test

Tested with my repo as well as all the molecule test scenarios.
Works for both l3ls and multipod

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.
  • I have updated the documentation accordingly.
  • I have updated molecule CI testing accordingly
  • All new and existing tests passed (pre-commit, make linting and make sanity-lint).

@github-actions github-actions bot added role: build_output_folders issue related to build_output_folders role role: eos_l3ls_evpn issue related to eos_l3ls_evpn role state: CI Updated CI scenario have been updated in the PR state: Documentation role Updated labels Jan 26, 2021
@ClausHolbechArista ClausHolbechArista marked this pull request as ready for review January 26, 2021 12:19
Copy link
Contributor

@titom73 titom73 left a comment

Choose a reason for hiding this comment

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

Looks good to me!
(Tested with an additional 3-stage clos fabric)

@ClausHolbechArista
Copy link
Contributor Author

Hold on a second. Found a few issues I will fix

@titom73 titom73 self-requested a review January 26, 2021 14:43
Copy link
Contributor

@titom73 titom73 left a comment

Choose a reason for hiding this comment

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

If we list mlag_peer in the topology, should not we also provide L3 interfaces for MLAG as well since these links are now listed in the documentation?

@ClausHolbechArista
Copy link
Contributor Author

I did not want to delay this by adding too many new areas, but we should add (in another PR):
Summary of # devices of each type
List of other interfaces (excl server) (custom and comming dci)
Mlag peer and ibgp vlan and pools
L2leaf inband management

@titom73
Copy link
Contributor

titom73 commented Jan 27, 2021

I did not want to delay this by adding too many new areas, but we should add (in another PR):
Summary of # devices of each type
List of other interfaces (excl server) (custom and comming dci)
Mlag peer and ibgp vlan and pools
L2leaf inband management

Ok sounds like a good plan.

@titom73 titom73 self-requested a review January 27, 2021 09:07
Copy link
Contributor

@titom73 titom73 left a comment

Choose a reason for hiding this comment

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

Looks good to me!

@ClausHolbechArista ClausHolbechArista merged commit 2221b03 into aristanetworks:devel Jan 27, 2021
@ClausHolbechArista ClausHolbechArista deleted the refactor-fabric-documentation branch July 9, 2021 19:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
role: build_output_folders issue related to build_output_folders role role: eos_l3ls_evpn issue related to eos_l3ls_evpn role state: CI Updated CI scenario have been updated in the PR state: Documentation role Updated
Projects
None yet
2 participants