Arista CloudVision ChatOps

The code in this repository has been migrated to the Nautobot ChatOps Repository as an integration - read more about it in the ChatOps Docs! As of July 2023 this repository has been FROZEN - all development / issues / discussions for this integration are in the Nautobot ChatOps Repository going forward.

Using the Nautobot ChatOps base framework, this app adds the ability to gather tag data, device configuration, devices in a specific container, task logs, configlets, device's common vulnerabilities and exposures, and device events from Arista's CloudVision using Slack, Webex Team, MS Teams, and Mattermost.

Screenshots

Installation

The extension is available as a Python package in PyPI and can be installed with pip

pip install nautobot-chatops-arista-cloudvision

You must first update the Nautobot configuration file with a new entry in the PLUGINS_CONFIG dictionary.

PLUGINS_CONFIG = {
    'nautobot_chatops': {
        'enable_slack': True,
        'slack_api_token': os.environ.get("SLACK_API_TOKEN"),
        'slack_signing_secret': os.environ.get("SLACK_SIGNING_SECRET")
    },
    'nautobot_chatops_arista_cloudvision' : {
        'cvaas_token': os.environ.get("CVAAS_TOKEN"),
        'cvp_username': os.environ.get("CVP_USERNAME"),
        'cvp_password': os.environ.get("CVP_PASSWORD"),
        'cvp_host': os.environ.get("CVP_HOST"),
        'cvp_insecure': os.environ.get("CVP_INSECURE"),
        'on_prem': os.environ.get("ON_PREM")
    }
}

After that, you must update environment variables depending on if you are using a CVaaS (CloudVision as a Service) or CloudVision on-premise. To update environment variables in Nautobot check out our blog post here

For CVAAS the following environment variables must be set.

CVAAS_TOKEN: Token generated from CVAAS service account. Documentation for that process can be found here in section 1.7
CVAAS_URL: This is the url of your CloudVision-as-a-Service. When setting this make sure to include www. When not set, this defaults to www.arista.io

For on premise instance of CloudVision, these environment variables must be set.

CVP_USERNAME: The username that will be used to authenticate to CloudVision.
CVP_PASSWORD: The password for the configured username.
CVP_HOST: The IP or hostname of the on premise CloudVision appliance.
CVP_INSECURE: If this is set to True, the appliance cert will be downloaded and automatically trusted. Otherwise, the appliance is expected to have a valid certificate.
ON_PREM: By default this is set to False, this must be changed to True if using an on-prem instance of CloudVision.

Once you have updated your environment file, restart both nautobot and nautobot-worker

$ sudo systemctl daemon-reload
$ sudo systemctl restart nautobot nautobot-worker

Usage

Command setup

Add a slash command to Slack called /cloudvision. See the nautobot-chatops installation guide for instructions on adding a slash command to your Slack channel.

The following commands are available:

get-devices-in-container [container-name]: Retrieves all the devices assigned to the specificied container.
get-configlet [configlet-name]: Get the configuration of the specified configlet.
get-device-configuration [device-name]: Get the configuration of the specified device.
get-task-logs [task-id]: Get the logs of the specified task.
get-applied-configlets [filter-type] [filter-value]: Get applied configlets to either a specified container or device.
get-active-events [filter-type] [filter-value] [start-time] [end-time]: Get active events in a given time frame. Filter-type can be filtered by device, type or severity. Filter-value is dynamically created based on the filter-type. Start-time accepts ISO time format as well as relative time inputs. Examples of that are -2w, -2d, -2h which will go back two weeks, two days and two hours, respectively.
get-tags [device-name]: Get system or user tags assigned to a device.
get-device-cve [device-name]: Gets all the CVEs of the specified device. Can also specifiy the all parameter to get a count of CVE account for each device.

Contributing

Pull requests are welcomed and automatically built and tested against multiple version of Python and multiple version of Nautobot through TravisCI.

The project is packaged with a light development environment based on docker-compose to help with the local development of the project and to run the tests within TravisCI.

The project is following Network to Code software development guideline and is leveraging:

Black, Pylint, Bandit and pydocstyle for Python linting and formatting.
Django unit test to ensure the plugin is working properly.

Development Environment

A slack workspace is needed to test in a development environment.

The development environment can be used in 2 ways. First, with a local poetry environment if you wish to develop outside of Docker. Second, inside of a docker container.

Invoke tasks

The PyInvoke library is used to provide some helper commands based on the environment. There are a few configuration parameters which can be passed to PyInvoke to override the default configuration:

nautobot_ver: the version of Nautobot to use as a base for any built docker containers (default: 1.2.0)
project_name: the default docker compose project name (default: nautobot_chatops_arista_cloudvision)
python_ver: the version of Python to use as a base for any built docker containers (default: 3.8)
local: a boolean flag indicating if invoke tasks should be run on the host or inside the docker containers (default: False, commands will be run in docker containers)
compose_dir: the full path to a directory containing the project compose files
compose_files: a list of compose files applied in order (see Multiple Compose files for more information)

Using PyInvoke these configuration options can be overridden using several methods. Perhaps the simplest is simply setting an environment variable INVOKE_NAUTOBOT-CHATOPS-EXTENSION-ARISTA_VARIABLE_NAME where VARIABLE_NAME is the variable you are trying to override. The only exception is compose_files, because it is a list it must be overridden in a yaml file. There is an example invoke.yml in this directory which can be used as a starting point.

Local Poetry Development Environment

Copy development/creds.example.env to development/creds.env (This file will be ignored by git and docker)
Uncomment the POSTGRES_HOST, REDIS_HOST, and NAUTOBOT_ROOT variables in development/creds.env
Create an invoke.yml with the following contents at the root of the repo:

---
nautobot_chatops_arista_cloudvision:
  local: true
  compose_files:
    - "docker-compose.requirements.yml"

Run the following commands:

poetry shell
poetry install --extras nautobot
export $(cat development/dev.env | xargs)
export $(cat development/creds.env | xargs)
invoke start && sleep 5
nautobot-server migrate

If you want to develop on the latest develop branch of Nautobot, run the following command: poetry add git+https://github.com/nautobot/nautobot@develop. After the @ symbol must match either a branch or a tag.

You can now run nautobot-server commands as you would from the Nautobot documentation for example to start the development server:

nautobot-server runserver 0.0.0.0:8080 --insecure

Nautobot server can now be accessed at http://localhost:8080.

Docker Development Environment

This project is managed by Python Poetry and has a few requirements to setup your development environment:

Install Poetry, see the Poetry Documentation for your operating system.
Install Docker, see the Docker documentation for your operating system.

Once you have Poetry and Docker installed you can run the following commands to install all other development dependencies in an isolated python virtual environment:

poetry shell
poetry install
invoke start

Nautobot server can now be accessed at http://localhost:8080.

CLI Helper Commands

The project is coming with a CLI helper based on invoke to help setup the development environment. The commands are listed below in 3 categories dev environment, utility and testing.

Each command can be executed with invoke <command>. Environment variables INVOKE_NAUTOBOT_CHATOPS_PLUGIN_CLOUDVISION_PYTHON_VER and INVOKE_NAUTOBOT_CHATOPS_PLUGIN_CLOUDVISION_NAUTOBOT_VER may be specified to override the default versions. Each command also has its own help invoke <command> --help

Docker dev environment

  build            Build all docker images.
  debug            Start Nautobot and its dependencies in debug mode.
  destroy          Destroy all containers and volumes.
  restart          Restart Nautobot and its dependencies.
  start            Start Nautobot and its dependencies in detached mode.
  stop             Stop Nautobot and its dependencies.

Utility

  cli              Launch a bash shell inside the running Nautobot container.
  create-user      Create a new user in django (default: admin), will prompt for password.
  makemigrations   Run Make Migration in Django.
  nbshell          Launch a nbshell session.

Testing

  bandit           Run bandit to validate basic static code security analysis.
  black            Run black to check that Python files adhere to its style standards.
  flake8           This will run flake8 for the specified name and Python version.
  pydocstyle       Run pydocstyle to validate docstring formatting adheres to NTC defined standards.
  pylint           Run pylint code analysis.
  tests            Run all tests for this plugin.
  unittest         Run Django unit tests for the plugin.

Questions

For any questions or comments, please check the FAQ first and feel free to swing by the Network to Code slack channel (channel #networktocode). Sign up here

nautobot/nautobot-plugin-chatops-arista-cloudvision