Skip to content

Commit

Permalink
Doc(eos_designs, eos_cli_config_gen): Various doc improvements (#3001)
Browse files Browse the repository at this point in the history
  • Loading branch information
carlbuchmann authored Jul 7, 2023
1 parent 6443612 commit 2d3a0e9
Show file tree
Hide file tree
Showing 12 changed files with 3,103 additions and 7,859 deletions.
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
# Ansible Collection For Arista Validated Designs - arista.avd
# Arista Validated Designs

![Arista AVD](https://img.shields.io/badge/Arista-AVD%20Automation-blue) ![collection version](https://img.shields.io/github/v/release/aristanetworks/ansible-avd) ![License](https://img.shields.io/github/license/aristanetworks/ansible-avd)

<center><img src="ansible_collections/arista/avd/media/avd-logo.png" alt="Arista AVD Overview" width="800"/></center>

[Arista Networks](https://www.arista.com/) supports Ansible for managing devices running the Extensible Operating System (EOS) operating system natively through EOS API (eAPI) or [CloudVision Portal (CVP)](https://www.arista.com/en/products/eos/eos-cloudvision).
This collection includes a set of ansible roles and modules to help kick-start your automation with Arista. The various roles and templates provided are designed to be customized and extended to your needs!
Arista Validated Designs (AVD) is an extensible data model that defines Arista's Unified Cloud Network architecture as "code".

Full documentation for the collection:
AVD Documentation:

- [Stable version](https://www.avd.sh/en/stable/)
- [Stable version](https://avd.arista.com/stable/)
- [Development version](https://www.avd.sh/en/devel/)

## Features
Expand All @@ -20,20 +19,20 @@ Full documentation for the collection:

## Reference designs

- [L3LS VXLAN-EVPN, L2LS, and MPLS (beta)](./ansible_collections/arista/avd/roles/eos_designs/README.md)
- [L3LS VXLAN-EVPN, L2LS, and MPLS](https://avd.arista.com/stable/roles/eos_designs/index.html)

## Collection installation
## AVD Ansible Collection

Ansible galaxy hosts all stable versions of this collection. Installation from ansible-galaxy is the most convenient approach for consuming `arista.avd` content. Please follow the collection installation [guide](./ansible_collections/arista/avd/docs/installation/collection-installation.md).
[Arista Networks](https://www.arista.com/) supports Ansible for managing devices running Arista's **Extensible Operating System (EOS)** natively through it's **EOS API (eAPI)** or [**CloudVision Portal (CVP)**](https://www.arista.com/en/products/eos/eos-cloudvision). The collection includes a set of Ansible roles and modules to help kick-start your automation with Arista. The various roles and templates provided are designed to be customized and extended to your needs.

## Examples
### Examples

- [Getting started examples](./ansible_collections/arista/avd/docs/getting-started/intro-to-ansible-and-avd.md)
- [Getting started](https://avd.arista.com/stable/docs/getting-started/intro-to-ansible-and-avd.html)
- [Arista NetDevOps Examples](https://github.com/aristanetworks/netdevops-examples)

## Additional resources
### Additional resources

- Ansible [EOS modules](https://docs.ansible.com/ansible/latest/collections/arista/eos/index.html) on ansible documentation.
- Ansible [EOS modules](https://docs.ansible.com/ansible/latest/collections/arista/eos/index.html) on Ansible documentation
- Ansible [CloudVision modules](https://cvp.avd.sh/en/stable/)
- [CloudVision Portal](https://www.arista.com/en/products/eos/eos-cloudvision)
- [Arista Design and Deployment Guides](https://www.arista.com/en/solutions/design-guides)
Expand Down
12 changes: 6 additions & 6 deletions ansible_collections/arista/avd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ Arista Validated Designs (AVD) is an extensible data model that defines Arista's

## Reference designs

- [L3LS VXLAN-EVPN, L2LS, and MPLS (beta)](https://avd.sh/en/stable/roles/eos_designs/index.html)
- [L3LS VXLAN-EVPN, L2LS, and MPLS](https://avd.arista.com/stable/roles/eos_designs/index.html)

## AVD Ansible Collection

[Arista Networks](https://www.arista.com/) supports Ansible for managing devices running Arista's **Extensible Operating System (EOS)** natively through it's **EOS API (eAPI)** or [**CloudVision Portal (CVP)**](https://www.arista.com/en/products/eos/eos-cloudvision). The collection includes a set of Ansible roles and modules to help kick-start your automation with Arista. The various roles and templates provided are designed to be customized and extended to your needs.

Full documentation for the collection:

- [stable version](https://www.avd.sh/en/stable/)
- [stable version](https://avd.arista.com/stable/)
- [development version](https://www.avd.sh/en/devel/)

### Roles overview
Expand All @@ -41,11 +41,11 @@ This repository provides content for Arista's **arista.avd** collection. The fol

### Collection installation

Ansible galaxy hosts all stable versions of the `arista.avd` collection. Installation from ansible-galaxy is the most convenient approach for consuming `arista.avd` content. Please follow the collection installation [guide](https://avd.sh/en/stable/docs/installation/collection-installation.html).
Ansible galaxy hosts all stable versions of the `arista.avd` collection. Installation from ansible-galaxy is the most convenient approach for consuming `arista.avd` content. Please follow the collection installation [guide](https://avd.arista.com/stable/docs/installation/collection-installation.html).

### Examples

- [Getting started](./docs/getting-started/intro-to-ansible-and-avd.md)
- [Getting started](https://avd.arista.com/stable/docs/getting-started/intro-to-ansible-and-avd.html)
- [Arista NetDevOps GitHub repository](https://github.com/aristanetworks/netdevops-examples)

### Custom plugins & modules
Expand All @@ -56,7 +56,7 @@ This repository provides custom plugins for Arista's AVD collection:

## Additional resources

- Ansible [EOS modules](https://docs.ansible.com/ansible/latest/collections/arista/eos/index.html) on ansible documentation.
- Ansible [EOS modules](https://docs.ansible.com/ansible/latest/collections/arista/eos/index.html) on Ansible documentation
- Ansible [CloudVision modules](https://cvp.avd.sh/en/stable/)
- [CloudVision Portal](https://www.arista.com/en/products/eos/eos-cloudvision)
- [Arista Design and Deployment Guides](https://www.arista.com/en/solutions/design-guides)
Expand All @@ -71,7 +71,7 @@ AVD version 4.x releases with full support from Arista TAC. If your organization

## Contributing

Contributing pull requests are gladly welcomed for this repository. If you are planning a big change, please start a discussion first to make sure we'll be able to merge it. Please see [contribution guide](https://avd.sh/en/stable/docs/contribution/overview.html) for additional details.
Contributing pull requests are gladly welcomed for this repository. If you are planning a big change, please start a discussion first to make sure we'll be able to merge it. Please see [contribution guide](https://avd.arista.com/stable/docs/contribution/overview.html) for additional details.

You can also open an [issue](https://github.com/aristanetworks/ansible-avd/issues) to report any problems or submit enhancements.

Expand Down
Loading

0 comments on commit 2d3a0e9

Please sign in to comment.