Skip to content

Latest commit

 

History

History
153 lines (115 loc) · 6.85 KB

README.md

File metadata and controls

153 lines (115 loc) · 6.85 KB
Raw

Ansible Collection: jeffkala.nautobot-eda

Ansible Event Drive (EDA) source plugin for Nautobot. This source plugin monitors the Nautobot Changelog. As changes are made in Nautobot events will be produced.

Requirements

Simple Example

---
- name: Watch for new changelog entries
  hosts: localhost
  sources:
    # Specifies the Nautobot instance, token, and the polling interval.
    - jeffkala.nautobot_eda.nautobot_changelog:
        instance: https://demo.nautobot.com)
        token: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
        interval: 1

  # This section defines the rules logic to implement.  In this example its simply capturing all events that have the event.id defined.
  # event.id in this case is the changelog id.
  rules:
    - name: New changelog created
      condition: event.id is defined
      # Action is triggered if condition is `true`.
      action:
        # For simple examples just print the event as a debug message.
        debug:

For more examples of how to trigger on more unique changelog events seen playbooks

Example Event Output

(
    "{'id': '0cc0b56a-3894-403b-9ffc-de65da564c60', 'display': 'dcim | device "
    "azd01-dist-01 updated by demo', 'url': "
    "'https://demo.nautobot.com/api/extras/object-changes/0cc0b56a-3894-403b-9ffc-de65da564c60/', "
    "'time': '2023-02-23T01:29:43.007930Z', 'user': {'display': 'demo', 'id': "
    "'49f4bf26-45f8-4661-8e77-1a728fea9f3a', 'url': "
    "'https://demo.nautobot.com/api/users/users/49f4bf26-45f8-4661-8e77-1a728fea9f3a/', "
    "'username': 'demo'}, 'user_name': 'demo', 'request_id': "
    "'b5a75f51-927d-49d2-94ee-4e64ef477e88', 'action': {'value': 'update', "
    "'label': 'Updated'}, 'changed_object_type': 'dcim.device', "
    "'changed_object_id': 'ce99c3d8-47da-4f79-b960-b2ac5e97b1a3', "
    "'changed_object': {'display': 'azd01-dist-01', 'id': "
    "'ce99c3d8-47da-4f79-b960-b2ac5e97b1a3', 'url': "
    "'https://demo.nautobot.com/api/dcim/devices/ce99c3d8-47da-4f79-b960-b2ac5e97b1a3/', "
    "'name': 'azd01-dist-01'}, 'object_data': {'face': '', 'name': "
    "'azd01-dist-01', 'rack': None, 'site': "
    "'be54682a-a877-4564-a396-ff4694986046', 'tags': [], 'serial': '', 'status': "
    "'afbc8eec-50e0-4d31-b875-1022c8208b7b', 'tenant': "
    "'a39f2dd8-84c8-4816-9e6f-4a7c46e91a77', 'cluster': None, 'created': "
    "'2022-11-09', 'comments': '', 'location': None, 'platform': "
    "'df107d2a-b84f-4a30-9e48-093e9ad9a550', 'position': None, 'asset_tag': None, "
    "'device_role': '8acdfbc3-c3ae-4b52-b8a3-f8766edce039', 'device_type': "
    "'09dbb4e4-b258-4614-a85a-125f5c5caa9e', 'primary_ip4': None, 'primary_ip6': "
    "None, 'vc_position': None, 'vc_priority': None, 'last_updated': "
    "'2023-02-23T01:29:42.935Z', 'custom_fields': {}, 'secrets_group': None, "
    "'virtual_chassis': None, 'local_context_data': None, 'local_context_schema': "
    "None, 'device_redundancy_group': None, 'device_redundancy_group_priority': "
    "None, 'local_context_data_owner_object_id': None, "
    "'local_context_data_owner_content_type': None}}"
)

Testing

For testing guidelines see explanation see Testing

Development and Contribution Guidelines

It is a standard Ansible collection module. So best practices are found here.

Poetry

Poetry is used in lieu of the "virtualenv" commands and is leveraged in both environments. The virtual environment will provide all of the Python packages required to manage the development environment such as Invoke. See the Local Development Environment section to see how to install Netutils if you're going to be developing locally (i.e. not using the Docker container).

The pyproject.toml file outlines all of the relevant dependencies for the project:

  • tool.poetry.dependencies - the main list of dependencies.
  • tool.poetry.dev-dependencies - development dependencies, to facilitate linting, testing, and documentation building.

The poetry shell command is used to create and enable a virtual environment managed by Poetry, so all commands ran going forward are executed within the virtual environment. This is similar to running the source venv/bin/activate command with virtualenvs. To install project dependencies in the virtual environment, you should run poetry install - this will install both project and development dependencies.

For more details about Poetry and its commands please check out its online documentation.

Full Docker Development Environment

This project is set up with a number of Invoke tasks consumed as simple CLI commands to get developing fast. You'll use a few invoke commands to get your environment up and running.

CLI Helper Commands

The project features a CLI helper based on invoke to help setup the development environment. The commands are listed below in 3 categories:

  • dev environment
  • utility
  • testing

Each command can be executed with invoke <command>. Each command also has its own help invoke <command> --help

Local dev environment

  build              Build all docker images.
  clean              Remove the project specific image.
  docs               Build and serve docs locally.
  rebuild            Clean the Docker image and then rebuild without using cache.

Utility

  cli                Enter the image to perform troubleshooting or dev work.
  clean-container    Remove stopped containers that source for image `netutils:`

Testing

  bandit             Run bandit to validate basic static code security analysis.
  black              Run black to check that Python files adhere to its style standards.
  coverage           Run the coverage report against pytest.
  flake8             Run flake8 to check that Python files adhere to its style standards.
  mypy               Run mypy to validate typing-hints.
  pylint             Run pylint code analysis.
  pydocstyle         Run pydocstyle to validate docstring formatting adheres to NTC defined standards.
  pytest             Run pytest for the specified name and Python version.
  tests              Run all tests for the specified name and Python version.
  yamllint           Run yamllint to validate formatting adheres to NTC defined YAML standards.

Test a Rulebook

Once you build and run the container you can run the rulebook.

ansible-rulebook --rulebook playbooks/pb_example1.yml -i inventory/inventory.yml --verbose

Perform tests locally before commiting and generating a PR for review.

Publish collection

This is currently in alpha for development purposes. Eventually this collection will most likely be bundled with networktocode.nautobot collection for easier use.