Поделиться через

Обзор шаблонов Python web azd

Шаблоны интерфейса командной строкиazd для разработчиков Python — это самый быстрый и простой способ создания, настройки и развертывания веб-приложений Python в Azure. В этой статье содержатся контекстные фоновые сведения, которые помогут вам понять компоненты, участвующие в развертывании, и как шаблоны упрощают развертывание.

Лучший способ начать — следовать краткому руководству по созданию первого веб-приложения Python и его развертыванию в Azure в минутах с azd помощью шаблонов. Если вы предпочитаете не настраивать локальную среду разработки, следуйте краткому руководству с помощью GitHub Codespaces для полного облачного взаимодействия со всеми предварительно настроенными средствами.

Что такое шаблоны Python web azd?

azd Шаблоны предназначены для опытных веб-разработчиков Python, которые хотят развернуть масштабируемые облачные приложения в Azure с минимальным временем установки.

Эти шаблоны предлагают простую отправную точку для создания и развертывания веб-приложений Python по следующим причинам:

  • Быстро настройте полную локальную среду разработки и размещения.
  • Автоматизация создания соответствующей среды развертывания Azure.
  • Использование простого и запоминающегося рабочего процесса CLI.

После настройки сред шаблоны предоставляют самый быстрый способ начать создание веб-приложения Python. Вы можете:

  • Измените предоставленные файлы кода в соответствии с требованиями приложения.
  • Развертывание обновлений с минимальными усилиями с помощью команд azd.
  • Расширьте шаблон, чтобы соответствовать архитектуре.

Эти шаблоны отражают проверенные шаблоны и рекомендации по проектированию, что позволяет выполнять следующие действия:

  • Стройте уверенно на прочной архитектурной основе.
  • Следуйте рекомендациям, разработанным отраслевыми экспертами с глубоким опытом работы в Python и Azure.
  • Обеспечение удобства обслуживания, масштабируемости и безопасности с самого начала.

Какие задачи можно выполнять с шаблонами?

При запуске веб-шаблона azd Python можно быстро выполнить несколько задач:

  • Создание начального приложения. Вы создаете веб-сайт для вымышленной компании с именем Relecloud. Этот начальный проект включает:

    • Хорошо упорядоченный, готовый к работе код
    • Рекомендации по веб-платформам Python (например, Flask, Django).
    • Правильное использование зависимостей, конфигурации и структуры.

    Шаблон предназначен для начальной точки— вы можете свободно настроить логику и развернуть или удалить ресурсы Azure для соответствия проекту.

  • Подготовка ресурсов Azure. Используя Bicep, современный язык инфраструктуры как кода (IaC), шаблон подготавливает все необходимые ресурсы Azure для:

    • Размещение веб-приложения (например, служба приложений, контейнерные приложения)
    • Подключение к базам данных (например, PostgreSQL, Cosmos DB)

    Файлы Bicep полностью редактируются— вы можете добавлять или настраивать службы Azure по мере развития приложения. Как и в предыдущей задаче, можно изменить шаблоны Bicep , чтобы добавить дополнительные службы Azure по мере необходимости.

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

    • Ваше приложение начнет работать в облаке всего за несколько минут.
    • Проверьте его поведение.
    • Определите, какие функции или конфигурацию необходимо обновить далее.

  • (Необязательно) Настройте репозиторий GitHub и конвейер CI/CD. При желании можно инициализировать репозиторий GitHub с GitHub Actions и конвейером непрерывной интеграции и непрерывной доставки (CI/CD), чтобы:

    • Автоматизация развертываний при изменениях кода.
    • Совместная работа с участниками команды.
    • Отправка обновлений в Azure путем объединения в основную ветвь.

    Эта интеграция поможет вам внедрить рекомендации DevOps с самого начала.

Где можно получить доступ к шаблонам?

Многие azd шаблоны доступны в галерее потрясающих шаблонов CLI для разработчиков Azure. Эти шаблоны предоставляют готовые к использованию проекты веб-приложения Python с четностью функций в популярных сочетаниях служб Azure и веб-платформ Python.

Каждый шаблон включает:

  • Пример приложения с чистым, поддерживаемым кодом.
  • Предварительно настроенная инфраструктура как код с помощью Bicep.
  • Рабочие процессы плавного развертывания с использованием Azure Developer CLI.
  • Опциональная интеграция CI/CD с помощью GitHub Actions

В следующих таблицах перечислены моникеры веб-шаблона azd Python, доступные для использования с командой azd init . Таблицы определяют технологии, реализованные в каждом шаблоне, и предоставляют ссылку на соответствующий репозиторий GitHub, где можно внести изменения.

Для веб-платформы Django доступны следующие azd шаблоны.

Шаблон База данных Платформа размещения репозиторий GitHub
azure-django-postgres-flexible-aca Гибкий сервер Базы данных Azure для PostgreSQL Приложения контейнеров Azure https://github.com/Azure-Samples/azure-django-postgres-flexible-aca
azure-django-postgres-flexible-appservice Гибкий сервер Базы данных Azure для PostgreSQL Служба приложений Azure https://github.com/Azure-Samples/azure-django-postgres-flexible-appservice
azure-django-cosmos-postgres-aca Azure Cosmos DB для Базы данных Azure для PostgreSQL Приложения контейнеров Azure https://github.com/Azure-Samples/azure-django-cosmos-postgres-aca
azure-django-cosmos-postgres-appservice Azure Cosmos DB для Базы данных Azure для PostgreSQL Служба приложений Azure https://github.com/Azure-Samples/azure-django-cosmos-postgres-appservice
azure-django-postgres-addon-aca Приложения контейнеров Azure с базой данных Azure для PostgreSQL Приложения контейнеров Azure https://github.com/Azure-Samples/azure-django-postgres-addon-aca

Как использовать шаблоны?

Каждый azd шаблон состоит из репозитория GitHub, содержащего код приложения (код Python, который использует популярную веб-платформу) и файлы инфраструктуры как кода (а именно Bicep) для создания ресурсов Azure. Шаблон также содержит конфигурацию, необходимую для настройки репозитория GitHub с конвейером CI/CD.

Ключевые компоненты каждого шаблона:

  • Код приложения: написан на Python и построен с помощью популярной веб-платформы (например, Flask, Django, FastAPI). Пример приложения демонстрирует рекомендации по маршрутизации, доступу к данным и настройке.

  • Infrastructure-as-Code (IaC): предоставляется через файлы Bicep для определения и подготовки необходимых ресурсов Azure, таких как:

    • Служба приложений или приложения-контейнеры
    • Базы данных Azure (например, PostgreSQL, Cosmos DB)
    • Службы ИИ Azure, хранилище и многое другое

  • Конфигурация CI/CD (необязательно): включает файлы для настройки репозитория GitHub с конвейером CI/CD GitHub Actions, что позволяет:

    • Автоматическое развертывание в Azure при каждой операции push или pull request в основную ветвь.
    • Простая интеграция с рабочим процессом DevOps

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

Для выполнения задач, определенных веб-шаблоном azd , используйте различные команды Python azd . Подробные описания этих команд см. в кратком руководстве: Развертывание шаблона интерфейса командной строки разработчика Azure. В кратком руководстве описаны действия по использованию определенного azd шаблона. Вам нужно выполнить только пять основных инструкций командной строки в рабочей среде и локальной среде разработки.

В следующей таблице приведены пять основных команд:

командование Описание задачи
azd init --template <template name> Создайте проект из шаблона и создайте копию кода приложения на локальном компьютере. Команда запрашивает указание имени среды (например, «myapp»), которое используется в качестве префикса при именовании развернутых ресурсов.
azd auth login Войдите в Azure. Команда открывает окно браузера, в котором можно войти в Azure. После входа окно браузера закрывается и команда завершается. Эта azd auth login команда требуется только при первом использовании интерфейса командной строки разработчика Azure (azd) для каждого сеанса.
azd up Подготовьте облачные ресурсы и разверните приложение на этих ресурсах.
azd deploy Разверните изменения в исходном коде приложения на ресурсы, уже предоставленные командой azd up.
azd down Удалите ресурсы Azure и конвейер CI/CD, если он использовался.

Подсказка

При работе с azd командами просмотрите запросы на ввод дополнительных сведений. После выполнения azd up команды может потребоваться выбрать подписку, если у вас несколько. Вам также может быть предложено указать регион. Вы можете изменить ответы на запросы, изменив переменные среды, хранящиеся в папке /.azure/ шаблона.

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

  • Код приложения: настройте код проекта Python для реализации собственной разработки, маршрутов и бизнес-логики.
  • Инфраструктура как код (Bicep): обновите файлы Bicep, чтобы подготовить дополнительные службы Azure, изменить конфигурации или удалить ненужные ресурсы.

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

Вы также можете изменить конфигурацию инфраструктуры как кода, если необходимо изменить ресурсы Azure. Дополнительные сведения см. в разделе "Что можно изменить или удалить " далее в этой статье.

Необязательные задачи шаблона

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

Повторное создание и изменение ресурсов Azure

После развертывания ресурсов Azure с помощью azd шаблона, вы можете изменить и повторно развернуть ресурс.

Настройка конвейера CI/CD

Интерфейс командной строки разработчика Azure (azd) предоставляет простой способ настройки конвейера CI/CD для нового веб-приложения Python. При объединении коммитов или пулл реквестов в основную ветвь пайплайн автоматически собирает и публикует изменения для ресурсов Azure.

  • Чтобы настроить конвейер CI/CD, необходимо указать репозиторий GitHub и необходимые параметры для включения конвейера.
  • Чтобы создать конвейер, используйте azd pipeline config команду.

После настройки конвейера каждый раз, когда изменения кода объединяются в основную ветвь репозитория, конвейер развертывает изменения в подготовленных службах Azure.

Альтернативы шаблонам

Если вы предпочитаете не использовать веб-шаблоны Python, существуют альтернативные методы развертывания веб-приложений azd Python в Azure и подготовки ресурсов Azure.

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

Вы также можете следовать комплексному руководству по использованию платформ веб-разработки Python:

Часто задаваемые вопросы

В следующих разделах приведены ответы на часто задаваемые вопросы о работе с веб-шаблонами azd Python.

Нужно ли использовать контейнеры разработки?

Нет. Веб-шаблоны azd Python используют контейнеры разработки Visual Studio Code по умолчанию. Контейнеры разработки предоставляют множество преимуществ, но требуют некоторых необходимых знаний и программного обеспечения. Если вы предпочитаете не использовать контейнеры разработки и вместо этого используете локальную среду разработки, ознакомьтесь с файлом README.md в корневом каталоге примера приложения для инструкций по настройке среды.

Что можно изменить или удалить?

Содержимое каждого веб-шаблона azd Python может отличаться в зависимости от типа проекта и используемого базового стека технологий. Шаблоны, определенные в этой статье, соответствуют общему соглашению о папке и файле, как описано в следующей таблице.

Папки и файлы Цель Описание
/ Корневой каталог Корневая папка для каждого шаблона содержит множество различных типов файлов и папок для разных целей.
/.лазурный azd Файлы конфигурации Папка .azure создается после выполнения azd init команды. Папка хранит файлы конфигурации для переменных среды, используемых azd командами. Можно изменить значения переменных среды, чтобы настроить приложение и ресурсы Azure. Дополнительные сведения см. в .env-файле, специфичном для среды.
/.devcontainer Файлы конфигурации контейнера разработки Контейнеры разработки позволяют создавать среду разработки на основе контейнеров вместе со всеми ресурсами, необходимыми для разработки программного обеспечения в Visual Studio Code. Папка devcontainer создается после того, как Visual Studio Code создает файл конфигурации контейнера разработки в ответ на команду шаблона.
/.github Файлы конфигурации GitHub Actions Эта папка содержит параметры конфигурации для необязательного конвейера CI/CD GitHub Actions, линтинга и тестов. Если вы не хотите настроить конвейер GitHub Actions с помощью azd pipeline config команды, можно изменить или удалить файл azure-dev.yaml .
/infra Файлы Bicep В папке infra хранятся файлы конфигурации Bicep. Bicep позволяет объявить ресурсы Azure, которые вы хотите развернуть в вашей среде. Необходимо изменить только файлы main.bicep и web.bicep . Дополнительные сведения см. в кратком руководстве: Масштабирование служб, развернутых с помощью веб-шаблонов Azd Python с помощью Bicep.
/src Файлы кода начального проекта Папка src содержит различные файлы кода, необходимые для подготовки начального проекта. Примеры файлов включают шаблоны, необходимые для веб-платформы, статических файлов, файлов Python (.py) для модели кода и данных, файлаrequirements.txt и т. д. Конкретные файлы зависят от веб-платформы, платформы доступа к данным и т. д. Эти файлы можно изменить в соответствии с требованиями проекта.
/.cruft.json Файл создания шаблона Файл JSON cruft используется для внутреннего создания веб-шаблонов Python azd. Этот файл можно безопасно удалить по мере необходимости.
/.gitattributes Файл с параметрами атрибута для Git Этот файл снабжает git важными настройками конфигурации для обработки файлов и папок. Этот файл можно изменить по мере необходимости.
/.gitignore Файл с пропущенными элементами для Git Файл .gitignore сообщает git о файлах и папках, которые следует исключить (игнорировать) при записи в репозиторий GitHub для шаблона. Этот файл можно изменить по мере необходимости.
/azure.yaml azd up файл конфигурации Этот файл конфигурации содержит параметры конфигурации для azd up команды. Он указывает службы и папки проекта для развертывания. Важно. Этот файл не должен быть удален.
/*.md Файлы формата Markdown Шаблон может включать различные файлы форматирования Markdown (MD) для различных целей. Вы можете безопасно удалить файлы Markdown.
/docker-compose.yml Настройки Docker Compose Этот файл YML создает пакет контейнера для веб-приложения Python перед развертыванием приложения в Azure.
/pyproject.toml Файл параметров сборки Python Файл TOML содержит требования к системе сборки проектов Python. Вы можете изменить этот файл, чтобы задать ваши предпочтения в инструментах, например, указав определенный линтер или фреймворк для модульного тестирования.
/requirements-dev.in Файл требований pip Этот файл используется для создания версии среды разработки требований с помощью pip install -r команды. Этот файл можно изменить, чтобы включить другие пакеты по мере необходимости.

Подсказка

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

Как обрабатывать ошибки шаблона?

Если при использовании шаблона возникает ошибка, ознакомьтесь с параметрами, описанными в статье "Устранение неполадок с интерфейсом команднойazd строки разработчика Azure". Вы также можете сообщать о проблемах в репозитории GitHub, связанном с шаблоном azd .

Связанный контент

  • Last updated on