Added readme (#5)

* Added readme

* Added control-center to scheme

Co-authored-by: Inal Arsanukaev <aiz@empayre.com>
This commit is contained in:
Inal Arsanukaev 2022-06-28 13:58:36 +03:00 committed by GitHub
parent 93a7126f47
commit 353d0f7975
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 29 additions and 6 deletions

View File

@ -1,11 +1,26 @@
# repairer
## Описание
Сервис для восстановления упавших машин.
Читает топик кафки с упавшими машинами, имеет три ручки для массового восстановления машин:
инвойсов, выплат(withdrawal_session) и repair машин непосредственно в машингане.
Эти ручки редиректят в соответствующие вызовы repair на интерфейсе hellgate, fistful или machinegun.
Читает топик кафки с упавшими машинами, сохраняет их базу данных.
Имеет три ручки для массового восстановления машин:
инвойсов, выплат(withdrawal_session) и восстановление машин непосредственно в машингане.
Эти ручки редиректят в соответствующие вызовы **repair** на интерфейсах **hellgate**, **fistful** или **machinegun**.
Вызовы выполняются массово и в асинхронном режиме. Для запущенных к восстановлению машин предусмотрен
специальный статус in_progress, означащий, что машина в процессе восстановления.
Финальным статусом является repaired или же машина может снова вернуться в статус failed
специальный статус **in_progress**, означащий, что машина в процессе восстановления.
Финальным статусом является **repaired**, или же машина может снова вернуться в статус **failed**
в случае неуспешного восстановления.
Протокол https://github.com/valitydev/repairer-proto
Имеет ручку поиска машин (search).
## Протокол
Сервис имплементирует протокол https://github.com/valitydev/repairer-proto
По этому протоколу сервис вызывается админкой **control-center**, в которой реализован визуальный интерфейс для отображения упавших машин и кнопки для их восстановления.
## Чтение из кафки и сохранение в базу данных postgres
![repairer-kafka](doc/repairer-kafka.svg)
## Восстановление машин
![repairer-repair](doc/repairer-repair.svg)

4
doc/repairer-kafka.svg Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 24 KiB

4
doc/repairer-repair.svg Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 19 KiB