https://github.com/pagerduty/pd-oncall-chat-topic
AWS Lambda Function that updates a Chat Room topic (eg, Slack)
https://github.com/pagerduty/pd-oncall-chat-topic
in-scope team-community type-service
Last synced: 8 days ago
JSON representation
AWS Lambda Function that updates a Chat Room topic (eg, Slack)
- Host: GitHub
- URL: https://github.com/pagerduty/pd-oncall-chat-topic
- Owner: PagerDuty
- License: apache-2.0
- Created: 2017-09-15T18:42:02.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-30T17:59:36.000Z (12 months ago)
- Last Synced: 2024-05-31T06:17:47.179Z (12 months ago)
- Topics: in-scope, team-community, type-service
- Language: Python
- Size: 446 KB
- Stars: 82
- Watchers: 121
- Forks: 34
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pd-oncall-chat-topic
AWS Lambda Function that updates a Chat Room topic (eg, Slack)
## Motivation
At [PagerDuty](https://www.pagerduty.com/), we
[use](https://www.pagerduty.com/blog/how-does-pagerduty-use-pagerduty/)
PagerDuty to manage our on-call schedules. One integration that we like is
knowing who is on-call for a given team, via posting the information in a Slack
channel topic.
At PagerDuty Summit, one of our customers asked if we have this integration
open-sourced for them to use as well. At the time, we did not, it was deeply
integrated into our ChatOps tooling that is very specific to the PagerDuty
infrastructure. However, this integration is applicable to many other
organizations.
This project started at one of our Hack Days, a day put aside monthly for
employees to build and present projects or ideas that fulfill some kind of need
at the company.
## How to Deploy
1. [Create](https://api.slack.com/quickstart) a Slack App and
- Configure the App with Bot Token Scopes required for public channels:
- `channels:read` -- View basic information about public channels in a workspace
- `channels:write.topic` -- Set the description of public channels
- [Optional] Configure the App with Bot Token Scopes required for private channels:
- `groups:read` -- View basic information about private channels that your slack app has been added to
- `groups:write.topic` -- Set the description of private channels
- Add the App to the channel(s) that need topic updates
2. Obtain a PagerDuty API Key (v2) [Directions Here](https://support.pagerduty.com/docs/using-the-api#section-generating-an-api-key)
3. Deploy CloudFormation
- Clone repo
- Modify 2 variables for your AWS Environment
([Makefile#L3-L6](https://github.com/PagerDuty/pd-oncall-chat-topic/blob/master/Makefile#L3-L6))
- `make deploy`
4. Write API Keys to EC2 SSM Parameter Store.
- The lambda function expects certain key names by default so the following
commands should work unless modified elsewhere (advanced config).
- `make put-pd-key`
- `make put-slack-key`
5. Write Config to DynamoDB for which channels to update.
- It is possible to use the AWS CLI for this (or finish
[#4](https://github.com/PagerDuty/pd-oncall-chat-topic/issues/4) for ease of
use)
- In lieu of above, manually update the table with item entries of this format:
```
{
"schedule": "P123456",
"slack": "C123456",
"sched_name": "Optional schedule name to use in topic"
}
```
(where `schedule` is the PagerDuty Schedule ID, and `slack` is the Slack
Channel ID. You can have a space-separated list of channels. `sched_name` is optional and if omitted will be looked up)
If you have a split on-call rotation, you may place multiple comma-separated schedules and schedule names.
## Architecture
The main part of this infrastructure is an AWS Lambda Function that operates on
a schedule (cron), reads configuration information from an DynamoDB Table and
secrets from AWS EC2 Parameter Store. This is all deployed from a AWS
CloudFormation template.
## Cost
The way that this Lambda Function is configured, is to run on a schedule every 5
minutes. Some basic (anecdotal) testing revealed that the execution is about 5
seconds per 5 updates (via threading). Assuming double that and erroring on the
side of a large configuration (10x) the execution time will cost below $2/month.
The DDB table will cost, ~$0.60/month.
## Contact
This integration is primarily maintained by the SRE Team at PagerDuty. The best
way to reach us is by opening a GitHub issue.