Platform Work Sample (Services)

The contained project serves as the backend/service layer of the Platform Engineering work sample.

##Setup

There are 3 ways to develop on this project:

Use our provided Vagrantfile to setup a VM deployment
Use our provided Vagrantfile to deploy only the databases
Do everything yourself manually

##Data Model

###Group The Group model has a 1-to-many association with a Deployment. It requires that an Id be provided during creation and by default, no Settings are configured. When a Check comes in that requires a notification, the system will first look at the Settings on the Deployment model and then fall back to the Group model Settings. If neither contains the specific integration, no notification is sent.

###Settings The Settings model is part of a Group and Deployment model. It contains all the necessary information to send a notfication for a particular service (i.e. Slack, Pagerduty, HipChat, Email, etc.).

###Deployment The Deployment model belongs to a Group and contains basic information about the customer deployment (i.e. name, account slug, etc.) and also contains Settings and an []Check. In order for the system to send a notification for a deployment, two criteria must be met: 1. the check must be registerd with the deployment via the []Check 2. Settings must exist for either the Deployment or associated Group.

###Check The Check model is a "dictionary" of all the checks returned by each deployment type that we wish to act on.

##Sending Test Alerts

You can send an "alert" to the system with the following command:

curl -u x:$COMPOSE_SERVICE_PASSWORD -XPOST http://<service_ip>:8000/margo/alerts -d \
'{ \
  "client": "localhost", \
  "check": { \
    "name": "redis0-redis_role", \
    "capsule_name": "redis0", \
    "output": "no master found", \
    "status": 1, \
    "capsule_id": "1324354657687980", \
    "deployment_id": "987654321", \
    "account": "compose" \
  } \
}'

Breakdown of each attribute:

client: where the alert came from
check: object
check.name: this is a combination of the alert name and the capsule name; in order for the system to process the alert properly, the first part of the name (i.e. everything before the first -) should match the capsule_name attribute
check.capsule_name: name of the capsule, typically in the form of redisX, elasticsearchX, mongodbX, etc. where 'X' is a number, 0 is always fine for testing of course
check.output: human readable text regarding the alert
check.status: one of 0/1/2/3 and match with the below constants, if you want to test a notification, set the value to 1, 2, or 3; if you want to resolve a notification, set the value to 0

const (
  Resolved = iota // 0
  Warning         // 1
  Critical        // 2
  Unknown         // 3
)

check.capsule_id: this is somewhat of a random value for testing purposes but you'll want to make the unique across deployments
check.deployment_id: this needs to match up with whatever deployment(s) you have registered with the system; based on the seed data, "987654321" or "13243647586970" are valid values
check.account: whatever your heart desires it's just an identifer for an account in the system

##HTTP Routes

###Deployments

###Groups

###Checks

##Work Sample

Add the necessary functionality in listener.go and notififer.go to be able to send notifications based on whether a new or resolved incident has been received (note: this should be determinable with the calls to Alerter)
Implement the Pagerduty (model_pagerduty.go) and Slack (model_slack.go) notifications by making calls in notififer.go, a function getInfo has already been provided that extracts the necessary model data from a check

HINTS:

Currently there's no communication channel created between listener and notifier, that's a good place to start
The models returned in getInfo provides all the information needed to determine whether a specific deployment or group should receive a notification for a particular service

compose/platform-ws-services

Platform Work Sample (Services)