Collection installation¶
Installation workflow¶
- Install Python 3.10 or later
- Install arista.avd collection including Python requirements.
- Modify
ansible.cfg
file to support additional jinja2 extensions
Install Collection from Ansible Galaxy¶
These instructions are for regular users to install via Ansible Galaxy. The instructions also include installation of all Python requirements for a given version. To set up a development environment, please follow the development tooling instructions. arista.avd can also be consumed using the “Universal” container. The arista.avd collection is available on the Ansible Galaxy server and can be automatically installed on your system.
Latest version¶
These commands install all Python requirements including ansible-core
and then installs the arista.avd
Ansible collection including
all required Ansible collections.
Warning
If you have an ansible.cfg
file in the directory where you run ansible-galaxy
, it may affect the directory under which the collection and dependencies will be installed.
Warning
Depending of your operating system settings, pip
might be replaced by pip3
.
Install a specific version¶
Install latest devel
version from AVD GitHub¶
pip install "pyavd[ansible] @ git+https://github.com/aristanetworks/avd.git@devel#subdirectory=python-avd"
ansible-galaxy collection install git+https://github.com/aristanetworks/avd.git#/ansible_collections/arista/avd/,devel
Note
Installing from devel
will require minimum Python 3.10, since the PyAVD package will be built during installation, and some
of the build tooling requires minimum 3.10.
Note
Collection dependencies like ansible-cvp
will be installed from Ansible Galaxy unless installed first using similar GitHub source.
Install in a specific directory¶
If you want to install collection in a specific directory part of your project, you can call ansible-galaxy
with the -p
option
and update your ansible.cfg
:
# Install collection under ${PWD}/collections/
$ ansible-galaxy collection install arista.avd -p collections/
# Update ansible.cfg file
$ vim ansible.cfg
collections_paths = ${PWD}/collections:~/.ansible/collections:/usr/share/ansible/collections
Upgrade installed AVD collection¶
You can use -U
to upgrade to a new version for any installed collection:
$ ansible-galaxy collection install -U arista.avd
Process install dependency map
Starting collection install process
Installing 'arista.avd:4.9.0' to '/home/arista/.ansible/collections/ansible_collections/arista/avd'
After an upgrade, some python requirements may have changed. Make sure to also update the Python requirements for the same version (the version given below matches the installed collection above):
Python requirements installation¶
Python requirements can be installed with the pip install "pyavd[ansible]"
.
The installed version of PyAVD must match the version of the arista.avd
collection.
See the collection installation section for details of each installation method.
Ansible configuration file¶
- Enable Jinja2 extensions:
loopcontrols
anddo
- By default, Ansible will issue a warning when a duplicate dict key is encountered in YAML. We recommend to change to error instead and stop playbook execution when a duplicate key is detected.
Arista EOS requirements¶
- EOS 4.21.8M or later
- Roles validated with eAPI transport ->
ansible_connection: httpapi
Arista CloudVision requirements¶
If you leverage CloudVision deployment with AVD, your CV instance must be supported by CloudVision Ansible collection
Note
When using ansible-cvp modules, the user who is executing the ansible-playbook must have access to both CVP and the EOS CLI.