Merge branch 'devel' into devel

.arista/secret_allowlist.yaml

@@ -0,0 +1,10 @@
+# Arista Secret Scanner allow list
+
+version: v1.0
+allowed_secrets:
+- secret_pattern: "http://arista:[email protected]:3128"
+  category: FALSE_POSITIVE
+  reason: Used as example in documentation
+- secret_pattern: "http://arista:[email protected]:3128"
+  category: FALSE_POSITIVE
+  reason: Used as example in documentation

.devcontainer/devcontainer.json

@@ -12,5 +12,6 @@
     // The dev entrypoint is used to install Ansible collections and requirements, as they are not included with the dev version.
     // "true" is required to exit "postStartCommand" without entering ZSH.
     // the script must be executed ONLY if Ansible is not installed
-    "postStartCommand": "/bin/entrypoint.sh true"
+    "postStartCommand": "/bin/entrypoint.sh true",
+    "remoteUser": "avd"
 }

.flake8

@@ -8,4 +8,4 @@ max-line-length = 160
 
 exclude =
   # The cv_client api is generated from proto files, so it should not be linted.
-  ansible_collections/arista/avd/plugins/plugin_utils/cv_client/api
+  python-avd/pyavd/_cv/api

.github/.markdownlintignore

@@ -2,4 +2,4 @@
 ansible_collections/arista/avd/molecule/eos_cli_config_gen/documentation/devices/ip-extended-community-lists-regexp.md
 ansible_collections/arista/avd/molecule/eos_cli_config_gen/documentation/devices/generate-default-config.md
 ansible_collections/arista/avd/molecule/eos_cli_config_gen_deprecated_vars/documentation/devices/host1.md
-ansible_collections/arista/avd/tests/unit/filters/toc_files/
+python-avd/tests/pyavd/j2filters/toc_files/

.github/changelog.sh

@@ -20,7 +20,7 @@ TYPES=(
   OPTIMIZE  "Code optimization"
   PERF      "Performance"
   REFACTOR  "Code Refactoring"
-  REFORMAT  "Code Reformating"
+  REFORMAT  "Code Reformatting"
   REVERT    "Revert"
   TEST      "Testing"
 )

.github/dependabot.yml

@@ -0,0 +1,52 @@
+---
+version: 2
+updates:
+  # Maintain dependencies for Python
+  # Need one per directory until the following issue is fixed - Beta in April 2024
+  # https://github.com/dependabot/dependabot-core/issues/2178
+  # This first entry for pip should cover python-avd
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    reviewers:
+      - "aristanetworks/avd-maintainers"
+    pull-request-branch-name:
+      separator: "/"
+    commit-message:
+      prefix: "Bump(requirements): "
+    # Allow up to 10 open pull requests for pip dependencies
+    open-pull-requests-limit: 10
+  # This next entry intends to ignore requirements-minimum.txt
+  # Need to check if it works or not.
+  - package-ecosystem: "pip"
+    directory: "/ansible_collections/arista/avd/requirements-minimum.txt"
+    schedule:
+      interval: "monthly"
+    # Allow up to 0 open pull requests for pip dependencies
+    open-pull-requests-limit: 0
+    ignore:
+      - dependency-name: "*"
+  # This second entry for pip covers the requirements file in the ansible collection
+  - package-ecosystem: "pip"
+    directory: "/ansible_collections/arista/avd/"
+    schedule:
+      interval: "daily"
+    reviewers:
+      - "aristanetworks/avd-maintainers"
+    pull-request-branch-name:
+      separator: "/"
+    commit-message:
+      prefix: "Bump(requirements): "
+    # Allow up to 10 open pull requests for pip dependencies
+    open-pull-requests-limit: 10
+  # Maintain dependencies for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    reviewers:
+      - "aristanetworks/avd-maintainers"
+    commit-message:
+      prefix: "CI: "
+    open-pull-requests-limit: 10

.github/ignore-codespell-words

@@ -0,0 +1,10 @@
+nd
+iif
+supress
+inout
+claus
+clos
+beed
+defauls
+toi
+pathc

.github/ignore-codespell-words.md

@@ -0,0 +1,27 @@
+# Codespell ignore file documentation
+
+Ignored words are stored in the `.github/ignore-codespell-words` file. This file
+intends to clarify why the words are ignored and if any action is pending
+
+- nd
+    Acronym for Neighbor Discovery
+- iif
+    Used as test data
+- supress
+    This word is in the schema - probably wrongly spelled. It was introduced in
+    https://github.com/aristanetworks/avd/pull/3360 in AVD 3.6.0
+    TODO - raise an issue to fix it.
+- inout
+    Key name `route_map_inout` in `eos_cli_config_gen` schema
+- claus
+    Maintainer name in some places in the code
+- clos
+    Used to design CLOS topology in documentation
+- beed
+    Used as example data
+- defauls
+    Used as test data
+- TOI
+    Acronym Transfer of Information
+- pathc
+    Used as test data

.github/labeler.yml

@@ -1,86 +1,130 @@
 "role: build_output_folders":
-  - ansible_collections/arista/avd/roles/build_output_folders/*
-  - ansible_collections/arista/avd/roles/build_output_folders/**/*
+  - changed-files:
+      - any-glob-to-any-file:
+          - ansible_collections/arista/avd/roles/build_output_folders/*
+          - ansible_collections/arista/avd/roles/build_output_folders/**/*
 
 "role: cvp_configlet_upload":
-  - ansible_collections/arista/avd/roles/cvp_configlet_upload/*
-  - ansible_collections/arista/avd/roles/cvp_configlet_upload/**/*
+  - changed-files:
+      - any-glob-to-any-file:
+          - ansible_collections/arista/avd/roles/cvp_configlet_upload/*
+          - ansible_collections/arista/avd/roles/cvp_configlet_upload/**/*
 
 "role: eos_cli_config_gen":
-  - ansible_collections/arista/avd/roles/eos_cli_config_gen/*
-  - ansible_collections/arista/avd/roles/eos_cli_config_gen/**/*
+  - changed-files:
+      - any-glob-to-any-file:
+          - ansible_collections/arista/avd/roles/eos_cli_config_gen/*
+          - ansible_collections/arista/avd/roles/eos_cli_config_gen/**/*
 
 "role: eos_config_deploy_cvp":
-  - ansible_collections/arista/avd/roles/eos_config_deploy_cvp/*
-  - ansible_collections/arista/avd/roles/eos_config_deploy_cvp/**/*
+  - changed-files:
+      - any-glob-to-any-file:
+          - ansible_collections/arista/avd/roles/eos_config_deploy_cvp/*
+          - ansible_collections/arista/avd/roles/eos_config_deploy_cvp/**/*
 
 "role: eos_config_deploy_eapi":
-  - ansible_collections/arista/avd/roles/eos_config_deploy_eapi/*
-  - ansible_collections/arista/avd/roles/eos_config_deploy_eapi/**/*
+  - changed-files:
+      - any-glob-to-any-file:
+          - ansible_collections/arista/avd/roles/eos_config_deploy_eapi/*
+          - ansible_collections/arista/avd/roles/eos_config_deploy_eapi/**/*
 
 "role: eos_designs":
-  - ansible_collections/arista/avd/roles/eos_designs/*
-  - ansible_collections/arista/avd/roles/eos_designs/**/*
+  - changed-files:
+      - any-glob-to-any-file:
+          - ansible_collections/arista/avd/roles/eos_designs/*
+          - ansible_collections/arista/avd/roles/eos_designs/**/*
 
 "role: eos_validate_state":
-  - ansible_collections/arista/avd/roles/eos_validate_state/*
-  - ansible_collections/arista/avd/roles/eos_validate_state/**/*
+  - changed-files:
+      - any-glob-to-any-file:
+          - ansible_collections/arista/avd/roles/eos_validate_state/*
+          - ansible_collections/arista/avd/roles/eos_validate_state/**/*
 
 "role: eos_snapshot":
-  - ansible_collections/arista/avd/roles/eos_snapshot/*
-  - ansible_collections/arista/avd/roles/eos_snapshot/**/*
+  - changed-files:
+      - any-glob-to-any-file:
+          - ansible_collections/arista/avd/roles/eos_snapshot/*
+          - ansible_collections/arista/avd/roles/eos_snapshot/**/*
 
 "role: dhcp_provisioner":
-  - ansible_collections/arista/avd/roles/dhcp_provisioner/*
-  - ansible_collections/arista/avd/roles/dhcp_provisioner/**/*
+  - changed-files:
+      - any-glob-to-any-file:
+          - ansible_collections/arista/avd/roles/dhcp_provisioner/*
+          - ansible_collections/arista/avd/roles/dhcp_provisioner/**/*
 
 "filter: natural_sort":
-  - ansible_collections/arista/avd/plugins/filter/natural_sort.py
+  - changed-files:
+      - any-glob-to-any-file:
+          - ansible_collections/arista/avd/plugins/filter/natural_sort.py
 
 "filter: is_in_filter":
-  - ansible_collections/arista/avd/plugins/filter/is_in_filter.py
+  - changed-files:
+      - any-glob-to-any-file:
+          - ansible_collections/arista/avd/plugins/filter/is_in_filter.py
 
 "filter: list_compress":
-  - ansible_collections/arista/avd/plugins/filter/list_compress.py
+  - changed-files:
+      - any-glob-to-any-file:
+          - ansible_collections/arista/avd/plugins/filter/list_compress.py
 
 "filter: defined":
-  - ansible_collections/arista/avd/plugins/filter/defined.py
+  - changed-files:
+      - any-glob-to-any-file:
+          - ansible_collections/arista/avd/plugins/filter/defined.py
 
 "module: configlet_build_config":
-  - ansible_collections/arista/avd/plugins/modules/configlet_build_config.py
+  - changed-files:
+      - any-glob-to-any-file:
+          - ansible_collections/arista/avd/plugins/modules/configlet_build_config.py
 
 "module: inventory_to_container":
-  - ansible_collections/arista/avd/plugins/modules/inventory_to_container.py
+  - changed-files:
+      - any-glob-to-any-file:
+          - ansible_collections/arista/avd/plugins/modules/inventory_to_container.py
 
 "type: Python filters":
-  - ansible_collections/arista/avd/plugins/filter/*.py
+  - changed-files:
+      - any-glob-to-any-file:
+          - ansible_collections/arista/avd/plugins/filter/*.py
 
 "type: Ansible roles":
-  - ansible_collections/arista/avd/plugins/roles/**/*.yml
-  - ansible_collections/arista/avd/plugins/roles/**/*.j2
+  - changed-files:
+      - any-glob-to-any-file:
+          - ansible_collections/arista/avd/plugins/roles/**/*.yml
+          - ansible_collections/arista/avd/plugins/roles/**/*.j2
 
 "state: Documentation role Updated":
-  - 'ansible_collections/arista/avd/roles/**/*.md'
+  - changed-files:
+      - any-glob-to-any-file:
+          - 'ansible_collections/arista/avd/roles/**/*.md'
 
 "type: documentation":
-  - README.md
-  - contributing.md
-  - ansible_collections/arista/avd/*.md
-  - ansible_collections/arista/avd/docs/*
-  - ansible_collections/arista/avd/docs/**/*
+  - changed-files:
+      - any-glob-to-any-file:
+          - README.md
+          - contributing.md
+          - ansible_collections/arista/avd/*.md
+          - ansible_collections/arista/avd/docs/*
+          - ansible_collections/arista/avd/docs/**/*
 
 "type: code quality":
-  - .github/labeler.yml
-  - .github/*
-  - .github/**/*
-  - development/docker-compose.yml
-  - development/Makefile
+  - changed-files:
+      - any-glob-to-any-file:
+          - .github/labeler.yml
+          - .github/*
+          - .github/**/*
+          - development/docker-compose.yml
+          - development/Makefile
 
 "type: dependencies":
-  - development/requirements-dev.txt
-  - development/requirements.txt
-  - ansible_collections/arista/avd/docs/requirements.txt
+  - changed-files:
+      - any-glob-to-any-file:
+          - development/requirements-dev.txt
+          - development/requirements.txt
+          - ansible_collections/arista/avd/docs/requirements.txt
 
 "state: CI Updated":
-  - ansible_collections/arista/avd/molecule/*
-  - ansible_collections/arista/avd/molecule/**/*
+  - changed-files:
+      - any-glob-to-any-file:
+          - ansible_collections/arista/avd/molecule/*
+          - ansible_collections/arista/avd/molecule/**/*

.github/requirements-ci.txt

@@ -0,0 +1,5 @@
+# Installing PyAVD from source.
+# The package path below is relative to the repo root and will only work if the pip install is executed from there.
+./python-avd
+# The -r path is relative to this file.
+-r ../ansible_collections/arista/avd/requirements.txt

.github/workflows/container_build_base.yml

@@ -20,7 +20,7 @@ jobs:
     strategy:
       matrix:
         container_name: [base]
-        python_version: ["3.9", "3.10", "3.11"]
+        python_version: ["3.10", "3.11", "3.12"]
         include:
           - python_version: "3.11"
             container_tags: latest

.github/workflows/container_build_dev.yml

@@ -20,7 +20,7 @@ jobs:
     strategy:
       matrix:
         container_name: [dev]
-        python_version: ["3.9", "3.10", "3.11"]
+        python_version: ["3.10", "3.11", "3.12"]
         include:
           - python_version: "3.11"
             container_tags: latest

.github/workflows/container_build_template.yml

@@ -122,17 +122,13 @@ jobs:
             exit 1
           fi
 
-      - name: Find ansible-core version 🔥
-        id: find-ansible-core-version
-        run: |
-          ANSIBLE_CORE_VERSION=$(cat ansible_collections/arista/avd/requirements-dev.txt| grep ansible-core)
-          echo "ansible_core_version=$ANSIBLE_CORE_VERSION" >> $GITHUB_OUTPUT
-
-      - name: Find ansible install location
-        id: find-ansible-install-location
+      - name: Find ansible and pyavd install location
+        id: find-install-locations
         run: |
+          PYAVD_INSTALL_LOCATION="git+https://github.com/${{ github.repository }}.git@${{ github.ref_name }}#subdirectory=python-avd"
           ANSIBLE_INSTALL_LOCATION="git+https://github.com/${{ github.repository }}.git#/ansible_collections/arista/avd/,${{ github.ref_name }}"
           echo "ansible_install_location=$ANSIBLE_INSTALL_LOCATION" >> $GITHUB_OUTPUT
+          echo "pyavd_install_location=$PYAVD_INSTALL_LOCATION" >> $GITHUB_OUTPUT
 
       # This check is temporarily deactivated, will be rewised in later PRs
       #
@@ -176,8 +172,8 @@ jobs:
         env:
           FROM_IMAGE: ${{ steps.generate-from-parameters.outputs.from_image }}
           FROM_VARIANT: ${{ steps.generate-from-parameters.outputs.from_variant }}
-          ANSIBLE_INSTALL_LOCATION: ${{ steps.find-ansible-install-location.outputs.ansible_install_location }}
-          ANSIBLE_CORE_VERSION: ${{ steps.find-ansible-core-version.outputs.ansible_core_version }}
+          ANSIBLE_INSTALL_LOCATION: ${{ steps.find-install-locations.outputs.ansible_install_location }}
+          PYAVD_INSTALL_LOCATION: ${{ steps.find-install-locations.outputs.pyavd_install_location }}
           USERNAME: ${{ inputs.username }}
           UID: ${{ inputs.user_id }}
           GID: ${{ inputs.group_id }}

.github/workflows/container_build_universal.yml

@@ -23,7 +23,7 @@ jobs:
     strategy:
       matrix:
         container_name: [universal]
-        python_version: ["3.9", "3.10", "3.11"]
+        python_version: ["3.10", "3.11", "3.12"]
         include:
           - python_version: "3.11"
             container_tags: latest