imapex/chronic_bus repository overview

⁠CHROnIC_Bus

##Cisco Health Report & ONline Information Collector This is an application designed to interact with infrastructure components, and perform an online analysis of them.

The Challenge - It can be tedious to collect the data needed for routine health analysis. For example, the UCS Health Check requres a PowerShell script to be ran, which requires the UCS PowerTools to be installed, as well as a number of security requirements. This can be very complex for anyone who does not routinely use PowerShell.

The Solution - Create an application that will enable interaction with UCS from the cloud. This particular application has several microservices, including:

• Bus - Used as a basic HTTP-based message queue
• Collector - On-prem component used to exchange core information between on-prem infrastructure and the Portal. Consumes messages from the queue.
• Portal - Information Collection service and agent used to push tasks into the queue.
• UCS ESX Analyzer - Process data and generate reports which are pushed back into the queue.

Contributors - Josh Anderson, Chad Peterson, Loy Evans

###This repo is for the following service: Bus - This microservice is designed to accept and distribute messages from a queue. Not designed to be an especially feature rich message bus, but created for a specific purpose - to asynchronously send/receive messages via HTTP REST API. This bus is designed to sit in a public infrastructure and be reachable from environments that sit behind a HTTP Proxy server, with limited outbound connectivity.

###This repo includes the following resources: Repo Information

• LICENSE
  • Code Licensing Information
• README.md
  • This document
• .gitignore
  • Standard gitignore file to prevent commiting unneeded or security risk files

CICD Build Configuration

• .drone.sec
  • Encrypted Drone Settings
• .drone.yml
  • CICD Build instructions for Drone Server
• drone_secrets_sample.yml
  • template for the secrets file that will be used to encrypt credentials
• Dockerfile
  • Docker build file for applicaiton container
• requirements.txt
  • pip installation requirements

Application Files

• app_install.sh
  • This is used to install the application to a MANTL/Marathon environment
• app_uninstall.sh
  • This is used to uninstall the application from a MANTL/Marathon environment
• chronic_bus.json
  • Configuration file used for the MANTL/Marathon installation
• app.py
  • This kicks off the application. This application listens and is delivered strictly as an API.
• test.py
  • Flask build test application. Used to validate API functionality for the build process.

⁠Installation

⁠Environment

• Docker Container⁠
• Native Python⁠

⁠Docker Installation

Prerequisites: The following components are required to locall run this container:

• Docker⁠

Get the container: The latest build of this project is available as a Docker image from Docker Hub:

docker pull joshand/chronic_bus:latest

Run the application:

docker run -d -p 5000:5000 --name Dockerfile joshand/chronic_hub:latest

Use the API: API Usage⁠ See below for API usage

⁠Local Python Installation

Prerequisites: The following components are required to locally run this project:

• Python 3.5⁠ - Install via homebrew recommended if on a Mac
• git - Part of the Xcode Command Line Tools
• pip⁠
• virtualenv⁠

Get the code: The latest build of this project is available on Github:

mkdir ~/chronic_bus
cd ~/chronic_bus
git clone https://github.com/joshand/CHROnIC_Bus

Set up virtual environment and PIP:

virtualenv chronic
source chronic/bin/activate
pip install -r requirements.txt

Execute the app:

python app.py

Use the API: API Usage⁠ See below for API usage

⁠API Usage

Note: This usage assumes you are executing on localhost

* 127.0.0.1:5000/api/send/<channelid>               POST        Used to post a new message to a channel on the bus.
    {
        "msgdata": "your data or message here",                 Mandatory: The data to include in the message.
        "desc": "description of the message",                   Optional: Friendly description of the task or message.
        "status": "0",                                          Optional: Current status of the message. Treated as null/0 if excluded.
        "webhook": "https://url_for_webhook"                    Optional: Specify a webhook to call when a message gets updated.
    }
* 127.0.0.1:5000/api/get                            GET         Used to get a list of all channels on the bus.
* 127.0.0.1:5000/api/get/<channelid>                GET         Used to retrieve messages from a channel on the bus where status is
                                                                  unset or =0. Sets status=1 on those messages. Add /force to show all.
* 127.0.0.1:5000/api/get/<channelid>/<statusid>     GET         Used to retrieve messages from a channel on the bus where status is
                                                                  specified by statusid.
* 127.0.0.1:5000/api/send/<channelid>               DELETE      Used to clear all messages from a channel on the bus.
* 127.0.0.1:5000/api/status/<messageid>             POST        Used to change the status of a particular message on the bus.
    {
        "status": "3"                                           Mandatory: New status of message.
    }
* 127.0.0.1:5000/api/status/<messageid>             GET         Used to get the status of a particular message on the bus.
* 127.0.0.1:5000/api/update/<messageid>             POST        Used to post a response to a given message on the bus.
    {
        "msgresp": "your data or message here"                  Required: Updated status to post for message. Sets status = 2.
    }