Skip to content
This repository has been archived by the owner on Sep 7, 2023. It is now read-only.

Chatbot that allows users to communicate directly with Ansible AWX/Tower from various chat platforms.

Notifications You must be signed in to change notification settings

nautobot/nautobot-plugin-chatops-ansible

Repository files navigation

nautobot-plugin-chatops-ansible

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.

A plugin for Nautobot Chatops Plugin

Installation

Build Status

Branch Status
main Build Status
develop Build Status

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

pip install git+https://github.com/nautobot/nautobot-plugin-chatops-ansible.git

This ChatOps Plugin to Nautobot ChatOps Plugin requires the following list of environment variables to be added into the environment.

  • NAUTOBOT_TOWER_URI: Ansible Tower HTTP URI
  • NAUTOBOT_TOWER_USERNAME: Ansible Tower username
  • NAUTOBOT_TOWER_PASSWORD: Ansible Tower password

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

$ sudo systemctl restart nautobot nautobot-worker

Usage

Command setup

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

You may need to adjust your Access Grants in Nautobot depending on your security requirements.

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.

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>. All commands support the arguments --nautobot-ver and --python-ver if you want to manually define the version of Python and Nautobot to use. Each command also has its own help invoke <command> --help

Local dev environment

  build            Build all docker images.
  debug            Start Nautobot and its dependencies in debug mode.
  destroy          Destroy all containers and volumes.
  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

  tests            Run all tests.
  pydocstyle       Run pydocstyle to validate docstring formatting adheres to NTC defined standards.
  bandit           Run bandit to validate basic static code security analysis.
  black            Run black to check that Python files adhere to its style standards.
  unittest         Run Django unit tests for the plugin.

Questions

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

About

Chatbot that allows users to communicate directly with Ansible AWX/Tower from various chat platforms.

Topics

Resources

Security policy

Stars

Watchers

Forks

Packages

No packages published