Видео демонстрация

summus

summus - от лат. высочайний, верховный

Что это?

Телеграм бот для работы с SberCloud. Позволяет управлять виртуальными машинами, хранилищами, сетями, образами и прочими сущностями, предоставляемыми SberCloud.

Установка и запуск

Переменные окружения

• TOKEN - токен Telegram бота

Docker

docker-compose up

Standalone

pip3 install -r requirements.txt

python3 -m src

Поддерживаемые сервисы

• Elastic Cloud Server
• Enterprise Management
• NAT Gateway
• Virtual Private Cloud
• Subnet
• Image Management Service
• Cloud Eye

Roadmap

• Создать минимального бота с базовыми возможностями управления ресурсами:
• • ECS
• • EPS
• • NAT
• • VPC
• • IMS
• • Subnet
• • CEM
• Написать несколько тестов, которые покроют базовые аспекты работы бота

---

• Покрыть ботом больше сервисов SberCloud
• Сделать более удобную систему авторизации
• Сделать более user-friendly интерфейс (предоставлять опцию выбора ресурса из имеющихся, когда есть возможность)

Требования

Функциональные

• Можно создавать, редактировать, удалять как минимум пять типов ресурсов.
• Можно получать информацию о доступных конфигурациях ресуров.
• Выгрузка отчёта по всем потребляемым ресурсам.
• Возможность получить сгенерированный терраформ-код для ресурса вместо создания.
• Есть мониторинг ресурса.

Нефункциональные

• Использован SDK.
• Авторизация с возможностью контроля прав доступа и грамотная обработка отсутствия у бота прав.
• Несложно добавить поддержку нового сервиса.
• Код покрыт тестами.

Документация

Как добавлять новые модули?

Модуль работает с запросами к SDK через библиотеку aiogram. Чтобы написать новый модуль необходимо выбрать сервис (неожиданно), который имеет Endpoint и соответственно SDK HuaweiCloud (SDK HuaweiCloud совместим с SberCloud). Используя примеры кода, которые предлагается в SDK, репозитории SDK и в уже реализованных модулях, несложно написать новый модуль.

Пример модуля (этот модуль не взаимодействует с HuaweiCloud)

Файл: src/modules/<MODULE_SHORT_NAME_LOWERCASE>.py

from enum import Enum

from aiogram import F, Router, types
from aiogram.types.callback_query import CallbackQuery
from aiogram.utils.keyboard import InlineKeyboardBuilder, InlineKeyboardMarkup
from aiogram.filters.callback_data import CallbackData
from aiogram.filters.state import StatesGroup, State
from aiogram.fsm.context import FSMContext

from src.module import Module
from src.utils import add_exit_button


# Объявление модуля
<MODULE_SHORT_NAME> = Module(
    name='<MODULE_PRETTY_NAME>',
    router=Router(name='<MODULE_SHORT_NAME>')
)

# Список действий модуля
class Action(str, Enum):
    CREATE = 'create'
    LIST = 'list'
    SHOW = 'show'
    <CUSTOM_ACTION> = '<CUSTOM_PRETTY_ACTION>'

class <MODULE_SHORT_NAME>Callback(CallbackData, prefix='<MODULE_SHORT_NAME>'):
    action: Action

def keyboard() -> InlineKeyboardMarkup:
    builder = InlineKeyboardBuilder()

    for action in Action:
        builder.button(
            text=action.value.title(),
            callback_data=<MODULE_SHORT_NAME>Callback(action=action.value),
        )

    add_exit_button(builder)
    builder.adjust(2)

    return builder.as_markup()

# Действие модуля
@<MODULE_SHORT_NAME>.router.callback_query(<MODULE_SHORT_NAME>Callback.filter(F.action == Action.<CUSTOM_ACTION>))
async def CUSTOM_ACTION(call: CallbackQuery, state: FSMContext):
    await call.message.answer('Hello, world!')
    await call.answer()

Файл: src/modules/__init__.py

from .vpc import VPC
from .eps import EPS
from .subnet import SUBNET
from .nat import NAT
from .ecs import ECS
from .<MODULE_SHORT_NAME_LOWERCASE> import <MODULE_SHORT_NAME>

modules = (EPS, VPC, SUBNET, NAT, ECS, <MODULE_SHORT_NAME>)

Итог:

Пример взаимодействия с SDK см. в src/modules

Тестирование

Для тестирования проекта используются библиотеки pytest

Переменные окружения для тестирования

• TOKEN - токен Telegram бота
• AK - Access Key Id
• SK - Secret Access Key
• PROJECT_ID
• ACCOUNT_ID

pytest src/test.py

---

К проекту приложили руки

• beshenkaD
• ktp0li
• ivabus

Лицензия

Проект лицензируется под GNU GPLv3.