krutaw / playbook

Playbook is a workflow engine for performing various tasks from the perspective of the NOC (Network Operations Center) team's perspective.

Playbook

---

What is this?

Playbook is a workflow engine for performing various tasks from the perspective of the NOC (Network Operations Center) team's perspective. The basic idea is to wrap tooling around action items that are performed when something happens. This could be restarting a service, calling the SME who is on-call via Twilio, etc.

Standards

• Language
  • All code shall conform to Python 3.6+
  • All code shall pass Python Linter

Models

• SMEs (Subject Matter Experts)
  • Cell Phone Number
  • Username
  • Email address
  • Given name
  • Surname
• Teams (made up of SMEs)
  • Team Name
  • Team manager
  • SME
• Calendars (allow for multiple per team)
  • Calendar name
  • Associated team
• RecurRule
  • Name
  • Description
  • Frequency
  • Params
• Schedule (allow for multiple per Calendar)
  • Schedule name
  • Associated Calendar
  • Start time
  • End time
  • Recurrence pattern (if any)
• Schedule order
  • OnCall SME
  • Oncall Order
  • Oncall Schedule (reference to Schedule)
• Actions
  • Action Type
    • Twilio SMS
    • Twilio Phone call
    • HipChat notification
      • Hipchat Room
    • Email
    • Ansible playbook
      • Associated certificate
    • Recovery check
  • Action Name
• Auth Certificate
  • Password
  • Certificate name
• Playbook
  • Playbook Name
  • Associated Team
• Play
  • Associated Playbook
  • Order
  • Associated Action
  • Number of Retries
  • Associated action to check recovery (used for auto-corrective actions only)

Interfaces

• Basic web interface for Playbook definition
• API for tool interaction

Logical workflow

Installation

• Clone
• Update core/Settings.py
  • REST_FRAMEWORK
    • URL_FIELD_NAME

Contributing

Please feel free to contribute or assist, this is literally a side project for me that I'm hoping will be useful to others. Please perform commits to the development branch and then do a pull request to merge into master.

playbook's Issues

Create models

Create all of the models based on the documentation thus far.

Dev branch

Create DEV branch and start performing all the work there first.

Rest API

Define the REST methods required and create the necessary Views using Django rest framework.

Fullcalendar integration

Need to write the Django bits to integrate with Fullcalendar to make the creation of on-call schedule "pretty".

Static content

Create the static content to eliminate the rest_framework errors:

[24/Feb/2018 22:38:21] "GET /static/rest_framework/css/bootstrap-tweaks.css HTTP/1.1" 304 0
[24/Feb/2018 22:38:21] "GET /static/rest_framework/css/bootstrap.min.css HTTP/1.1" 304 0
[24/Feb/2018 22:38:21] "GET /static/rest_framework/css/prettify.css HTTP/1.1" 304 0
[24/Feb/2018 22:38:21] "GET /static/rest_framework/css/default.css HTTP/1.1" 304 0
[24/Feb/2018 22:38:21] "GET /static/rest_framework/js/jquery-1.12.4.min.js HTTP/1.1" 304 0
[24/Feb/2018 22:38:21] "GET /static/rest_framework/js/bootstrap.min.js HTTP/1.1" 304 0
[24/Feb/2018 22:38:21] "GET /static/rest_framework/js/ajax-form.js HTTP/1.1" 304 0
[24/Feb/2018 22:38:21] "GET /static/rest_framework/js/csrf.js HTTP/1.1" 304 0
[24/Feb/2018 22:38:21] "GET /static/rest_framework/js/prettify-min.js HTTP/1.1" 304 0
[24/Feb/2018 22:38:21] "GET /static/rest_framework/js/default.js HTTP/1.1" 304 0