/myhero_app

Primary LanguagePython

MyHero App Service

This is the App Service for a basic microservice demo application. This provides a logic layer for a voting system where users can vote for their favorite movie superhero.

Details on deploying the entire demo to a Mantl cluster can be found at

The application was designed to provide a simple demo for Cisco Mantl. It is written as a simple Python Flask application and deployed as a docker container.

Other services are:

The docker containers are available at

Basic Application Details

Required

  • flask
  • ArgumentParser
  • requests

Environment Installation

pip install -r requirements.txt

Basic Usage

In order to run, the service needs 3 pieces of information to be provided:

  • Data Server Address
  • Data Server Authentication Key to Use
  • Application Server Authentication Key to Require

These details can be provided in one of three ways.

  • As a command line argument
    • python myhero_app/myhero_app.py --dataserver "http://myhero-data.server.com" --datakey "DATA AUTH KEY" --appsecret "APP AUTH KEY"
  • As environment variables
    • export myhero_data_server="http://myhero-data.server.com"
    • export myhero_data_key="DATA AUTH KEY"
    • export myhero_app_key="APP AUTH KEY"
    • python myhero_app/myhero_app.py
  • As raw input when the application is run
    • python myhero_app/myhero_app.py
    • What is the data server address? http://myhero-data.server.com
    • Data Server Key: DATA AUTH KEY
    • App Server Key: APP AUTH KEY

A command line argument overrides an environment variable, and raw input is only used if neither of the other two options provide needed details.

Alternate and Advanced Configurations

Finding Data Server Details with SRV Lookup

If in your deployment, the myhero_data microservice is deployed in a way that the data server address (ie IP and Port) are dynamic, there is support for querying an SRV record to determine the details.

An example of this type of setup would be deploying MyHero to a Mantl.io cluster where Consul.io is used for service discovery. Rather than hard code in the address of the data server, you would query Consul for the address infromation.

To use this method, you will provide a different argument or environment variable to the program.

  • As a command line argument
    • python myhero_app/myhero_app.py --datasrv "data-myhero.service.consul" --datakey "DATA AUTH KEY" --appsecret "APP AUTH KEY"
  • As environment variables
    • export myhero_data_srv="data-myhero.service.consul"
    • export myhero_data_key="DATA AUTH KEY"
    • export myhero_app_key="APP AUTH KEY"
    • python myhero_app/myhero_app.py

Vote Processing Mode

When an API request comes in to place a vote, there are two modes that the APP service can run in.

The default mode is "direct". In this mode, the APP service will directly call the data service to place the vote.

There is an optional mode of "queue". In this mode, rather than sending a direct API call to the data service for each vote, the APP service will publish the vote to an MQTT Queue where a seperate service, myhero_ernst, subscribes to the queue and processes the votes. The reason this option is in place is to prevent overloading the data service if a high number and rate of votes is expected. By funnelling through a queueing service, we protect the data service.

To leverage the direct mode, nothing needs to be done, this is the default. To leverage the queue mode, you need to take these additional steps.

  • Deploy an MQTT server to queue the votes as they come in
  • Deploy the myhero_ernst service to subscribe and act on votes as they come through
  • Activate the mode at run time by either passing in a command line arguement or setting an additional environment variable
    • Argument Method
      • python myhero_app/myhero_app.py --mode queue
    • Environment Variable Method
      • export myhero_app_mode=queue
      • python myhero_app/myhero_app.py

Accessing

Initial and Basic APIs. These are v1 APIs that require no authentication and will eventually be removed

  • Basic List of Hero Choices
    • curl http://localhost:5000/hero_list
  • Current results calculations
    • curl http://localhost:5000/results
  • Place a vote for an option
    • curl http://localhost:5000/vote/<HERO>

New v2 APIs These newer APIs require authentication as well as support more features

  • Get the current list of options for voting
    • curl -X GET -H "key: APP AUTH KEY" http://localhost:5000/options
  • Add a new option to the list
    • curl -X PUT -H "key: APP AUTH KEY" http://localhost:5000/options -d '{"option":"Deadpool"}'
  • Replace the entire options list
    • curl-X POST -H "key: APP AUTH KEY" http://localhost:5000/options -d @sample_post.json
    • Data should be of same format as a GET request
  • Delete a single option from the list
    • curl -X DELETE -H "key: APP AUTH KEY" http://localhost:5000/options/Deadpool
  • Place a Vote for an option
    • curl -X POST -H "key: APP AUTH KEY" http://localhost:5000/vote/Deadpool
  • Get current results
    • curl -X GET -H "key: APP AUTH KEY" http://localhost:5000/results

Local Development with Vagrant

I've included the configuration files needed to do local development with Vagrant in the repo. Vagrant will still use Docker for local development and requires the following be installed on your laptop:

To start local development run:

  • vagrant up
  • Now you can interact with the API or interface at localhost:15001 (configured in Vagrantfile)
    • example: from your local machine curl -H "key: DevApp" http://localhost:15001/options
    • Environment Variables are configured in Vagrantfile for development

Each of the services in the application (i.e. myhero_web, myhero_app, and myhero_data) include Vagrant support to allow working locally on all three simultaneously.