Деплой приложения FastAPI

Чтобы развернуть приложение FastAPI, перейдите в раздел Apps и кликните на кнопку «Создать».

Пример FastAPI-приложения для деплоя можно найти на Гитхабе.

Шаг 1. Выбор приложения

В пункте «Тип» перейдите на вкладку Backend и выберите Python — FastAPI.

Шаг 2. Подключение репозитория

Вы можете подключить репозиторий:

• Из своего аккаунта GitHub, GitLab или BitBucket. Кликните на название платформы, авторизуйтесь и выберите нужный репозиторий. Если вы уже авторизованы, панель сразу покажет доступные репозитории.

• По URL, указав ссылку на репозиторий, созданный на любой платформе. Кликните «Подключите git-репозиторий по URL» (либо «Добавить аккаунт» → «Подключите git-репозиторий по URL») и укажите Git URL репозитория. Если репозиторий приватный, введите реквизиты доступа.

Подробнее о подключении репозиториев — здесь.

Шаг 3. Выбор ветки и коммита

1. Выберите ветку для деплоя.

2. По умолчанию мы включаем опцию «Сборка по последнему выполненному коммиту». В этом случае сервис Apps выполнит деплой по самому актуальному коммиту, а в дальнейшем будет автоматически пересобирать приложение при добавлении новых коммитов в репозиторий. 

При необходимости вы сможете отключить автодеплой в дальнейшем.

Если вы хотите выбрать конкретный коммит вручную — отключите эту опцию.

Шаг 4. Регион и конфигурация сервера

Приложение FastAPI должно быть развернуто на отдельном облачном сервере. Выберите регион размещения сервера и его конфигурацию. 

В дальнейшем, если потребуется, вы сможете перейти на более мощный тариф.

Шаг 5. Настройка параметров сборки

Сервис автоматически определит команду сборки для вашего проекта, поэтому в большинстве случаев этот параметр можно оставить без изменений. Если в проекте есть файл requirements.txt, мы поставим зависимости из него.

В сервисе используется версия Python 3.8. 

Для проекта на FastAPI мы по умолчанию выполним:

apt-get install -y python3 python3-pip gunicorn python3-psycopg2 libpq-dev python-dev default-mysql-client python3-dev default-libmysqlclient-dev python3-mysqldb --fix-missing
pip3 install psycopg2 fastapi uvicorn
ln /usr/bin/python3 /usr/bin/python -sf
ln /usr/bin/pip3 /usr/bin/pip -sf

Также, при наличии файла requirements.txt:

pip3 install --upgrade -r requirements.txt

Если вы понимаете, что вам нужно модифицировать процесс сборки, вы можете указать дополнительную команду сборки. Можно указать несколько команд, разделяя их с помощью &&. Например, если требуется установить определенные драйверы, добавьте в команду сборки:

apt install имя_пакета

При необходимости вы также можете задать переменные. 

В качестве команды запуска по умолчанию будет использоваться:

uvicorn main:app --host 0.0.0.0

Для корректного запуска может потребоваться отредактировать команду под ваш проект, задав порт:

uvicorn main:app --host 0.0.0.0 --port 80

Также убедитесь, что основной файл проекта называется main.py.

У вас будет возможность внести изменения в любые из этих параметров в дальнейшем и перезапустить деплой с новыми настройками, если потребуется.

Шаг 6. Информация о приложении

Задайте свое имя приложения, если требуется, и комментарий к нему. Это данные, которые будут отображаться в панели управления.

Также выберите, в какой проект его нужно добавить.

Эти настройки также можно изменить в дальнейшем.

Шаг 7. Деплой

Нажмите «Запустить деплой». Как только процесс начнется, вы увидите лог деплоя на вкладке «Деплой».

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

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

Готово! Ваш проект развернут и готов к работе.

В дальнейшем Apps будет отслеживать обновления в репозитории и, если включен автодеплой, автоматически перезапускать проект с новыми изменениями.

IP-адрес приложения и бесплатный технический домен, привязанный к нему по умолчанию, можно найти на вкладе «Дашборд». Привязать собственный домен можно по нашей инструкции.

Приложение будет доступно по 443 порту; порт 80 также открыт.