Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cds-snc/sre-bot
Slack bot for site reliability engineering
https://github.com/cds-snc/sre-bot
Last synced: about 2 hours ago
JSON representation
Slack bot for site reliability engineering
- Host: GitHub
- URL: https://github.com/cds-snc/sre-bot
- Owner: cds-snc
- License: mit
- Created: 2022-02-21T15:09:38.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T15:28:28.000Z (14 days ago)
- Last Synced: 2024-10-29T16:13:08.296Z (14 days ago)
- Language: Python
- Size: 3.53 MB
- Stars: 6
- Watchers: 17
- Forks: 1
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SRE Bot
A slack bot for site reliability engineering at CDS.
This bot is using the Bolt framework in python (https://slack.dev/bolt-python/) and uses a web socket connection to Slack.
## Local Development with Containers
This project uses [Visual Studio Code Remote - Containers](https://code.visualstudio.com/docs/remote/containers).
Here are the instructions to get started with developing locally.
Requirements:
- Docker installed and running
- VS Code
Steps:
1. Clone the repo
2. Open VS Code with Dev Container (see [Quick start: Open an existing folder in a container](https://code.visualstudio.com/docs/remote/containers#_quick-start-open-an-existing-folder-in-a-container))
3. Install Python dependencies
```
cd app && pip install --no-cache-dir -r requirements.txt
```
4. Add a ``.env`` file to the ``/workspace/app`` folder (Contact SRE team for the project specific .env setup)
5. Launch the dev bot with ```make dev```
6. Test your development in the dedicated channel (SRE team will confirm which channel to point to)
## Refactoring
The bot is currently being refactored to separate the integration concerns from the bot's features and commands. The goal is to make the bot more modular and easier to maintain.
### Integrations
The `app/integrations` will contain the bot's interactions with external services (e.g. Google Workspace, Slack, etc.)
The integrations will be responsible for handling the bot's interactions with the external services. They will be responsible for sending and receiving messages, and handling any other interactions with the external services.
From a design perspective, they should be as simple as possible, and should not contain any business logic. They should be responsible for handling the interactions with the external services, and should delegate any business logic to the features.
### Features (aka modules)
The `app/modules` will contain the bot's features and commands. Each feature will have its own directory and will be responsible for handling the bot's interactions with the user.
The features may end up needing to interact with the integrations to perform their tasks.
### Jobs
The `app/jobs` will contain the bot's scheduled jobs. Each job will have its own directory and will be responsible for handling the bot's scheduled tasks.
Examples may include sending daily reminders, checking the status of a service, etc.