Skip to content

Commit aa964c4

Browse files
Doc(eos_designs,eos_cli_config_gen): Update roles documentation (#6464)
1 parent 965b760 commit aa964c4

2 files changed

Lines changed: 11 additions & 12 deletions

File tree

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,11 @@ title: Ansible Collection Role eos_cli_config_gen
1212

1313
## Overview
1414

15-
**eos_cli_config_gen**, is a role that generates eos cli syntax and device documentation.
15+
**eos_cli_config_gen**, is a role that generates EOS CLI configuration and device documentation.
1616

1717
The **eos_cli_config_gen** role:
1818

1919
- Designed to generate the intended configuration offline, without relying on switch current state information.
20-
- Facilitates the evaluation of the configuration prior to deployment with tools like [Batfish](https://www.batfish.org/)
2120
- Facilitates the evaluation of the configuration post deployment with [anta_runner](../anta_runner/README.md) role.
2221

2322
## Role Inputs and Outputs
@@ -34,13 +33,13 @@ Figure 1 below provides a visualization of the roles inputs, and outputs and tas
3433
**Outputs:**
3534

3635
- EOS configuration in CLI format.
37-
- Device Documentation in Markdown format.
36+
- Device documentation in Markdown format.
3837

3938
**Tasks:**
4039

41-
1. Import device structured configuration from YAML file unless `structured_config` flag is set by `eos_designs`.
40+
1. Load and validate input variables according to the EOS Config schema.
4241
2. Generate EOS configuration in CLI format.
43-
3. Generate Device Documentation in Markdown format.
42+
3. Generate device documentation in Markdown format.
4443

4544
## Requirements
4645

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,26 +44,26 @@ To understand the interaction between `eos_designs` input variables and `eos_cli
4444
**Outputs:**
4545

4646
- A structured EOS configuration file in YAML format. This provides the following benefits:
47-
- Leverage the structured data to create eos CLI configuration.
47+
- Leverage the structured data to create EOS CLI configuration.
4848
- Leverage the structured data to create end-user documentation.
4949
- Leverage the structured data for pre and post-fabric validation.
5050
- Fabric Documentation in Markdown format.
5151
- Leaf and Spine Topology summary in CSV format.
5252

5353
**Tasks:**
5454

55-
1. Set AVD facts.
56-
2. Generate YAML file with host variables (Optional for debugging/development with tag -> debug).
57-
3. Set device configuration facts.
58-
4. Write structured device configuration to YAML file.
59-
5. Include device structured configuration that was previously generated.
55+
1. Template and validate input variables according to the AVD Design schema.
56+
2. Generate AVD facts.
57+
3. Generate the structured configuration for each device.
58+
4. Write the structured configurations to files.
59+
5. Optionally return the structured configurations as Ansible facts.
6060
6. Generate fabric documentation in Markdown format.
6161
7. Generate fabric point-to-point links summary in CSV format.
6262
8. Generate fabric physical topology summary in CSV format.
6363

6464
## Reference Designs
6565

66-
The following reference design types are included in the roles default variables:
66+
The following reference design types are included in the role's default variables:
6767

6868
- L3LS EVPN: Layer 3 Leaf Spine with VXLAN EVPN
6969
- L2LS: Layer 2 Leaf Spine

0 commit comments

Comments
 (0)