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.

Sign up for GitHub

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

Feat(eos_cli_config_gen): Improve generated documentation #3377

Merged
merged 5 commits into from
Dec 5, 2023
Merged

Feat(eos_cli_config_gen): Improve generated documentation #3377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b05ca2b
Fix(eos_cli_config_gen): Make generated documentation pass markdown l…
carlbuchmann Dec 1, 2023
65670c5
optimize code
carlbuchmann Dec 1, 2023
a26a7e2
Merge branch 'devel' into fix-markdown-docs-cli-gen
gmuloc Dec 5, 2023
491899d
Test: Run molecule for ipvpn stuff
gmuloc Dec 5, 2023
c48cf22
Merge branch 'devel' into fix-markdown-docs-cli-gen
ClausHolbechArista Dec 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 4 additions & 2 deletions .github/.markdownlintignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
ansible_collections/arista/avd/molecule/
ansible_collections/arista/avd/examples/*/documentation/
# Regex trigering MD052 - [Missing link or image reference definition: "0-9"] [Context: "[0-9][0-9]"]
ansible_collections/arista/avd/molecule/eos_cli_config_gen/documentation/devices/ip-extended-community-lists-regexp.md
ansible_collections/arista/avd/molecule/eos_cli_config_gen/documentation/devices/generate-default-config.md
ansible_collections/arista/avd/molecule/eos_cli_config_gen_deprecated_vars/documentation/devices/host1.md
ansible_collections/arista/avd/tests/unit/filters/toc_files/
10 changes: 5 additions & 5 deletions ...e_collections/arista/avd/examples/campus-fabric/documentation/devices/LEAF1A.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
- [Spanning Tree Device Configuration](#spanning-tree-device-configuration)
- [Internal VLAN Allocation Policy](#internal-vlan-allocation-policy)
- [Internal VLAN Allocation Policy Summary](#internal-vlan-allocation-policy-summary)
- [Internal VLAN Allocation Policy Configuration](#internal-vlan-allocation-policy-configuration)
- [Internal VLAN Allocation Policy Device Configuration](#internal-vlan-allocation-policy-device-configuration)
- [VLANs](#vlans)
- [VLANs Summary](#vlans-summary)
- [VLANs Device Configuration](#vlans-device-configuration)
Expand Down Expand Up @@ -117,7 +117,7 @@ ntp server vrf MGMT time.google.com prefer
| -------- | -------- | -------- |
| MGMT | - | - |

#### Management API HTTP Configuration
#### Management API HTTP Device Configuration

```eos
!
Expand Down Expand Up @@ -219,7 +219,7 @@ spanning-tree mst 0 priority 16384
| ------------------| --------------- | ------------ |
| ascending | 1006 | 1199 |

### Internal VLAN Allocation Policy Configuration
### Internal VLAN Allocation Policy Device Configuration

```eos
!
Expand Down Expand Up @@ -1460,8 +1460,8 @@ no ip routing vrf MGMT

#### Static Routes Summary

| VRF | Destination Prefix | Next Hop IP | Exit interface | Administrative Distance | Tag | Route Name | Metric |
| --- | ------------------ | ----------------------- | ------------------- | ----------------------------- | ----------------- | ----------------------------- | -------------- |
| VRF | Destination Prefix | Next Hop IP | Exit interface | Administrative Distance | Tag | Route Name | Metric |
| --- | ------------------ | ----------- | -------------- | ----------------------- | --- | ---------- | ------ |
| MGMT | 0.0.0.0/0 | 172.100.100.1 | - | 1 | - | - | - |
| default | 0.0.0.0/0 | 10.10.10.1 | - | 1 | - | - | - |

Expand Down
10 changes: 5 additions & 5 deletions ...e_collections/arista/avd/examples/campus-fabric/documentation/devices/LEAF1B.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
- [Spanning Tree Device Configuration](#spanning-tree-device-configuration)
- [Internal VLAN Allocation Policy](#internal-vlan-allocation-policy)
- [Internal VLAN Allocation Policy Summary](#internal-vlan-allocation-policy-summary)
- [Internal VLAN Allocation Policy Configuration](#internal-vlan-allocation-policy-configuration)
- [Internal VLAN Allocation Policy Device Configuration](#internal-vlan-allocation-policy-device-configuration)
- [VLANs](#vlans)
- [VLANs Summary](#vlans-summary)
- [VLANs Device Configuration](#vlans-device-configuration)
Expand Down Expand Up @@ -117,7 +117,7 @@ ntp server vrf MGMT time.google.com prefer
| -------- | -------- | -------- |
| MGMT | - | - |

#### Management API HTTP Configuration
#### Management API HTTP Device Configuration

```eos
!
Expand Down Expand Up @@ -219,7 +219,7 @@ spanning-tree mst 0 priority 16384
| ------------------| --------------- | ------------ |
| ascending | 1006 | 1199 |

### Internal VLAN Allocation Policy Configuration
### Internal VLAN Allocation Policy Device Configuration

```eos
!
Expand Down Expand Up @@ -1460,8 +1460,8 @@ no ip routing vrf MGMT

#### Static Routes Summary

| VRF | Destination Prefix | Next Hop IP | Exit interface | Administrative Distance | Tag | Route Name | Metric |
| --- | ------------------ | ----------------------- | ------------------- | ----------------------------- | ----------------- | ----------------------------- | -------------- |
| VRF | Destination Prefix | Next Hop IP | Exit interface | Administrative Distance | Tag | Route Name | Metric |
| --- | ------------------ | ----------- | -------------- | ----------------------- | --- | ---------- | ------ |
| MGMT | 0.0.0.0/0 | 172.100.100.1 | - | 1 | - | - | - |
| default | 0.0.0.0/0 | 10.10.10.1 | - | 1 | - | - | - |

Expand Down
10 changes: 5 additions & 5 deletions ...e_collections/arista/avd/examples/campus-fabric/documentation/devices/LEAF2A.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
- [Spanning Tree Device Configuration](#spanning-tree-device-configuration)
- [Internal VLAN Allocation Policy](#internal-vlan-allocation-policy)
- [Internal VLAN Allocation Policy Summary](#internal-vlan-allocation-policy-summary)
- [Internal VLAN Allocation Policy Configuration](#internal-vlan-allocation-policy-configuration)
- [Internal VLAN Allocation Policy Device Configuration](#internal-vlan-allocation-policy-device-configuration)
- [VLANs](#vlans)
- [VLANs Summary](#vlans-summary)
- [VLANs Device Configuration](#vlans-device-configuration)
Expand Down Expand Up @@ -116,7 +116,7 @@ ntp server vrf MGMT time.google.com prefer
| -------- | -------- | -------- |
| MGMT | - | - |

#### Management API HTTP Configuration
#### Management API HTTP Device Configuration

```eos
!
Expand Down Expand Up @@ -190,7 +190,7 @@ spanning-tree mst 0 priority 16384
| ------------------| --------------- | ------------ |
| ascending | 1006 | 1199 |

### Internal VLAN Allocation Policy Configuration
### Internal VLAN Allocation Policy Device Configuration

```eos
!
Expand Down Expand Up @@ -6826,8 +6826,8 @@ no ip routing vrf MGMT

#### Static Routes Summary

| VRF | Destination Prefix | Next Hop IP | Exit interface | Administrative Distance | Tag | Route Name | Metric |
| --- | ------------------ | ----------------------- | ------------------- | ----------------------------- | ----------------- | ----------------------------- | -------------- |
| VRF | Destination Prefix | Next Hop IP | Exit interface | Administrative Distance | Tag | Route Name | Metric |
| --- | ------------------ | ----------- | -------------- | ----------------------- | --- | ---------- | ------ |
| MGMT | 0.0.0.0/0 | 172.100.100.1 | - | 1 | - | - | - |
| default | 0.0.0.0/0 | 10.10.10.1 | - | 1 | - | - | - |

Expand Down
10 changes: 5 additions & 5 deletions ...e_collections/arista/avd/examples/campus-fabric/documentation/devices/LEAF3A.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
- [Spanning Tree Device Configuration](#spanning-tree-device-configuration)
- [Internal VLAN Allocation Policy](#internal-vlan-allocation-policy)
- [Internal VLAN Allocation Policy Summary](#internal-vlan-allocation-policy-summary)
- [Internal VLAN Allocation Policy Configuration](#internal-vlan-allocation-policy-configuration)
- [Internal VLAN Allocation Policy Device Configuration](#internal-vlan-allocation-policy-device-configuration)
- [VLANs](#vlans)
- [VLANs Summary](#vlans-summary)
- [VLANs Device Configuration](#vlans-device-configuration)
Expand Down Expand Up @@ -117,7 +117,7 @@ ntp server vrf MGMT time.google.com prefer
| -------- | -------- | -------- |
| MGMT | - | - |

#### Management API HTTP Configuration
#### Management API HTTP Device Configuration

```eos
!
Expand Down Expand Up @@ -219,7 +219,7 @@ spanning-tree mst 0 priority 16384
| ------------------| --------------- | ------------ |
| ascending | 1006 | 1199 |

### Internal VLAN Allocation Policy Configuration
### Internal VLAN Allocation Policy Device Configuration

```eos
!
Expand Down Expand Up @@ -2567,8 +2567,8 @@ no ip routing vrf MGMT

#### Static Routes Summary

| VRF | Destination Prefix | Next Hop IP | Exit interface | Administrative Distance | Tag | Route Name | Metric |
| --- | ------------------ | ----------------------- | ------------------- | ----------------------------- | ----------------- | ----------------------------- | -------------- |
| VRF | Destination Prefix | Next Hop IP | Exit interface | Administrative Distance | Tag | Route Name | Metric |
| --- | ------------------ | ----------- | -------------- | ----------------------- | --- | ---------- | ------ |
| MGMT | 0.0.0.0/0 | 172.100.100.1 | - | 1 | - | - | - |
| default | 0.0.0.0/0 | 10.10.10.1 | - | 1 | - | - | - |

Expand Down
10 changes: 5 additions & 5 deletions ...e_collections/arista/avd/examples/campus-fabric/documentation/devices/LEAF3B.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
- [Spanning Tree Device Configuration](#spanning-tree-device-configuration)
- [Internal VLAN Allocation Policy](#internal-vlan-allocation-policy)
- [Internal VLAN Allocation Policy Summary](#internal-vlan-allocation-policy-summary)
- [Internal VLAN Allocation Policy Configuration](#internal-vlan-allocation-policy-configuration)
- [Internal VLAN Allocation Policy Device Configuration](#internal-vlan-allocation-policy-device-configuration)
- [VLANs](#vlans)
- [VLANs Summary](#vlans-summary)
- [VLANs Device Configuration](#vlans-device-configuration)
Expand Down Expand Up @@ -117,7 +117,7 @@ ntp server vrf MGMT time.google.com prefer
| -------- | -------- | -------- |
| MGMT | - | - |

#### Management API HTTP Configuration
#### Management API HTTP Device Configuration

```eos
!
Expand Down Expand Up @@ -219,7 +219,7 @@ spanning-tree mst 0 priority 16384
| ------------------| --------------- | ------------ |
| ascending | 1006 | 1199 |

### Internal VLAN Allocation Policy Configuration
### Internal VLAN Allocation Policy Device Configuration

```eos
!
Expand Down Expand Up @@ -2567,8 +2567,8 @@ no ip routing vrf MGMT

#### Static Routes Summary

| VRF | Destination Prefix | Next Hop IP | Exit interface | Administrative Distance | Tag | Route Name | Metric |
| --- | ------------------ | ----------------------- | ------------------- | ----------------------------- | ----------------- | ----------------------------- | -------------- |
| VRF | Destination Prefix | Next Hop IP | Exit interface | Administrative Distance | Tag | Route Name | Metric |
| --- | ------------------ | ----------- | -------------- | ----------------------- | --- | ---------- | ------ |
| MGMT | 0.0.0.0/0 | 172.100.100.1 | - | 1 | - | - | - |
| default | 0.0.0.0/0 | 10.10.10.1 | - | 1 | - | - | - |

Expand Down
10 changes: 5 additions & 5 deletions ...e_collections/arista/avd/examples/campus-fabric/documentation/devices/LEAF3C.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
- [Spanning Tree Device Configuration](#spanning-tree-device-configuration)
- [Internal VLAN Allocation Policy](#internal-vlan-allocation-policy)
- [Internal VLAN Allocation Policy Summary](#internal-vlan-allocation-policy-summary)
- [Internal VLAN Allocation Policy Configuration](#internal-vlan-allocation-policy-configuration)
- [Internal VLAN Allocation Policy Device Configuration](#internal-vlan-allocation-policy-device-configuration)
- [VLANs](#vlans)
- [VLANs Summary](#vlans-summary)
- [VLANs Device Configuration](#vlans-device-configuration)
Expand Down Expand Up @@ -114,7 +114,7 @@ ntp server vrf MGMT time.google.com prefer
| -------- | -------- | -------- |
| MGMT | - | - |

#### Management API HTTP Configuration
#### Management API HTTP Device Configuration

```eos
!
Expand Down Expand Up @@ -188,7 +188,7 @@ spanning-tree mst 0 priority 16384
| ------------------| --------------- | ------------ |
| ascending | 1006 | 1199 |

### Internal VLAN Allocation Policy Configuration
### Internal VLAN Allocation Policy Device Configuration

```eos
!
Expand Down Expand Up @@ -2456,8 +2456,8 @@ no ip routing vrf MGMT

#### Static Routes Summary

| VRF | Destination Prefix | Next Hop IP | Exit interface | Administrative Distance | Tag | Route Name | Metric |
| --- | ------------------ | ----------------------- | ------------------- | ----------------------------- | ----------------- | ----------------------------- | -------------- |
| VRF | Destination Prefix | Next Hop IP | Exit interface | Administrative Distance | Tag | Route Name | Metric |
| --- | ------------------ | ----------- | -------------- | ----------------------- | --- | ---------- | ------ |
| MGMT | 0.0.0.0/0 | 172.100.100.1 | - | 1 | - | - | - |
| default | 0.0.0.0/0 | 10.10.10.1 | - | 1 | - | - | - |

Expand Down
10 changes: 5 additions & 5 deletions ...e_collections/arista/avd/examples/campus-fabric/documentation/devices/LEAF3D.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
- [Spanning Tree Device Configuration](#spanning-tree-device-configuration)
- [Internal VLAN Allocation Policy](#internal-vlan-allocation-policy)
- [Internal VLAN Allocation Policy Summary](#internal-vlan-allocation-policy-summary)
- [Internal VLAN Allocation Policy Configuration](#internal-vlan-allocation-policy-configuration)
- [Internal VLAN Allocation Policy Device Configuration](#internal-vlan-allocation-policy-device-configuration)
- [VLANs](#vlans)
- [VLANs Summary](#vlans-summary)
- [VLANs Device Configuration](#vlans-device-configuration)
Expand Down Expand Up @@ -114,7 +114,7 @@ ntp server vrf MGMT time.google.com prefer
| -------- | -------- | -------- |
| MGMT | - | - |

#### Management API HTTP Configuration
#### Management API HTTP Device Configuration

```eos
!
Expand Down Expand Up @@ -188,7 +188,7 @@ spanning-tree mst 0 priority 16384
| ------------------| --------------- | ------------ |
| ascending | 1006 | 1199 |

### Internal VLAN Allocation Policy Configuration
### Internal VLAN Allocation Policy Device Configuration

```eos
!
Expand Down Expand Up @@ -2456,8 +2456,8 @@ no ip routing vrf MGMT

#### Static Routes Summary

| VRF | Destination Prefix | Next Hop IP | Exit interface | Administrative Distance | Tag | Route Name | Metric |
| --- | ------------------ | ----------------------- | ------------------- | ----------------------------- | ----------------- | ----------------------------- | -------------- |
| VRF | Destination Prefix | Next Hop IP | Exit interface | Administrative Distance | Tag | Route Name | Metric |
| --- | ------------------ | ----------- | -------------- | ----------------------- | --- | ---------- | ------ |
| MGMT | 0.0.0.0/0 | 172.100.100.1 | - | 1 | - | - | - |
| default | 0.0.0.0/0 | 10.10.10.1 | - | 1 | - | - | - |

Expand Down
10 changes: 5 additions & 5 deletions ...e_collections/arista/avd/examples/campus-fabric/documentation/devices/LEAF3E.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
- [Spanning Tree Device Configuration](#spanning-tree-device-configuration)
- [Internal VLAN Allocation Policy](#internal-vlan-allocation-policy)
- [Internal VLAN Allocation Policy Summary](#internal-vlan-allocation-policy-summary)
- [Internal VLAN Allocation Policy Configuration](#internal-vlan-allocation-policy-configuration)
- [Internal VLAN Allocation Policy Device Configuration](#internal-vlan-allocation-policy-device-configuration)
- [VLANs](#vlans)
- [VLANs Summary](#vlans-summary)
- [VLANs Device Configuration](#vlans-device-configuration)
Expand Down Expand Up @@ -114,7 +114,7 @@ ntp server vrf MGMT time.google.com prefer
| -------- | -------- | -------- |
| MGMT | - | - |

#### Management API HTTP Configuration
#### Management API HTTP Device Configuration

```eos
!
Expand Down Expand Up @@ -188,7 +188,7 @@ spanning-tree mst 0 priority 16384
| ------------------| --------------- | ------------ |
| ascending | 1006 | 1199 |

### Internal VLAN Allocation Policy Configuration
### Internal VLAN Allocation Policy Device Configuration

```eos
!
Expand Down Expand Up @@ -2456,8 +2456,8 @@ no ip routing vrf MGMT

#### Static Routes Summary

| VRF | Destination Prefix | Next Hop IP | Exit interface | Administrative Distance | Tag | Route Name | Metric |
| --- | ------------------ | ----------------------- | ------------------- | ----------------------------- | ----------------- | ----------------------------- | -------------- |
| VRF | Destination Prefix | Next Hop IP | Exit interface | Administrative Distance | Tag | Route Name | Metric |
| --- | ------------------ | ----------- | -------------- | ----------------------- | --- | ---------- | ------ |
| MGMT | 0.0.0.0/0 | 172.100.100.1 | - | 1 | - | - | - |
| default | 0.0.0.0/0 | 10.10.10.1 | - | 1 | - | - | - |

Expand Down
15 changes: 7 additions & 8 deletions ...e_collections/arista/avd/examples/campus-fabric/documentation/devices/SPINE1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
- [Spanning Tree Device Configuration](#spanning-tree-device-configuration)
- [Internal VLAN Allocation Policy](#internal-vlan-allocation-policy)
- [Internal VLAN Allocation Policy Summary](#internal-vlan-allocation-policy-summary)
- [Internal VLAN Allocation Policy Configuration](#internal-vlan-allocation-policy-configuration)
- [Internal VLAN Allocation Policy Device Configuration](#internal-vlan-allocation-policy-device-configuration)
- [VLANs](#vlans)
- [VLANs Summary](#vlans-summary)
- [VLANs Device Configuration](#vlans-device-configuration)
Expand Down Expand Up @@ -118,7 +118,7 @@ ntp server vrf MGMT time.google.com prefer
| -------- | -------- | -------- |
| MGMT | - | - |

#### Management API HTTP Configuration
#### Management API HTTP Device Configuration

```eos
!
Expand Down Expand Up @@ -220,7 +220,7 @@ spanning-tree mst 0 priority 4096
| ------------------| --------------- | ------------ |
| ascending | 1006 | 1199 |

### Internal VLAN Allocation Policy Configuration
### Internal VLAN Allocation Policy Device Configuration

```eos
!
Expand Down Expand Up @@ -424,7 +424,6 @@ interface Port-Channel551
| --------- | ----------- | --- | ------------ |
| Loopback0 | Router_ID | default | - |


#### Loopback Interfaces Device Configuration

```eos
Expand Down Expand Up @@ -569,9 +568,9 @@ service routing protocols model multi-agent

#### Virtual Router MAC Address Summary

##### Virtual Router MAC Address: 00:1c:73:00:dc:01
Virtual Router MAC Address: 00:1c:73:00:dc:01

#### Virtual Router MAC Address Configuration
#### Virtual Router MAC Address Device Configuration

```eos
!
Expand Down Expand Up @@ -608,8 +607,8 @@ no ip routing vrf MGMT

#### Static Routes Summary

| VRF | Destination Prefix | Next Hop IP | Exit interface | Administrative Distance | Tag | Route Name | Metric |
| --- | ------------------ | ----------------------- | ------------------- | ----------------------------- | ----------------- | ----------------------------- | -------------- |
| VRF | Destination Prefix | Next Hop IP | Exit interface | Administrative Distance | Tag | Route Name | Metric |
| --- | ------------------ | ----------- | -------------- | ----------------------- | --- | ---------- | ------ |
| MGMT | 0.0.0.0/0 | 172.100.100.1 | - | 1 | - | - | - |

#### Static Routes Device Configuration
Expand Down
Loading
Loading