Release v0.5.0 (#56)

* feat(api): Add support of configuration management API  (#51) #minor
* feat(ui): Add configuration management UI (#52)  #minor

Signed-off-by: hayk96 <hayko5999@gmail.com>

Author: hayk96

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 0.5.0 / 2024-12-06
+
+* [REFACTOR] Created a `PrometheusAPIClient` class for core API functionalities such as creating/deleting rule files and updating/reloading configurations. Removed a duplicated validation function and moved it to the utils folder. Also Updated the architecture diagram. #53
+* [ENHANCEMENT] Introduced a new web page called Config Management for managing Prometheus configuration through a web interface. This page utilizes the /configs API. #52
+* [ENHANCEMENT] Introduces a new API /configs for Prometheus configuration (prometheus.yml). 
+This API provides three methods: GET, PUT, and PATCH:
+  - Fetch the existing configuration in JSON or YAML format.
+  - Update the entire Prometheus configuration file.
+  - Partially update specific sections of the configuration file. Adds an OpenAPI specification for the prometheus.yml #51
+* [CHANGE] The name of the page API Documentation has been renamed to **API Reference**. Changed server address in API reference page. #50
+
 ## 0.4.2 / 2024-07-05
 
 * [CHANGE] Replaced base64 encoded files in web assets (HTML, CSS) with common images and added a new route for images. 

README.md

@@ -65,8 +65,8 @@ enhances flexibility and automation in monitoring and alerting workflows.
 ### Prerequisites
 
 The following prerequisites are required to get up and running with this tool:
-- The Prometheus server's rules directory must be shared and accessible
-- The Prometheus lifecycle API must be enabled to allow requesting the /reload API
+- Prometheus server's rules directory and configuration file (prometheus.yml) must be shared and accessible
+- Prometheus lifecycle API must be enabled to allow requesting the /reload API
 
 ### Quick Start
 

docs/examples/docker/docker-compose.yml

@@ -18,8 +18,10 @@ services:
     ports:
       - "5000:5000"
     volumes:
+      - "./prometheus.yml:/app/prometheus.yml:rw"
       - "./rules:/app/rules:rw"
     command:
       - --prom.addr=http://prometheus:9090
+      - --config.file=/app/prometheus.yml
       - --rule.path=/app/rules
       - --web.enable-ui=true

docs/images/architecture.png

@@ -10,15 +10,13 @@
 import uvicorn
 import sys
 
-
 args = arg_parser()
-prom_addr, rule_path = args.get("prom.addr"), args.get("rule.path")
 host, port = args.get("web.listen_address").split(":")
 
-if not all([settings.check_rules_directory(rule_path),
-            settings.check_fs_permissions(rule_path),
-            settings.establish_prom_connection(prom_addr),
-            settings.check_reload_api_status(prom_addr)]):
+if not all([settings.check_files_and_directories(),
+            settings.check_fs_permissions(),
+            settings.establish_prom_connection(),
+            settings.check_reload_api_status()]):
     sys.exit()
 
 

main.py

@@ -4,6 +4,7 @@ email-validator==2.0.0
 APScheduler==3.10.4
 pytimeparse2==1.7.1
 jsonschema==4.17.3
+starlette==0.35.1
 requests==2.28.2
 pydantic==1.10.7
 fastapi==0.109.0

requirements.txt

@@ -1,10 +1,11 @@
-from .. v1.endpoints import reverse_proxy, rules, policies, web, health, export
+from .. v1.endpoints import reverse_proxy, rules, policies, web, health, export, configs
 from fastapi import APIRouter
 
 api_router = APIRouter()
 api_router.include_router(rules.router, prefix="/api/v1")
 api_router.include_router(export.router, prefix="/api/v1")
 api_router.include_router(policies.router, prefix="/api/v1")
+api_router.include_router(configs.router, prefix="/api/v1")
 api_router.include_router(web.router, prefix="")
 api_router.include_router(health.router, prefix="")
 api_router.add_route("/{path:path}", reverse_proxy._reverse_proxy, ["GET", "POST", "PUT"])