| garciadeblas | 9cbad10 | 2023-04-05 11:09:19 +0200 | [diff] [blame] | 1 | .. |
| 2 | ####################################################################################### |
| 3 | # Copyright ETSI Contributors and Others. |
| 4 | # |
| 5 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | # you may not use this file except in compliance with the License. |
| 7 | # You may obtain a copy of the License at |
| 8 | # |
| 9 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | # |
| 11 | # Unless required by applicable law or agreed to in writing, software |
| 12 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or |
| 14 | # implied. |
| 15 | # See the License for the specific language governing permissions and |
| 16 | # limitations under the License. |
| 17 | ####################################################################################### |
| 18 | |
| 19 | ================== |
| 20 | webhook-translator |
| 21 | ================== |
| 22 | |
| 23 | webhook-translator is a component in the Service Assurance architecture for OSM. |
| 24 | |
| 25 | Its role is to receive alerts from entities such as Prometheus AlertManager or external systems, and to translate them to a format that can be consumed by Airflow DAGs. It basically receives HTTP POST messages and forwards them to an Airflow webhook |
| 26 | |
| 27 | The main characteristics are: |
| 28 | |
| 29 | * Lightweight: a very small number of lines of code does the work. |
| 30 | * Stateless. It only translates HTTP requests. No state for those translations. When running as a Kubernetes deployment, native scaling is achieved by means of Kubernetes services. |
| 31 | * Simple. Based on `FastAPI <https://fastapi.tiangolo.com/>` |
| 32 | * Independent from the source of the alert. No maintenance is required to incorporate new alert sources. |
| 33 | |