Skip to content

tools for parsing, validating and importing runbooks from repos

License

Notifications You must be signed in to change notification settings

simonw/runbook.md

Repository files navigation

Runbook.md

This utility offers the user the opportunity to create and upload a RUNBOOK.md file into Biz Ops to populate all the critical fields.

In this BETA implementation we offer both a GUI and a /ingest endpoint (to which you can POST RUNBOOK.md) content

See a sample of the format/content of the RUNBOOK.md file here

image

Local environment

Send record to kinesis stream

In Makefile the run task set up the offline kinesis environment and create the stream called change-request-api-test-enriched-stream.
If you want to put a record on the stream you can run the following command.

aws kinesis --endpoint-url http://localhost:4567 put-record --stream-name change-request-api-test-enriched-stream  --partition-key “MyFirstMessage” --data "{\"systemData\":{\"name\":\"Biz Ops Search\",\"SF_ID\":\"a22D0000002ugnxIAA\",\"serviceTier\":\"Bronze\",\"dataOwner\":{\"email\":\"rhys.evans@ft.com\"},\"supportedBy\":{\"email\":\"reliability.engineering@ft.com\"},\"repositories\":{\"code\":\"github:Financial-Times/biz-ops-api\"},\"deliveredBy\":{\"productOwners\":[{\"email\":\"sarah.wells@ft.com\"}],\"group\":{\"code\":\"operationsreliability\",\"name\":\"Operations & Reliability\"}}},\"githubData\":{\"title\":\"Fix change type in salesforce\",\"htmlUrl\":\"https://github.com/Financial-Times/change-api/pull/52\"},\"user\":{\"githubName\":\"testUser\",\"email\":null},\"environment\":\"production\",\"systemCode\":\"biz-ops-search\",\"commit\":\"c50128fc67f055356d4171f570aa2600e42dc2d1\",\"timestamp\":\"2019-06-18T09:38:44.286Z\",\"loggerContext\":{\"traceId\":\"e3860769-3341-4ea2-b29e-c9d96c260f13\",\"clientSystemCode\":\"biz-ops-search\"},\"isProdEnv\":true,\"salesforceSystemId\":\"a22D0000002ugnxIAA\"}"

About

tools for parsing, validating and importing runbooks from repos

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Packages