From 24acf63631fdb4a4517c489aed7d6cd16e6be390 Mon Sep 17 00:00:00 2001 From: pvinci-arista <102165259+pvinci-arista@users.noreply.github.com> Date: Fri, 25 Oct 2024 04:21:38 -0400 Subject: [PATCH] Doc(eos_designs): correct dc_name docs (#4646) --- .../avd/roles/eos_designs/docs/tables/fabric-topology.md | 4 ++-- python-avd/pyavd/_eos_designs/schema/eos_designs.schema.yml | 2 +- .../_eos_designs/schema/schema_fragments/dc_name.schema.yml | 2 +- .../tests/schema_tools/artifacts/eos_designs.schema.yml | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/ansible_collections/arista/avd/roles/eos_designs/docs/tables/fabric-topology.md b/ansible_collections/arista/avd/roles/eos_designs/docs/tables/fabric-topology.md index 8b11e0cbb5e..486c47eaf7f 100644 --- a/ansible_collections/arista/avd/roles/eos_designs/docs/tables/fabric-topology.md +++ b/ansible_collections/arista/avd/roles/eos_designs/docs/tables/fabric-topology.md @@ -7,14 +7,14 @@ | Variable | Type | Required | Default | Value Restrictions | Description | | -------- | ---- | -------- | ------- | ------------------ | ----------- | - | [dc_name](## "dc_name") | String | | | | POD Name is used in:
- Fabric Documentation (Optional, falls back to fabric_name)
- SNMP Location: `snmp_settings.location` (Optional)
- HER Overlay DC scoped flood lists: `overlay_her_flood_list_scope: dc` (Required)
| + | [dc_name](## "dc_name") | String | | | | DC Name is used in:
- Fabric Documentation (Optional, falls back to fabric_name)
- SNMP Location: `snmp_settings.location` (Optional)
- HER Overlay DC scoped flood lists: `overlay_her_flood_list_scope: dc` (Required)
| | [fabric_name](## "fabric_name") | String | Required | | | Fabric Name, required to match Ansible Group name covering all devices in the Fabric, **must** be an inventory group name. | | [pod_name](## "pod_name") | String | | | | POD Name is used in:
- Fabric Documentation (Optional, falls back to dc_name and then to fabric_name)
- SNMP Location: `snmp_settings.location` (Optional)
- VRF Loopbacks: `vtep_diagnostic.loopback_ip_pools.pod` (Required)

Recommended to be common between Spines and Leafs within a POD (One l3ls topology).
| === "YAML" ```yaml - # POD Name is used in: + # DC Name is used in: # - Fabric Documentation (Optional, falls back to fabric_name) # - SNMP Location: `snmp_settings.location` (Optional) # - HER Overlay DC scoped flood lists: `overlay_her_flood_list_scope: dc` (Required) diff --git a/python-avd/pyavd/_eos_designs/schema/eos_designs.schema.yml b/python-avd/pyavd/_eos_designs/schema/eos_designs.schema.yml index bdf4cc18fa6..1568bf980e5 100644 --- a/python-avd/pyavd/_eos_designs/schema/eos_designs.schema.yml +++ b/python-avd/pyavd/_eos_designs/schema/eos_designs.schema.yml @@ -868,7 +868,7 @@ keys: dc_name: documentation_options: table: fabric-topology - description: 'POD Name is used in: + description: 'DC Name is used in: - Fabric Documentation (Optional, falls back to fabric_name) diff --git a/python-avd/pyavd/_eos_designs/schema/schema_fragments/dc_name.schema.yml b/python-avd/pyavd/_eos_designs/schema/schema_fragments/dc_name.schema.yml index 65810ccab31..769f6258589 100644 --- a/python-avd/pyavd/_eos_designs/schema/schema_fragments/dc_name.schema.yml +++ b/python-avd/pyavd/_eos_designs/schema/schema_fragments/dc_name.schema.yml @@ -10,7 +10,7 @@ keys: documentation_options: table: fabric-topology description: | - POD Name is used in: + DC Name is used in: - Fabric Documentation (Optional, falls back to fabric_name) - SNMP Location: `snmp_settings.location` (Optional) - HER Overlay DC scoped flood lists: `overlay_her_flood_list_scope: dc` (Required) diff --git a/python-avd/tests/schema_tools/artifacts/eos_designs.schema.yml b/python-avd/tests/schema_tools/artifacts/eos_designs.schema.yml index 574120fcab8..5f3e21d8b66 100644 --- a/python-avd/tests/schema_tools/artifacts/eos_designs.schema.yml +++ b/python-avd/tests/schema_tools/artifacts/eos_designs.schema.yml @@ -485,7 +485,7 @@ keys: dc_name: documentation_options: table: fabric-topology - description: 'POD Name is used in: + description: 'DC Name is used in: - Fabric Documentation (Optional, falls back to fabric_name)