Skip to content

Commit 933280f

Browse files
committed
Doc: Update terminology for Arista AVD data models
1 parent bfc6337 commit 933280f

32 files changed

+200
-189
lines changed

ansible_collections/arista/avd/examples/campus-fabric/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ mgmt_interface_vrf: default
152152

153153
AVD Fabric Input Variables
154154

155-
To apply AVD input variables to the nodes in the fabric, we make use of Ansible group_vars. How and where you define the variables is your choice. The group_vars table below is one example of AVD fabric variables.
155+
To apply AVD input data models to the nodes in the fabric, we make use of Ansible group_vars. How and where you define the variables is your choice. The group_vars table below is one example of AVD fabric variables.
156156

157157
| group_vars/ | Description |
158158
| ------------------------ | --------------------------------------------- |

ansible_collections/arista/avd/roles/cv_deploy/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ cv_devices: [ DC1-L3LEAF1A, DC1-L3LEAF1B ]
184184

185185
The role will fail if a device is not found on CloudVision. Any workspace created will be abandoned automatically.
186186

187-
Devices with `is_deployed: false` set as part of `eos_designs` inputs will automatically be ignored.
187+
Devices with `is_deployed: false` set as part of AVD inputs will automatically be ignored.
188188

189189
It is possible to ignore other missing devices by simply skipping them and continue with the remaining devices.
190190

ansible_collections/arista/avd/roles/eos_cli_config_gen/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Requirements are located in the [collection installation guide](../../../../../d
4848

4949
## Input Variables
5050

51-
The input variables are documented in the [Input Variables](docs/input-variables.md) section.
51+
The input variables are documented in the [Structured EOS configuration data models](docs/input-variables.md) section.
5252

5353
## Role Configuration
5454

ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/input-variables.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,28 @@
11
---
22
# This title is used for search results
3-
title: Input variables for eos_cli_config_gen
3+
title: Structured EOS configuration data models
44
---
55
<!--
66
~ Copyright (c) 2023-2025 Arista Networks, Inc.
77
~ Use of this source code is governed by the Apache License 2.0
88
~ that can be found in the LICENSE file.
99
-->
1010

11-
# Input variables for eos_cli_config_gen
11+
# Structured EOS Configuration data models
1212

13-
This document describes the supported input variables for the role `arista.avd.eos_cli_config_gen`.
13+
The structured EOS configuration provides device-centric data models for expressing the Arista EOS device configurations syntax.
14+
15+
!!! note
16+
For Ansible users this document describes the supported input variables for the role `arista.avd.eos_cli_config_gen`.
1417

1518
Since several data models have changed between AVD versions 5.x and 6.x, it is recommended to study the [Porting Guide for AVD 6.x.x](../../../../../../docs/porting-guides/6.x.x.md) for existing deployments.
1619

17-
The input variables are documented below in tables and YAML.
20+
The data models are documented below in tables and YAML.
1821

1922
All values are optional.
2023

2124
!!! note
22-
All input variables are validated by a schema. If additional custom keys are desired, a key starting with an underscore `_`, will be ignored.
25+
All data models are validated by a schema. If additional custom keys are desired, a key starting with an underscore `_`, will be ignored.
2326

2427
!!! warning
2528
Available features and variables may vary by platforms, refer to documentation on arista.com for specifics.

ansible_collections/arista/avd/roles/eos_designs/docs/how-to/custom-descriptions-names.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ It provides extra protection from malicious format strings and adds support for
2222

2323
The following syntax is supported: `"{" [field_name] ["?"] ["<" prefix] [">" suffix] ["!" conversion] [":" format_spec] "}"`:
2424

25-
- `[field_name]`: Template field or variable, as per `eos_designs` input variables documentation.
25+
- `[field_name]`: Template field or variable, as per AVD inputs variables documentation.
2626
- `["?"]`: The literal `?` signals that the field is optional and will not be printed if the value is missing or None.
2727
- `["<" prefix]`: Prefix string including spaces which will be inserted before the field value. Most useful in combination with `?`. Prefix should not contain `"<"`, `">"`, `"!"` or `":"`.
2828
- `[">" suffix]`: The suffix string including spaces which will be inserted after the field value. Most useful in combination with `?`. The suffix should not contain `"<"`, `">"`, `"!"` or `":"`.
@@ -56,8 +56,8 @@ results in: `SERVERS_server2`
5656

5757
## Default description or name values
5858

59-
Below is a complete list of input variables and default values to facilitate customizing the description and names of values.
60-
Please consult the `eos_designs` input variables documentation to obtain the available template field(s) (`[field_name]`).
59+
Below is a complete list of data models and default values to facilitate customizing the description and names of values.
60+
Please consult the AVD inputs data model documentation to obtain the available template field(s) (`[field_name]`).
6161

6262
```yaml
6363
# Loopback interfaces description

ansible_collections/arista/avd/roles/eos_designs/docs/how-to/wan.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Please familiarize yourself with the Arista WAN terminology before proceeding:
5050

5151
### Known limitations
5252

53-
- Zones are not configurable for CV Pathfinder. All sites are being configured in a default zone `<region_name>-ZONE` with ID `1`. Hence, in `eos_designs`, the `transit` node type is always configured as `transit region`.
53+
- Zones are not configurable for CV Pathfinder. All sites are being configured in a default zone `<region_name>-ZONE` with ID `1`. Hence, with Arista AVD the `transit` node type is always configured as `transit region`.
5454
- All Pathfinders must be able to create a full mesh
5555
- No IPv6 support
5656
- Path-group ID is currently required under `wan_path_groups` until an algorithm is implemented to auto generate IDs.
@@ -85,7 +85,7 @@ Please familiarize yourself with the Arista WAN terminology before proceeding:
8585
!!! info
8686

8787
`eos_cli_config_gen` schema should support all of the required keys to configure a WAN network, whether AutoVPN or Pathfinder except for the most recent features.
88-
This means that any missing `eos_designs` feature should be supported using `custom_structured_configuration` functionality.
88+
This means that any missing Arista AVD features should be supported using `custom_structured_configuration` functionality.
8989
If you find any missing functionality, please open an issue on Github.
9090

9191
## Getting started with WAN
@@ -103,7 +103,7 @@ Please familiarize yourself with the Arista WAN terminology before proceeding:
103103

104104
#### Summary
105105

106-
The following table list the `eos_designs` top level keys used for WAN and how they should be set:
106+
The following table list the AVD inputs top level keys used for WAN and how they should be set:
107107

108108
| Key | Must be the same for all the WAN routers | Comment |
109109
| --- | ---------------------------------------- | ------- |

ansible_collections/arista/avd/roles/eos_designs/docs/input-variables.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,26 @@
11
---
22
# This title is used for search results
3-
title: Input variables for eos_designs
3+
title: AVD input data models
44
---
55
<!--
66
~ Copyright (c) 2023-2025 Arista Networks, Inc.
77
~ Use of this source code is governed by the Apache License 2.0
88
~ that can be found in the LICENSE file.
99
-->
1010

11-
# Input variables for eos_designs
11+
# AVD input data models
1212

13-
This document describes the supported input variables for the role `arista.avd.eos_designs`.
13+
AVD inputs provide opinionated yet flexible network-wide data models expressing the intent of your network design and configuration.
14+
15+
!!! note
16+
For Ansible users this document describes the supported input variables for the role `arista.avd.eos_designs`.
1417

1518
Since several data models have changed between AVD versions 5.x and 6.x, it is recommended to study the [Porting Guide for AVD 6.x.x](../../../../../../docs/porting-guides/6.x.x.md) for existing deployments.
1619

17-
The input variables are documented below in tables and YAML.
20+
The data models are documented below in tables and YAML.
1821

1922
!!! note
20-
All input variables are validated by a schema. If additional custom keys are desired, a key starting with an underscore `_`, will be ignored.
23+
All AVD input data models are validated by a schema. If additional custom keys are desired, a key starting with an underscore `_`, will be ignored.
2124

2225
!!! warning
2326
Available features and variables may vary by platforms, refer to documentation on arista.com for specifics.
@@ -27,11 +30,11 @@ The input variables are documented below in tables and YAML.
2730

2831
## Supported designs
2932

30-
`eos_designs` supports multiple options such as L3LS-EVPN with 3-stage or 5-stage, L2LS, MPLS, AutoVPN and CV Pathfinder. The sections below highlight some of these topologies, but you can extend `eos_designs` to support your own topology by using [`node_type_keys`](#node-type-customization) to create your own node type.
33+
Arista AVD supports multiple network design types such as L3LS-EVPN with 3-stage, 5-stage, L2LS, MPLS, AutoVPN and CV Pathfinder. The sections below highlight some of these topologies, but you can extend Arista AVD to support your own topology by using [`node_type_keys`](#node-type-customization) to create your own node type.
3134

3235
### 3-stage clos topology support (Leaf & Spine)
3336

34-
- The **eos_designs** role support various deployments with layer 3 leaf and spine (3-stage Clos) and optionally, with dedicated overlay controllers.
37+
- Arista AVD supports various deployments with layer 3 leaf and spine (3-stage Clos) and optionally, with dedicated overlay controllers.
3538
- 3 stage Clos fabric can be represented as spines, L3 leafs and L2 leafs, and also referred to as a "POD".
3639

3740
See the following examples:
@@ -41,14 +44,14 @@ See the following examples:
4144

4245
### 5-stage clos topology support (Super Spine)
4346

44-
- The **eos_designs** role support larger deployments with super-spines (5-stage Clos) and optionally, with dedicated overlay controllers.
47+
- Arista AVD supports larger deployments with super-spines (5-stage Clos) and optionally, with dedicated overlay controllers.
4548
- 5 stage Clos fabric can be represented as multiple leaf-spine structures (called PODs - Point of Delivery) interconnected by super-spines.
4649
- The logic to deploy every leaf-spine POD fabric remains unchanged.
4750
- Super-spines can be deployed as a single plane (typically chassis switches) or multiple planes.
4851

4952
### Layer 2 Leaf Spine
5053

51-
- The **eos_designs** role support various deployments with layer 2 leaf and spine. For example, routing may terminate at the spine level or an external L3 device.
54+
- Arista AVD supports various deployments with layer 2 leaf and spine. For example, routing may terminate at the spine level or an external L3 device.
5255
- The Clos fabric can be represented as L3 spines, spines, and leafs.
5356

5457
See the following examples:
@@ -58,7 +61,7 @@ See the following examples:
5861

5962
### MPLS
6063

61-
The **eos_designs** role supports any arbitrary physical mesh topology by combining and interconnecting different node types with the `core_interfaces` settings.
64+
Arista AVD supports any arbitrary physical mesh topology by combining and interconnecting different node types with the `core_interfaces` settings.
6265

6366
The following underlay routing protocols are supported:
6467

@@ -87,7 +90,7 @@ See the following example:
8790

8891
### WAN - AutoVPN and CV Pathfinder
8992

90-
The **eos_designs** role with the `l3ls-evpn` design type supports the node types `wan_rr` and `wan_router`.
93+
Arista AVD supports AutoVPN and CV Pathfinder deployments with the node types `wan_rr` and `wan_router`.
9194
The default underlay routing protocol is set to none but eBGP is supported as well.
9295

9396
The following overlay routing protocols are supported:
@@ -177,7 +180,7 @@ The pool manager stores data in a YAML file per fabric. The default path is `<ro
177180

178181
## Node Type Variables
179182

180-
The following tables provide information on the default node types that are pre-defined in `eos_designs`.
183+
The following tables provide information on the default node types that are pre-defined in AVD.
181184

182185
To customize or create new node types, please refer to [node type customization](#node-type-customization) section.
183186

@@ -882,7 +885,7 @@ The following overlay routing protocols are supported:
882885
- CVX (CloudVision eXchange)
883886

884887
¹ For use with design type "l2ls" or other designs where there is no requirement for a routing protocol for underlay and/or overlay on l3 devices.<br />
885-
² By setting `overlay_routing_protocol:HER`, `eos_designs` will configure static VXLAN flood-lists instead of using a dynamic overlay protocol.
888+
² By setting `overlay_routing_protocol:HER`, Arista AVD will configure static VXLAN flood-lists instead of using a dynamic overlay protocol.
886889

887890
--8<--
888891
ansible_collections/arista/avd/roles/eos_designs/docs/tables/overlay-settings.md

ansible_collections/arista/avd/roles/eos_designs/docs/tables/cloudvision-tags.md

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)