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

Doc(eos_designs): Add warning about WAN BGP peer groups password #4265

Merged
merged 6 commits into from
Jul 26, 2024
Merged

Doc(eos_designs): Add warning about WAN BGP peer groups password #4265

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b33bb53
Doc(eos_designs): Add warning about WAN BGP peer groups password
gmuloc Jul 26, 2024
de03169
Apply suggestions from code review
gmuloc Jul 26, 2024
73707be
Doc: Update per comment
gmuloc Jul 26, 2024
b0b5505
Update python-avd/pyavd/_eos_designs/schema/schema_fragments/bgp_peer…
ClausHolbechArista Jul 26, 2024
3a651de
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 26, 2024
0dfbaca
Merge branch 'devel' into doc-wan-rr-overlay-peer-grouppassword
ClausHolbechArista Jul 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions ansible_collections/arista/avd/roles/eos_designs/docs/how-to/wan.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,13 @@ Additionally, following keys must be set for the WAN route servers for the conne

- `bgp_peer_groups.wan_overlay_peers.listen_range_prefixes`: To set the ranges of IP address from which to expect BGP peerings for the WAN. Include the VTEP ranges for all routers connecting to this patfinder.

!!! warning

When configuring a password on the `wan_overlay_peers` BGP peer group,
it may also be required to set a password for the `wan_rr_overlay_peers` BGP peer group.
This is required in the case where one or more pathfinders use the same VTEP IP range as the edge routers.
If the password is not set, the static BGP peerings between Pathfinders may not come up.

#### WAN mode

AVD supports two design types for WAN:
Expand Down
12 changes: 10 additions & 2 deletions ansible_collections/arista/avd/roles/eos_designs/docs/tables/bgp-settings.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions python-avd/pyavd/_eos_designs/schema/eos_designs.jsonschema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3832,7 +3832,7 @@
},
"password": {
"type": "string",
"description": "Type 7 encrypted password.",
"description": "Type 7 encrypted password.\nWhen configuring a password on the `wan_overlay_peers` BGP peer group,\nit may also be required to set a password for the `wan_rr_overlay_peers` BGP peer group.\nThis is required in the case where one or more pathfinders use the same VTEP IP range as the edge routers.\nIf the password is not set, the static BGP peerings between Pathfinders may not come up.",
"title": "Password"
},
"bfd": {
Expand Down Expand Up @@ -4350,7 +4350,7 @@
},
"password": {
"type": "string",
"description": "Type 7 encrypted password.",
"description": "Type 7 encrypted password.\nWhen configuring a password on the `wan_overlay_peers` BGP peer group,\nit may also be required to set a password for the `wan_rr_overlay_peers` BGP peer group.\nThis is required in the case where one or more pathfinders use the same VTEP IP range as the edge routers.\nIf the password is not set, the static BGP peerings between Pathfinders may not come up.",
"title": "Password"
},
"bfd": {
Expand Down
26 changes: 24 additions & 2 deletions python-avd/pyavd/_eos_designs/schema/eos_designs.schema.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,18 @@ keys:
description: Name of peer group.
password:
type: str
description: Type 7 encrypted password.
description: 'Type 7 encrypted password.

When configuring a password on the `wan_overlay_peers` BGP peer group,

it may also be required to set a password for the `wan_rr_overlay_peers`
BGP peer group.

This is required in the case where one or more pathfinders use the same
VTEP IP range as the edge routers.

If the password is not set, the static BGP peerings between Pathfinders
may not come up.'
bfd:
type: bool
default: true
Expand Down Expand Up @@ -410,7 +421,18 @@ keys:
description: Name of peer group.
password:
type: str
description: Type 7 encrypted password.
description: 'Type 7 encrypted password.

When configuring a password on the `wan_overlay_peers` BGP peer group,

it may also be required to set a password for the `wan_rr_overlay_peers`
BGP peer group.

This is required in the case where one or more pathfinders use the same
VTEP IP range as the edge routers.

If the password is not set, the static BGP peerings between Pathfinders
may not come up.'
bfd:
type: bool
default: true
Expand Down
14 changes: 12 additions & 2 deletions python-avd/pyavd/_eos_designs/schema/schema_fragments/bgp_peer_groups.schema.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,12 @@ keys:
description: Name of peer group.
password:
type: str
description: Type 7 encrypted password.
description: |-
Type 7 encrypted password.
When configuring a password on the `wan_overlay_peers` BGP peer group,
it may also be required to set a password for the `wan_rr_overlay_peers` BGP peer group.
This is required in the case where one or more pathfinders use the same VTEP IP range as the edge routers.
ClausHolbechArista marked this conversation as resolved.
Show resolved Hide resolved
If the password is not set, the static BGP peerings between Pathfinders may not come up.
bfd:
type: bool
default: True
Expand Down Expand Up @@ -206,7 +211,12 @@ keys:
description: Name of peer group.
password:
type: str
description: Type 7 encrypted password.
description: |-
Type 7 encrypted password.
When configuring a password on the `wan_overlay_peers` BGP peer group,
it may also be required to set a password for the `wan_rr_overlay_peers` BGP peer group.
This is required in the case where one or more pathfinders use the same VTEP IP range as the edge routers.
If the password is not set, the static BGP peerings between Pathfinders may not come up.
bfd:
type: bool
default: True
Expand Down
Loading