Alarm Manager

A quick proof of concept for a lambda function which raises alarms as tickets in Jira using the Atlassian API instead of emails.

TODO

Create basic Lambda function using docker image
Create CloudFormation template to deploy to AWS
Create Postman collection for Atlassian API endpoints
Create Jira user and grant token
Test creating Jira tickets from Lambda
Add TypeScript
Create a ticket builder
Create ticket based on a mock CloudWatch event

Atlassian API

Atlassian recommends using basic auth for personal scripts, bots, and ad-hoc execution of the REST APIs.

To authenticate with the API using basic auth:

Generate an API token for Jira using your Atlassian Account.
Build a string of the form useremail:api_token.

BASE64 encode the string

echo -n user@example.com:api_token_string | base64

Supply an Authorization header with content Basic followed by the encoded string.

curl -D- \
-X GET \
-H "Authorization: Basic ZnJlZDpmcmVk" \
-H "Content-Type: application/json" \
"https://your-domain.atlassian.net/rest/api/2/issue/QA-31"

See documentation for ad-hoc-api-calls for more information.

Atlassian Document Format

The Atlassian Document Format (ADF) represents rich text stored in Atlassian products. For example, in Jira Cloud platform, the text in issue comments and in textarea custom fields is stored as ADF.

An Atlassian Document Format document is a JSON object:

http://go.atlassian.com/adf-json-schema.

There is a javascript library for building ADF objects:

https://atlaskit.atlassian.com/packages/editor/adf-utils

Run locally

Build the container image:
```
docker build -t poc-alarms-manager .
```

Run container:

docker run \
-p 9000:8080 \
-e JIRA_URL=https://team-123456.atlassian.net/rest/api/3 \
-e JIRA_TOKEN=<JIRA_TOKEN> \
poc-alarms-manager

Test function:

curl -XPOST "http://localhost:9000/2015-03-31/functions/function/invocations" \
-d '{
    "message": "Error on people-service",
    "date": "2021-12-02",
    "service": "lender-dashboard",
    "level": "error"
}'

Run in AWS

Log into ECR:

aws ecr get-login-password \
--region eu-west-2 | docker login \
--username AWS \
--password-stdin <ACCOUNT_ID>.dkr.ecr.eu-west-2.amazonaws.com

Tag the container image:

docker tag poc-alarms-manager:latest <ACCOUNT_ID>.dkr.ecr.eu-west-2.amazonaws.com/poc-alarms-manager:latest

Push the iamge to ECR:

docker push <ACCOUNT_ID>.dkr.ecr.eu-west-2.amazonaws.com/poc-alarms-manager:latest

Deploy the CloudFormation stack:

aws cloudformation deploy \
--template-file lambda.yml \
--stack-name AlarmsManagerStack \
--capabilities CAPABILITY_NAMED_IAM \
--parameter-overrides JiraURL=https://team-123456.atlassian.net/rest/api/3 JiraToken=<JIRA_TOKEN>