Skip to content

Latest commit

 

History

History
217 lines (161 loc) · 10.6 KB

README.ru.md

File metadata and controls

217 lines (161 loc) · 10.6 KB

Open vAIR

🌍 Переводы

📖 Описание проекта

Open vAIR — это облегченное решение на основе проекта vAIR, предназначенное для использования в качестве среды разработки и системы виртуализации. Программа функционирует в интерактивном режиме, предоставляя гибкий и удобный инструмент для управления виртуальной инфраструктурой.

Python FastAPI Linux Ubuntu Docker RabbitMQ Postgres

Технологии:

docker linux postgresql python rabbitMQ fastapi qemu

📦 Установка

Для установки Open vAIR на чистую систему с операционной системой Linux выполните следующие действия. Рекомендуется использовать Ubuntu 20.04, которая наиболее протестирована. Также поддерживается Ubuntu 22.04.

☑️ Подготовка к установке проекта

  1. Убедитесь, что все системные пакеты обновлены. Для этого выполните следующие команды:

    sudo apt update && sudo apt upgrade -y

    Важно: Не забудьте перезагрузить систему после выполнения команд для применения всех изменений.

  2. Выполните следующие команды для создания и настройки пользователя:

    1. Создайте пользователя:

      sudo useradd -s /bin/bash -d /opt/aero -m aero

    2. Назначьте необходимые права:

      sudo chmod +x /opt/aero

    3. Добавьте пользователя в список суперпользователей:

      echo "aero ALL=(ALL) NOPASSWD: ALL" | sudo tee /etc/sudoers.d/aero

    4. Переключитесь на нового пользователя:

      sudo -u aero -i

  3. Скачайте репозиторий проекта:

    # GitHub
git clone https://github.com/Aerodisk/openvair.git

# GitFlic
git clone https://gitflic.ru/project/aerodisk_open_vair/openvair.git

# GitVerse
git clone https://gitverse.ru/Aerodisk/openvair.git

# GitLab
git clone https://git.aerodisk.ru/openvair/openvair.git

  4. Настройте конфигурационный файл:

    vi ~/openvair/project_config.toml

⚙️ Настройка проекта

Перед установкой Open vAIR необходимо задать логин и пароль в файле /opt/aero/openvair/project_config.toml. Эти данные требуются для авторизации в системе и доступа ко всем функциям приложения.

Пример конфигурации:

[default_user]
login = ''
password = ''

Примечание: Поля логина и пароля обязательно должны быть заполнены пользователем. В противном случае установка будет прервана.

🌀 Туннелирование приложения

Если приложение необходимо запускать на отдельном хосте в качестве сервера, настройте туннелирование в виртуальную сеть. Определите локальный IP-адрес хоста, выполнив команду:

ip a

Укажите полученный IP-адрес в конфигурационном файле:

[web_app]
host = '192.168.1.2'
port = 8000

🚀 Запуск установки

  1. Запустите скрипт установки:
./openvair/install.sh

По завершении установки вы получите сообщение с текущим адресом приложения, логином и паролем для работы с системой.

🗑️ Деинсталляция

Для удаления Open vAIR выполните скрипт деинсталляции:

./openvair/uninstall.sh

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

Документацию можно найти в файле /docs/build/index.html, который будет создан после установки проекта. Также документация доступна по эндпоинту /docs/ после завершения установки.

😈 Демоны

Демон приложения web-app

Демон web-app обеспечивает автоматический запуск и перезапуск основного приложения на базе FastAPI, которое отвечает за работу API и GUI. Доступ к приложению осуществляется по адресу, указанному в секции web_app файла configtoml. По умолчанию это http://127.0.0.1:8000.

  • Проверка состояния демона:
sudo systemctl status web-app.service
  • Перезапуск демона:
sudo systemctl restart web-app.service
  • Остановка демона:
sudo systemctl stop web-app.service
  • Просмотр логов демона:
sudo journalctl -fu web-app.service

Демон service-layer

Демоны service-layer выполняют удаленные вызовы функций сервисного слоя. Каждый модуль имеет свой собственный демон service-layer. Для проверки статуса и просмотра логов используйте аналогичные команды, изменив название сервиса на <module_name>-service-layer.service.

Например:

sudo systemctl status storage-service-layer.service

Демон domain

Демоны domain выполняют удаленные вызовы функций слоя доменной области. Для каждого модуля существует свой демон domain. Для проверки статуса и просмотра логов используйте аналогичные команды, изменив название сервиса на <module_name>-domain.service.

sudo systemctl status storage-domain.service

🔗 Ссылки на документацию

🔗 Frontend проекта

  • Для работы с интерфейсом пользователя (Frontend) используйте репозиторий Open vAIR UI.

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

  • Для работы с документацией проекта используйте репозиторий Open vAIR docs.

🔗 Полезные ссылки

Статистика (включая проекты документации и frontend)

aerodisk

 aerodisk

Вклад

Инструкции по внесению вклада в проект:

  1. Форкните репозиторий
  2. Создайте новую ветку (git checkout -b feature/ваша-фича)
  3. Внесите изменения и закоммитьте (git commit -m 'Добавил новую фичу')
  4. Запушьте изменения (git push origin feature/ваша-фича)
  5. Создайте Pull Request