gcp-budget-alerts-service

The microservice is for tracking and monitoring the spending amount at the GCP service. This microservice elevates an alert whenever the overall budget surpasses or meets predefined thresholds.

Architecture

Architecture for the Alert Service

Installation Guideline

Prerequisite

1. pyenv
2. python 3.8
3. A Slack App for delivering messages on the channel. Setup Guideline

Steps

1. Clone the repository

   git clone https://github.com/ColoredCow/gcp-budget-alerts-service.git

2. Switch to project folder and setup the vertual environment

   cd gcp-budget-alerts-service
   python -m venv venv

3. Activate the virtual environment

   source ./venv/bin/activate

4. Install the dependencies:

   pip install -r requirements-dev.txt

5. Set up your .env file by copying .env.example

   cp .env.example .env

6. Add/update variables in your .env file for your environment.
7. Run the following command to get started with pre-commit

   pre-commit install

8. Start the server by following command

   functions_framework --target=handle --debug