diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml index 873aa1dbdd8..568094bf105 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yml +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -64,7 +64,7 @@ body: id: terms attributes: label: Contributing Guide - description: By submitting this issue, you agree to follow our [Contributing Guide](https://avd.sh/en/latest/docs/contribution/overview.html) + description: By submitting this issue, you agree to follow our [Contributing Guide](https://avd.arista.com/devel/docs/contribution/overview.html) options: - label: I agree to follow this project's Code of Conduct required: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml index 4e204cf1ad5..9b479eecf9f 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yml +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -71,7 +71,7 @@ body: id: terms attributes: label: Contributing Guide - description: By submitting this issue, you agree to follow our [Contributing Guide](https://avd.sh/en/latest/docs/contribution/overview.html) + description: By submitting this issue, you agree to follow our [Contributing Guide](https://avd.arista.com/devel/docs/contribution/overview.html) options: - label: I agree to follow this project's Code of Conduct required: true diff --git a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md index a7138e66e87..71ac12705bd 100644 --- a/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md +++ b/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md @@ -30,6 +30,6 @@ Fixes # - [ ] My code has been rebased from devel before I start -- [ ] I have read the [**CONTRIBUTING**](https://avd.sh/en/latest/docs/contribution/overview.html) document. +- [ ] I have read the [**CONTRIBUTING**](https://avd.arista.com/devel/docs/contribution/overview.html) document. - [ ] My change requires a change to the documentation and documentation have been updated accordingly. - [ ] I have updated [molecule CI](https://github.com/aristanetworks/avd/tree/devel/ansible_collections/arista/avd/molecule) testing accordingly. (check the box if not applicable) diff --git a/.github/PULL_REQUEST_TEMPLATE/schema_eos_cli_config_gen.md b/.github/PULL_REQUEST_TEMPLATE/schema_eos_cli_config_gen.md index 158a471d107..272b840fa23 100644 --- a/.github/PULL_REQUEST_TEMPLATE/schema_eos_cli_config_gen.md +++ b/.github/PULL_REQUEST_TEMPLATE/schema_eos_cli_config_gen.md @@ -10,7 +10,7 @@ - README.md is most complete with all keys. README_v4.0 includes partial data models after conversion to lists. - Schema fragment path is `roles/eos_cli_config_gen/schemas/schema_fragments/.schema.yml`. - Copy line 1-5 from another schema (comments and outer type:dict). - - Refer to [schema documentation](https://avd.sh/en/devel/docs/input-variable-validation.html) for syntax and/or use YAML Lint plugin from Redhat in VSCode. + - Refer to [schema documentation](https://avd.arista.com/devel/docs/contribution/input-variable-validation.html) for syntax and/or use YAML Lint plugin from Redhat in VSCode. - Use `convert_types` on value that could be mixed type or misinterpreted like integers and numeric strings. - [ ] If the data model has been converted from wildcard dicts: - Add `convert_types: ['dict']` to the schema. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a7138e66e87..3b7190587ac 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -30,6 +30,6 @@ Fixes # - [ ] My code has been rebased from devel before I start -- [ ] I have read the [**CONTRIBUTING**](https://avd.sh/en/latest/docs/contribution/overview.html) document. +- [ ] I have read the [**CONTRIBUTING**](https://avd.arista.com/stable/docs/contribution/overview.html) document. - [ ] My change requires a change to the documentation and documentation have been updated accordingly. - [ ] I have updated [molecule CI](https://github.com/aristanetworks/avd/tree/devel/ansible_collections/arista/avd/molecule) testing accordingly. (check the box if not applicable) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index edefb38cca7..9c10809c62b 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -139,7 +139,7 @@ repos: python-avd/pyavd/.*/schema/.*schema\.yml| # Exclude YAML schemas file python-avd/pyavd/_cv/api/.*| # Exclude auto generated files for CV API python-avd/pyavd/_cv/extra_cv_protos/.*| # Exclude extra CV proto files - ansible-avd/ansible_collections/arista/avd/docs/plugins/.* | # Excluded auto generated doc for Ansible plugins + docs/plugins/.* | # Excluded auto generated doc for Ansible plugins )$ - repo: local @@ -148,8 +148,8 @@ repos: - id: docs-plugin-modules name: Build documentation for collection modules and action plugins. entry: >- - ansible-doc-extractor --template ansible_collections/arista/avd/docs/templates/plugin-docs.j2 - --markdown "ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/" + ansible-doc-extractor --template docs/templates/plugin-docs.j2 + --markdown "docs/plugins/Modules_and_action_plugins/" language: python types: [python] additional_dependencies: ['ansible-doc-extractor>=0.1.10', 'ansible-core>=2.16.0,<2.19.0'] @@ -158,8 +158,8 @@ repos: - id: docs-plugin-filter name: Build documentation for collection filter plugins. entry: >- - ansible-doc-extractor --template ansible_collections/arista/avd/docs/templates/plugin-docs.j2 - --markdown "ansible_collections/arista/avd/docs/plugins/Filter_plugins/" + ansible-doc-extractor --template docs/templates/plugin-docs.j2 + --markdown "docs/plugins/Filter_plugins/" language: python types_or: [python, yaml] additional_dependencies: ['ansible-doc-extractor>=0.1.10', 'ansible-core>=2.16.0,<2.19.0'] @@ -169,8 +169,8 @@ repos: - id: docs-plugin-lookup name: Build documentation for collection lookup plugins. entry: >- - ansible-doc-extractor --template ansible_collections/arista/avd/docs/templates/plugin-docs.j2 - --markdown "ansible_collections/arista/avd/docs/plugins/Lookup_plugins/" + ansible-doc-extractor --template docs/templates/plugin-docs.j2 + --markdown "docs/plugins/Lookup_plugins/" language: python types: [python] additional_dependencies: ['ansible-doc-extractor>=0.1.10', 'ansible-core>=2.16.0,<2.19.0'] @@ -179,8 +179,8 @@ repos: - id: docs-plugin-test name: Build documentation for collection test plugins. entry: >- - ansible-doc-extractor --template ansible_collections/arista/avd/docs/templates/plugin-docs.j2 - --markdown "ansible_collections/arista/avd/docs/plugins/Test_plugins/" + ansible-doc-extractor --template docs/templates/plugin-docs.j2 + --markdown "docs/plugins/Test_plugins/" language: python types: [python] additional_dependencies: ['ansible-doc-extractor>=0.1.10', 'ansible-core>=2.16.0,<2.19.0'] @@ -189,8 +189,8 @@ repos: - id: docs-plugin-vars name: Build documentation for collection var plugins. entry: >- - ansible-doc-extractor --template ansible_collections/arista/avd/docs/templates/plugin-docs.j2 - --markdown "ansible_collections/arista/avd/docs/plugins/Vars_plugins/" + ansible-doc-extractor --template docs/templates/plugin-docs.j2 + --markdown "docs/plugins/Vars_plugins/" language: python types: [python] additional_dependencies: ['ansible-doc-extractor>=0.1.10', 'ansible-core>=2.16.0,<2.19.0'] diff --git a/ansible_collections/arista/avd/CNAME b/ansible_collections/arista/avd/CNAME index 1e6b3114baa..c306847ed7b 100644 --- a/ansible_collections/arista/avd/CNAME +++ b/ansible_collections/arista/avd/CNAME @@ -1 +1 @@ -www.avd.sh +avd.arista.com diff --git a/ansible_collections/arista/avd/docs/requirements.txt b/ansible_collections/arista/avd/docs/requirements.txt index 28737438922..b459f90129f 100644 --- a/ansible_collections/arista/avd/docs/requirements.txt +++ b/ansible_collections/arista/avd/docs/requirements.txt @@ -1,6 +1,7 @@ mkdocs mkdocs-material<10 mkdocs-material-extensions +mkdocs-same-dir pymdown-extensions mdx_truly_sane_lists mike==1.1.2 diff --git a/ansible_collections/arista/avd/examples/campus-fabric/README.md b/ansible_collections/arista/avd/examples/campus-fabric/README.md index fa42c392d36..3a8d3b71a29 100644 --- a/ansible_collections/arista/avd/examples/campus-fabric/README.md +++ b/ansible_collections/arista/avd/examples/campus-fabric/README.md @@ -17,7 +17,7 @@ This example describes and includes all the AVD files used to build a Campus Fab ## Installation & Requirements --8<-- -examples/common/installation.md +ansible_collections/arista/avd/examples/common/example-installation.md --8<-- ``` shell @@ -69,7 +69,7 @@ Below is the basic configuration file for SPINE1: ``` shell --8<-- -examples/campus-fabric/switch-basic-configurations/SPINE1.cfg +ansible_collections/arista/avd/examples/campus-fabric/switch-basic-configurations/SPINE1.cfg --8<-- ``` @@ -106,7 +106,7 @@ If DNS is unavailable, define the variable ansible_host as an IP address for eac ``` yaml --8<-- -examples/campus-fabric/inventory.yml +ansible_collections/arista/avd/examples/campus-fabric/inventory.yml --8<-- ``` @@ -172,7 +172,7 @@ The tabs below show the Ansible **group_vars** used in this example. ``` yaml --8<-- - examples/campus-fabric/group_vars/DC1.yml + ansible_collections/arista/avd/examples/campus-fabric/group_vars/DC1.yml --8<-- ``` @@ -185,7 +185,7 @@ The tabs below show the Ansible **group_vars** used in this example. ``` yaml --8<-- - examples/campus-fabric/group_vars/DC1_FABRIC.yml + ansible_collections/arista/avd/examples/campus-fabric/group_vars/DC1_FABRIC.yml --8<-- ``` @@ -194,7 +194,7 @@ The tabs below show the Ansible **group_vars** used in this example. ``` yaml --8<-- - examples/campus-fabric/group_vars/DC1_SPINES.yml + ansible_collections/arista/avd/examples/campus-fabric/group_vars/DC1_SPINES.yml --8<-- ``` @@ -203,7 +203,7 @@ The tabs below show the Ansible **group_vars** used in this example. ``` yaml --8<-- - examples/campus-fabric/group_vars/DC1_LEAFS.yml + ansible_collections/arista/avd/examples/campus-fabric/group_vars/DC1_LEAFS.yml --8<-- ``` @@ -212,16 +212,16 @@ The tabs below show the Ansible **group_vars** used in this example. ``` yaml --8<-- - examples/campus-fabric/group_vars/DC1_NETWORK_SERVICES.yml + ansible_collections/arista/avd/examples/campus-fabric/group_vars/DC1_NETWORK_SERVICES.yml --8<-- ``` === "DC1_NETWORK_PORTS" - Our fabric would not be complete without connecting some devices to it. Therefore, we define port profiles and network port ranges in the **group_vars/DC1_NETWORKS_PORTS.yml** file. A single port_profile may be used across several switches and port ranges. In our example, we create a port profile called `PP-DOT1X` to define generic 802.1x (NAC) settings we wish to apply to a range of ports. The `network_ports` data model defines which switches and ports to apply the port profile. This data model allows a single regex statement to define a list of switches. In addition, the variable `switch_ports` expands into a range of ports. You can view more details of the `range_expand` filter [here](../../docs/plugins/Filter_plugins/range_expand.md). These variables are applied to the spine and leaf nodes since they are a part of this inventory group. + Our fabric would not be complete without connecting some devices to it. Therefore, we define port profiles and network port ranges in the **group_vars/DC1_NETWORKS_PORTS.yml** file. A single port_profile may be used across several switches and port ranges. In our example, we create a port profile called `PP-DOT1X` to define generic 802.1x (NAC) settings we wish to apply to a range of ports. The `network_ports` data model defines which switches and ports to apply the port profile. This data model allows a single regex statement to define a list of switches. In addition, the variable `switch_ports` expands into a range of ports. You can view more details of the `range_expand` filter [here](../../../../../docs/plugins/Filter_plugins/range_expand.md). These variables are applied to the spine and leaf nodes since they are a part of this inventory group. ``` yaml --8<-- - examples/campus-fabric/group_vars/DC1_NETWORK_PORTS.yml + ansible_collections/arista/avd/examples/campus-fabric/group_vars/DC1_NETWORK_PORTS.yml --8<-- ``` @@ -276,7 +276,7 @@ Now that we have defined all of our Ansible variables (AVD inputs), it is time t ``` yaml --8<-- - examples/campus-fabric/build.yml + ansible_collections/arista/avd/examples/campus-fabric/build.yml --8<-- ``` @@ -284,7 +284,7 @@ Now that we have defined all of our Ansible variables (AVD inputs), it is time t ``` yaml --8<-- - examples/campus-fabric/deploy.yml + ansible_collections/arista/avd/examples/campus-fabric/deploy.yml --8<-- ``` @@ -314,7 +314,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/campus-fabric/intended/configs/SPINE1.cfg + ansible_collections/arista/avd/examples/campus-fabric/intended/configs/SPINE1.cfg --8<-- ``` @@ -322,7 +322,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/campus-fabric/intended/configs/SPINE2.cfg + ansible_collections/arista/avd/examples/campus-fabric/intended/configs/SPINE2.cfg --8<-- ``` @@ -330,7 +330,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/campus-fabric/intended/configs/LEAF1A.cfg + ansible_collections/arista/avd/examples/campus-fabric/intended/configs/LEAF1A.cfg --8<-- ``` @@ -338,7 +338,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/campus-fabric/intended/configs/LEAF1B.cfg + ansible_collections/arista/avd/examples/campus-fabric/intended/configs/LEAF1B.cfg --8<-- ``` @@ -346,7 +346,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/campus-fabric/intended/configs/LEAF2A.cfg + ansible_collections/arista/avd/examples/campus-fabric/intended/configs/LEAF2A.cfg --8<-- ``` @@ -354,7 +354,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/campus-fabric/intended/configs/LEAF3A.cfg + ansible_collections/arista/avd/examples/campus-fabric/intended/configs/LEAF3A.cfg --8<-- ``` @@ -362,7 +362,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/campus-fabric/intended/configs/LEAF3B.cfg + ansible_collections/arista/avd/examples/campus-fabric/intended/configs/LEAF3B.cfg --8<-- ``` @@ -370,7 +370,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/campus-fabric/intended/configs/LEAF3C.cfg + ansible_collections/arista/avd/examples/campus-fabric/intended/configs/LEAF3C.cfg --8<-- ``` @@ -378,7 +378,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/campus-fabric/intended/configs/LEAF3D.cfg + ansible_collections/arista/avd/examples/campus-fabric/intended/configs/LEAF3D.cfg --8<-- ``` @@ -386,7 +386,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/campus-fabric/intended/configs/LEAF3E.cfg + ansible_collections/arista/avd/examples/campus-fabric/intended/configs/LEAF3E.cfg --8<-- ``` diff --git a/ansible_collections/arista/avd/examples/common/installation.md b/ansible_collections/arista/avd/examples/common/example-installation.md similarity index 93% rename from ansible_collections/arista/avd/examples/common/installation.md rename to ansible_collections/arista/avd/examples/common/example-installation.md index 6a2bcbf37c4..4d0ef6c03ba 100644 --- a/ansible_collections/arista/avd/examples/common/installation.md +++ b/ansible_collections/arista/avd/examples/common/example-installation.md @@ -6,7 +6,7 @@ Requirements to use this example: -- Follow the [installation guide](../../docs/installation/collection-installation.md) for AVD +- Follow the [installation guide](../../../../../docs/installation/collection-installation.md) for AVD - Run the following playbook to copy the AVD **examples** to your current working directory, for example `ansible-avd-examples`: ```shell diff --git a/ansible_collections/arista/avd/examples/cv-pathfinder/README.md b/ansible_collections/arista/avd/examples/cv-pathfinder/README.md index b6eff246f79..a3e451112b2 100644 --- a/ansible_collections/arista/avd/examples/cv-pathfinder/README.md +++ b/ansible_collections/arista/avd/examples/cv-pathfinder/README.md @@ -34,7 +34,7 @@ This example will go over the following: ## Installation --8<-- -examples/common/installation.md +ansible_collections/arista/avd/examples/common/example-installation.md --8<-- ```shell @@ -172,7 +172,7 @@ In this example, we consider that no DNS entry is available to reach the devices ```yaml title="inventory.yml" --8<-- -examples/cv-pathfinder/inventory.yml +ansible_collections/arista/avd/examples/cv-pathfinder/inventory.yml --8<-- ``` @@ -182,7 +182,7 @@ when required to decrypt files or inline variables. ```yaml title="ansible.cfg" --8<-- -examples/cv-pathfinder/ansible.cfg +ansible_collections/arista/avd/examples/cv-pathfinder/ansible.cfg --8<-- ``` @@ -201,7 +201,7 @@ As discussed in the single DC example, basic connectivity between the Ansible ho ```eos title="site1-border1-basic-configuration.txt" --8<-- -examples/cv-pathfinder/switch-basic-configurations/site1-border1-basic-configuration.txt +ansible_collections/arista/avd/examples/cv-pathfinder/switch-basic-configurations/site1-border1-basic-configuration.txt --8<-- ``` @@ -214,7 +214,7 @@ To define device types, required by AVD, this example leverages the `default_nod ```yaml title="groups_vars/all.yml" --8<-- -examples/cv-pathfinder/group_vars/all.yml:19: +ansible_collections/arista/avd/examples/cv-pathfinder/group_vars/all.yml:19: --8<-- ``` @@ -266,7 +266,7 @@ The `management.yml` file contains the configuration for: ```yaml title="group_vars/WAN/management.yml" --8<-- -examples/cv-pathfinder/group_vars/WAN//management.yml +ansible_collections/arista/avd/examples/cv-pathfinder/group_vars/WAN//management.yml --8<-- ``` @@ -276,7 +276,7 @@ The `ansible-avd-examples/cv-pathfinder/group_vars/WAN/cv_pathfinder_settings.ym ```yaml title="group_vars/WAN/cv_pathfinder_settings.yml" --8<-- -examples/cv-pathfinder/group_vars/WAN//cv_pathfinder_settings.yml +ansible_collections/arista/avd/examples/cv-pathfinder/group_vars/WAN//cv_pathfinder_settings.yml --8<-- ``` @@ -369,7 +369,7 @@ apply common configurations. ```yaml title="group_vars/WAN/l3_interface_profiles.yml" --8<-- -examples/cv-pathfinder/group_vars/WAN//l3_interface_profiles.yml +ansible_collections/arista/avd/examples/cv-pathfinder/group_vars/WAN//l3_interface_profiles.yml --8<-- ``` @@ -385,7 +385,7 @@ used for DPS. ```yaml title="group_vars/WAN/tenants.yml" --8<-- -examples/cv-pathfinder/group_vars/WAN//tenants.yml +ansible_collections/arista/avd/examples/cv-pathfinder/group_vars/WAN//tenants.yml --8<-- ``` @@ -395,7 +395,7 @@ The pathfinder configuration can be found in `group_vars/PATHFINDERS.yml`: ```yaml title="group_vars/PATHFINDERS.yml" --8<-- -examples/cv-pathfinder/group_vars/PATHFINDERS.yml +ansible_collections/arista/avd/examples/cv-pathfinder/group_vars/PATHFINDERS.yml --8<-- ``` @@ -433,7 +433,7 @@ The following diagrams describe the connectivity of Site 1's physical, LAN, and ```yaml title="group_vars/SITE1.yml" --8<-- -examples/cv-pathfinder/group_vars/SITE1.yml +ansible_collections/arista/avd/examples/cv-pathfinder/group_vars/SITE1.yml --8<-- ``` @@ -460,7 +460,7 @@ The following diagrams describe the Site2 physical, LAN and HA tunnels connectiv ```yaml title="group_vars/SITE2.yml" --8<-- -examples/cv-pathfinder/group_vars/SITE2.yml +ansible_collections/arista/avd/examples/cv-pathfinder/group_vars/SITE2.yml --8<-- ``` @@ -478,7 +478,7 @@ The following diagrams describe the Site3 physical and LAN connectivity. ```yaml title="group_vars/SITE3.yml" --8<-- -examples/cv-pathfinder/group_vars/SITE3.yml +ansible_collections/arista/avd/examples/cv-pathfinder/group_vars/SITE3.yml --8<-- ``` @@ -494,7 +494,7 @@ Example of using this playbook without devices (local tasks): ```yaml --8<-- - examples/cv-pathfinder/build.yml + ansible_collections/arista/avd/examples/cv-pathfinder/build.yml --8<-- ``` @@ -523,7 +523,7 @@ To build and deploy the configurations to CVaaS, run first the `build.yml` playb ```yaml --8<-- - examples/cv-pathfinder/deploy.yml + ansible_collections/arista/avd/examples/cv-pathfinder/deploy.yml --8<-- ``` diff --git a/ansible_collections/arista/avd/examples/dual-dc-l3ls/README.md b/ansible_collections/arista/avd/examples/dual-dc-l3ls/README.md index 84983c0268b..afe567f4afb 100644 --- a/ansible_collections/arista/avd/examples/dual-dc-l3ls/README.md +++ b/ansible_collections/arista/avd/examples/dual-dc-l3ls/README.md @@ -43,7 +43,7 @@ There are two playbooks included in this example to show the following: ## Installation --8<-- -examples/common/installation.md +ansible_collections/arista/avd/examples/common/example-installation.md --8<-- ```shell @@ -162,7 +162,7 @@ In this example, we will consider that no DNS is available and define the IPs th ```yaml --8<-- - examples/dual-dc-l3ls/inventory.yml + ansible_collections/arista/avd/examples/dual-dc-l3ls/inventory.yml --8<-- ``` @@ -174,7 +174,7 @@ As discussed in the single DC scenario, all device types must be explicitly defi ```yaml --8<-- - examples/dual-dc-l3ls/group_vars/DC1_SPINES.yml + ansible_collections/arista/avd/examples/dual-dc-l3ls/group_vars/DC1_SPINES.yml --8<-- ``` @@ -182,7 +182,7 @@ As discussed in the single DC scenario, all device types must be explicitly defi ```yaml --8<-- - examples/dual-dc-l3ls/group_vars/DC1_L3_LEAVES.yml + ansible_collections/arista/avd/examples/dual-dc-l3ls/group_vars/DC1_L3_LEAVES.yml --8<-- ``` @@ -190,7 +190,7 @@ As discussed in the single DC scenario, all device types must be explicitly defi ```yaml --8<-- - examples/dual-dc-l3ls/group_vars/DC1_L2_LEAVES.yml + ansible_collections/arista/avd/examples/dual-dc-l3ls/group_vars/DC1_L2_LEAVES.yml --8<-- ``` @@ -198,7 +198,7 @@ As discussed in the single DC scenario, all device types must be explicitly defi ```yaml --8<-- - examples/dual-dc-l3ls/group_vars/DC2_SPINES.yml + ansible_collections/arista/avd/examples/dual-dc-l3ls/group_vars/DC2_SPINES.yml --8<-- ``` @@ -206,7 +206,7 @@ As discussed in the single DC scenario, all device types must be explicitly defi ```yaml --8<-- - examples/dual-dc-l3ls/group_vars/DC2_L3_LEAVES.yml + ansible_collections/arista/avd/examples/dual-dc-l3ls/group_vars/DC2_L3_LEAVES.yml --8<-- ``` @@ -214,7 +214,7 @@ As discussed in the single DC scenario, all device types must be explicitly defi ```yaml --8<-- - examples/dual-dc-l3ls/group_vars/DC2_L2_LEAVES.yml + ansible_collections/arista/avd/examples/dual-dc-l3ls/group_vars/DC2_L2_LEAVES.yml --8<-- ``` @@ -226,7 +226,7 @@ In this section, only additions to the previous example will be discussed. The o ```yaml title="FABRIC.yml" --8<-- - examples/dual-dc-l3ls/group_vars/FABRIC.yml:70:91 + ansible_collections/arista/avd/examples/dual-dc-l3ls/group_vars/FABRIC.yml:70:91 --8<-- ``` @@ -356,7 +356,7 @@ Since we are adding the EVPN DC GW functionality in DC2, we must also add it in ```yaml title="DC1.yml" --8<-- - examples/dual-dc-l3ls/group_vars/DC1.yml:82:111 + ansible_collections/arista/avd/examples/dual-dc-l3ls/group_vars/DC1.yml:82:111 --8<-- ``` @@ -364,7 +364,7 @@ Finally, the definition in DC2 for the L2 leaf switches: ```yaml title="DC2.yml" --8<-- - examples/dual-dc-l3ls/group_vars/DC2.yml:113:138 + ansible_collections/arista/avd/examples/dual-dc-l3ls/group_vars/DC2.yml:113:138 --8<-- ``` @@ -376,7 +376,7 @@ It is important to consider adding the new leaves to the Inventory as described ```yaml title="NETWORK_SERVICES.yml" --8<-- -examples/dual-dc-l3ls/group_vars/NETWORK_SERVICES.yml +ansible_collections/arista/avd/examples/dual-dc-l3ls/group_vars/NETWORK_SERVICES.yml --8<-- ``` @@ -386,7 +386,7 @@ After the previous section, all VRFs and VLANs across the fabric are now defined ```yaml title="CONNECTED_ENDPOINTS.yml" --8<-- -examples/dual-dc-l3ls/group_vars/CONNECTED_ENDPOINTS.yml +ansible_collections/arista/avd/examples/dual-dc-l3ls/group_vars/CONNECTED_ENDPOINTS.yml --8<-- ``` @@ -404,7 +404,7 @@ Example of using this playbook without devices (local tasks): ```yaml --8<-- - examples/dual-dc-l3ls/build.yml + ansible_collections/arista/avd/examples/dual-dc-l3ls/build.yml --8<-- ``` @@ -418,7 +418,7 @@ To build and deploy the configurations to your switches directly, using eAPI, ru ```yaml --8<-- - examples/dual-dc-l3ls/deploy.yml + ansible_collections/arista/avd/examples/dual-dc-l3ls/deploy.yml --8<-- ``` @@ -447,7 +447,7 @@ ok: [dc1-leaf1a -> localhost] => (item=/home/user/Documents/git_projects/ansible If similar output is not shown, make sure: -1. The documented [requirements](../../docs/installation/collection-installation.md) are met. +1. The documented [requirements](../../../../../docs/installation/collection-installation.md) are met. 2. The latest `arista.avd` collection is installed. ## Troubleshooting diff --git a/ansible_collections/arista/avd/examples/isis-ldp-ipvpn/README.md b/ansible_collections/arista/avd/examples/isis-ldp-ipvpn/README.md index a2f3920d821..b2c4f8e2efe 100644 --- a/ansible_collections/arista/avd/examples/isis-ldp-ipvpn/README.md +++ b/ansible_collections/arista/avd/examples/isis-ldp-ipvpn/README.md @@ -12,7 +12,7 @@ title: AVD example for a MPLS-VPN based WAN Network ## Introduction -This example is the logical second step in introducing AVD to new users, following the [Introduction to Ansible and AVD](../../docs/getting-started/intro-to-ansible-and-avd.md) section. New users with access to virtual routers (using Arista vEOS-lab or cEOS) can learn how to generate configuration and documentation for a complete fabric environment. Users with access to physical routers will have to adapt a few settings. This is all documented inline in the comments included in the YAML files. If a lab with virtual or physical routers is not accessible, this example can also be used to only generate the output from AVD if desired. +This example is the logical second step in introducing AVD to new users, following the [Introduction to Ansible and AVD](../../../../../docs/getting-started/intro-to-ansible-and-avd.md) section. New users with access to virtual routers (using Arista vEOS-lab or cEOS) can learn how to generate configuration and documentation for a complete fabric environment. Users with access to physical routers will have to adapt a few settings. This is all documented inline in the comments included in the YAML files. If a lab with virtual or physical routers is not accessible, this example can also be used to only generate the output from AVD if desired. The example includes and describes all the AVD files and their content used to build a MPLS-VPN WAN network covering two sites using the following: @@ -25,7 +25,7 @@ This example does not include Integration with CloudVision to keep everything as ## Installation --8<-- -examples/common/installation.md +ansible_collections/arista/avd/examples/common/example-installation.md --8<-- ```shell @@ -98,7 +98,7 @@ Below is the basic configuration file for `p1`: ```eos title="p1-basic-configuration.txt" --8<-- -examples/isis-ldp-ipvpn/switch-basic-configurations/p1-basic-configuration.txt +ansible_collections/arista/avd/examples/isis-ldp-ipvpn/switch-basic-configurations/p1-basic-configuration.txt --8<-- ``` @@ -230,7 +230,7 @@ Since this example covers building a MPLS WAN network, AVD must know about the d ```yaml --8<-- - examples/isis-ldp-ipvpn/group_vars/WAN1_P_ROUTERS.yml + ansible_collections/arista/avd/examples/isis-ldp-ipvpn/group_vars/WAN1_P_ROUTERS.yml --8<-- ``` @@ -238,7 +238,7 @@ Since this example covers building a MPLS WAN network, AVD must know about the d ```yaml --8<-- - examples/isis-ldp-ipvpn/group_vars/WAN1_PE_ROUTERS.yml + ansible_collections/arista/avd/examples/isis-ldp-ipvpn/group_vars/WAN1_PE_ROUTERS.yml --8<-- ``` @@ -246,7 +246,7 @@ Since this example covers building a MPLS WAN network, AVD must know about the d ```yaml --8<-- - examples/isis-ldp-ipvpn/group_vars/WAN1_RR_ROUTERS.yml + ansible_collections/arista/avd/examples/isis-ldp-ipvpn/group_vars/WAN1_RR_ROUTERS.yml --8<-- ``` @@ -441,7 +441,7 @@ core_interfaces: ```yaml title="NETWORK_SERVICES.yml" --8<-- -examples/isis-ldp-ipvpn/group_vars/NETWORK_SERVICES.yml +ansible_collections/arista/avd/examples/isis-ldp-ipvpn/group_vars/NETWORK_SERVICES.yml --8<-- ``` @@ -480,7 +480,7 @@ In this example, the deploy playbook looks like the following: ```yaml title="deploy.yml" --8<-- -examples/isis-ldp-ipvpn/deploy.yml +ansible_collections/arista/avd/examples/isis-ldp-ipvpn/deploy.yml --8<-- ``` @@ -495,7 +495,7 @@ Example of using the build playbook without devices (local tasks): ```yaml title="build.yml" --8<-- -examples/isis-ldp-ipvpn/build.yml +ansible_collections/arista/avd/examples/isis-ldp-ipvpn/build.yml --8<-- ``` @@ -523,7 +523,7 @@ ok: [p1 -> localhost] => (item=/home/user/Documents/git_projects/ansible-avd-exa If similar output is not shown, make sure: -1. The documented [requirements](../../docs/installation/collection-installation.md) are met. +1. The documented [requirements](../../../../../docs/installation/collection-installation.md) are met. 2. The latest `arista.avd` collection is installed. ## Troubleshooting diff --git a/ansible_collections/arista/avd/examples/l2ls-fabric/README.md b/ansible_collections/arista/avd/examples/l2ls-fabric/README.md index b1661b4f877..6cc05ce5481 100644 --- a/ansible_collections/arista/avd/examples/l2ls-fabric/README.md +++ b/ansible_collections/arista/avd/examples/l2ls-fabric/README.md @@ -28,7 +28,7 @@ The example is meant as a starting foundation. You may build more advanced fabri ## Installation & Requirements --8<-- -examples/common/installation.md +ansible_collections/arista/avd/examples/common/example-installation.md --8<-- ``` shell @@ -75,7 +75,7 @@ Below is the basic configuration file for SPINE1: ``` shell --8<-- -examples/l2ls-fabric/switch-basic-configurations/SPINE1.cfg +ansible_collections/arista/avd/examples/l2ls-fabric/switch-basic-configurations/SPINE1.cfg --8<-- ``` @@ -112,7 +112,7 @@ Alternatively, if DNS is unavailable, define the ansible_host variable as an IP ``` yaml --8<-- -examples/l2ls-fabric/inventory.yml +ansible_collections/arista/avd/examples/l2ls-fabric/inventory.yml --8<-- ``` @@ -138,7 +138,7 @@ The tabs below show the Ansible **group_vars** used in this example. ``` yaml --8<-- - examples/l2ls-fabric/group_vars/DC1.yml + ansible_collections/arista/avd/examples/l2ls-fabric/group_vars/DC1.yml --8<-- ``` @@ -151,7 +151,7 @@ The tabs below show the Ansible **group_vars** used in this example. ``` yaml --8<-- - examples/l2ls-fabric/group_vars/DC1_FABRIC.yml + ansible_collections/arista/avd/examples/l2ls-fabric/group_vars/DC1_FABRIC.yml --8<-- ``` @@ -160,7 +160,7 @@ The tabs below show the Ansible **group_vars** used in this example. ``` yaml --8<-- - examples/l2ls-fabric/group_vars/DC1_SPINES.yml + ansible_collections/arista/avd/examples/l2ls-fabric/group_vars/DC1_SPINES.yml --8<-- ``` @@ -169,7 +169,7 @@ The tabs below show the Ansible **group_vars** used in this example. ``` yaml --8<-- - examples/l2ls-fabric/group_vars/DC1_LEAFS.yml + ansible_collections/arista/avd/examples/l2ls-fabric/group_vars/DC1_LEAFS.yml --8<-- ``` @@ -178,7 +178,7 @@ The tabs below show the Ansible **group_vars** used in this example. ``` yaml --8<-- - examples/l2ls-fabric/group_vars/DC1_NETWORK_SERVICES.yml + ansible_collections/arista/avd/examples/l2ls-fabric/group_vars/DC1_NETWORK_SERVICES.yml --8<-- ``` @@ -187,7 +187,7 @@ The tabs below show the Ansible **group_vars** used in this example. ``` yaml --8<-- - examples/l2ls-fabric/group_vars/DC1_NETWORK_PORTS.yml + ansible_collections/arista/avd/examples/l2ls-fabric/group_vars/DC1_NETWORK_PORTS.yml --8<-- ``` @@ -199,7 +199,7 @@ Now that we have defined all of our Ansible variables (AVD inputs), it is time t ``` yaml --8<-- - examples/l2ls-fabric/build.yml + ansible_collections/arista/avd/examples/l2ls-fabric/build.yml --8<-- ``` @@ -207,7 +207,7 @@ Now that we have defined all of our Ansible variables (AVD inputs), it is time t ``` yaml --8<-- - examples/l2ls-fabric/deploy.yml + ansible_collections/arista/avd/examples/l2ls-fabric/deploy.yml --8<-- ``` @@ -237,7 +237,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/l2ls-fabric/intended/configs/SPINE1.cfg + ansible_collections/arista/avd/examples/l2ls-fabric/intended/configs/SPINE1.cfg --8<-- ``` @@ -245,7 +245,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/l2ls-fabric/intended/configs/SPINE2.cfg + ansible_collections/arista/avd/examples/l2ls-fabric/intended/configs/SPINE2.cfg --8<-- ``` @@ -253,7 +253,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/l2ls-fabric/intended/configs/LEAF1.cfg + ansible_collections/arista/avd/examples/l2ls-fabric/intended/configs/LEAF1.cfg --8<-- ``` @@ -261,7 +261,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/l2ls-fabric/intended/configs/LEAF2.cfg + ansible_collections/arista/avd/examples/l2ls-fabric/intended/configs/LEAF2.cfg --8<-- ``` @@ -269,7 +269,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/l2ls-fabric/intended/configs/LEAF3.cfg + ansible_collections/arista/avd/examples/l2ls-fabric/intended/configs/LEAF3.cfg --8<-- ``` @@ -277,7 +277,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/l2ls-fabric/intended/configs/LEAF4.cfg + ansible_collections/arista/avd/examples/l2ls-fabric/intended/configs/LEAF4.cfg --8<-- ``` diff --git a/ansible_collections/arista/avd/examples/single-dc-l3ls/README.md b/ansible_collections/arista/avd/examples/single-dc-l3ls/README.md index f750aec50ac..84fc9039198 100644 --- a/ansible_collections/arista/avd/examples/single-dc-l3ls/README.md +++ b/ansible_collections/arista/avd/examples/single-dc-l3ls/README.md @@ -12,7 +12,7 @@ title: AVD example for a single data center using L3LS ## Introduction -This example is meant to be used as the logical second step in introducing AVD to new users, directly following the [Introduction to Ansible and AVD](../../docs/getting-started/intro-to-ansible-and-avd.md) section. New users with access to virtual switches (using Arista vEOS-lab or cEOS) can learn how to generate configuration and documentation for a complete fabric environment. Users with access to physical switches will have to adapt a few settings. This is all documented inline in the comments included in the YAML files. If a lab with virtual or physical switches is not accessible, this example can be used only to generate the output from AVD if required. +This example is meant to be used as the logical second step in introducing AVD to new users, directly following the [Introduction to Ansible and AVD](../../../../../docs/getting-started/intro-to-ansible-and-avd.md) section. New users with access to virtual switches (using Arista vEOS-lab or cEOS) can learn how to generate configuration and documentation for a complete fabric environment. Users with access to physical switches will have to adapt a few settings. This is all documented inline in the comments included in the YAML files. If a lab with virtual or physical switches is not accessible, this example can be used only to generate the output from AVD if required. The example includes and describes all the AVD files and their content used to build an L3LS EVPN/VXLAN Symmetric IRB network covering a single DC using the following: @@ -29,7 +29,7 @@ Ansible playbooks are included to show the following: ## Installation --8<-- -examples/common/installation.md +ansible_collections/arista/avd/examples/common/example-installation.md --8<-- ```shell @@ -108,7 +108,7 @@ Below is the basic configuration file for `dc1-leaf1a`: ```eos title="dc1-leaf1a-basic-configuration.txt" --8<-- -examples/single-dc-l3ls/switch-basic-configurations/dc1-leaf1a-basic-configuration.txt +ansible_collections/arista/avd/examples/single-dc-l3ls/switch-basic-configurations/dc1-leaf1a-basic-configuration.txt --8<-- ``` @@ -161,7 +161,7 @@ Alternatively, if there is no DNS available, or if devices need to be reached us ```yaml title="inventory.yml" --8<-- -examples/single-dc-l3ls/inventory.yml +ansible_collections/arista/avd/examples/single-dc-l3ls/inventory.yml --8<-- ``` @@ -222,7 +222,7 @@ all: - Please note that the username (`ansible`) and password (`ansible`) defined here must exist in CloudVision. - - More information is available [here](https://avd.sh/en/stable/roles/eos_config_deploy_cvp/index.html?h=is_deployed#inputs) + - More information is available [here](https://avd.arista.com/stable/roles/eos_config_deploy_cvp/index.html?h=is_deployed#inputs) 2. `NETWORK_SERVICES` @@ -244,7 +244,7 @@ Since this example covers building an L3LS network, AVD must know about the devi ```yaml --8<-- - examples/single-dc-l3ls/group_vars/DC1_SPINES.yml + ansible_collections/arista/avd/examples/single-dc-l3ls/group_vars/DC1_SPINES.yml --8<-- ``` @@ -252,7 +252,7 @@ Since this example covers building an L3LS network, AVD must know about the devi ```yaml --8<-- - examples/single-dc-l3ls/group_vars/DC1_L3_LEAVES.yml + ansible_collections/arista/avd/examples/single-dc-l3ls/group_vars/DC1_L3_LEAVES.yml --8<-- ``` @@ -260,7 +260,7 @@ Since this example covers building an L3LS network, AVD must know about the devi ```yaml --8<-- - examples/single-dc-l3ls/group_vars/DC1_L2_LEAVES.yml + ansible_collections/arista/avd/examples/single-dc-l3ls/group_vars/DC1_L2_LEAVES.yml --8<-- ``` @@ -569,7 +569,7 @@ After the previous section, all VRFs and VLANs across the fabric are now defined ```yaml title="CONNECTED_ENDPOINTS.yml" --8<-- -examples/single-dc-l3ls/group_vars/CONNECTED_ENDPOINTS.yml +ansible_collections/arista/avd/examples/single-dc-l3ls/group_vars/CONNECTED_ENDPOINTS.yml --8<-- ``` @@ -622,7 +622,7 @@ The `build.yml` playbook looks like the following: ```yaml title="build.yml" --8<-- -examples/single-dc-l3ls/build.yml +ansible_collections/arista/avd/examples/single-dc-l3ls/build.yml --8<-- ``` @@ -634,7 +634,7 @@ The `deploy.yml` playbook looks like the following: ```yaml title="deploy.yml" --8<-- -examples/single-dc-l3ls/deploy.yml +ansible_collections/arista/avd/examples/single-dc-l3ls/deploy.yml --8<-- ``` @@ -645,7 +645,7 @@ The `deploy-cvp.yml` playbook looks like the following: ```yaml title="deploy-cvp.yml" --8<-- -examples/single-dc-l3ls/deploy-cvp.yml +ansible_collections/arista/avd/examples/single-dc-l3ls/deploy-cvp.yml --8<-- ``` @@ -704,7 +704,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/single-dc-l3ls/intended/configs/dc1-spine1.cfg + ansible_collections/arista/avd/examples/single-dc-l3ls/intended/configs/dc1-spine1.cfg --8<-- ``` @@ -712,7 +712,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/single-dc-l3ls/intended/configs/dc1-spine2.cfg + ansible_collections/arista/avd/examples/single-dc-l3ls/intended/configs/dc1-spine2.cfg --8<-- ``` @@ -720,7 +720,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/single-dc-l3ls/intended/configs/dc1-leaf1a.cfg + ansible_collections/arista/avd/examples/single-dc-l3ls/intended/configs/dc1-leaf1a.cfg --8<-- ``` @@ -728,7 +728,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/single-dc-l3ls/intended/configs/dc1-leaf1b.cfg + ansible_collections/arista/avd/examples/single-dc-l3ls/intended/configs/dc1-leaf1b.cfg --8<-- ``` @@ -736,7 +736,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/single-dc-l3ls/intended/configs/dc1-leaf1c.cfg + ansible_collections/arista/avd/examples/single-dc-l3ls/intended/configs/dc1-leaf1c.cfg --8<-- ``` @@ -744,7 +744,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/single-dc-l3ls/intended/configs/dc1-leaf2a.cfg + ansible_collections/arista/avd/examples/single-dc-l3ls/intended/configs/dc1-leaf2a.cfg --8<-- ``` @@ -752,7 +752,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/single-dc-l3ls/intended/configs/dc1-leaf2b.cfg + ansible_collections/arista/avd/examples/single-dc-l3ls/intended/configs/dc1-leaf2b.cfg --8<-- ``` @@ -760,7 +760,7 @@ Your configuration files should be similar to these. ``` shell --8<-- - examples/single-dc-l3ls/intended/configs/dc1-leaf2c.cfg + ansible_collections/arista/avd/examples/single-dc-l3ls/intended/configs/dc1-leaf2c.cfg --8<-- ``` @@ -782,7 +782,7 @@ ok: [dc1-leaf1a -> localhost] => (item=/home/user/Documents/git_projects/ansible If similar output is not shown, make sure: -1. The documented [requirements](../../docs/installation/collection-installation.md) are met. +1. The documented [requirements](../../../../../docs/installation/collection-installation.md) are met. 2. The latest `arista.avd` collection is installed. ## Troubleshooting diff --git a/ansible_collections/arista/avd/plugins/modules/cv_workflow.py b/ansible_collections/arista/avd/plugins/modules/cv_workflow.py index 31eda6d0ad9..62ee4e91dce 100644 --- a/ansible_collections/arista/avd/plugins/modules/cv_workflow.py +++ b/ansible_collections/arista/avd/plugins/modules/cv_workflow.py @@ -138,10 +138,12 @@ - |- When interacting with CVaaS the regional URL where the tenant is deployed should be used, e.g: `cv_servers: [ www.cv-prod-euwest-2.arista.io ]` - To see the full list of regional URLs, please visit the [cv_deploy](../../../roles/cv_deploy/README.md#overview) + To see the full list of regional URLs, please visit the + [cv_deploy](../../../ansible_collections/arista/avd/roles/cv_deploy/README.md#overview) role documentation. - |- - To generate service accounts check [cv_deploy](../../../roles/cv_deploy/README.md#steps-to-create-service-accounts-on-cloudvision) + To generate service accounts check + [cv_deploy](../../../ansible_collections/arista/avd/roles/cv_deploy/README.md#steps-to-create-service-accounts-on-cloudvision) role documentation or the CloudVision Help Center. """ diff --git a/ansible_collections/arista/avd/roles/build_output_folders/README.md b/ansible_collections/arista/avd/roles/build_output_folders/README.md index 1ec8afa9dc2..118fba42fa3 100644 --- a/ansible_collections/arista/avd/roles/build_output_folders/README.md +++ b/ansible_collections/arista/avd/roles/build_output_folders/README.md @@ -81,4 +81,4 @@ Below is an example to use in your playbook to build output folders using defaul ## License -Project is published under [Apache 2.0 License](../../LICENSE) +Project is published under [Apache 2.0 License](https://github.com/aristanetworks/avd/blob/devel/LICENSE) diff --git a/ansible_collections/arista/avd/roles/cv_deploy/README.md b/ansible_collections/arista/avd/roles/cv_deploy/README.md index 517eef7eecd..9fb65b29146 100644 --- a/ansible_collections/arista/avd/roles/cv_deploy/README.md +++ b/ansible_collections/arista/avd/roles/cv_deploy/README.md @@ -55,7 +55,7 @@ The API to CloudVision is using gRPC over encrypted HTTP/2. - Configuration deployment is based on the "Static Configuration Studio" which was a Beta feature on CloudVision 2024.1.0. Make sure to enable "Studios - End-to-End Provisioning" under Settings, Features. - ![Figure 1: Ansible Role arista.avd.cv_deploy](../../docs/_media/studios_end_to_end_provisioning.png) + ![Figure 1: Ansible Role arista.avd.cv_deploy](../../../../../docs/_media/studios_end_to_end_provisioning.png) - Currently only the first of the given cv_servers is being used. ## Roadmap @@ -96,8 +96,8 @@ The workspace will be built and submitted, and a change control will be created Figure 2 below provides a visualization of the role's inputs, outputs executed by the role. -![Figure 2: Ansible Role arista.avd.cv_deploy](../../docs/_media/cv_deploy_dark.svg#only-dark) -![Figure 2: Ansible Role arista.avd.cv_deploy](../../docs/_media/cv_deploy_light.svg#only-light) +![Figure 2: Ansible Role arista.avd.cv_deploy](../../../../../docs/_media/cv_deploy_dark.svg#only-dark) +![Figure 2: Ansible Role arista.avd.cv_deploy](../../../../../docs/_media/cv_deploy_light.svg#only-light) ### Inputs @@ -253,7 +253,7 @@ The directories are configured with the same variables as for the other AVD role ```yaml --8<-- -roles/cv_deploy/defaults/main/directories.yml +ansible_collections/arista/avd/roles/cv_deploy/defaults/main/directories.yml --8<-- ``` @@ -270,9 +270,9 @@ Make sure to copy the generated password. You only get view it once. Click "Save" to exit the dialogue box. ``` -![Figure: 1](../../media/serviceaccount1.png) -![Figure: 2](../../media/serviceaccount2.png) -![Figure: 3](../../media/serviceaccount3.png) +![Figure: 1](../../../../../docs/_media/serviceaccount1.png) +![Figure: 2](../../../../../docs/_media/serviceaccount2.png) +![Figure: 3](../../../../../docs/_media/serviceaccount3.png) !!! note The name of the service account must match a username configured to be authorized on @@ -280,4 +280,4 @@ Click "Save" to exit the dialogue box. ## License -Project is published under [Apache 2.0 License](../../LICENSE) +Project is published under [Apache 2.0 License](https://github.com/aristanetworks/avd/blob/devel/LICENSE) diff --git a/ansible_collections/arista/avd/roles/cvp_configlet_upload/README.md b/ansible_collections/arista/avd/roles/cvp_configlet_upload/README.md index 5f64f99494a..ba214e7f568 100644 --- a/ansible_collections/arista/avd/roles/cvp_configlet_upload/README.md +++ b/ansible_collections/arista/avd/roles/cvp_configlet_upload/README.md @@ -26,8 +26,8 @@ ansible-galaxy collection install arista.cvp Figure 1 below provides a visualization of the role's inputs, outputs, and tasks in order executed by the role. -![Figure 1: Ansible Role cvp_configlet_upload](../../docs/_media/cvp_configlet_upload_dark.svg#only-dark) -![Figure 1: Ansible Role cvp_configlet_upload](../../docs/_media/cvp_configlet_upload_light.svg#only-light) +![Figure 1: Ansible Role cvp_configlet_upload](../../../../../docs/_media/cvp_configlet_upload_dark.svg#only-dark) +![Figure 1: Ansible Role cvp_configlet_upload](../../../../../docs/_media/cvp_configlet_upload_light.svg#only-light) 1. Read content of `{{ configlet_directory }}` and create **cv_configlet** input structure. 2. Collect CloudVision facts. @@ -101,8 +101,8 @@ ansible-playbook playbook.to.deploy.with.cvp.yml --tags "provision" ## Requirements -Requirements are located here: [avd-requirements](../../docs/installation/collection-installation.md#python-requirements-installation) +Requirements are located here: [avd-requirements](../../../../../docs/installation/collection-installation.md#python-requirements-installation) ## License -Project is published under [Apache 2.0 License](../../LICENSE) +Project is published under [Apache 2.0 License](https://github.com/aristanetworks/avd/blob/devel/LICENSE) diff --git a/ansible_collections/arista/avd/roles/dhcp_provisioner/README.md b/ansible_collections/arista/avd/roles/dhcp_provisioner/README.md index ab784e40aac..b5d47f92704 100644 --- a/ansible_collections/arista/avd/roles/dhcp_provisioner/README.md +++ b/ansible_collections/arista/avd/roles/dhcp_provisioner/README.md @@ -129,8 +129,8 @@ custom_structured_configuration_daemon_terminattr: ## Requirements -Requirements are located here: [avd-requirements](../../docs/installation/collection-installation.md#python-requirements-installation) +Requirements are located here: [avd-requirements](../../../../../docs/installation/collection-installation.md#python-requirements-installation) ## License -Project is published under [Apache 2.0 License](../../LICENSE) +Project is published under [Apache 2.0 License](https://github.com/aristanetworks/avd/blob/devel/LICENSE) diff --git a/ansible_collections/arista/avd/roles/eos_cli_config_gen/README.md b/ansible_collections/arista/avd/roles/eos_cli_config_gen/README.md index bed4372c3e5..ace1426f6fc 100644 --- a/ansible_collections/arista/avd/roles/eos_cli_config_gen/README.md +++ b/ansible_collections/arista/avd/roles/eos_cli_config_gen/README.md @@ -24,8 +24,8 @@ The **eos_cli_config_gen** role: Figure 1 below provides a visualization of the roles inputs, and outputs and tasks in order executed by the role. -![Figure 1: Ansible Role eos_cli_config_gen](../../docs/_media/eos_cli_config_gen_dark.svg#only-dark) -![Figure 1: Ansible Role eos_cli_config_gen](../../docs/_media/eos_cli_config_gen_light.svg#only-light) +![Figure 1: Ansible Role eos_cli_config_gen](../../../../../docs/_media/eos_cli_config_gen_dark.svg#only-dark) +![Figure 1: Ansible Role eos_cli_config_gen](../../../../../docs/_media/eos_cli_config_gen_light.svg#only-light) **Inputs:** @@ -44,7 +44,7 @@ Figure 1 below provides a visualization of the roles inputs, and outputs and tas ## Requirements -Requirements are located in the [collection installation guide](../../docs/installation/collection-installation.md) +Requirements are located in the [collection installation guide](../../../../../docs/installation/collection-installation.md) ## Input Variables @@ -58,4 +58,4 @@ Role configuration settings can be set either as regular inventory variables or ## License -Project is published under [Apache 2.0 License](../../LICENSE) +Project is published under [Apache 2.0 License](https://github.com/aristanetworks/avd/blob/devel/LICENSE) diff --git a/ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/how-to/custom-templates.md b/ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/how-to/custom-templates.md index 32f1ce190e3..698b6d351be 100644 --- a/ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/how-to/custom-templates.md +++ b/ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/how-to/custom-templates.md @@ -41,7 +41,7 @@ custom_templates: - custom_template_name.j2 ``` -For more details, see [Extensibility with Custom Templates](https://avd.sh/en/stable/roles/eos_cli_config_gen/docs/role-configuration.html#extensibility-with-custom-templates) +For more details, see [Extensibility with Custom Templates](https://avd.arista.com/stable/roles/eos_cli_config_gen/docs/role-configuration.html#extensibility-with-custom-templates) ## Adding the Custom Template to the `eos_cli_config_gen` Role diff --git a/ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/input-variables.md b/ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/input-variables.md index 3f23f535102..e8abfc8148c 100644 --- a/ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/input-variables.md +++ b/ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/input-variables.md @@ -12,7 +12,7 @@ title: Input variables for eos_cli_config_gen This document describes the supported input variables for the role `arista.avd.eos_cli_config_gen`. -Since several data models have changed between AVD versions 4.x and 5.x, it is recommended to study the [Porting Guide for AVD 5.x.x](../../../docs/porting-guides/5.x.x.md) for existing deployments. +Since several data models have changed between AVD versions 4.x and 5.x, it is recommended to study the [Porting Guide for AVD 5.x.x](../../../../../../docs/porting-guides/5.x.x.md) for existing deployments. The input variables are documented below in tables and YAML. @@ -29,73 +29,73 @@ All values are optional. ### AAA accounting --8<-- -roles/eos_cli_config_gen/docs/tables/aaa-accounting.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/aaa-accounting.md --8<-- ### AAA authentication --8<-- -roles/eos_cli_config_gen/docs/tables/aaa-authentication.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/aaa-authentication.md --8<-- ### AAA authorization --8<-- -roles/eos_cli_config_gen/docs/tables/aaa-authorization.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/aaa-authorization.md --8<-- ### AAA root --8<-- -roles/eos_cli_config_gen/docs/tables/aaa-root.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/aaa-root.md --8<-- ### AAA server groups --8<-- -roles/eos_cli_config_gen/docs/tables/aaa-server-groups.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/aaa-server-groups.md --8<-- ### Enable password --8<-- -roles/eos_cli_config_gen/docs/tables/enable-password.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/enable-password.md --8<-- ### IP radius source-interfaces --8<-- -roles/eos_cli_config_gen/docs/tables/ip-radius-source-interfaces.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ip-radius-source-interfaces.md --8<-- ### IP tacacs source-interfaces --8<-- -roles/eos_cli_config_gen/docs/tables/ip-tacacs-source-interfaces.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ip-tacacs-source-interfaces.md --8<-- ### Local users --8<-- -roles/eos_cli_config_gen/docs/tables/local-users.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/local-users.md --8<-- ### Radius server --8<-- -roles/eos_cli_config_gen/docs/tables/radius-server.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/radius-server.md --8<-- ### Roles --8<-- -roles/eos_cli_config_gen/docs/tables/roles.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/roles.md --8<-- ### Tacacs servers --8<-- -roles/eos_cli_config_gen/docs/tables/tacacs-servers.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/tacacs-servers.md --8<-- ## ACLs @@ -113,13 +113,13 @@ Access list names must be unique. The legacy data model supports simplified ACL definition with `sequence` to `action` mapping: --8<-- -roles/eos_cli_config_gen/docs/tables/access-lists.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/access-lists.md --8<-- The improved data model has a more sophisticated design documented below: --8<-- -roles/eos_cli_config_gen/docs/tables/ip-access-lists.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ip-access-lists.md --8<-- The improved data model allows to limit the number of ACL entries that AVD is allowed to generate by defining `ip_access_lists_max_entries`. @@ -128,31 +128,31 @@ If the number is above the limit, the playbook will fail. This provides a simpli The numbers must be based on the hardware tests and AVD does not provide any guidance. Note that other EOS features may use the same hardware resources and affect the supported scale. --8<-- -roles/eos_cli_config_gen/docs/tables/ip-access-lists-max-entries.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ip-access-lists-max-entries.md --8<-- ### IPv6 access-lists --8<-- -roles/eos_cli_config_gen/docs/tables/ipv6-access-lists.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ipv6-access-lists.md --8<-- ### IPv6 standard access-lists --8<-- -roles/eos_cli_config_gen/docs/tables/ipv6-standard-access-lists.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ipv6-standard-access-lists.md --8<-- ### MAC access-lists --8<-- -roles/eos_cli_config_gen/docs/tables/mac-access-lists.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/mac-access-lists.md --8<-- ### Standard access-lists --8<-- -roles/eos_cli_config_gen/docs/tables/standard-access-lists.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/standard-access-lists.md --8<-- ## Endpoint Security @@ -160,19 +160,19 @@ roles/eos_cli_config_gen/docs/tables/standard-access-lists.md ### Address-locking --8<-- -roles/eos_cli_config_gen/docs/tables/address-locking.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/address-locking.md --8<-- ### Dot1x --8<-- -roles/eos_cli_config_gen/docs/tables/dot1x.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/dot1x.md --8<-- ### MAC security --8<-- -roles/eos_cli_config_gen/docs/tables/mac-security.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/mac-security.md --8<-- ## Filters and policies @@ -180,19 +180,19 @@ roles/eos_cli_config_gen/docs/tables/mac-security.md ### AS path --8<-- -roles/eos_cli_config_gen/docs/tables/as-path.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/as-path.md --8<-- ### Class-maps --8<-- -roles/eos_cli_config_gen/docs/tables/class-maps.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/class-maps.md --8<-- ### Dynamic prefix lists --8<-- -roles/eos_cli_config_gen/docs/tables/dynamic-prefix-lists.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/dynamic-prefix-lists.md --8<-- ### IP community lists @@ -208,73 +208,73 @@ Community list names must be unique. The legacy data model supports simplified community list definition that only allows a single action to be defined as string: --8<-- -roles/eos_cli_config_gen/docs/tables/community-lists.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/community-lists.md --8<-- The improved data model has a better design documented below: --8<-- -roles/eos_cli_config_gen/docs/tables/ip-community-lists.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ip-community-lists.md --8<-- ### IP extcommunity-lists --8<-- -roles/eos_cli_config_gen/docs/tables/ip-extcommunity-lists.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ip-extcommunity-lists.md --8<-- ### IP extcommunity-lists-regexp --8<-- -roles/eos_cli_config_gen/docs/tables/ip-extcommunity-lists-regexp.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ip-extcommunity-lists-regexp.md --8<-- ### IPv6 prefix-lists --8<-- -roles/eos_cli_config_gen/docs/tables/ipv6-prefix-lists.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ipv6-prefix-lists.md --8<-- ### Match list input --8<-- -roles/eos_cli_config_gen/docs/tables/match-list-input.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/match-list-input.md --8<-- ### Peer-filters --8<-- -roles/eos_cli_config_gen/docs/tables/peer-filters.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/peer-filters.md --8<-- ### Policy-maps --8<-- -roles/eos_cli_config_gen/docs/tables/policy-maps.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/policy-maps.md --8<-- ### Prefix-lists --8<-- -roles/eos_cli_config_gen/docs/tables/prefix-lists.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/prefix-lists.md --8<-- ### Route-maps --8<-- -roles/eos_cli_config_gen/docs/tables/route-maps.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/route-maps.md --8<-- ### Trackers --8<-- -roles/eos_cli_config_gen/docs/tables/trackers.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/trackers.md --8<-- ### Traffic policies --8<-- -roles/eos_cli_config_gen/docs/tables/traffic-policies.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/traffic-policies.md --8<-- ## Interfaces @@ -282,109 +282,109 @@ roles/eos_cli_config_gen/docs/tables/traffic-policies.md ### DPS interfaces --8<-- -roles/eos_cli_config_gen/docs/tables/dps-interfaces.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/dps-interfaces.md --8<-- ### Errdisable --8<-- -roles/eos_cli_config_gen/docs/tables/errdisable.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/errdisable.md --8<-- ### Ethernet interfaces --8<-- -roles/eos_cli_config_gen/docs/tables/ethernet-interfaces.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ethernet-interfaces.md --8<-- ### Interface defaults --8<-- -roles/eos_cli_config_gen/docs/tables/interface-defaults.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/interface-defaults.md --8<-- ### Interface profiles --8<-- -roles/eos_cli_config_gen/docs/tables/interface-profiles.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/interface-profiles.md --8<-- ### LACP --8<-- -roles/eos_cli_config_gen/docs/tables/lacp.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/lacp.md --8<-- ### Link tracking groups --8<-- -roles/eos_cli_config_gen/docs/tables/link-tracking-groups.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/link-tracking-groups.md --8<-- ### LLDP --8<-- -roles/eos_cli_config_gen/docs/tables/lldp.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/lldp.md --8<-- ### Loopback interfaces --8<-- -roles/eos_cli_config_gen/docs/tables/loopback-interfaces.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/loopback-interfaces.md --8<-- ### Management interfaces --8<-- -roles/eos_cli_config_gen/docs/tables/management-interfaces.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/management-interfaces.md --8<-- ### Patch panel --8<-- -roles/eos_cli_config_gen/docs/tables/patch-panel.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/patch-panel.md --8<-- ### Port-channel interfaces --8<-- -roles/eos_cli_config_gen/docs/tables/port-channel-interfaces.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/port-channel-interfaces.md --8<-- ### Switchport default --8<-- -roles/eos_cli_config_gen/docs/tables/switchport-default.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/switchport-default.md --8<-- ### Switchport port security --8<-- -roles/eos_cli_config_gen/docs/tables/switchport-port-security.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/switchport-port-security.md --8<-- ### Transceiver QSFP default mode 4x10 --8<-- -roles/eos_cli_config_gen/docs/tables/transceiver-qsfp-default-mode-4x10.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/transceiver-qsfp-default-mode-4x10.md --8<-- ### Tunnel interfaces --8<-- -roles/eos_cli_config_gen/docs/tables/tunnel-interfaces.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/tunnel-interfaces.md --8<-- ### VLAN interfaces --8<-- -roles/eos_cli_config_gen/docs/tables/vlan-interfaces.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/vlan-interfaces.md --8<-- ### VXLAN interface --8<-- -roles/eos_cli_config_gen/docs/tables/vxlan-interface.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/vxlan-interface.md --8<-- ## Maintenance Mode @@ -392,19 +392,19 @@ roles/eos_cli_config_gen/docs/tables/vxlan-interface.md ### BGP groups --8<-- -roles/eos_cli_config_gen/docs/tables/bgp-groups.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/bgp-groups.md --8<-- ### Interface groups --8<-- -roles/eos_cli_config_gen/docs/tables/interface-groups.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/interface-groups.md --8<-- ### Maintenance --8<-- -roles/eos_cli_config_gen/docs/tables/maintenance.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/maintenance.md --8<-- ## Management @@ -412,139 +412,139 @@ roles/eos_cli_config_gen/docs/tables/maintenance.md ### Aliases --8<-- -roles/eos_cli_config_gen/docs/tables/aliases.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/aliases.md --8<-- ### Banners --8<-- -roles/eos_cli_config_gen/docs/tables/banners.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/banners.md --8<-- ### Boot --8<-- -roles/eos_cli_config_gen/docs/tables/boot.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/boot.md --8<-- ### Clock --8<-- -roles/eos_cli_config_gen/docs/tables/clock.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/clock.md --8<-- ### DNS domain --8<-- -roles/eos_cli_config_gen/docs/tables/dns-domain.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/dns-domain.md --8<-- ### Domain-list --8<-- -roles/eos_cli_config_gen/docs/tables/domain-list.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/domain-list.md --8<-- ### Hostname --8<-- -roles/eos_cli_config_gen/docs/tables/hostname.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/hostname.md --8<-- ### IP domain lookup --8<-- -roles/eos_cli_config_gen/docs/tables/ip-domain-lookup.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ip-domain-lookup.md --8<-- ### IP HTTP client source-interfaces --8<-- -roles/eos_cli_config_gen/docs/tables/ip-http-client-source-interfaces.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ip-http-client-source-interfaces.md --8<-- ### IP name servers --8<-- -roles/eos_cli_config_gen/docs/tables/ip-name-servers.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ip-name-servers.md --8<-- ### IP SSH client source-interfaces --8<-- -roles/eos_cli_config_gen/docs/tables/ip-ssh-client-source-interfaces.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ip-ssh-client-source-interfaces.md --8<-- ### Management accounts --8<-- -roles/eos_cli_config_gen/docs/tables/management-accounts.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/management-accounts.md --8<-- ### Management API HTTP --8<-- -roles/eos_cli_config_gen/docs/tables/management-api-http.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/management-api-http.md --8<-- ### Management API models --8<-- -roles/eos_cli_config_gen/docs/tables/management-api-models.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/management-api-models.md --8<-- ### Management console --8<-- -roles/eos_cli_config_gen/docs/tables/management-console.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/management-console.md --8<-- ### Management defaults --8<-- -roles/eos_cli_config_gen/docs/tables/management-defaults.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/management-defaults.md --8<-- ### Management security --8<-- -roles/eos_cli_config_gen/docs/tables/management-security.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/management-security.md --8<-- ### Management SSH --8<-- -roles/eos_cli_config_gen/docs/tables/management-ssh.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/management-ssh.md --8<-- ### Management tech-support --8<-- -roles/eos_cli_config_gen/docs/tables/management-tech-support.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/management-tech-support.md --8<-- ### NTP --8<-- -roles/eos_cli_config_gen/docs/tables/ntp.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ntp.md --8<-- ### Prompt --8<-- -roles/eos_cli_config_gen/docs/tables/prompt.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/prompt.md --8<-- ### Terminal --8<-- -roles/eos_cli_config_gen/docs/tables/terminal.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/terminal.md --8<-- ### Virtual source NAT VRFs --8<-- -roles/eos_cli_config_gen/docs/tables/virtual-source-nat-vrfs.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/virtual-source-nat-vrfs.md --8<-- ## Miscellaneous @@ -552,43 +552,43 @@ roles/eos_cli_config_gen/docs/tables/virtual-source-nat-vrfs.md ### Config comment --8<-- -roles/eos_cli_config_gen/docs/tables/config-comment.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/config-comment.md --8<-- ### Config end --8<-- -roles/eos_cli_config_gen/docs/tables/config-end.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/config-end.md --8<-- ### CVX --8<-- -roles/eos_cli_config_gen/docs/tables/cvx.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/cvx.md --8<-- ### EOS cli --8<-- -roles/eos_cli_config_gen/docs/tables/eos-cli.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/eos-cli.md --8<-- ### Is deployed --8<-- -roles/eos_cli_config_gen/docs/tables/is-deployed.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/is-deployed.md --8<-- ### Management CVX --8<-- -roles/eos_cli_config_gen/docs/tables/management-cvx.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/management-cvx.md --8<-- ### MCS client --8<-- -roles/eos_cli_config_gen/docs/tables/mcs-client.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/mcs-client.md --8<-- ## Monitoring @@ -596,103 +596,103 @@ roles/eos_cli_config_gen/docs/tables/mcs-client.md ### Daemons --8<-- -roles/eos_cli_config_gen/docs/tables/daemons.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/daemons.md --8<-- ### Daemon terminattr --8<-- -roles/eos_cli_config_gen/docs/tables/daemon-terminattr.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/daemon-terminattr.md --8<-- ### Event handlers --8<-- -roles/eos_cli_config_gen/docs/tables/event-handlers.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/event-handlers.md --8<-- ### Event monitor --8<-- -roles/eos_cli_config_gen/docs/tables/event-monitor.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/event-monitor.md --8<-- ### Flow tracking --8<-- -roles/eos_cli_config_gen/docs/tables/flow-tracking.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/flow-tracking.md --8<-- ### Load interval --8<-- -roles/eos_cli_config_gen/docs/tables/load-interval.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/load-interval.md --8<-- ### Logging --8<-- -roles/eos_cli_config_gen/docs/tables/logging.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/logging.md --8<-- ### Management API gNMI --8<-- -roles/eos_cli_config_gen/docs/tables/management-api-gnmi.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/management-api-gnmi.md --8<-- ### Monitor connectivity --8<-- -roles/eos_cli_config_gen/docs/tables/monitor-connectivity.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/monitor-connectivity.md --8<-- ### Monitor server Radius --8<-- -roles/eos_cli_config_gen/docs/tables/monitor-server-radius.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/monitor-server-radius.md --8<-- ### Monitor sessions --8<-- -roles/eos_cli_config_gen/docs/tables/monitor-sessions.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/monitor-sessions.md --8<-- ### Monitor layer 1 --8<-- -roles/eos_cli_config_gen/docs/tables/monitor-layer1.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/monitor-layer1.md --8<-- ### Monitor telemetry --8<-- -roles/eos_cli_config_gen/docs/tables/monitor-telemetry.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/monitor-telemetry.md --8<-- ### SFLOW --8<-- -roles/eos_cli_config_gen/docs/tables/sflow.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/sflow.md --8<-- ### SNMP server --8<-- -roles/eos_cli_config_gen/docs/tables/snmp-server.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/snmp-server.md --8<-- ### Tap aggregation --8<-- -roles/eos_cli_config_gen/docs/tables/tap-aggregation.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/tap-aggregation.md --8<-- ### VM tracer-sessions --8<-- -roles/eos_cli_config_gen/docs/tables/vmtracer-sessions.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/vmtracer-sessions.md --8<-- ## Multicast @@ -700,31 +700,31 @@ roles/eos_cli_config_gen/docs/tables/vmtracer-sessions.md ### IP IGMP snooping --8<-- -roles/eos_cli_config_gen/docs/tables/ip-igmp-snooping.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ip-igmp-snooping.md --8<-- ### Router IGMP --8<-- -roles/eos_cli_config_gen/docs/tables/router-igmp.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/router-igmp.md --8<-- ### Router MSDP --8<-- -roles/eos_cli_config_gen/docs/tables/router-msdp.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/router-msdp.md --8<-- ### Router multicast --8<-- -roles/eos_cli_config_gen/docs/tables/router-multicast.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/router-multicast.md --8<-- ### Router PIM sparse-mode --8<-- -roles/eos_cli_config_gen/docs/tables/router-pim-sparse-mode.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/router-pim-sparse-mode.md --8<-- ## Quality of Service @@ -732,37 +732,37 @@ roles/eos_cli_config_gen/docs/tables/router-pim-sparse-mode.md ### Priority flow control --8<-- -roles/eos_cli_config_gen/docs/tables/priority-flow-control.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/priority-flow-control.md --8<-- ### QoS --8<-- -roles/eos_cli_config_gen/docs/tables/qos.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/qos.md --8<-- ### QoS profiles --8<-- -roles/eos_cli_config_gen/docs/tables/qos-profiles.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/qos-profiles.md --8<-- ### Queue monitor-length --8<-- -roles/eos_cli_config_gen/docs/tables/queue-monitor-length.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/queue-monitor-length.md --8<-- ### Queue monitor-streaming --8<-- -roles/eos_cli_config_gen/docs/tables/queue-monitor-streaming.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/queue-monitor-streaming.md --8<-- ### Application traffic recognition --8<-- -roles/eos_cli_config_gen/docs/tables/application-traffic-recognition.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/application-traffic-recognition.md --8<-- ## Routing @@ -770,187 +770,187 @@ roles/eos_cli_config_gen/docs/tables/application-traffic-recognition.md ### ARP --8<-- -roles/eos_cli_config_gen/docs/tables/arp.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/arp.md --8<-- ### DHCP relay --8<-- -roles/eos_cli_config_gen/docs/tables/dhcp-relay.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/dhcp-relay.md --8<-- ### IP DHCP relay --8<-- -roles/eos_cli_config_gen/docs/tables/ip-dhcp-relay.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ip-dhcp-relay.md --8<-- ### IP DHCP Snooping --8<-- -roles/eos_cli_config_gen/docs/tables/ip-dhcp-snooping.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ip-dhcp-snooping.md --8<-- ### DHCP Servers --8<-- -roles/eos_cli_config_gen/docs/tables/dhcp-servers.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/dhcp-servers.md --8<-- ### IP ICMP redirect --8<-- -roles/eos_cli_config_gen/docs/tables/ip-icmp-redirect.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ip-icmp-redirect.md --8<-- ### IP NAT --8<-- -roles/eos_cli_config_gen/docs/tables/ip-nat.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ip-nat.md --8<-- ### IP routing IPv6 interfaces --8<-- -roles/eos_cli_config_gen/docs/tables/ip-routing-ipv6-interfaces.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ip-routing-ipv6-interfaces.md --8<-- ### IP routing --8<-- -roles/eos_cli_config_gen/docs/tables/ip-routing.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ip-routing.md --8<-- ### IP virtual router MAC address --8<-- -roles/eos_cli_config_gen/docs/tables/ip-virtual-router-mac-address.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ip-virtual-router-mac-address.md --8<-- ### IPv6 DHCP relay --8<-- -roles/eos_cli_config_gen/docs/tables/ipv6-dhcp-relay.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ipv6-dhcp-relay.md --8<-- ### IPv6 ICMP redirects --8<-- -roles/eos_cli_config_gen/docs/tables/ipv6-icmp-redirect.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ipv6-icmp-redirect.md --8<-- ### IPv6 static routes --8<-- -roles/eos_cli_config_gen/docs/tables/ipv6-static-routes.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ipv6-static-routes.md --8<-- ### IPv6 unicast routing --8<-- -roles/eos_cli_config_gen/docs/tables/ipv6-unicast-routing.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ipv6-unicast-routing.md --8<-- ### MPLS --8<-- -roles/eos_cli_config_gen/docs/tables/mpls.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/mpls.md --8<-- ### Router adaptive virtual topology --8<-- -roles/eos_cli_config_gen/docs/tables/router-adaptive-virtual-topology.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/router-adaptive-virtual-topology.md --8<-- ### Router BFD --8<-- -roles/eos_cli_config_gen/docs/tables/router-bfd.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/router-bfd.md --8<-- ### Router BGP --8<-- -roles/eos_cli_config_gen/docs/tables/router-bgp.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/router-bgp.md --8<-- ### Router general --8<-- -roles/eos_cli_config_gen/docs/tables/router-general.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/router-general.md --8<-- ### Router internet-exit --8<-- -roles/eos_cli_config_gen/docs/tables/router-internet-exit.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/router-internet-exit.md --8<-- ### Router ISIS --8<-- -roles/eos_cli_config_gen/docs/tables/router-isis.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/router-isis.md --8<-- ### Router L2 VPN --8<-- -roles/eos_cli_config_gen/docs/tables/router-l2-vpn.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/router-l2-vpn.md --8<-- ### Router OSPF --8<-- -roles/eos_cli_config_gen/docs/tables/router-ospf.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/router-ospf.md --8<-- ### Router path selection --8<-- -roles/eos_cli_config_gen/docs/tables/router-path-selection.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/router-path-selection.md --8<-- ### Router service-insertion --8<-- -roles/eos_cli_config_gen/docs/tables/router-service-insertion.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/router-service-insertion.md --8<-- ### Router traffic engineering --8<-- -roles/eos_cli_config_gen/docs/tables/router-traffic-engineering.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/router-traffic-engineering.md --8<-- ### Service routing configuration bgp --8<-- -roles/eos_cli_config_gen/docs/tables/service-routing-configuration-bgp.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/service-routing-configuration-bgp.md --8<-- ### Service routing protocols model --8<-- -roles/eos_cli_config_gen/docs/tables/service-routing-protocols-model.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/service-routing-protocols-model.md --8<-- ### Static routes --8<-- -roles/eos_cli_config_gen/docs/tables/static-routes.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/static-routes.md --8<-- ### STUN --8<-- -roles/eos_cli_config_gen/docs/tables/stun.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/stun.md --8<-- ### VRFs --8<-- -roles/eos_cli_config_gen/docs/tables/vrfs.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/vrfs.md --8<-- ## Security @@ -958,13 +958,13 @@ roles/eos_cli_config_gen/docs/tables/vrfs.md ### IP Security --8<-- -roles/eos_cli_config_gen/docs/tables/ip-security.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ip-security.md --8<-- ### Router segment-security --8<-- -roles/eos_cli_config_gen/docs/tables/router-segment-security.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/router-segment-security.md --8<-- ## Switching @@ -972,25 +972,25 @@ roles/eos_cli_config_gen/docs/tables/router-segment-security.md ### MLAG configuration --8<-- -roles/eos_cli_config_gen/docs/tables/mlag-configuration.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/mlag-configuration.md --8<-- ### Spanning-tree --8<-- -roles/eos_cli_config_gen/docs/tables/spanning-tree.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/spanning-tree.md --8<-- ### VLAN internal order --8<-- -roles/eos_cli_config_gen/docs/tables/vlan-internal-order.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/vlan-internal-order.md --8<-- ### VLANs --8<-- -roles/eos_cli_config_gen/docs/tables/vlans.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/vlans.md --8<-- ## System settings @@ -998,79 +998,79 @@ roles/eos_cli_config_gen/docs/tables/vlans.md ### Agents --8<-- -roles/eos_cli_config_gen/docs/tables/agents.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/agents.md --8<-- ### Hardware counters --8<-- -roles/eos_cli_config_gen/docs/tables/hardware-counters.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/hardware-counters.md --8<-- ### Hardware --8<-- -roles/eos_cli_config_gen/docs/tables/hardware.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/hardware.md --8<-- ### IP hardware --8<-- -roles/eos_cli_config_gen/docs/tables/ip-hardware.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ip-hardware.md --8<-- ### IPv6 hardware --8<-- -roles/eos_cli_config_gen/docs/tables/ipv6-hardware.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ipv6-hardware.md --8<-- ### L2 protocol --8<-- -roles/eos_cli_config_gen/docs/tables/l2-protocol.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/l2-protocol.md --8<-- ### MAC address-table --8<-- -roles/eos_cli_config_gen/docs/tables/mac-address-table.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/mac-address-table.md --8<-- ### Platform --8<-- -roles/eos_cli_config_gen/docs/tables/platform.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/platform.md --8<-- ### PoE --8<-- -roles/eos_cli_config_gen/docs/tables/poe.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/poe.md --8<-- ### PTP --8<-- -roles/eos_cli_config_gen/docs/tables/ptp.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/ptp.md --8<-- ### Redundancy --8<-- -roles/eos_cli_config_gen/docs/tables/redundancy.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/redundancy.md --8<-- ### System --8<-- -roles/eos_cli_config_gen/docs/tables/system.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/system.md --8<-- ### TCAM profile --8<-- -roles/eos_cli_config_gen/docs/tables/tcam-profile.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/tcam-profile.md --8<-- ## Metadata @@ -1078,5 +1078,5 @@ roles/eos_cli_config_gen/docs/tables/tcam-profile.md These fields are not generating any configuration. They are meant to be used by tools that parse structured configuration. --8<-- -roles/eos_cli_config_gen/docs/tables/metadata.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/metadata.md --8<-- diff --git a/ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/role-configuration.md b/ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/role-configuration.md index 91964495699..7d8e12e282f 100644 --- a/ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/role-configuration.md +++ b/ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/role-configuration.md @@ -18,7 +18,7 @@ Default output directories can be updated by modifying the default role variable ``` yaml --8<-- -roles/eos_cli_config_gen/defaults/main/output_directories.yml +ansible_collections/arista/avd/roles/eos_cli_config_gen/defaults/main/output_directories.yml --8<-- ``` @@ -40,7 +40,7 @@ This behavior can be adjusted by setting the variable described below. If the validation mode is set to `warning`, execution will continue with invalid data, which can lead to hard-to-read errors or incorrect behavior. --8<-- -roles/eos_cli_config_gen/docs/tables/role-input-validation.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/role-input-validation.md --8<-- ## Extensibility with Custom Templates @@ -62,7 +62,7 @@ roles/eos_cli_config_gen/docs/tables/role-input-validation.md If adding custom keys to an existing AVD data model, start the key with an underscore `_`, so it will be ignored by schema validation. --8<-- -roles/eos_cli_config_gen/docs/tables/custom-templates.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/custom-templates.md --8<-- ## Generation of device configuration and documentation @@ -70,7 +70,7 @@ roles/eos_cli_config_gen/docs/tables/custom-templates.md The following settings can be leveraged to control generation of device configuration and documentation. --8<-- -roles/eos_cli_config_gen/docs/tables/role-settings.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/role-settings.md --8<-- ### Generate default config @@ -90,5 +90,5 @@ The following commands will be generated when `generate_default_config` is set t - End of configuration delimiter --8<-- -roles/eos_cli_config_gen/docs/tables/generate-default-config.md +ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/tables/generate-default-config.md --8<-- diff --git a/ansible_collections/arista/avd/roles/eos_config_deploy_cvp/README.md b/ansible_collections/arista/avd/roles/eos_config_deploy_cvp/README.md index a89c68cf576..b364e0f84ef 100644 --- a/ansible_collections/arista/avd/roles/eos_config_deploy_cvp/README.md +++ b/ansible_collections/arista/avd/roles/eos_config_deploy_cvp/README.md @@ -33,8 +33,8 @@ ansible-galaxy collection install arista.cvp Figure 1 below provides a visualization of the role's inputs, outputs, and tasks in order executed by the role. -![Figure 1: Ansible Role eos_config_deploy_eapi](../../docs/_media/eos_config_deploy_cvp_dark.svg#only-dark) -![Figure 1: Ansible Role eos_config_deploy_eapi](../../docs/_media/eos_config_deploy_cvp_light.svg#only-light) +![Figure 1: Ansible Role eos_config_deploy_eapi](../../../../../docs/_media/eos_config_deploy_cvp_dark.svg#only-dark) +![Figure 1: Ansible Role eos_config_deploy_eapi](../../../../../docs/_media/eos_config_deploy_cvp_light.svg#only-light) 1. Read inventory 1. Build containers topology @@ -78,7 +78,7 @@ Default output directories can be updated by modifying the default role variable ``` yaml --8<-- -roles/eos_config_deploy_cvp/defaults/main/output_directories.yml +ansible_collections/arista/avd/roles/eos_config_deploy_cvp/defaults/main/output_directories.yml --8<-- ``` @@ -308,8 +308,8 @@ ansible-playbook playbook.to.deploy.with.cvp.yml --skip-tags "containers,apply" ## Requirements -Requirements are located here: [avd-requirements](../../docs/installation/collection-installation.md#python-requirements-installation) +Requirements are located here: [avd-requirements](../../../../../docs/installation/collection-installation.md#python-requirements-installation) ## License -Project is published under [Apache 2.0 License](../../LICENSE) +Project is published under [Apache 2.0 License](https://github.com/aristanetworks/avd/blob/devel/LICENSE) diff --git a/ansible_collections/arista/avd/roles/eos_config_deploy_cvp/docs/avd-to-cvaas.md b/ansible_collections/arista/avd/roles/eos_config_deploy_cvp/docs/avd-to-cvaas.md index bfa74f6f6db..a777e0cbb3f 100644 --- a/ansible_collections/arista/avd/roles/eos_config_deploy_cvp/docs/avd-to-cvaas.md +++ b/ansible_collections/arista/avd/roles/eos_config_deploy_cvp/docs/avd-to-cvaas.md @@ -36,9 +36,9 @@ Make sure to copy the generated password. You only get view it once. Click "Save" to exit the dialogue box. ``` -![Figure: 1](../../../media/serviceaccount1.png) -![Figure: 2](../../../media/serviceaccount2.png) -![Figure: 3](../../../media/serviceaccount3.png) +![Figure: 1](../../../../../../docs/_media/serviceaccount1.png) +![Figure: 2](../../../../../../docs/_media/serviceaccount2.png) +![Figure: 3](../../../../../../docs/_media/serviceaccount3.png) !!! note The name of the service account must match a username configured to be authorized on diff --git a/ansible_collections/arista/avd/roles/eos_config_deploy_eapi/README.md b/ansible_collections/arista/avd/roles/eos_config_deploy_eapi/README.md index 1ea0d9439ac..289236d3142 100644 --- a/ansible_collections/arista/avd/roles/eos_config_deploy_eapi/README.md +++ b/ansible_collections/arista/avd/roles/eos_config_deploy_eapi/README.md @@ -23,8 +23,8 @@ The **eos_config_deploy_eapi** role: Figure 1 below provides a visualization of the role's inputs, outputs, and tasks in order executed by the role. -![Figure 1: Ansible Role eos_config_deploy_eapi](../../docs/_media/eos_config_deploy_eapi_dark.svg#only-dark) -![Figure 1: Ansible Role eos_config_deploy_eapi](../../docs/_media/eos_config_deploy_eapi_light.svg#only-light) +![Figure 1: Ansible Role eos_config_deploy_eapi](../../../../../docs/_media/eos_config_deploy_eapi_dark.svg#only-dark) +![Figure 1: Ansible Role eos_config_deploy_eapi](../../../../../docs/_media/eos_config_deploy_eapi_light.svg#only-light) **Inputs:** @@ -47,14 +47,14 @@ Figure 1 below provides a visualization of the role's inputs, outputs, and tasks ``` yaml --8<-- -roles/eos_config_deploy_eapi/defaults/main.yml +ansible_collections/arista/avd/roles/eos_config_deploy_eapi/defaults/main.yml --8<-- ``` ## Requirements -Requirements are located here: [avd-requirements](../../docs/installation/collection-installation.md#python-requirements-installation) +Requirements are located here: [avd-requirements](../../../../../docs/installation/collection-installation.md#python-requirements-installation) ## License -Project is published under [Apache 2.0 License](../../LICENSE) +Project is published under [Apache 2.0 License](https://github.com/aristanetworks/avd/blob/devel/LICENSE) diff --git a/ansible_collections/arista/avd/roles/eos_designs/README.md b/ansible_collections/arista/avd/roles/eos_designs/README.md index ac0e7a9adc3..049cbd78428 100644 --- a/ansible_collections/arista/avd/roles/eos_designs/README.md +++ b/ansible_collections/arista/avd/roles/eos_designs/README.md @@ -30,8 +30,8 @@ The **eos_designs** role: Figure 1 below provides a visualization of the role's inputs, outputs, and tasks in order executed by the role. -![EOS Designs Overview](../../docs/_media/eos_designs_dark.svg#only-dark) -![EOS Designs Overview](../../docs/_media/eos_designs_light.svg#only-light) +![EOS Designs Overview](../../../../../docs/_media/eos_designs_dark.svg#only-dark) +![EOS Designs Overview](../../../../../docs/_media/eos_designs_light.svg#only-light) **Inputs:** @@ -93,13 +93,13 @@ Across all designs, the following functionality is provided: **5 Stage topology example:**
- 5 Stage topology example + 5 Stage topology example
**Disaggregated topology example:**
- Disaggregated topology example + Disaggregated topology example
### Layer 2 Leaf Spine @@ -115,7 +115,7 @@ Across all designs, the following functionality is provided: **L2LS topology example:**
- L2LS topology example + L2LS topology example
### MPLS Core with MPLS EVPN, VPN-IPv4, VPN-IPv6 @@ -130,7 +130,7 @@ Across all designs, the following functionality is provided: **MPLS topology example:**
- MPLS topology example + MPLS topology example
### WAN AutoVPN / CV Pathfinder @@ -143,12 +143,12 @@ Across all designs, the following functionality is provided: **WAN topology example:**
- WAN topology example + WAN topology example
## Requirements -Requirements are located in the [collection installation guide](../../docs/installation/collection-installation.md) +Requirements are located in the [collection installation guide](../../../../../docs/installation/collection-installation.md) ## Input Variables @@ -187,4 +187,4 @@ bfd_multihop: ## License -Project is published under [Apache 2.0 License](../../LICENSE) +Project is published under [Apache 2.0 License](https://github.com/aristanetworks/avd/blob/devel/LICENSE) diff --git a/ansible_collections/arista/avd/roles/eos_designs/docs/how-to/custom-structured-configuration.md b/ansible_collections/arista/avd/roles/eos_designs/docs/how-to/custom-structured-configuration.md index 7638e1dd664..b59cf5902e4 100644 --- a/ansible_collections/arista/avd/roles/eos_designs/docs/how-to/custom-structured-configuration.md +++ b/ansible_collections/arista/avd/roles/eos_designs/docs/how-to/custom-structured-configuration.md @@ -31,10 +31,10 @@ However if there is no clash, then the value of the variable will be the one def The consequence is that upgrading AVD to a newer version for instance, or configuring additional `eos_designs` functionality in an existing AVD project, could lead to additional variable keys being generated by `eos_designs` in the structured_config, overwriting previously working `eos_cli_config_gen` keys. - +
- Variable Precedence logical diagram + Variable Precedence logical diagram
The recommendation is to use `custom_structured_configuration` as described below. This configuration will be merged on top of the `eos_designs` generated variables. @@ -308,7 +308,7 @@ overwrite list data unintentionally. So going forward `replace` should be avoide ### Variables and Options --8<-- -roles/eos_designs/docs/tables/custom-structured-configuration.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/custom-structured-configuration.md --8<-- ### Examples diff --git a/ansible_collections/arista/avd/roles/eos_designs/docs/how-to/custom-templates.md b/ansible_collections/arista/avd/roles/eos_designs/docs/how-to/custom-templates.md index 85f1847ae59..f8ed3f300f0 100644 --- a/ansible_collections/arista/avd/roles/eos_designs/docs/how-to/custom-templates.md +++ b/ansible_collections/arista/avd/roles/eos_designs/docs/how-to/custom-templates.md @@ -55,7 +55,7 @@ eos_designs_custom_templates: strip_empty_keys: false ``` -For more details, see [Custom Templates](https://avd.arista.com/4.3/roles/eos_designs/docs/role-configuration.html#custom-templates). +For more details, see [Custom Templates](https://avd.arista.com/stable/roles/eos_designs/docs/role-configuration.html#custom-templates). ## Adding the Custom Template to the `eos-designs` Role diff --git a/ansible_collections/arista/avd/roles/eos_designs/docs/how-to/ptp.md b/ansible_collections/arista/avd/roles/eos_designs/docs/how-to/ptp.md index cf6e9efef24..7496354460f 100644 --- a/ansible_collections/arista/avd/roles/eos_designs/docs/how-to/ptp.md +++ b/ansible_collections/arista/avd/roles/eos_designs/docs/how-to/ptp.md @@ -77,7 +77,7 @@ spine: Common PTP settings can be specified for the entire topology to greatly simplify the configuration of PTP: --8<-- -roles/eos_designs/docs/tables/ptp.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/ptp.md --8<-- These settings can also be defined on a more specific group_vars level, if the network design requires this. @@ -299,7 +299,7 @@ ptp monitor threshold missing-message sync 3 sequence-ids All parameters can be overridden if required: --8<-- -roles/eos_designs/docs/tables/node-type-ptp-configuration.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/node-type-ptp-configuration.md --8<-- ### Setting PTP DSCP values diff --git a/ansible_collections/arista/avd/roles/eos_designs/docs/how-to/wan.md b/ansible_collections/arista/avd/roles/eos_designs/docs/how-to/wan.md index f4d46b5dcec..8fb877adec1 100644 --- a/ansible_collections/arista/avd/roles/eos_designs/docs/how-to/wan.md +++ b/ansible_collections/arista/avd/roles/eos_designs/docs/how-to/wan.md @@ -709,10 +709,10 @@ interaction to help understand how everything fits together. This diagram represents the common scenario for a single router, without any LAN. It will be reused when adding LAN protocols to help understand the changes. - +
- WAN LAN Common design + WAN LAN Common design
#### LAN HA common configuration @@ -781,10 +781,10 @@ From a configuration standpoint: The following diagram represents this scenario: - +
- WAN Direct HA + WAN Direct HA
#### EBGP LAN @@ -800,10 +800,10 @@ The following diagram represents this scenario: The following diagram shows the additional route-maps configured to support eBGP on LAN: - +
- WAN eBGP LAN Single Router + WAN eBGP LAN Single Router
##### HA (PREVIEW) @@ -825,20 +825,20 @@ for eBGP LAN routing protocol the following is done to enable HA: This is described in the following diagram: - +
- WAN eBGP LAN with HA + WAN eBGP LAN with HA
##### HA with Direct Link (PREVIEW) In the situation where the LAN is EBGP but HA is configured over a direct link, there is no peering with the HA peer required via the LAN and the configuration is simplified as follow: - +
- WAN eBGP LAN with Direct HA link + WAN eBGP LAN with Direct HA link
!!! warning @@ -906,7 +906,7 @@ The tags will only be generated when `wan_mode` is set to `cv-pathfinder`. As described in the design principles, the goal is to be able to distribute the WAN routers in separate Ansible inventories. -When leveraging multiple inventories, the arista.avd collection provide capabilities to create [global variables](../../../../docs/plugins/Vars_plugins/global_vars.md). +When leveraging multiple inventories, the arista.avd collection provide capabilities to create [global variables](../../../../../../../docs/plugins/Vars_plugins/global_vars.md). The following example will be leveraging this capability to share required WAN variables across multiple inventories. This example contains contains two sites, SITE1 and SITE2 and a dedicate inventory for pathfinder nodes. diff --git a/ansible_collections/arista/avd/roles/eos_designs/docs/input-variables.md b/ansible_collections/arista/avd/roles/eos_designs/docs/input-variables.md index b476bf0c80f..46e8aabe365 100644 --- a/ansible_collections/arista/avd/roles/eos_designs/docs/input-variables.md +++ b/ansible_collections/arista/avd/roles/eos_designs/docs/input-variables.md @@ -12,7 +12,7 @@ title: Input variables for eos_designs This document describes the supported input variables for the role `arista.avd.eos_designs`. -Since several data models have changed between AVD versions 4.x and 5.x, it is recommended to study the [Porting Guide for AVD 5.x.x](../../../docs/porting-guides/5.x.x.md) for existing deployments. +Since several data models have changed between AVD versions 4.x and 5.x, it is recommended to study the [Porting Guide for AVD 5.x.x](../../../../../../docs/porting-guides/5.x.x.md) for existing deployments. The input variables are documented below in tables and YAML. @@ -36,7 +36,7 @@ The input variables are documented below in tables and YAML. The default [Node Type Variables](#node-type-variables) can be used with all designs. --8<-- -roles/eos_designs/docs/tables/design.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/design.md --8<-- ### 3-stage clos topology support (Leaf & Spine) @@ -109,7 +109,7 @@ For more information please read the [WAN how-to guide](./how-to/wan.md). ## Fabric topology hierarchy
- 5 stage topology + 5 stage topology
As per the diagram above, the topology hierarchy is the following: @@ -121,13 +121,13 @@ As per the diagram above, the topology hierarchy is the following: You **must** define the `fabric_name` variable and it **must** match the Ansible inventory group name covering all devices in scope of the fabric. --8<-- -roles/eos_designs/docs/tables/fabric-topology.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/fabric-topology.md --8<-- ## Fabric IP Addressing --8<-- -roles/eos_designs/docs/tables/fabric-ip-addressing.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/fabric-ip-addressing.md --8<-- ## Node Type Variables @@ -355,7 +355,7 @@ The default value of `node_type_keys` depend on the `design.type` setting which ``` --8<-- -roles/eos_designs/docs/tables/node-type-keys.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/node-type-keys.md --8<-- ### Context for ip_addressing templates @@ -508,7 +508,7 @@ the values are not part of the officially supported data models and may change w ``` --8<-- -roles/eos_designs/docs/tables/type-setting.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/type-setting.md --8<-- ## Default node types settings @@ -521,7 +521,7 @@ on the hostname. This functionality will be restored as part of a later update to eos_validate_state and this note will then be removed. --8<-- -roles/eos_designs/docs/tables/default-node-types.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/default-node-types.md --8<-- ## Node type settings @@ -542,7 +542,7 @@ defaults <- node_group <- node_group.node <- node Define common node settings under defaults. This reduces user input requirements, limiting errors. --8<-- -roles/eos_designs/docs/tables/node-type-structure.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/node-type-structure.md --8<-- ### Node type common configuration @@ -556,13 +556,13 @@ Define your nodes, id, management and common configuration elements. A static unique identifier (id) is assigned to each device. This is leveraged to derive the IP address assignment from each summary defined in the Fabric Underlay and Overlay Topology Variables. --8<-- -roles/eos_designs/docs/tables/node-type-common-configuration.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/node-type-common-configuration.md --8<-- ### Node type inband management --8<-- -roles/eos_designs/docs/tables/node-type-inband-management-configuration.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/node-type-inband-management-configuration.md --8<-- ### Node type uplink management @@ -574,7 +574,7 @@ Source uplink interfaces and parent interfaces are defined on the child. Leverage [`default_interfaces`](#default-interface-settings) data model to auto define uplink and downlink interfaces based on the node id. --8<-- -roles/eos_designs/docs/tables/node-type-uplink-configuration.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/node-type-uplink-configuration.md --8<-- ### Node type L2 and MLAG configuration @@ -583,67 +583,67 @@ roles/eos_designs/docs/tables/node-type-uplink-configuration.md Alternate addressing schemes are available at [`fabric_ip_addressing`](#fabric-ip-addressing). --8<-- -roles/eos_designs/docs/tables/node-type-l2-mlag-configuration.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/node-type-l2-mlag-configuration.md --8<-- ### Node type Loopback and VTEP configuration --8<-- -roles/eos_designs/docs/tables/node-type-loopback-vtep-configuration.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/node-type-loopback-vtep-configuration.md --8<-- ### Node type L3 interfaces configuration --8<-- -roles/eos_designs/docs/tables/node-type-l3-interfaces-configuration.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/node-type-l3-interfaces-configuration.md --8<-- ### Node type BGP configuration --8<-- -roles/eos_designs/docs/tables/node-type-bgp-configuration.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/node-type-bgp-configuration.md --8<-- ### Node type network services configuration --8<-- -roles/eos_designs/docs/tables/node-type-evpn-services-configuration.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/node-type-evpn-services-configuration.md --8<-- ### Node type EVPN gateway configuration --8<-- -roles/eos_designs/docs/tables/node-type-evpn-ipvpn-gateway-configuration.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/node-type-evpn-ipvpn-gateway-configuration.md --8<-- ### Node type EVPN multi-domain gateway configuration --8<-- -roles/eos_designs/docs/tables/node-type-evpn-multi-domain-gateway-configuration.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/node-type-evpn-multi-domain-gateway-configuration.md --8<-- ### Node type ISIS Configuration --8<-- -roles/eos_designs/docs/tables/node-type-isis-configuration.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/node-type-isis-configuration.md --8<-- ### Node type MPLS configuration --8<-- -roles/eos_designs/docs/tables/node-type-mpls-configuration.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/node-type-mpls-configuration.md --8<-- ### Node type WAN configuration --8<-- -roles/eos_designs/docs/tables/node-type-wan-configuration.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/node-type-wan-configuration.md --8<-- ### Node type PTP configuration --8<-- -roles/eos_designs/docs/tables/node-type-ptp-configuration.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/node-type-ptp-configuration.md --8<-- ## Default interface settings @@ -674,7 +674,7 @@ roles/eos_designs/docs/tables/node-type-ptp-configuration.md ``` --8<-- -roles/eos_designs/docs/tables/default-interfaces.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/default-interfaces.md --8<-- ## L3 edge and DCI settings @@ -687,7 +687,7 @@ For BGP peerings the AS number must be specified. If the AS number is different Make sure to configure the variables in a group_vars file covering all devices mentioned in the data model. --8<-- -roles/eos_designs/docs/tables/l3-edge.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/l3-edge.md --8<-- ## Core interfaces settings @@ -700,7 +700,7 @@ For BGP peerings the AS number must be specified. If the AS number is different Make sure to configure the variables in a group_vars file covering all devices mentioned in the data model. --8<-- -roles/eos_designs/docs/tables/core-interfaces.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/core-interfaces.md --8<-- ## Flagging a device as not deployed @@ -712,7 +712,7 @@ roles/eos_designs/docs/tables/core-interfaces.md - To overcome this and shutdown interfaces towards undeployed peers, the variable `shutdown_interfaces_towards_undeployed_peers` can be used, satisfying the `eos_validate_state` role interface and lldp_topology tests. Again, this is only an issue if `eos_config_deploy_cvp` is used and the devices are not present in the network. --8<-- -roles/eos_designs/docs/tables/is-deployed.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/is-deployed.md --8<-- ## Fabric settings @@ -745,7 +745,7 @@ The following underlay routing protocols are supported: - The port-channel towards the L2 switch will be assigned to this trunk group only - Add `UPLINK` Trunk Group to all vlans on the L2 Switch and assign this to the uplink port-channel - ![Figure: Enable Trunk Groups](../../../media/enable_trunk_groups.png) + ![Figure: Enable Trunk Groups](../../../../../../docs/_media/enable_trunk_groups.png) While it is recommended for consistency to set `enable_trunk_groups` for all devices in the fabric, it can also be set in group_vars or host_vars since trunk-groups are only local to a switch. @@ -761,52 +761,52 @@ The following underlay routing protocols are supported: Using the figure under [Details on `enable_trunk_groups`](#details-on-enable_trunk_groups) as basis enabling with feature would remove the unmatched trunk groups like this: - ![Figure: Enable only_local_vlan_trunk_groups](../../../media/only_local_vlan_trunk_groups.png) + ![Figure: Enable only_local_vlan_trunk_groups](../../../../../../docs/_media/only_local_vlan_trunk_groups.png) --8<-- -roles/eos_designs/docs/tables/fabric-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/fabric-settings.md --8<-- ## Management interface settings --8<-- -roles/eos_designs/docs/tables/management-interface-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/management-interface-settings.md --8<-- ## BFD settings --8<-- -roles/eos_designs/docs/tables/bfd-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/bfd-settings.md --8<-- ## BGP settings --8<-- -roles/eos_designs/docs/tables/bgp-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/bgp-settings.md --8<-- ## IPv4 ACL settings --8<-- -roles/eos_designs/docs/tables/ipv4-acls.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/ipv4-acls.md --8<-- ### IPv4 Prefix-List Catalog settings --8<-- -roles/eos_designs/docs/tables/ipv4-prefix-list-catalog.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/ipv4-prefix-list-catalog.md --8<-- ## OSPF settings --8<-- -roles/eos_designs/docs/tables/ospf-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/ospf-settings.md --8<-- ## ISIS settings --8<-- -roles/eos_designs/docs/tables/isis-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/isis-settings.md --8<-- ## Overlay settings @@ -823,13 +823,13 @@ The following overlay routing protocols are supported: ² By setting `overlay_routing_protocol:HER`, `eos_designs` will configure static VXLAN flood-lists instead of using a dynamic overlay protocol. --8<-- -roles/eos_designs/docs/tables/overlay-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/overlay-settings.md --8<-- ## EVPN settings --8<-- -roles/eos_designs/docs/tables/evpn-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/evpn-settings.md --8<-- ## WAN Settings @@ -837,7 +837,7 @@ roles/eos_designs/docs/tables/evpn-settings.md ### WAN generic settings --8<-- -roles/eos_designs/docs/tables/wan-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/wan-settings.md --8<-- ### WAN hierarchy @@ -847,19 +847,19 @@ roles/eos_designs/docs/tables/wan-settings.md This section is only relevant for CV Pathfinder and not for AutoVPN --8<-- -roles/eos_designs/docs/tables/wan-cv-pathfinder-regions.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/wan-cv-pathfinder-regions.md --8<-- ### WAN path-groups and carriers --8<-- -roles/eos_designs/docs/tables/wan-path-groups-and-carriers.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/wan-path-groups-and-carriers.md --8<-- ### WAN route-servers --8<-- -roles/eos_designs/docs/tables/wan-route-servers.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/wan-route-servers.md --8<-- ### WAN Virtual topologies @@ -867,13 +867,13 @@ roles/eos_designs/docs/tables/wan-route-servers.md WAN virtual topologies leverage Deep Packet Inspection Engine to match traffic. --8<-- -roles/eos_designs/docs/tables/wan-virtual-topologies.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/wan-virtual-topologies.md --8<-- #### Application Classification --8<-- -roles/eos_designs/docs/tables/application-classification.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/application-classification.md --8<-- #### Internet Exit policies @@ -883,7 +883,7 @@ roles/eos_designs/docs/tables/application-classification.md This section is only relevant for CV Pathfinder and not for AutoVPN --8<-- -roles/eos_designs/docs/tables/cv-pathfinder-internet-exit-policies.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/cv-pathfinder-internet-exit-policies.md --8<-- ##### Zscaler Internet Exit @@ -894,37 +894,37 @@ roles/eos_designs/docs/tables/cv-pathfinder-internet-exit-policies.md See the top level key description for more information. --8<-- -roles/eos_designs/docs/tables/zscaler-endpoints.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/zscaler-endpoints.md --8<-- ## Management settings --8<-- -roles/eos_designs/docs/tables/management-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/management-settings.md --8<-- ### Source-interfaces settings --8<-- -roles/eos_designs/docs/tables/management-source-interfaces-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/management-source-interfaces-settings.md --8<-- ### sFlow settings --8<-- -roles/eos_designs/docs/tables/management-sflow-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/management-sflow-settings.md --8<-- ### Flow Tracking Settings --8<-- -roles/eos_designs/docs/tables/management-flow-tracking-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/management-flow-tracking-settings.md --8<-- ### SNMP settings --8<-- -roles/eos_designs/docs/tables/management-snmp-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/management-snmp-settings.md --8<-- ## Monitoring @@ -932,13 +932,13 @@ roles/eos_designs/docs/tables/management-snmp-settings.md ### Event monitor --8<-- -roles/eos_designs/docs/tables/event-monitor.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/event-monitor.md --8<-- ### Load interval --8<-- -roles/eos_designs/docs/tables/load-interval.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/load-interval.md --8<-- ## Quality of Service @@ -946,19 +946,19 @@ roles/eos_designs/docs/tables/load-interval.md ### Queue monitor-streaming --8<-- -roles/eos_designs/docs/tables/queue-monitor-streaming.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/queue-monitor-streaming.md --8<-- ## System settings --8<-- -roles/eos_designs/docs/tables/system-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/system-settings.md --8<-- ## CloudVision Settings --8<-- -roles/eos_designs/docs/tables/cloudvision-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/cloudvision-settings.md --8<-- ## Endpoint connectivity @@ -1145,7 +1145,7 @@ Both data models support variable inheritance from profiles defined under [`port ``` --8<-- -roles/eos_designs/docs/tables/connected-endpoints.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/connected-endpoints.md --8<-- ### Connected endpoints default description or description template settings @@ -1153,7 +1153,7 @@ roles/eos_designs/docs/tables/connected-endpoints.md Connected endpoints support the customization of generated descriptions with a static value or template. --8<-- -roles/eos_designs/docs/tables/default-connected-endpoints-description.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/default-connected-endpoints-description.md --8<-- ### Network ports settings @@ -1312,7 +1312,7 @@ All ranges defined under `switch_ports` will be expanded to individual port conf To leverage automatic channel-id computation and configure port-channel with multiple members, `connected_endpoints` should be used. --8<-- -roles/eos_designs/docs/tables/network-ports.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/network-ports.md --8<-- ### Network ports default description or description template settings @@ -1320,7 +1320,7 @@ roles/eos_designs/docs/tables/network-ports.md Network ports support the customization of generated descriptions with a static value or template. --8<-- -roles/eos_designs/docs/tables/default-network-ports-description.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/default-network-ports-description.md --8<-- ### Port profiles settings @@ -1331,7 +1331,7 @@ Keys are the same as used under endpoint adapters. Keys defined under endpoints A port profile can refer to another port profile using `parent_profile` to inherit settings in up to two levels (adapter->profile->parent_profile). --8<-- -roles/eos_designs/docs/tables/port-profiles.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/port-profiles.md --8<-- ### Connected endpoints keys settings @@ -1347,7 +1347,7 @@ The keys can be customized to provide a better better organization or grouping o The default values will be overridden if defining this key, so it is recommended to copy the defaults and modify them. --8<-- -roles/eos_designs/docs/tables/connected-endpoints-keys.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/connected-endpoints-keys.md --8<-- ## Network Services @@ -1381,29 +1381,29 @@ The keys used to define network services are configurable using [`network_servic The default available keys is `tenants`. --8<-- -roles/eos_designs/docs/tables/network-services.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/network-services.md --8<-- --8<-- -roles/eos_designs/docs/tables/new-network-services-bgp-vrf-config.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/new-network-services-bgp-vrf-config.md --8<-- #### Network services VRFs configuration --8<-- -roles/eos_designs/docs/tables/network-services-vrfs-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/network-services-vrfs-settings.md --8<-- #### Network services VRF SVIs configuration --8<-- -roles/eos_designs/docs/tables/network-services-vrfs-svis-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/network-services-vrfs-svis-settings.md --8<-- #### Network services VRF L3 Interfaces configuration --8<-- -roles/eos_designs/docs/tables/network-services-vrfs-l3-interfaces-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/network-services-vrfs-l3-interfaces-settings.md --8<-- #### Network services VRF Loopbacks configuration @@ -1414,37 +1414,37 @@ Loopbacks are usually configured with `vtep_diagnostic` which supports IP pools IP addresses on individual nodes. --8<-- -roles/eos_designs/docs/tables/network-services-vrfs-loopbacks-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/network-services-vrfs-loopbacks-settings.md --8<-- #### Network services VRF BGP configuration --8<-- -roles/eos_designs/docs/tables/network-services-vrfs-bgp-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/network-services-vrfs-bgp-settings.md --8<-- #### Network services VRF OSPF configuration --8<-- -roles/eos_designs/docs/tables/network-services-vrfs-ospf-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/network-services-vrfs-ospf-settings.md --8<-- #### Network services L2 VLANs configuration --8<-- -roles/eos_designs/docs/tables/network-services-l2vlans-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/network-services-l2vlans-settings.md --8<-- #### Network services point-to-point services configuration --8<-- -roles/eos_designs/docs/tables/network-services-point-to-point-services-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/network-services-point-to-point-services-settings.md --8<-- #### Network services multicast configuration --8<-- -roles/eos_designs/docs/tables/network-services-multicast-settings.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/network-services-multicast-settings.md --8<-- ### SVI profiles settings @@ -1463,7 +1463,7 @@ SVI profiles can be leveraged to share common settings between SVIs. 6. svi_parent_profile.structured_config --8<-- -roles/eos_designs/docs/tables/svi-profiles.md +ansible_collections/arista/avd/roles/eos_designs/docs/tables/svi-profiles.md --8<-- ### EVPN VLAN aware bundles settings @@ -1474,7 +1474,7 @@ or `[].vrfs[].svis[].evpn_vlan_bundle` or `      - <str>](## "network_ports.[].switches.[]") | String | | | | | | [    platforms](## "network_ports.[].platforms") | List, items: String | | | Min Length: 1 | Regex matching the full platform name of one or more switches. If used in combination with switch hostname matching, both criteria must match for configuration.
If you need to add custom platforms to match specific port quantities, create them under `custom_platform_settings`. Entries under `custom_platform_settings` should
match the platform match criteria.

For example, `720XP-48Y6` would require a custom platform type:

platforms:
- 720XP
- 720XP-48Y6 | | [      - <str>](## "network_ports.[].platforms.[]") | String | | | | | - | [    switch_ports](## "network_ports.[].switch_ports") | List, items: String | | | | List of ranges using AVD range_expand syntax.
For example:

switch_ports:
- Ethernet1
- Ethernet2-48

All switch_ports ranges are expanded into individual port configurations.

For more details and examples of the `range_expand` syntax, see the [`arista.avd.range_expand` documentation](../../../docs/plugins/Filter_plugins/range_expand.md).
| + | [    switch_ports](## "network_ports.[].switch_ports") | List, items: String | | | | List of ranges using AVD range_expand syntax.
For example:

switch_ports:
- Ethernet1
- Ethernet2-48

All switch_ports ranges are expanded into individual port configurations.

For more details and examples of the `range_expand` syntax, see the [`arista.avd.range_expand` documentation](../../../../../../docs/plugins/Filter_plugins/range_expand.md).
| | [      - <str>](## "network_ports.[].switch_ports.[]") | String | | | | | | [    description](## "network_ports.[].description") | String | | | | Description or description template to be used on all ports.
This can be a template using the AVD string formatter syntax: https://avd.arista.com/devel/roles/eos_designs/docs/how-to/custom-descriptions-names.html#avd-string-formatter-syntax.
The available template fields are:
- `endpoint_type` - always set to `network_port`.
- `endpoint` - content of the `endpoint` key if set.
- `port_channel_id`: The port-channel number for the switch.

The default description is set by `default_network_ports_description`.
By default the description is templated from the `endpoint` key if set. | | [    endpoint](## "network_ports.[].endpoint") | String | | | | Name or description of the endpoints connected to these ports. | @@ -215,7 +215,7 @@ # # All switch_ports ranges are expanded into individual port configurations. # - # For more details and examples of the `range_expand` syntax, see the [`arista.avd.range_expand` documentation](../../../docs/plugins/Filter_plugins/range_expand.md). + # For more details and examples of the `range_expand` syntax, see the [`arista.avd.range_expand` documentation](../../../../../../docs/plugins/Filter_plugins/range_expand.md). switch_ports: - diff --git a/ansible_collections/arista/avd/roles/eos_snapshot/README.md b/ansible_collections/arista/avd/roles/eos_snapshot/README.md index 259d3177c39..2fa5508f2b0 100644 --- a/ansible_collections/arista/avd/roles/eos_snapshot/README.md +++ b/ansible_collections/arista/avd/roles/eos_snapshot/README.md @@ -19,8 +19,8 @@ It supports reports with the following format: text, markdown, JSON, and YAML. Figure 1 below visualizes the role's inputs, outputs, and tasks. -![Figure 1: Ansible Role eos_snapshot](../../docs/_media/eos_snapshot_dark.svg#only-dark) -![Figure 1: Ansible Role eos_snapshot](../../docs/_media/eos_snapshot_light.svg#only-light) +![Figure 1: Ansible Role eos_snapshot](../../../../../docs/_media/eos_snapshot_dark.svg#only-dark) +![Figure 1: Ansible Role eos_snapshot](../../../../../docs/_media/eos_snapshot_light.svg#only-light) **Inputs:** @@ -74,7 +74,7 @@ commands_list: ## Requirements -Requirements are located here: [avd-requirements](../../docs/installation/collection-installation.md#python-requirements-installation) +Requirements are located here: [avd-requirements](../../../../../docs/installation/collection-installation.md#python-requirements-installation) ## Example Playbook @@ -153,4 +153,4 @@ ansible-playbook playbooks/pb_collect_yml --inventory inventory/inventory.yml ## License -Project is published under [Apache 2.0 License](../../LICENSE) +Project is published under [Apache 2.0 License](https://github.com/aristanetworks/avd/blob/devel/LICENSE) diff --git a/ansible_collections/arista/avd/roles/eos_validate_state/README.md b/ansible_collections/arista/avd/roles/eos_validate_state/README.md index 36358c74229..9df583de268 100644 --- a/ansible_collections/arista/avd/roles/eos_validate_state/README.md +++ b/ansible_collections/arista/avd/roles/eos_validate_state/README.md @@ -33,8 +33,8 @@ ansible-playbook playbooks/fabric-validate.yaml --check Figure 1 below provides a visualization of the role's inputs, outputs, and tasks in order executed by the role. -![Figure 1: Ansible Role eos_validate_state](../../docs/_media/eos_validate_state_dark.svg#only-dark) -![Figure 1: Ansible Role eos_validate_state](../../docs/_media/eos_validate_state_light.svg#only-light) +![Figure 1: Ansible Role eos_validate_state](../../../../../docs/_media/eos_validate_state_dark.svg#only-dark) +![Figure 1: Ansible Role eos_validate_state](../../../../../docs/_media/eos_validate_state_light.svg#only-light) **Inputs:** @@ -217,7 +217,7 @@ The variable `only_failed_tests` is used to limit the number of tests shown in t ## Requirements -Requirements are located here: [avd-requirements](../../docs/installation/collection-installation.md#python-requirements-installation) +Requirements are located here: [avd-requirements](../../../../../docs/installation/collection-installation.md#python-requirements-installation) ## Custom ANTA catalog @@ -353,7 +353,7 @@ ansible-playbook playbooks/pb_validate_yml --inventory inventory/inventory.yml ## License -Project is published under [Apache 2.0 License](../../LICENSE) +Project is published under [Apache 2.0 License](https://github.com/aristanetworks/avd/blob/devel/LICENSE) ## Known issues diff --git a/ansible_collections/arista/avd/media/5-stage-topology.gif b/docs/_media/5-stage-topology.gif similarity index 100% rename from ansible_collections/arista/avd/media/5-stage-topology.gif rename to docs/_media/5-stage-topology.gif diff --git a/ansible_collections/arista/avd/docs/_media/avd-eos-cli-config-gen-doc-overview.png b/docs/_media/avd-eos-cli-config-gen-doc-overview.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/avd-eos-cli-config-gen-doc-overview.png rename to docs/_media/avd-eos-cli-config-gen-doc-overview.png diff --git a/ansible_collections/arista/avd/docs/_media/avd-eos-lab-topology-overview.gif b/docs/_media/avd-eos-lab-topology-overview.gif similarity index 100% rename from ansible_collections/arista/avd/docs/_media/avd-eos-lab-topology-overview.gif rename to docs/_media/avd-eos-lab-topology-overview.gif diff --git a/ansible_collections/arista/avd/media/avd-logo.png b/docs/_media/avd-logo.png similarity index 100% rename from ansible_collections/arista/avd/media/avd-logo.png rename to docs/_media/avd-logo.png diff --git a/ansible_collections/arista/avd/docs/_media/avd_roles_dark.svg b/docs/_media/avd_roles_dark.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/avd_roles_dark.svg rename to docs/_media/avd_roles_dark.svg diff --git a/ansible_collections/arista/avd/docs/_media/avd_roles_light.svg b/docs/_media/avd_roles_light.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/avd_roles_light.svg rename to docs/_media/avd_roles_light.svg diff --git a/ansible_collections/arista/avd/docs/_media/avd_workflow_eapi_dark.svg b/docs/_media/avd_workflow_eapi_dark.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/avd_workflow_eapi_dark.svg rename to docs/_media/avd_workflow_eapi_dark.svg diff --git a/ansible_collections/arista/avd/docs/_media/avd_workflow_eapi_light.svg b/docs/_media/avd_workflow_eapi_light.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/avd_workflow_eapi_light.svg rename to docs/_media/avd_workflow_eapi_light.svg diff --git a/ansible_collections/arista/avd/docs/_media/awx-create-inventory.png b/docs/_media/awx-create-inventory.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/awx-create-inventory.png rename to docs/_media/awx-create-inventory.png diff --git a/ansible_collections/arista/avd/docs/_media/awx-create-project-venv.png b/docs/_media/awx-create-project-venv.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/awx-create-project-venv.png rename to docs/_media/awx-create-project-venv.png diff --git a/ansible_collections/arista/avd/docs/_media/awx-create-source.png b/docs/_media/awx-create-source.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/awx-create-source.png rename to docs/_media/awx-create-source.png diff --git a/ansible_collections/arista/avd/docs/_media/awx-create-template.png b/docs/_media/awx-create-template.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/awx-create-template.png rename to docs/_media/awx-create-template.png diff --git a/ansible_collections/arista/avd/docs/_media/awx-inventory-add-source.png b/docs/_media/awx-inventory-add-source.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/awx-inventory-add-source.png rename to docs/_media/awx-inventory-add-source.png diff --git a/ansible_collections/arista/avd/docs/_media/awx-inventory-list-devices.png b/docs/_media/awx-inventory-list-devices.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/awx-inventory-list-devices.png rename to docs/_media/awx-inventory-list-devices.png diff --git a/ansible_collections/arista/avd/docs/_media/awx-inventory-sync-source.png b/docs/_media/awx-inventory-sync-source.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/awx-inventory-sync-source.png rename to docs/_media/awx-inventory-sync-source.png diff --git a/ansible_collections/arista/avd/docs/_media/awx-playbook-run.png b/docs/_media/awx-playbook-run.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/awx-playbook-run.png rename to docs/_media/awx-playbook-run.png diff --git a/ansible_collections/arista/avd/docs/_media/cloudvision-deployed-configlet.png b/docs/_media/cloudvision-deployed-configlet.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/cloudvision-deployed-configlet.png rename to docs/_media/cloudvision-deployed-configlet.png diff --git a/ansible_collections/arista/avd/docs/_media/cloudvision-device-topology.png b/docs/_media/cloudvision-device-topology.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/cloudvision-device-topology.png rename to docs/_media/cloudvision-device-topology.png diff --git a/ansible_collections/arista/avd/docs/_media/cloudvision-initial-configlet.png b/docs/_media/cloudvision-initial-configlet.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/cloudvision-initial-configlet.png rename to docs/_media/cloudvision-initial-configlet.png diff --git a/ansible_collections/arista/avd/docs/_media/cloudvision-uploaded-configlets.png b/docs/_media/cloudvision-uploaded-configlets.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/cloudvision-uploaded-configlets.png rename to docs/_media/cloudvision-uploaded-configlets.png diff --git a/ansible_collections/arista/avd/docs/_media/cloudvision-ztpd-devices.png b/docs/_media/cloudvision-ztpd-devices.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/cloudvision-ztpd-devices.png rename to docs/_media/cloudvision-ztpd-devices.png diff --git a/ansible_collections/arista/avd/docs/_media/cv_ansible_logo.png b/docs/_media/cv_ansible_logo.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/cv_ansible_logo.png rename to docs/_media/cv_ansible_logo.png diff --git a/ansible_collections/arista/avd/docs/_media/cv_deploy_dark.svg b/docs/_media/cv_deploy_dark.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/cv_deploy_dark.svg rename to docs/_media/cv_deploy_dark.svg diff --git a/ansible_collections/arista/avd/docs/_media/cv_deploy_light.svg b/docs/_media/cv_deploy_light.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/cv_deploy_light.svg rename to docs/_media/cv_deploy_light.svg diff --git a/ansible_collections/arista/avd/docs/_media/cvp_configlet_upload_dark.svg b/docs/_media/cvp_configlet_upload_dark.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/cvp_configlet_upload_dark.svg rename to docs/_media/cvp_configlet_upload_dark.svg diff --git a/ansible_collections/arista/avd/docs/_media/cvp_configlet_upload_light.svg b/docs/_media/cvp_configlet_upload_light.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/cvp_configlet_upload_light.svg rename to docs/_media/cvp_configlet_upload_light.svg diff --git a/ansible_collections/arista/avd/media/dissag-topology.gif b/docs/_media/dissag-topology.gif similarity index 100% rename from ansible_collections/arista/avd/media/dissag-topology.gif rename to docs/_media/dissag-topology.gif diff --git a/ansible_collections/arista/avd/media/enable_trunk_groups.png b/docs/_media/enable_trunk_groups.png similarity index 100% rename from ansible_collections/arista/avd/media/enable_trunk_groups.png rename to docs/_media/enable_trunk_groups.png diff --git a/ansible_collections/arista/avd/docs/_media/eos_cli_config_gen_dark.svg b/docs/_media/eos_cli_config_gen_dark.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/eos_cli_config_gen_dark.svg rename to docs/_media/eos_cli_config_gen_dark.svg diff --git a/ansible_collections/arista/avd/docs/_media/eos_cli_config_gen_light.svg b/docs/_media/eos_cli_config_gen_light.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/eos_cli_config_gen_light.svg rename to docs/_media/eos_cli_config_gen_light.svg diff --git a/ansible_collections/arista/avd/docs/_media/eos_config_deploy_cvp_dark.svg b/docs/_media/eos_config_deploy_cvp_dark.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/eos_config_deploy_cvp_dark.svg rename to docs/_media/eos_config_deploy_cvp_dark.svg diff --git a/ansible_collections/arista/avd/docs/_media/eos_config_deploy_cvp_light.svg b/docs/_media/eos_config_deploy_cvp_light.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/eos_config_deploy_cvp_light.svg rename to docs/_media/eos_config_deploy_cvp_light.svg diff --git a/ansible_collections/arista/avd/docs/_media/eos_config_deploy_eapi_dark.svg b/docs/_media/eos_config_deploy_eapi_dark.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/eos_config_deploy_eapi_dark.svg rename to docs/_media/eos_config_deploy_eapi_dark.svg diff --git a/ansible_collections/arista/avd/docs/_media/eos_config_deploy_eapi_light.svg b/docs/_media/eos_config_deploy_eapi_light.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/eos_config_deploy_eapi_light.svg rename to docs/_media/eos_config_deploy_eapi_light.svg diff --git a/ansible_collections/arista/avd/docs/_media/eos_designs_dark.svg b/docs/_media/eos_designs_dark.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/eos_designs_dark.svg rename to docs/_media/eos_designs_dark.svg diff --git a/ansible_collections/arista/avd/docs/_media/eos_designs_light.svg b/docs/_media/eos_designs_light.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/eos_designs_light.svg rename to docs/_media/eos_designs_light.svg diff --git a/ansible_collections/arista/avd/docs/_media/eos_snapshot_dark.svg b/docs/_media/eos_snapshot_dark.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/eos_snapshot_dark.svg rename to docs/_media/eos_snapshot_dark.svg diff --git a/ansible_collections/arista/avd/docs/_media/eos_snapshot_light.svg b/docs/_media/eos_snapshot_light.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/eos_snapshot_light.svg rename to docs/_media/eos_snapshot_light.svg diff --git a/ansible_collections/arista/avd/docs/_media/eos_validate_state_dark.svg b/docs/_media/eos_validate_state_dark.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/eos_validate_state_dark.svg rename to docs/_media/eos_validate_state_dark.svg diff --git a/ansible_collections/arista/avd/docs/_media/eos_validate_state_light.svg b/docs/_media/eos_validate_state_light.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/eos_validate_state_light.svg rename to docs/_media/eos_validate_state_light.svg diff --git a/ansible_collections/arista/avd/media/example-playbook-deploy-cvp.gif b/docs/_media/example-playbook-deploy-cvp.gif similarity index 100% rename from ansible_collections/arista/avd/media/example-playbook-deploy-cvp.gif rename to docs/_media/example-playbook-deploy-cvp.gif diff --git a/ansible_collections/arista/avd/media/example-playbook-deploy-eapi.gif b/docs/_media/example-playbook-deploy-eapi.gif similarity index 100% rename from ansible_collections/arista/avd/media/example-playbook-deploy-eapi.gif rename to docs/_media/example-playbook-deploy-eapi.gif diff --git a/ansible_collections/arista/avd/docs/_media/excalidraw/avd_roles.excalidraw b/docs/_media/excalidraw/avd_roles.excalidraw similarity index 100% rename from ansible_collections/arista/avd/docs/_media/excalidraw/avd_roles.excalidraw rename to docs/_media/excalidraw/avd_roles.excalidraw diff --git a/ansible_collections/arista/avd/docs/_media/excalidraw/avd_workflow_eapi.excalidraw b/docs/_media/excalidraw/avd_workflow_eapi.excalidraw similarity index 100% rename from ansible_collections/arista/avd/docs/_media/excalidraw/avd_workflow_eapi.excalidraw rename to docs/_media/excalidraw/avd_workflow_eapi.excalidraw diff --git a/ansible_collections/arista/avd/docs/_media/excalidraw/cvp_configlet_upload.excalidraw b/docs/_media/excalidraw/cvp_configlet_upload.excalidraw similarity index 100% rename from ansible_collections/arista/avd/docs/_media/excalidraw/cvp_configlet_upload.excalidraw rename to docs/_media/excalidraw/cvp_configlet_upload.excalidraw diff --git a/ansible_collections/arista/avd/docs/_media/excalidraw/deploy_to_cv.excalidraw b/docs/_media/excalidraw/deploy_to_cv.excalidraw similarity index 100% rename from ansible_collections/arista/avd/docs/_media/excalidraw/deploy_to_cv.excalidraw rename to docs/_media/excalidraw/deploy_to_cv.excalidraw diff --git a/ansible_collections/arista/avd/docs/_media/excalidraw/eos_cli_config_gen.excalidraw b/docs/_media/excalidraw/eos_cli_config_gen.excalidraw similarity index 100% rename from ansible_collections/arista/avd/docs/_media/excalidraw/eos_cli_config_gen.excalidraw rename to docs/_media/excalidraw/eos_cli_config_gen.excalidraw diff --git a/ansible_collections/arista/avd/docs/_media/excalidraw/eos_config_deploy_cvp.excalidraw b/docs/_media/excalidraw/eos_config_deploy_cvp.excalidraw similarity index 100% rename from ansible_collections/arista/avd/docs/_media/excalidraw/eos_config_deploy_cvp.excalidraw rename to docs/_media/excalidraw/eos_config_deploy_cvp.excalidraw diff --git a/ansible_collections/arista/avd/docs/_media/excalidraw/eos_config_deploy_eapi.excalidraw b/docs/_media/excalidraw/eos_config_deploy_eapi.excalidraw similarity index 100% rename from ansible_collections/arista/avd/docs/_media/excalidraw/eos_config_deploy_eapi.excalidraw rename to docs/_media/excalidraw/eos_config_deploy_eapi.excalidraw diff --git a/ansible_collections/arista/avd/docs/_media/excalidraw/eos_designs.excalidraw b/docs/_media/excalidraw/eos_designs.excalidraw similarity index 100% rename from ansible_collections/arista/avd/docs/_media/excalidraw/eos_designs.excalidraw rename to docs/_media/excalidraw/eos_designs.excalidraw diff --git a/ansible_collections/arista/avd/docs/_media/excalidraw/eos_snapshot.excalidraw b/docs/_media/excalidraw/eos_snapshot.excalidraw similarity index 100% rename from ansible_collections/arista/avd/docs/_media/excalidraw/eos_snapshot.excalidraw rename to docs/_media/excalidraw/eos_snapshot.excalidraw diff --git a/ansible_collections/arista/avd/docs/_media/excalidraw/eos_validate_state.excalidraw b/docs/_media/excalidraw/eos_validate_state.excalidraw similarity index 100% rename from ansible_collections/arista/avd/docs/_media/excalidraw/eos_validate_state.excalidraw rename to docs/_media/excalidraw/eos_validate_state.excalidraw diff --git a/ansible_collections/arista/avd/docs/_media/excalidraw/pyavd_functions.excalidraw b/docs/_media/excalidraw/pyavd_functions.excalidraw similarity index 100% rename from ansible_collections/arista/avd/docs/_media/excalidraw/pyavd_functions.excalidraw rename to docs/_media/excalidraw/pyavd_functions.excalidraw diff --git a/ansible_collections/arista/avd/docs/_media/favicon.ico b/docs/_media/favicon.ico similarity index 100% rename from ansible_collections/arista/avd/docs/_media/favicon.ico rename to docs/_media/favicon.ico diff --git a/ansible_collections/arista/avd/docs/_media/figure-2-cloudvision-change-control.png b/docs/_media/figure-2-cloudvision-change-control.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/figure-2-cloudvision-change-control.png rename to docs/_media/figure-2-cloudvision-change-control.png diff --git a/ansible_collections/arista/avd/docs/_media/first-cvp-avd-topology.png b/docs/_media/first-cvp-avd-topology.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/first-cvp-avd-topology.png rename to docs/_media/first-cvp-avd-topology.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/aap-cvp-eos.svg b/docs/_media/getting-started/aap-avd/aap-cvp-eos.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/aap-cvp-eos.svg rename to docs/_media/getting-started/aap-avd/aap-cvp-eos.svg diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/aap-dashboardpng.png b/docs/_media/getting-started/aap-avd/aap-dashboardpng.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/aap-dashboardpng.png rename to docs/_media/getting-started/aap-avd/aap-dashboardpng.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/add-template.png b/docs/_media/getting-started/aap-avd/add-template.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/add-template.png rename to docs/_media/getting-started/aap-avd/add-template.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/all-hosts.png b/docs/_media/getting-started/aap-avd/all-hosts.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/all-hosts.png rename to docs/_media/getting-started/aap-avd/all-hosts.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/create-ee.png b/docs/_media/getting-started/aap-avd/create-ee.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/create-ee.png rename to docs/_media/getting-started/aap-avd/create-ee.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/create-source.png b/docs/_media/getting-started/aap-avd/create-source.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/create-source.png rename to docs/_media/getting-started/aap-avd/create-source.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/cvp-cc.png b/docs/_media/getting-started/aap-avd/cvp-cc.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/cvp-cc.png rename to docs/_media/getting-started/aap-avd/cvp-cc.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/inv-job-output.png b/docs/_media/getting-started/aap-avd/inv-job-output.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/inv-job-output.png rename to docs/_media/getting-started/aap-avd/inv-job-output.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/inv-job-sync.png b/docs/_media/getting-started/aap-avd/inv-job-sync.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/inv-job-sync.png rename to docs/_media/getting-started/aap-avd/inv-job-sync.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/inv-sync.png b/docs/_media/getting-started/aap-avd/inv-sync.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/inv-sync.png rename to docs/_media/getting-started/aap-avd/inv-sync.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/job-output.png b/docs/_media/getting-started/aap-avd/job-output.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/job-output.png rename to docs/_media/getting-started/aap-avd/job-output.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/job-updates.png b/docs/_media/getting-started/aap-avd/job-updates.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/job-updates.png rename to docs/_media/getting-started/aap-avd/job-updates.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/run-job.png b/docs/_media/getting-started/aap-avd/run-job.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/run-job.png rename to docs/_media/getting-started/aap-avd/run-job.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/save-inv.png b/docs/_media/getting-started/aap-avd/save-inv.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/save-inv.png rename to docs/_media/getting-started/aap-avd/save-inv.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/save-project.png b/docs/_media/getting-started/aap-avd/save-project.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/save-project.png rename to docs/_media/getting-started/aap-avd/save-project.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/select-add-ee.png b/docs/_media/getting-started/aap-avd/select-add-ee.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/select-add-ee.png rename to docs/_media/getting-started/aap-avd/select-add-ee.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/select-add-inv.png b/docs/_media/getting-started/aap-avd/select-add-inv.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/select-add-inv.png rename to docs/_media/getting-started/aap-avd/select-add-inv.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/select-add-project.png b/docs/_media/getting-started/aap-avd/select-add-project.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/select-add-project.png rename to docs/_media/getting-started/aap-avd/select-add-project.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/select-ee.png b/docs/_media/getting-started/aap-avd/select-ee.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/select-ee.png rename to docs/_media/getting-started/aap-avd/select-ee.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/select-inv.png b/docs/_media/getting-started/aap-avd/select-inv.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/select-inv.png rename to docs/_media/getting-started/aap-avd/select-inv.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/select-projects.png b/docs/_media/getting-started/aap-avd/select-projects.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/select-projects.png rename to docs/_media/getting-started/aap-avd/select-projects.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/select-sources.png b/docs/_media/getting-started/aap-avd/select-sources.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/select-sources.png rename to docs/_media/getting-started/aap-avd/select-sources.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/select-templates.png b/docs/_media/getting-started/aap-avd/select-templates.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/select-templates.png rename to docs/_media/getting-started/aap-avd/select-templates.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/survey-enabled.png b/docs/_media/getting-started/aap-avd/survey-enabled.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/survey-enabled.png rename to docs/_media/getting-started/aap-avd/survey-enabled.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/survey-save.png b/docs/_media/getting-started/aap-avd/survey-save.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/survey-save.png rename to docs/_media/getting-started/aap-avd/survey-save.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/template-save.png b/docs/_media/getting-started/aap-avd/template-save.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/template-save.png rename to docs/_media/getting-started/aap-avd/template-save.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/template-survey.png b/docs/_media/getting-started/aap-avd/template-survey.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/aap-avd/template-survey.png rename to docs/_media/getting-started/aap-avd/template-survey.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/collections.svg b/docs/_media/getting-started/collections.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/collections.svg rename to docs/_media/getting-started/collections.svg diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/group-vars-folder-structure.png b/docs/_media/getting-started/group-vars-folder-structure.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/group-vars-folder-structure.png rename to docs/_media/getting-started/group-vars-folder-structure.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/groups.svg b/docs/_media/getting-started/groups.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/groups.svg rename to docs/_media/getting-started/groups.svg diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/inventory-folder-structure.png b/docs/_media/getting-started/inventory-folder-structure.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/inventory-folder-structure.png rename to docs/_media/getting-started/inventory-folder-structure.png diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/requirements.svg b/docs/_media/getting-started/requirements.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/requirements.svg rename to docs/_media/getting-started/requirements.svg diff --git a/ansible_collections/arista/avd/docs/_media/getting-started/single-dc.svg b/docs/_media/getting-started/single-dc.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/getting-started/single-dc.svg rename to docs/_media/getting-started/single-dc.svg diff --git a/ansible_collections/arista/avd/docs/_media/git-structure.gif b/docs/_media/git-structure.gif similarity index 100% rename from ansible_collections/arista/avd/docs/_media/git-structure.gif rename to docs/_media/git-structure.gif diff --git a/ansible_collections/arista/avd/media/l2ls-topology.svg b/docs/_media/l2ls-topology.svg similarity index 100% rename from ansible_collections/arista/avd/media/l2ls-topology.svg rename to docs/_media/l2ls-topology.svg diff --git a/ansible_collections/arista/avd/docs/_media/lab-nat-topology-example.png b/docs/_media/lab-nat-topology-example.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/lab-nat-topology-example.png rename to docs/_media/lab-nat-topology-example.png diff --git a/ansible_collections/arista/avd/media/mpls-topology.svg b/docs/_media/mpls-topology.svg similarity index 100% rename from ansible_collections/arista/avd/media/mpls-topology.svg rename to docs/_media/mpls-topology.svg diff --git a/ansible_collections/arista/avd/media/only_local_vlan_trunk_groups.png b/docs/_media/only_local_vlan_trunk_groups.png similarity index 100% rename from ansible_collections/arista/avd/media/only_local_vlan_trunk_groups.png rename to docs/_media/only_local_vlan_trunk_groups.png diff --git a/ansible_collections/arista/avd/docs/_media/pyavd_functions_dark.svg b/docs/_media/pyavd_functions_dark.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/pyavd_functions_dark.svg rename to docs/_media/pyavd_functions_dark.svg diff --git a/ansible_collections/arista/avd/docs/_media/pyavd_functions_light.svg b/docs/_media/pyavd_functions_light.svg similarity index 100% rename from ansible_collections/arista/avd/docs/_media/pyavd_functions_light.svg rename to docs/_media/pyavd_functions_light.svg diff --git a/ansible_collections/arista/avd/media/role_eos_designs.gif b/docs/_media/role_eos_designs.gif similarity index 100% rename from ansible_collections/arista/avd/media/role_eos_designs.gif rename to docs/_media/role_eos_designs.gif diff --git a/ansible_collections/arista/avd/media/serviceaccount1.png b/docs/_media/serviceaccount1.png similarity index 100% rename from ansible_collections/arista/avd/media/serviceaccount1.png rename to docs/_media/serviceaccount1.png diff --git a/ansible_collections/arista/avd/media/serviceaccount2.png b/docs/_media/serviceaccount2.png similarity index 100% rename from ansible_collections/arista/avd/media/serviceaccount2.png rename to docs/_media/serviceaccount2.png diff --git a/ansible_collections/arista/avd/media/serviceaccount3.png b/docs/_media/serviceaccount3.png similarity index 100% rename from ansible_collections/arista/avd/media/serviceaccount3.png rename to docs/_media/serviceaccount3.png diff --git a/ansible_collections/arista/avd/docs/_media/streaming-inventory.png b/docs/_media/streaming-inventory.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/streaming-inventory.png rename to docs/_media/streaming-inventory.png diff --git a/ansible_collections/arista/avd/docs/_media/studios_end_to_end_provisioning.png b/docs/_media/studios_end_to_end_provisioning.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/studios_end_to_end_provisioning.png rename to docs/_media/studios_end_to_end_provisioning.png diff --git a/ansible_collections/arista/avd/media/variables_precedence.png b/docs/_media/variables_precedence.png similarity index 100% rename from ansible_collections/arista/avd/media/variables_precedence.png rename to docs/_media/variables_precedence.png diff --git a/ansible_collections/arista/avd/docs/_media/vscode-container-demo-overview.png b/docs/_media/vscode-container-demo-overview.png similarity index 100% rename from ansible_collections/arista/avd/docs/_media/vscode-container-demo-overview.png rename to docs/_media/vscode-container-demo-overview.png diff --git a/ansible_collections/arista/avd/media/wan-topology.svg b/docs/_media/wan-topology.svg similarity index 100% rename from ansible_collections/arista/avd/media/wan-topology.svg rename to docs/_media/wan-topology.svg diff --git a/ansible_collections/arista/avd/media/wan_direct_ha_no_lan.png b/docs/_media/wan_direct_ha_no_lan.png similarity index 100% rename from ansible_collections/arista/avd/media/wan_direct_ha_no_lan.png rename to docs/_media/wan_direct_ha_no_lan.png diff --git a/ansible_collections/arista/avd/media/wan_ebgp_lan_ha.png b/docs/_media/wan_ebgp_lan_ha.png similarity index 100% rename from ansible_collections/arista/avd/media/wan_ebgp_lan_ha.png rename to docs/_media/wan_ebgp_lan_ha.png diff --git a/ansible_collections/arista/avd/media/wan_ebgp_lan_ha_direct.png b/docs/_media/wan_ebgp_lan_ha_direct.png similarity index 100% rename from ansible_collections/arista/avd/media/wan_ebgp_lan_ha_direct.png rename to docs/_media/wan_ebgp_lan_ha_direct.png diff --git a/ansible_collections/arista/avd/media/wan_ebgp_lan_single_router.png b/docs/_media/wan_ebgp_lan_single_router.png similarity index 100% rename from ansible_collections/arista/avd/media/wan_ebgp_lan_single_router.png rename to docs/_media/wan_ebgp_lan_single_router.png diff --git a/ansible_collections/arista/avd/media/wan_lan_common.png b/docs/_media/wan_lan_common.png similarity index 100% rename from ansible_collections/arista/avd/media/wan_lan_common.png rename to docs/_media/wan_lan_common.png diff --git a/ansible_collections/arista/avd/docs/_overrides/main.html b/docs/_overrides/main.html similarity index 100% rename from ansible_collections/arista/avd/docs/_overrides/main.html rename to docs/_overrides/main.html diff --git a/ansible_collections/arista/avd/docs/containers/overview.md b/docs/containers/overview.md similarity index 100% rename from ansible_collections/arista/avd/docs/containers/overview.md rename to docs/containers/overview.md diff --git a/ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md b/docs/contribution/authoring_eos_cli_config_gen.md similarity index 100% rename from ansible_collections/arista/avd/docs/contribution/authoring_eos_cli_config_gen.md rename to docs/contribution/authoring_eos_cli_config_gen.md diff --git a/ansible_collections/arista/avd/docs/contribution/development-tooling.md b/docs/contribution/development-tooling.md similarity index 100% rename from ansible_collections/arista/avd/docs/contribution/development-tooling.md rename to docs/contribution/development-tooling.md diff --git a/ansible_collections/arista/avd/docs/contribution/eos_designs_internal_notes.md b/docs/contribution/eos_designs_internal_notes.md similarity index 99% rename from ansible_collections/arista/avd/docs/contribution/eos_designs_internal_notes.md rename to docs/contribution/eos_designs_internal_notes.md index 0371cbb97f8..b0e1e76133b 100644 --- a/ansible_collections/arista/avd/docs/contribution/eos_designs_internal_notes.md +++ b/docs/contribution/eos_designs_internal_notes.md @@ -47,7 +47,7 @@ The module is used in `arista.avd.eos_designs` to set facts for devices, which a cprofile_file: ``` -See the full argument spec [here](../../plugins/modules/eos_designs_facts.py) +See the full argument spec [here](../plugins/Modules_and_action_plugins/eos_designs_facts.md) #### Output data model diff --git a/ansible_collections/arista/avd/docs/contribution/input-variable-validation.md b/docs/contribution/input-variable-validation.md similarity index 100% rename from ansible_collections/arista/avd/docs/contribution/input-variable-validation.md rename to docs/contribution/input-variable-validation.md diff --git a/ansible_collections/arista/avd/docs/contribution/overview.md b/docs/contribution/overview.md similarity index 100% rename from ansible_collections/arista/avd/docs/contribution/overview.md rename to docs/contribution/overview.md diff --git a/ansible_collections/arista/avd/docs/contribution/style-guide.md b/docs/contribution/style-guide.md similarity index 100% rename from ansible_collections/arista/avd/docs/contribution/style-guide.md rename to docs/contribution/style-guide.md diff --git a/ansible_collections/arista/avd/docs/getting-started/avd-aap.md b/docs/getting-started/avd-aap.md similarity index 99% rename from ansible_collections/arista/avd/docs/getting-started/avd-aap.md rename to docs/getting-started/avd-aap.md index 64fa1ae23ba..0811b6c8f17 100644 --- a/ansible_collections/arista/avd/docs/getting-started/avd-aap.md +++ b/docs/getting-started/avd-aap.md @@ -11,7 +11,7 @@ This guide will walk you through the steps required to get up and running with A ## Requirements to get started - An accessible lab topology running Arista EOS. -- An AVD project or Git repository with playbooks and an inventory. To get started, you may also use any of our [example topologies](../../examples/single-dc-l3ls/README.md). +- An AVD project or Git repository with playbooks and an inventory. To get started, you may also use any of our [example topologies](../../ansible_collections/arista/avd/examples/single-dc-l3ls/README.md). - A RHEL instance running AAP. - If you need access to a RHEL instance, you can join the [developer program](https://www.redhat.com/en/technologies/linux-platforms/enterprise-linux/developer-program) to get a copy. - To get started, you may also sign up for a 60-day [trial license](https://www.redhat.com/en/technologies/management/ansible/trial) for AAP. diff --git a/ansible_collections/arista/avd/docs/getting-started/intro-to-ansible-and-avd.md b/docs/getting-started/intro-to-ansible-and-avd.md similarity index 95% rename from ansible_collections/arista/avd/docs/getting-started/intro-to-ansible-and-avd.md rename to docs/getting-started/intro-to-ansible-and-avd.md index e7e602f02a2..cf24929c4ec 100644 --- a/ansible_collections/arista/avd/docs/getting-started/intro-to-ansible-and-avd.md +++ b/docs/getting-started/intro-to-ansible-and-avd.md @@ -329,10 +329,10 @@ Following the scope definition, the ***tasks*** are then defined. In this example, the play executes two tasks: -1. Import a ***role*** called [***arista.avd.eos_designs***](../../roles/eos_designs/README.md). -2. Import a ***role*** called [***arista.avd.eos_cli_config_gen***](../../roles/eos_cli_config_gen/README.md). +1. Import a ***role*** called [***arista.avd.eos_designs***](../../ansible_collections/arista/avd/roles/eos_designs/README.md). +2. Import a ***role*** called [***arista.avd.eos_cli_config_gen***](../../ansible_collections/arista/avd/roles/eos_cli_config_gen/README.md). -The ***arista.avd.eos_designs*** role takes inputs from a number of [places](../../roles/eos_designs/README.md#role-inputs-and-outputs): +The ***arista.avd.eos_designs*** role takes inputs from a number of [places](../../ansible_collections/arista/avd/roles/eos_designs/README.md#role-inputs-and-outputs): - role/defaults definitions - group_vars @@ -344,7 +344,7 @@ Based on some or all of these inputs, it generates the following output: - Fabric Documentation in Markdown format. - Leaf and Spine Topology summary in CSV format. -The second role, ***arista.avd.eos_cli_config_gen*** uses the structured EOS configuration in YAML format as its [input](../../roles/eos_cli_config_gen/README.md#role-inputs-and-outputs) +The second role, ***arista.avd.eos_cli_config_gen*** uses the structured EOS configuration in YAML format as its [input](../../ansible_collections/arista/avd/roles/eos_cli_config_gen/README.md#role-inputs-and-outputs) (generated by arista.avd.eos_designs) and outputs the following: - EOS configuration in CLI format. @@ -352,8 +352,8 @@ The second role, ***arista.avd.eos_cli_config_gen*** uses the structured EOS con Running the play described above would result in several files containing the configuration and documentation for the devices in scope - in this case, DC1_FABRIC. Then, to apply the configuration to the actual devices, you would run additional roles such as: -- [eos_config_deploy_cvp](../../roles/eos_config_deploy_cvp/README.md), which deploys the EOS configuration via the CloudVision Management platform, including change control with RBAC and full rollback capability. -- [eos_config_deploy_eapi](../../roles/eos_config_deploy_eapi/README.md), which deploys the EOS configuration directly to Arista devices using config replace. This option provides no change control and no rollback capability. +- [eos_config_deploy_cvp](../../ansible_collections/arista/avd/roles/eos_config_deploy_cvp/README.md), which deploys the EOS configuration via the CloudVision Management platform, including change control with RBAC and full rollback capability. +- [eos_config_deploy_eapi](../../ansible_collections/arista/avd/roles/eos_config_deploy_eapi/README.md), which deploys the EOS configuration directly to Arista devices using config replace. This option provides no change control and no rollback capability. While this play shows both the `eos_designs` and `eos_cli_config_gen` roles used together, it's entirely possible to make use of just `eos_cli_config_gen` by itself - this would allow (for example) generation of management configuration that could potentially be merged into an existing network as discussed earlier. @@ -369,8 +369,8 @@ This System of Record means you have a complete overview of your designed networ Below you will find two examples of documentation automatically created by Ansible AVD: -- [Documentation for L3LS fabric](../../examples/single-dc-l3ls/documentation/fabric/FABRIC-documentation.md) -- [A single leaf inside the fabric above](../../examples/single-dc-l3ls/documentation/devices/dc1-leaf1a.md) +- [Documentation for L3LS fabric](../../ansible_collections/arista/avd/examples/single-dc-l3ls/documentation/fabric/FABRIC-documentation.md) +- [A single leaf inside the fabric above](../../ansible_collections/arista/avd/examples/single-dc-l3ls/documentation/devices/dc1-leaf1a.md) ## How do I use AVD? @@ -694,10 +694,10 @@ This takes place without manual intervention and with very little chance for hum Below are a number of links to additional documentation about Ansible AVD and Ansible in general: -- [Role documentation for eos_design](../../roles/eos_designs/README.md) -- [Role documentation for eos_cli_config_gen](../../roles/eos_cli_config_gen/README.md) +- [Role documentation for eos_design](../../ansible_collections/arista/avd/roles/eos_designs/README.md) +- [Role documentation for eos_cli_config_gen](../../ansible_collections/arista/avd/roles/eos_cli_config_gen/README.md) - [RedHat Ansible Tower Documentation](https://docs.ansible.com/ansible/latest/reference_appendices/tower.html) -- [Role documentation for eos_config_deploy_cvp](../../roles/eos_config_deploy_cvp/README.md) / [eos_config_deploy_eapi](../../roles/eos_config_deploy_eapi/README.md) +- [Role documentation for eos_config_deploy_cvp](../../ansible_collections/arista/avd/roles/eos_config_deploy_cvp/README.md) / [eos_config_deploy_eapi](../../ansible_collections/arista/avd/roles/eos_config_deploy_eapi/README.md) ## Next steps diff --git a/ansible_collections/arista/avd/docs/installation/collection-installation.md b/docs/installation/collection-installation.md similarity index 95% rename from ansible_collections/arista/avd/docs/installation/collection-installation.md rename to docs/installation/collection-installation.md index f107c49a3df..35ca24689c2 100644 --- a/ansible_collections/arista/avd/docs/installation/collection-installation.md +++ b/docs/installation/collection-installation.md @@ -118,3 +118,8 @@ If you leverage [CloudVision](https://www.arista.com/en/products/eos/eos-cloudvi !!! note When using ansible-cvp modules, the user who is executing the ansible-playbook must have access to both CVP and the EOS CLI. + +## Ansible Documentation + +- [Ansible Collection User Guide](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) +- [Ansible User Guide](https://docs.ansible.com/ansible/latest/user_guide/index.html) diff --git a/ansible_collections/arista/avd/docs/plugins/Filter_plugins/add_md_toc.md b/docs/plugins/Filter_plugins/add_md_toc.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Filter_plugins/add_md_toc.md rename to docs/plugins/Filter_plugins/add_md_toc.md diff --git a/ansible_collections/arista/avd/docs/plugins/Filter_plugins/decrypt.md b/docs/plugins/Filter_plugins/decrypt.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Filter_plugins/decrypt.md rename to docs/plugins/Filter_plugins/decrypt.md diff --git a/ansible_collections/arista/avd/docs/plugins/Filter_plugins/default.md b/docs/plugins/Filter_plugins/default.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Filter_plugins/default.md rename to docs/plugins/Filter_plugins/default.md diff --git a/ansible_collections/arista/avd/docs/plugins/Filter_plugins/encrypt.md b/docs/plugins/Filter_plugins/encrypt.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Filter_plugins/encrypt.md rename to docs/plugins/Filter_plugins/encrypt.md diff --git a/ansible_collections/arista/avd/docs/plugins/Filter_plugins/hide_passwords.md b/docs/plugins/Filter_plugins/hide_passwords.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Filter_plugins/hide_passwords.md rename to docs/plugins/Filter_plugins/hide_passwords.md diff --git a/ansible_collections/arista/avd/docs/plugins/Filter_plugins/is_in_filter.md b/docs/plugins/Filter_plugins/is_in_filter.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Filter_plugins/is_in_filter.md rename to docs/plugins/Filter_plugins/is_in_filter.md diff --git a/ansible_collections/arista/avd/docs/plugins/Filter_plugins/list_compress.md b/docs/plugins/Filter_plugins/list_compress.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Filter_plugins/list_compress.md rename to docs/plugins/Filter_plugins/list_compress.md diff --git a/ansible_collections/arista/avd/docs/plugins/Filter_plugins/natural_sort.md b/docs/plugins/Filter_plugins/natural_sort.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Filter_plugins/natural_sort.md rename to docs/plugins/Filter_plugins/natural_sort.md diff --git a/ansible_collections/arista/avd/docs/plugins/Filter_plugins/range_expand.md b/docs/plugins/Filter_plugins/range_expand.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Filter_plugins/range_expand.md rename to docs/plugins/Filter_plugins/range_expand.md diff --git a/ansible_collections/arista/avd/docs/plugins/Filter_plugins/snmp_hash.md b/docs/plugins/Filter_plugins/snmp_hash.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Filter_plugins/snmp_hash.md rename to docs/plugins/Filter_plugins/snmp_hash.md diff --git a/ansible_collections/arista/avd/docs/plugins/Filter_plugins/status_render.md b/docs/plugins/Filter_plugins/status_render.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Filter_plugins/status_render.md rename to docs/plugins/Filter_plugins/status_render.md diff --git a/ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/configlet_build_config.md b/docs/plugins/Modules_and_action_plugins/configlet_build_config.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/configlet_build_config.md rename to docs/plugins/Modules_and_action_plugins/configlet_build_config.md diff --git a/ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/cv_workflow.md b/docs/plugins/Modules_and_action_plugins/cv_workflow.md similarity index 96% rename from ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/cv_workflow.md rename to docs/plugins/Modules_and_action_plugins/cv_workflow.md index 2143e7362b5..164f56816d2 100644 --- a/ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/cv_workflow.md +++ b/docs/plugins/Modules_and_action_plugins/cv_workflow.md @@ -60,9 +60,11 @@ The `arista.avd.cv_workflow` module is an Ansible Action Plugin providing the fo - When interacting with CVaaS the regional URL where the tenant is deployed should be used, e.g: `cv_servers: [ www.cv-prod-euwest-2.arista.io ]` - To see the full list of regional URLs, please visit the [cv_deploy](../../../roles/cv_deploy/README.md#overview) + To see the full list of regional URLs, please visit the + [cv_deploy](../../../ansible_collections/arista/avd/roles/cv_deploy/README.md#overview) role documentation. -- To generate service accounts check [cv_deploy](../../../roles/cv_deploy/README.md#steps-to-create-service-accounts-on-cloudvision) +- To generate service accounts check + [cv_deploy](../../../ansible_collections/arista/avd/roles/cv_deploy/README.md#steps-to-create-service-accounts-on-cloudvision) role documentation or the CloudVision Help Center. ## Examples diff --git a/ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/eos_cli_config_gen.md b/docs/plugins/Modules_and_action_plugins/eos_cli_config_gen.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/eos_cli_config_gen.md rename to docs/plugins/Modules_and_action_plugins/eos_cli_config_gen.md diff --git a/ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/eos_designs_documentation.md b/docs/plugins/Modules_and_action_plugins/eos_designs_documentation.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/eos_designs_documentation.md rename to docs/plugins/Modules_and_action_plugins/eos_designs_documentation.md diff --git a/ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/eos_designs_facts.md b/docs/plugins/Modules_and_action_plugins/eos_designs_facts.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/eos_designs_facts.md rename to docs/plugins/Modules_and_action_plugins/eos_designs_facts.md diff --git a/ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/eos_designs_structured_config.md b/docs/plugins/Modules_and_action_plugins/eos_designs_structured_config.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/eos_designs_structured_config.md rename to docs/plugins/Modules_and_action_plugins/eos_designs_structured_config.md diff --git a/ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/eos_validate_state_reports.md b/docs/plugins/Modules_and_action_plugins/eos_validate_state_reports.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/eos_validate_state_reports.md rename to docs/plugins/Modules_and_action_plugins/eos_validate_state_reports.md diff --git a/ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/eos_validate_state_runner.md b/docs/plugins/Modules_and_action_plugins/eos_validate_state_runner.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/eos_validate_state_runner.md rename to docs/plugins/Modules_and_action_plugins/eos_validate_state_runner.md diff --git a/ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/inventory_to_container.md b/docs/plugins/Modules_and_action_plugins/inventory_to_container.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/inventory_to_container.md rename to docs/plugins/Modules_and_action_plugins/inventory_to_container.md diff --git a/ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/set_vars.md b/docs/plugins/Modules_and_action_plugins/set_vars.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/set_vars.md rename to docs/plugins/Modules_and_action_plugins/set_vars.md diff --git a/ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/verify_requirements.md b/docs/plugins/Modules_and_action_plugins/verify_requirements.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Modules_and_action_plugins/verify_requirements.md rename to docs/plugins/Modules_and_action_plugins/verify_requirements.md diff --git a/ansible_collections/arista/avd/docs/plugins/Test_plugins/contains.md b/docs/plugins/Test_plugins/contains.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Test_plugins/contains.md rename to docs/plugins/Test_plugins/contains.md diff --git a/ansible_collections/arista/avd/docs/plugins/Test_plugins/defined.md b/docs/plugins/Test_plugins/defined.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Test_plugins/defined.md rename to docs/plugins/Test_plugins/defined.md diff --git a/ansible_collections/arista/avd/docs/plugins/Vars_plugins/global_vars.md b/docs/plugins/Vars_plugins/global_vars.md similarity index 100% rename from ansible_collections/arista/avd/docs/plugins/Vars_plugins/global_vars.md rename to docs/plugins/Vars_plugins/global_vars.md diff --git a/ansible_collections/arista/avd/docs/porting-guides/4.x.x.md b/docs/porting-guides/4.x.x.md similarity index 98% rename from ansible_collections/arista/avd/docs/porting-guides/4.x.x.md rename to docs/porting-guides/4.x.x.md index 2cf68026fce..a326ba08852 100644 --- a/ansible_collections/arista/avd/docs/porting-guides/4.x.x.md +++ b/docs/porting-guides/4.x.x.md @@ -153,7 +153,7 @@ bgp_update_wait_install: false The following keys under `bgp_peer_groups` have been replaced to avoid upper-case variables: -See the full data model in the [documentation](../../roles/eos_designs/docs/input-variables.md#bgp-settings) +See the full data model in the [documentation](../../ansible_collections/arista/avd/roles/eos_designs/docs/input-variables.md#bgp-settings) === "Removed keys" @@ -542,14 +542,14 @@ The `hardware_counters.features` model has been improved to allow more options. direction: in ``` -See the full data model in the [documentation](../../roles/eos_cli_config_gen/docs/input-variables.md#hardware-counters) +See the full data model in the [documentation](../../ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/input-variables.md#hardware-counters) ### ip_name_servers The `name_server` key has been deprecated in favor of `ip_name_servers`, more aligned with the EOS CLI. -See the full data model in the [documentation](../../roles/eos_cli_config_gen/docs/input-variables.md#ip-name-servers) +See the full data model in the [documentation](../../ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/input-variables.md#ip-name-servers) === "3.x" diff --git a/ansible_collections/arista/avd/docs/porting-guides/5.x.x.md b/docs/porting-guides/5.x.x.md similarity index 99% rename from ansible_collections/arista/avd/docs/porting-guides/5.x.x.md rename to docs/porting-guides/5.x.x.md index 9ee76cf3393..f01554483a6 100644 --- a/ansible_collections/arista/avd/docs/porting-guides/5.x.x.md +++ b/docs/porting-guides/5.x.x.md @@ -1646,4 +1646,4 @@ and the following command line: ansible-playbook playbooks/fabric-validate.yaml ``` -The test categories are listed in the [role documentation](../../roles/eos_validate_state/README.md#test-categories) +The test categories are listed in the [role documentation](../../ansible_collections/arista/avd/roles/eos_validate_state/README.md#test-categories) diff --git a/ansible_collections/arista/avd/docs/pyavd.md b/docs/pyavd/pyavd.md similarity index 89% rename from ansible_collections/arista/avd/docs/pyavd.md rename to docs/pyavd/pyavd.md index 2fb5f7daa45..927f8a9a769 100644 --- a/ansible_collections/arista/avd/docs/pyavd.md +++ b/docs/pyavd/pyavd.md @@ -12,9 +12,9 @@ PyAVD does not provide any inventory or variable management, so PyAVD cannot rep Supported features: -- Validation of inputs based on the [`eos_designs` input schema](../roles/eos_designs/docs/input-variables.md). +- Validation of inputs based on the [`eos_designs` input schema](../../ansible_collections/arista/avd/roles/eos_designs/docs/input-variables.md). - Generation of "avd_facts" and "structured config" to be used in other PyAVD functions. -- Validation of "structured config" based on the [`eos_cli_config_gen` input schema](../roles/eos_cli_config_gen/docs/input-variables.md). +- Validation of "structured config" based on the [`eos_cli_config_gen` input schema](../../ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/input-variables.md). - Generation of device configuration. - Generation of device documentation. @@ -22,8 +22,8 @@ Feedback is very welcome. Please use [GitHub discussions](https://github.com/ari ## Functions overview -![Arista AVD Overview](_media/pyavd_functions_dark.svg#only-dark) -![Arista AVD Overview](_media/pyavd_functions_light.svg#only-light) +![Arista AVD Overview](../_media/pyavd_functions_dark.svg#only-dark) +![Arista AVD Overview](../_media/pyavd_functions_light.svg#only-light) ## Known limitations @@ -67,7 +67,7 @@ Python dependencies are automatically installed with above command. ### Optional requirements -To install Ansible [AVD collection Python requirements](installation/collection-installation.md#python-requirements-installation) install with extra `ansible`: +To install Ansible [AVD collection Python requirements](../installation/collection-installation.md#python-requirements-installation) install with extra `ansible`: ```sh pip install pyavd[ansible] diff --git a/ansible_collections/arista/avd/docs/release-notes/1.0.x.md b/docs/release-notes/1.0.x.md similarity index 100% rename from ansible_collections/arista/avd/docs/release-notes/1.0.x.md rename to docs/release-notes/1.0.x.md diff --git a/ansible_collections/arista/avd/docs/release-notes/1.1.x.md b/docs/release-notes/1.1.x.md similarity index 100% rename from ansible_collections/arista/avd/docs/release-notes/1.1.x.md rename to docs/release-notes/1.1.x.md diff --git a/ansible_collections/arista/avd/docs/release-notes/2.x.x.md b/docs/release-notes/2.x.x.md similarity index 100% rename from ansible_collections/arista/avd/docs/release-notes/2.x.x.md rename to docs/release-notes/2.x.x.md diff --git a/ansible_collections/arista/avd/docs/release-notes/3.x.x.md b/docs/release-notes/3.x.x.md similarity index 99% rename from ansible_collections/arista/avd/docs/release-notes/3.x.x.md rename to docs/release-notes/3.x.x.md index c8d7471ca6d..46e2574dd3c 100644 --- a/ansible_collections/arista/avd/docs/release-notes/3.x.x.md +++ b/docs/release-notes/3.x.x.md @@ -157,7 +157,7 @@ ## Release 3.8.0 - Version 3.8.0 includes input data validation for `eos_cli_config_gen` based on data model schemas. - By default data issues will be reported as warnings and will not block the playbook. See details [here](../../roles/eos_cli_config_gen/docs/role-configuration.md#input-variables-validation-settings). + By default data issues will be reported as warnings and will not block the playbook. See details [here](../../ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/role-configuration.md#input-variables-validation-settings). Please report any problems on [Github discussions](https://github.com/aristanetworks/avd/discussions/categories/data-model-schemas), if it seems like the schema is wrong or too restrictive. Other feedback is also most welcome. diff --git a/ansible_collections/arista/avd/docs/release-notes/4.x.x.md b/docs/release-notes/4.x.x.md similarity index 100% rename from ansible_collections/arista/avd/docs/release-notes/4.x.x.md rename to docs/release-notes/4.x.x.md diff --git a/ansible_collections/arista/avd/docs/release-notes/5.x.x.md b/docs/release-notes/5.x.x.md similarity index 100% rename from ansible_collections/arista/avd/docs/release-notes/5.x.x.md rename to docs/release-notes/5.x.x.md diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000000..b459f90129f --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,12 @@ +mkdocs +mkdocs-material<10 +mkdocs-material-extensions +mkdocs-same-dir +pymdown-extensions +mdx_truly_sane_lists +mike==1.1.2 +mkdocs-git-revision-date-localized-plugin +mkdocs-git-revision-date-plugin +mkdocs-exclude +mkdocs-include-dir-to-nav +mkdocstrings[python] diff --git a/ansible_collections/arista/avd/docs/stylesheets/extra.ivory.css.backup b/docs/stylesheets/extra.ivory.css.backup similarity index 100% rename from ansible_collections/arista/avd/docs/stylesheets/extra.ivory.css.backup rename to docs/stylesheets/extra.ivory.css.backup diff --git a/ansible_collections/arista/avd/docs/stylesheets/extra.material.css b/docs/stylesheets/extra.material.css similarity index 100% rename from ansible_collections/arista/avd/docs/stylesheets/extra.material.css rename to docs/stylesheets/extra.material.css diff --git a/ansible_collections/arista/avd/docs/stylesheets/tables.js b/docs/stylesheets/tables.js similarity index 100% rename from ansible_collections/arista/avd/docs/stylesheets/tables.js rename to docs/stylesheets/tables.js diff --git a/ansible_collections/arista/avd/docs/templates/avd_schema_table.j2 b/docs/templates/avd_schema_table.j2 similarity index 100% rename from ansible_collections/arista/avd/docs/templates/avd_schema_table.j2 rename to docs/templates/avd_schema_table.j2 diff --git a/ansible_collections/arista/avd/docs/templates/plugin-docs.j2 b/docs/templates/plugin-docs.j2 similarity index 100% rename from ansible_collections/arista/avd/docs/templates/plugin-docs.j2 rename to docs/templates/plugin-docs.j2 diff --git a/ansible_collections/arista/avd/docs/semantic-versioning.md b/docs/versioning/semantic-versioning.md similarity index 100% rename from ansible_collections/arista/avd/docs/semantic-versioning.md rename to docs/versioning/semantic-versioning.md diff --git a/ansible_collections/arista/avd/index.md b/index.md similarity index 84% rename from ansible_collections/arista/avd/index.md rename to index.md index f9a293b3e3c..86a3d4ad738 100644 --- a/ansible_collections/arista/avd/index.md +++ b/index.md @@ -6,7 +6,7 @@ # Arista Validated Designs -
Arista AVD Overview
+
Arista AVD Overview
Arista Validated Designs (AVD) is an extensible data model that defines Arista's Unified Cloud Network architecture as "code". @@ -24,10 +24,10 @@ Arista Validated Designs (AVD) is an extensible data model that defines Arista's ## Reference designs -- [L3LS VXLAN-EVPN](roles/eos_designs/README.md#layer-3-leaf-spine-with-vxlan-evpn) -- [L2LS](roles/eos_designs/README.md#layer-2-leaf-spine) -- [MPLS](roles/eos_designs/README.md#mpls-core-with-mpls-evpn-vpn-ipv4-vpn-ipv6) -- [WAN AutoVPN/CV Pathfinder](roles/eos_designs/README.md#wan-autovpn-cv-pathfinder) +- [L3LS VXLAN-EVPN](ansible_collections/arista/avd/roles/eos_designs/README.md#layer-3-leaf-spine-with-vxlan-evpn) +- [L2LS](ansible_collections/arista/avd/roles/eos_designs/README.md#layer-2-leaf-spine) +- [MPLS](ansible_collections/arista/avd/roles/eos_designs/README.md#mpls-core-with-mpls-evpn-vpn-ipv4-vpn-ipv6) +- [WAN AutoVPN/CV Pathfinder](ansible_collections/arista/avd/roles/eos_designs/README.md#wan-autovpn-cv-pathfinder) ## AVD Ansible Collection @@ -76,6 +76,6 @@ You can also open an [issue](https://github.com/aristanetworks/avd/issues) to re ## License -Copyright (c) 2019-2024 Arista Networks, Inc. +Copyright (c) 2019-2025 Arista Networks, Inc. -The project is published under [Apache 2.0 License](LICENSE) +The project is published under [Apache 2.0 License](https://github.com/aristanetworks/avd/blob/devel/LICENSE) diff --git a/media/example-playbook-deploy-cvp.gif b/media/example-playbook-deploy-cvp.gif deleted file mode 100644 index c28afb551c3..00000000000 Binary files a/media/example-playbook-deploy-cvp.gif and /dev/null differ diff --git a/media/example-playbook-deploy-eapi.gif b/media/example-playbook-deploy-eapi.gif deleted file mode 100644 index cbba5f77d8f..00000000000 Binary files a/media/example-playbook-deploy-eapi.gif and /dev/null differ diff --git a/mkdocs.yml b/mkdocs.yml index 5956d09e32a..4e57c7b7099 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,7 +2,7 @@ site_name: Arista AVD site_author: Arista Ansible Team site_description: Arista Validated Designs documentation -copyright: Copyright © 2019 - 2023 Arista Networks +copyright: Copyright © 2019 - 2025 Arista Networks strict: true exclude_docs: | /README.md @@ -13,10 +13,9 @@ repo_url: https://github.com/aristanetworks/avd # Configuration use_directory_urls: false -edit_uri: edit/devel/ansible_collections/arista/avd/ +edit_uri: edit/devel/ theme: name: material - # custom_dir: ansible_collections/arista/avd/docs/_overrides features: - content.code.annotate - content.code.copy @@ -73,25 +72,47 @@ extra_javascript: plugins: - exclude: glob: - - .* - - changelogs/* - - molecule/* - - tests/* - - plugins/README.md + - README.md + - contributing.md + - ansible_collections/arista/avd/bindep.txt + - ansible_collections/arista/avd/CHANGELOG.rst + - ansible_collections/arista/avd/CNAME + - ansible_collections/arista/avd/collections.yml + - ansible_collections/arista/avd/galaxy.yml + - ansible_collections/arista/avd/LICENSE + - ansible_collections/arista/avd/pylintrc + - ansible_collections/arista/avd/pytest.ini + - ansible_collections/arista/avd/README.md + - ansible_collections/arista/avd/requirements-dev.txt + - ansible_collections/arista/avd/requirements.txt + - ansible_collections/arista/avd/meta/* + - ansible_collections/arista/avd/playbooks/* + - ansible_collections/arista/avd/plugins/* + - ansible_collections/arista/avd/changelogs/* + - ansible_collections/arista/avd/molecule/* + - ansible_collections/arista/avd/tests/* + - ansible_collections/arista/avd/plugins/README.md - docs/release-notes/1.0.x.md - docs/release-notes/1.1.x.md - docs/release-notes/2.x.x.md - docs/release-notes/3.x.x.md - - docs/*/4.x.x.md - - roles/*/docs/tables/* + - docs/release-notes/4.x.x.md + - docs/porting-guides/4.x.x.md + - ansible_collections/arista/avd/roles/*/docs/tables/* + - development/* + - galaxy-importer/* + - python-avd/* regex: # Exclude examples common md snippets - - '^examples\/common/.*' + - 'ansible_collections\/arista\/avd\/examples\/common/.*' # Exclude all examples but single-dc-l3ls which is referenced in getting getting-started - - '^examples\/((?!single-dc-l3ls).*)\/documentation\/.*' + - 'ansible_collections\/arista\/avd\/examples\/((?!single-dc-l3ls).*)\/documentation\/.*' # Exclude all single-dc-l3ls files not referenced in getting getting-started - - '^examples\/single-dc-l3ls\/documentation\/fabric\/((?!FABRIC-documentation.md).*)' - - '^examples\/single-dc-l3ls\/documentation\/devices\/((?!dc1-leaf1a.md).*)' + - 'ansible_collections\/arista\/avd\/examples\/single-dc-l3ls\/documentation\/fabric\/((?!FABRIC-documentation.md).*)' + - 'ansible_collections\/arista\/avd\/examples\/single-dc-l3ls\/documentation\/devices\/((?!dc1-leaf1a.md).*)' + - '.*.py$' + - '.*.pyc$' + - '.*.j2$' - include_dir_to_nav - git-revision-date-localized: type: date @@ -102,6 +123,8 @@ plugins: python: paths: - python-avd + - same-dir + markdown_extensions: - admonition - attr_list @@ -121,7 +144,8 @@ markdown_extensions: - pymdownx.smartsymbols: fractions: false - pymdownx.snippets: - base_path: 'ansible_collections/arista/avd/' + base_path: + - './' - pymdownx.superfences: custom_fences: - name: mermaid @@ -139,49 +163,49 @@ markdown_extensions: permalink: true # TOC -docs_dir: ansible_collections/arista/avd/ +docs_dir: . nav: - Home: index.md - Getting Started: - Introduction to Ansible and AVD: docs/getting-started/intro-to-ansible-and-avd.md - AVD and Ansible Automation Platform: docs/getting-started/avd-aap.md - Examples: - - Single DC L3LS: examples/single-dc-l3ls/README.md - - Dual DC L3LS: examples/dual-dc-l3ls/README.md - - L2LS Fabric: examples/l2ls-fabric/README.md - - Campus Fabric: examples/campus-fabric/README.md - - ISIS-LDP IPVPN: examples/isis-ldp-ipvpn/README.md - - CV Pathfinder: examples/cv-pathfinder/README.md + - Single DC L3LS: ansible_collections/arista/avd/examples/single-dc-l3ls/README.md + - Dual DC L3LS: ansible_collections/arista/avd/examples/dual-dc-l3ls/README.md + - L2LS Fabric: ansible_collections/arista/avd/examples/l2ls-fabric/README.md + - Campus Fabric: ansible_collections/arista/avd/examples/campus-fabric/README.md + - ISIS-LDP IPVPN: ansible_collections/arista/avd/examples/isis-ldp-ipvpn/README.md + - CV Pathfinder: ansible_collections/arista/avd/examples/cv-pathfinder/README.md - Installation: - Collection Installation: docs/installation/collection-installation.md - Ansible Collection Roles: - eos_designs: - - Overview: roles/eos_designs/README.md - - Role Configuration: roles/eos_designs/docs/role-configuration.md - - Input Variables: roles/eos_designs/docs/input-variables.md + - Overview: ansible_collections/arista/avd/roles/eos_designs/README.md + - Role Configuration: ansible_collections/arista/avd/roles/eos_designs/docs/role-configuration.md + - Input Variables: ansible_collections/arista/avd/roles/eos_designs/docs/input-variables.md - How-To Guides: - - Configuring PTP: roles/eos_designs/docs/how-to/ptp.md - - Configuring WAN: roles/eos_designs/docs/how-to/wan.md - - Custom descriptions and names: roles/eos_designs/docs/how-to/custom-descriptions-names.md - - Custom Structured Configuration: roles/eos_designs/docs/how-to/custom-structured-configuration.md - - Custom Templates: roles/eos_designs/docs/how-to/custom-templates.md - - Generate CloudVision Tags Preview: roles/eos_designs/docs/how-to/cloudvision-tags-preview.md + - Configuring PTP: ansible_collections/arista/avd/roles/eos_designs/docs/how-to/ptp.md + - Configuring WAN: ansible_collections/arista/avd/roles/eos_designs/docs/how-to/wan.md + - Custom descriptions and names: ansible_collections/arista/avd/roles/eos_designs/docs/how-to/custom-descriptions-names.md + - Custom Structured Configuration: ansible_collections/arista/avd/roles/eos_designs/docs/how-to/custom-structured-configuration.md + - Custom Templates: ansible_collections/arista/avd/roles/eos_designs/docs/how-to/custom-templates.md + - Generate CloudVision Tags Preview: ansible_collections/arista/avd/roles/eos_designs/docs/how-to/cloudvision-tags-preview.md - eos_cli_config_gen: - - Overview: roles/eos_cli_config_gen/README.md - - Role Configuration: roles/eos_cli_config_gen/docs/role-configuration.md - - Input Variables: roles/eos_cli_config_gen/docs/input-variables.md + - Overview: ansible_collections/arista/avd/roles/eos_cli_config_gen/README.md + - Role Configuration: ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/role-configuration.md + - Input Variables: ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/input-variables.md - How-To Guides: - - Custom Templates: roles/eos_cli_config_gen/docs/how-to/custom-templates.md - - cvp_configlet_upload: roles/cvp_configlet_upload/README.md + - Custom Templates: ansible_collections/arista/avd/roles/eos_cli_config_gen/docs/how-to/custom-templates.md + - cvp_configlet_upload: ansible_collections/arista/avd/roles/cvp_configlet_upload/README.md - eos_config_deploy_cvp: - - Overview: roles/eos_config_deploy_cvp/README.md - - Integrating AVD with CVaaS: roles/eos_config_deploy_cvp/docs/avd-to-cvaas.md - - eos_config_deploy_eapi: roles/eos_config_deploy_eapi/README.md - - eos_validate_state: roles/eos_validate_state/README.md - - eos_snapshot: roles/eos_snapshot/README.md - - dhcp_provisioner: roles/dhcp_provisioner/README.md - - build_output_folders: roles/build_output_folders/README.md - - cv_deploy: roles/cv_deploy/README.md + - Overview: ansible_collections/arista/avd/roles/eos_config_deploy_cvp/README.md + - Integrating AVD with CVaaS: ansible_collections/arista/avd/roles/eos_config_deploy_cvp/docs/avd-to-cvaas.md + - eos_config_deploy_eapi: ansible_collections/arista/avd/roles/eos_config_deploy_eapi/README.md + - eos_validate_state: ansible_collections/arista/avd/roles/eos_validate_state/README.md + - eos_snapshot: ansible_collections/arista/avd/roles/eos_snapshot/README.md + - dhcp_provisioner: ansible_collections/arista/avd/roles/dhcp_provisioner/README.md + - build_output_folders: ansible_collections/arista/avd/roles/build_output_folders/README.md + - cv_deploy: ansible_collections/arista/avd/roles/cv_deploy/README.md - Ansible Collection Plugins: docs/plugins/ - Contributing to AVD: - Overview: docs/contribution/overview.md @@ -190,17 +214,9 @@ nav: - Validation of Input Variables: docs/contribution/input-variable-validation.md - EOS Designs internal notes: docs/contribution/eos_designs_internal_notes.md - Authoring eos_cli_config_gen Role Guide: docs/contribution/authoring_eos_cli_config_gen.md - - External Resources: - - Ansible Collection User Guide: https://docs.ansible.com/ansible/latest/user_guide/collections_using.html - - Ansible User Guide: https://docs.ansible.com/ansible/latest/user_guide/index.html - Release Notes: docs/release-notes/5.x.x.md - Porting Guide: docs/porting-guides/5.x.x.md - - PyAVD: docs/pyavd.md - - Versioning: docs/semantic-versioning.md + - PyAVD: docs/pyavd/pyavd.md + - Versioning: docs/versioning/semantic-versioning.md - AVD Dev Containers: - Overview: docs/containers/overview.md - - About: - - AVD on Ansible Galaxy: https://galaxy.ansible.com/arista/avd - - Arista CVP Collection: https://cvp.avd.sh/en/latest/ - - Arista Installation Script: https://github.com/arista-netdevops-community/avd-install - - Arista NetDevOps Community: https://aristanetworks.github.io/netdevops-examples/ diff --git a/python-avd/pyavd/_eos_designs/schema/__init__.py b/python-avd/pyavd/_eos_designs/schema/__init__.py index f11983019d3..3e5e412f13e 100644 --- a/python-avd/pyavd/_eos_designs/schema/__init__.py +++ b/python-avd/pyavd/_eos_designs/schema/__init__.py @@ -8234,11 +8234,11 @@ class StructuredConfig(EosCliConfigGen.EthernetInterfacesItem): For more details and examples of the `range_expand` syntax, see the [`arista.avd.range_expand` - documentation](../../../docs/plugins/Filter_plugins/range_expand.md). + documentation](../../../../../../docs/plugins/Filter_plugins/range_expand.md). - Subclass of AvdList with - `str` items. + Subclass of AvdList + with `str` items. """ description: str | None """ @@ -8492,11 +8492,11 @@ def __init__( For more details and examples of the `range_expand` syntax, see the [`arista.avd.range_expand` - documentation](../../../docs/plugins/Filter_plugins/range_expand.md). + documentation](../../../../../../docs/plugins/Filter_plugins/range_expand.md). - Subclass of AvdList with - `str` items. + Subclass of AvdList + with `str` items. description: Description or description template to be used on all ports. This can be a template using the AVD 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 2236585b9c9..f7b0fa48b76 100644 --- a/python-avd/pyavd/_eos_designs/schema/eos_designs.schema.yml +++ b/python-avd/pyavd/_eos_designs/schema/eos_designs.schema.yml @@ -2335,7 +2335,7 @@ keys: description: "List of ranges using AVD range_expand syntax.\nFor example:\n\nswitch_ports:\n \ - Ethernet1\n - Ethernet2-48\n\nAll switch_ports ranges are expanded into individual port configurations.\n\nFor more details and examples - of the `range_expand` syntax, see the [`arista.avd.range_expand` documentation](../../../docs/plugins/Filter_plugins/range_expand.md).\n" + of the `range_expand` syntax, see the [`arista.avd.range_expand` documentation](../../../../../../docs/plugins/Filter_plugins/range_expand.md).\n" items: type: str description: diff --git a/python-avd/pyavd/_eos_designs/schema/schema_fragments/network_ports.schema.yml b/python-avd/pyavd/_eos_designs/schema/schema_fragments/network_ports.schema.yml index e63b894ade5..a5758d57a45 100644 --- a/python-avd/pyavd/_eos_designs/schema/schema_fragments/network_ports.schema.yml +++ b/python-avd/pyavd/_eos_designs/schema/schema_fragments/network_ports.schema.yml @@ -48,7 +48,7 @@ keys: All switch_ports ranges are expanded into individual port configurations. - For more details and examples of the `range_expand` syntax, see the [`arista.avd.range_expand` documentation](../../../docs/plugins/Filter_plugins/range_expand.md). + For more details and examples of the `range_expand` syntax, see the [`arista.avd.range_expand` documentation](../../../../../../docs/plugins/Filter_plugins/range_expand.md). items: type: str description: