Vue d’ensemble des modèles Web azd Python

  • Article

Les modèles AZURE Developer CLI (azd) web Python constituent le moyen le plus rapide et le plus simple de commencer à créer et déployer des applications web Python sur Azure. Cet article fournit des informations contextuelles sur l’arrière-plan à mesure que vous démarrez.

La meilleure façon de commencer consiste à suivre le guide de démarrage rapide pour créer votre première application web Python et la déployer dans Azure en quelques minutes avec des azd modèles. Si vous ne souhaitez pas configurer un environnement de développement local, vous pouvez toujours suivre le guide de démarrage rapide à l’aide de GitHub Codespaces à la place.

Quels sont les modèles azd web Python ?

Il existe de nombreux azd modèles disponibles dans la galerie de modèles AZD impressionnants. Toutefois, cette collection de modèles web azd Python est unique, car elles fournissent un exemple d’application web avec une parité de fonctionnalités entre de nombreuses combinaisons populaires de ressources Azure et de frameworks web Python.

Lorsque vous exécutez un modèle web azd Python, vous allez :

  • Créer une application de démarrage - Plus précisément, un site web pour une société fictive nommée Relecloud. Le code du projet présente de nombreuses bonnes pratiques pour les frameworks et packages Python donnés requis pour cette pile de technologies particulière. Le modèle est destiné à être un point de départ pour votre application. Vous ajoutez ou supprimez la logique d’application et les ressources Azure en fonction des besoins.
  • Provisionner des ressources Azure : le modèle provisionne des ressources Azure pour l’hébergement de votre application web et de votre base de données à l’aide de Bicep, un outil d’infrastructure en tant que code populaire. Là encore, vous modifiez les modèles Bicep si vous devez ajouter d’autres services Azure.
  • Déployez l’application de démarrage sur les ressources Azure nouvellement approvisionnées : l’application de démarrage est automatiquement déployée afin de pouvoir la voir en quelques minutes et décider de ce que vous souhaitez modifier.
  • Facultatif : Configurez un dépôt GitHub et un pipeline CI/CD . Si vous le souhaitez, le modèle contient la logique permettant de configurer un dépôt GitHub pour vous, y compris un pipeline CI/CD GitHub Actions. En quelques minutes, vous pouvez apporter des modifications au code du projet web. Lorsque vous fusionnez ces modifications vers la branche principale de votre dépôt GitHub, le pipeline CI/CD les publie dans votre nouvel environnement d’hébergement Azure.

À qui cette fonctionnalité est-elle destinée ?

Les modèles sont destinés à être utilisés par les développeurs web Python expérimentés qui souhaitent commencer à créer une nouvelle application web Python ciblant le déploiement Azure.

Pourquoi voudrais-je l’utiliser ?

L’utilisation des azd modèles offre plusieurs avantages :

  • Démarrage le plus rapide possible : avec votre environnement de développement local et les configurations d’environnement d’hébergement, vous pouvez vous concentrer sur la création de votre application en quelques minutes.
  • Démarrage le plus simple possible : exécutez seulement quelques instructions de ligne de commande pour générer un environnement de développement local, d’hébergement et de déploiement entier. Le flux de travail est facile à utiliser et facile à mémoriser.
  • Reposez sur les meilleures pratiques : chaque modèle est créé et géré par Python sur les anciens combattants du secteur Azure. Ajoutez votre code en suivant leurs approches de conception pour s’appuyer sur une base solide.

Index des modèles

Le tableau suivant répertorie les monikers de modèle web azd Python disponibles à utiliser avec la azd init commande, les technologies implémentées dans chaque modèle et un lien vers le dépôt GitHub si vous souhaitez apporter des modifications.

Modèle Web Framework Base de données Plateforme d’hébergement Dépôt GitHub
azure-django-postgres-flexible-aca Django Serveur flexible PostgreSQL Azure Container Apps référentiel
azure-django-postgres-flexible-appservice Django Serveur flexible PostgreSQL Azure App Service référentiel
azure-django-cosmos-postgres-aca Django Cosmos DB (adaptateur PostgreSQL) Azure Container Apps référentiel
azure-django-cosmos-postgres-appservice Django Cosmos DB (adaptateur PostgreSQL) Azure App Service référentiel
azure-django-postgres-addon-aca Django Module complémentaire PostgreSQL Azure Container Apps Azure Container Apps référentiel

Comment fonctionnent les modèles ?

Vous utilisez différentes azd commandes pour effectuer des tâches définies par un azd modèle. Ces commandes sont décrites en détail dans Prise en main d’Azure Developer CLI.

Le azd modèle comprend un référentiel GitHub contenant le code d’application (code Python utilisant une infrastructure web populaire) et les fichiers infrastructure-as-code (à savoir Bicep) pour créer les ressources Azure. Il contient également la configuration requise pour configurer un dépôt GitHub avec un pipeline CI/CD.

Le guide de démarrage rapide vous guide tout au long des étapes permettant d’utiliser un modèle spécifique azd . Il vous suffit d’exécuter cinq instructions de ligne de commande pour l’environnement d’hébergement de production et l’environnement de développement local :

  1. azd init --template <template name> - crée un projet à partir d’un modèle et crée une copie du code d’application sur votre ordinateur local. La commande vous invite à fournir un nom d’environnement (tel que « myapp ») utilisé comme préfixe dans le nommage des ressources déployées.
  2. azd auth login - vous connecte à Azure. La commande ouvre une fenêtre de navigateur dans laquelle vous pouvez vous connecter à Azure. Une fois connecté, la fenêtre du navigateur se ferme et la commande se termine. La azd auth login commande n’est requise que la première fois que vous utilisez Azure Developer CLI (azd) par session.
  3. azd up - provisionne les ressources cloud et déploie l’application sur ces ressources.
  4. azd deploy - déploie les modifications apportées au code source de l’application sur les ressources déjà approvisionnées par azd up.
  5. azd down : supprime les ressources Azure et le pipeline CI/CD s’il a été utilisé.

Conseil

Regardez la sortie des azd invites auxquelles vous devez répondre. Par exemple, après avoir exécuté la azd up commande, vous pouvez être invité à sélectionner un abonnement si vous appartenez à plusieurs. En outre, vous serez invité à sélectionner une région. Vous pouvez modifier les réponses aux invites en modifiant les variables d’environnement stockées dans le dossier /.azure/ du modèle.

Une fois le modèle terminé, vous disposez d’une copie personnelle du modèle d’origine où vous pouvez modifier chaque fichier en fonction des besoins. Au minimum, vous pouvez modifier le code du projet Python afin que le projet ait votre logique de conception et d’application. Vous pouvez également modifier la configuration d’infrastructure en tant que code si vous devez modifier les ressources Azure. Consultez la section intitulée Que puis-je modifier ou supprimer ?

Facultatif : Modifier et reprovisionner des ressources Azure

Si vous souhaitez modifier les ressources Azure approvisionnées, vous pouvez modifier les fichiers Bicep appropriés dans le modèle et l’utiliser :

  1. azd provision - réprovisionne les ressources Azure à l’état souhaité tel que défini dans les fichiers Bicep.

Configurer un pipeline CI/CD

Azure Developer CLI (azd) offre un moyen simple de configurer un pipeline CI/CD pour votre nouvelle application web Python. Chaque fois que vous fusionnez des validations ou des demandes de tirage dans votre branche principale, le pipeline CI/CD génère et publie automatiquement vos modifications dans vos ressources Azure.

Facultatif : configurer automatiquement le pipeline CI/CD GitHub Actions

Si vous souhaitez implémenter la fonctionnalité de pipeline CI/CD GitHub Actions, utilisez la commande suivante :

  1. azd pipeline config : vous permet de désigner un référentiel Et des paramètres GitHub pour activer le pipeline CI\CD. Une fois configuré, chaque fois que les modifications de code sont fusionnées vers la branche principale du référentiel, le pipeline déploie les modifications apportées à vos services Azure provisionnés.

Quelles sont mes autres options ?

Si vous ne souhaitez pas utiliser azd de modèles, vous pouvez déployer votre application Python sur Azure et créer des ressources Azure de plusieurs façons.

Vous pouvez effectuer de nombreuses étapes de création et de déploiement de ressources à l’aide de l’un des outils suivants :

Ou si vous recherchez un didacticiel de bout en bout qui propose des infrastructures de développement web Python, case activée out :

Dois-je utiliser dev Containers ?

Non. Les modèles web azd Python utilisent les conteneurs de développement par défaut. Les conteneurs de développement offrent de nombreux avantages, mais nécessitent des connaissances et des logiciels requis. Si vous ne souhaitez pas utiliser les conteneurs de développement et que vous préférez utiliser votre environnement de développement local à la place, consultez le fichier README.md dans le répertoire racine de l’exemple d’application pour obtenir des instructions de configuration de l’environnement.

Que puis-je modifier ou supprimer ?

Le contenu de chaque azd modèle peut varier en fonction du type de projet et de la pile technologique sous-jacente utilisée. Les modèles répertoriés dans cet article suivent une convention commune :

Dossier/fichiers Objectif Description
/ répertoire racine Le répertoire racine contient de nombreux types différents de fichiers et de dossiers à de nombreuses fins différentes.
/.Azure fichiers de configuration azd Contient les variables d’environnement utilisées par les commandes AZURE Developer CLI (azd). Ce dossier est créé après avoir exécuté la azd init commande. Vous pouvez modifier les valeurs des variables d’environnement pour personnaliser l’application et les ressources Azure. Pour plus d’informations, consultez le fichier .env spécifique à l’environnement.
/.devcontainer Fichiers de configuration du conteneur de développement Les conteneurs de développement vous permettent de créer un environnement de développement basé sur des conteneurs avec toutes les ressources dont vous avez besoin pour le développement logiciel à l’intérieur de Visual Studio Code.
.github/ Configuration de GitHub Actions Contient les paramètres de configuration pour le pipeline CI/CD GitHub Actions facultatif, ainsi que le linting et les tests. Le fichier azure-dev.yaml peut être modifié ou supprimé si vous ne souhaitez pas configurer le pipeline GitHub Actions à l’aide azd pipeline config de la commande.
/Infra Fichiers Bicep Bicep vous permet de déclarer les ressources Azure que vous souhaitez déployer dans votre environnement. Vous devez uniquement modifier les fichiers main.bicep et web.bicep . Consultez démarrage rapide : Mise à l’échelle des services déployés avec les modèles web Python à l’aide azd de Bicep.
src/ fichiers de code de projet de démarrage Inclut tous les modèles requis par l’infrastructure web, les fichiers statiques, les fichiers .py pour la logique de code et les modèles de données, un requirements.txt, et ainsi de suite. Les fichiers spécifiques dépendent du framework web, de l’infrastructure d’accès aux données, et ainsi de suite. Vous pouvez modifier ces fichiers en fonction des besoins de votre projet.
/.cruft.json fichier de génération de modèle Utilisé en interne pour générer les azd modèles. Vous pouvez supprimer ce fichier en toute sécurité.
/.gitattributes attributs git Fournit git avec une configuration importante sur la gestion des fichiers et des dossiers. Vous pouvez modifier ce fichier en fonction des besoins.
/..gitignore git ignore Indique à git d’ignorer les fichiers et dossiers d’être inclus dans le référentiel. Vous pouvez modifier ce fichier en fonction des besoins.
/azure.yaml azd fichier de configuration Contient les paramètres de configuration pour azd up déclarer les services et dossiers de projet qui seront déployés. Ce fichier NE DOIT PAS être supprimé.
/*.Md Fichiers markdown Il existe plusieurs fichiers Markdown à des fins différentes. Vous pouvez supprimer ces fichiers en toute sécurité.
/docker-compose.yml Docker compose Crée le package de conteneur pour l’application avant son déploiement sur Azure.
/pyproject.toml Système de génération Python Contient la configuration système requise de build des projets Python. Vous pouvez modifier ce fichier pour inclure vos outils préférés (par exemple, pour utiliser un framework de test unitaire et linter).
/requirements-dev.in fichier de configuration requise pip Utilisé pour créer une version d’environnement de développement des exigences à l’aide pip install -r de la commande. Vous pouvez modifier ce fichier pour inclure d’autres packages en fonction des besoins.

Conseil

Utilisez de bonnes pratiques de contrôle de version afin de pouvoir revenir à un point dans le temps où le projet fonctionnait au cas où vous arrêtiez inexplicablement quelque chose.

Forum Aux Questions

Q : J’ai reçu une erreur lors de l’utilisation d’un azd modèle. Que puis-je faire ?

R : consultez Résoudre les problèmes liés à Azure Developer CLI. Vous pouvez également signaler des problèmes sur le dépôt GitHub du modèle respectif azd .