arista.avd - Design Driven Network Automation

Description

• Flexibility with Open Data Models: Extensible fabric-wide network models, simplifying configuration, delivering consistency, and reducing errors
• Simplification through Multi-Domain Automation: A framework that can automate the data center, campus or wide area network, enabled by a consistent EOS software image and management platform
• Comprehensive Workflows: Automating the full life cycle of network provisioning from config generation to pre- and post-deployment validation and self-documentation of the network

AVD Documentation:

• Stable version
• Development version

Requirements

The AVD collection has the following requirements:

• Python 3.10 or above
• Ansible Core 2.16.0 to 2.18.x
• the Python package pyavd[ansible-collection] matching the collection version
• Modify the ansible.cfg file to support additional Jinja2 extensions

Installation

Follow the installation guide to install the requirements.

Before using this collection, you need to install it with the Ansible Galaxy command-line tool:

ansible-galaxy collection install arista.avd

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:

collections:
  - name: arista.avd

Note that if you install the collection from Ansible Galaxy, it will not be upgraded automatically when you upgrade the Ansible package.

To upgrade the collection to the latest available version, run the following command:

ansible-galaxy collection install arista.avd --upgrade

You can also install a specific version of the collection, for example, if you need to downgrade when something is broken in the latest version (please report an issue in this repository). Use the following syntax to install version 4.7.1:

ansible-galaxy collection install arista.avd:==5.2.3

See using Ansible collections for more details.

Additional Python Dependencies

The AVD collection requires the installation of additional Python packages. To ensure you install the correct versions, run the following commands:

export ARISTA_AVD_DIR=$(ansible-galaxy collection list arista.avd --format yaml | head -1 | cut -d: -f1)
pip3 install -r ${ARISTA_AVD_DIR}/arista/avd/requirements.txt

Enable Jinja2 Extensions

In your ansible.cfg file, add the following modifications:

[defaults]
jinja2_extensions=jinja2.ext.loopcontrols,jinja2.ext.do
duplicate_dict_key=error

Use Cases

Please see the documentation for examples in data center, campus, and wide area network environments.

• Getting started
• Examples

Testing

Every pull request is thoroughly tested by our extensive CI pipeline and reviewed by the AVD Maintainer team.

Contributing

Contributing pull requests are gladly welcomed for this repository. If you are planning a significant change, please start a discussion first to ensure we can merge it. Please see contribution guide for additional details.

You can also open an issue to report any problems or submit requests for enhancements.

Support

• AVD is an open-source project maintained by a dedicated Arista engineering team. Customers can purchase TAC support for AVD through the A-Care Service contract. TAC support for AVD must be purchased separately.
• Without a support contract AVD code can be used as-is, without any warranty and with best-effort problem resolution via GitHub discussions board.

Release Notes and Roadmap

Please see the release notes for the latest updates to the AVD collection.

Related Information

• arista.avd documentation

License Information

Copyright (c) 2019-2024 Arista Networks, Inc.

The project is published under Apache 2.0 License