Zapewnienie zgodności projektu z interfejsem wiersza polecenia dla deweloperów platformy Azure

Interfejs wiersza polecenia dla deweloperów platformy Azure (azd) umożliwia deweloperom tworzenie szkieletu aplikacji dla chmury przy użyciu szablonów hostowanych w usłudze GitHub. Firma Microsoft udostępnia kilka szablonów , które ułatwiają rozpoczęcie pracy. Z tego artykułu dowiesz się, jak utworzyć własną aplikację azd zgodną.

Omówienie architektury szablonu

Poniższy diagram zawiera krótkie omówienie procesu tworzenia azd szablonu:

Wszystkie azd szablony mają tę samą strukturę plików na azd podstawie konwencji. W poniższej hierarchii przedstawiono strukturę katalogów, którą utworzysz w tym samouczku.

├── .azdo                                        [ Configures an Azure Pipeline ]
├── .devcontainer                                [ For DevContainer ]
├── .github                                      [ Configures a GitHub workflow ]
├── .vscode                                      [ VS Code workspace configurations ]
├── .azure                                       [ Stores Azure configurations and environment variables ]
├── infra                                        [ Contains infrastructure as code files ]
│   ├── main.bicep/main.tf                       [ Main infrastructure file ]
│   ├── main.parameters.json/main.tfvars.json    [ Parameters file ]
│   └── core/modules                             [ Contains reusable Bicep/Terraform modules ]
└── azure.yaml                                   [ Describes the app and type of Azure resources]

Inicjowanie szablonu

Polecenie azd init służy do inicjowania aplikacji do aprowizowania i wdrażania zasobów aplikacji na platformie Azure. To polecenie wyświetla monit o wybranie między dwoma różnymi przepływami pracy w celu zainicjowania szablonu opisanego w poniższych sekcjach.

• Użyj kodu w bieżącym katalogu: wybierz tę opcję, aby poinstruować azd , aby przeanalizować kod w katalogu pod kątem tożsamości używanych technologii, takich jak język programowania, struktura i system bazy danych. azd Następnie automatycznie wygeneruje zasoby szablonu, takie jak azure.yaml plik definicji usługi i infra folder z plikami infrastruktury jako kodu.

• Wybierz szablon: wybierz tę opcję, aby użyć istniejącego szablonu jako punktu początkowego. Domyślnie azd umożliwia przeglądanie szablonów z galerii Awesome AZD , ale można również skonfigurować własne galerie szablonów. Po wybraniu szablonu zasoby tego szablonu zostaną dodane do istniejącego katalogu projektu.

Szczegóły każdego z tych przepływów pracy zostały opisane w poniższych sekcjach.

Używanie kodu w katalogu

1. Możesz wykonać kroki opisane wcześniej przy użyciu własnego projektu. Jeśli jednak wolisz użyć przykładowej aplikacji, sklonuj następujące repozytorium początkowe do pustego katalogu na komputerze:

   git clone https://github.com/Azure-Samples/msdocs-python-flask-webapp-quickstart
   

2. Otwórz wybrane narzędzie wiersza polecenia do katalogu głównego projektu.

3. Uruchom polecenie , azd init aby zainicjować szablon.

   azd init
   

4. Po wyświetleniu monitu wybierz opcję Użyj kodu w bieżącym katalogu. azd analizuje projekt i zawiera podsumowanie wykrytych usług i zalecanych zasobów hostingu platformy Azure.

5. Wybierz pozycję Potwierdź i kontynuuj inicjowanie mojej aplikacji. azd generuje następujące zasoby w katalogu głównym projektu:

   • Plik azure.yaml z odpowiednimi definicjami usługi.
   • Folder infra z plikami infrastruktury jako kodu w celu aprowizowania i wdrażania projektu na platformie Azure.
   • .azure Folder ze zmiennymi środowiskowymi ustawionymi w .env pliku.

   Więcej informacji na temat tego procesu wykrywania i generowania znajduje się w dalszej części artykułu.

6. Wygenerowane pliki działają zgodnie z podanymi przykładowymi aplikacjami i mogą również korzystać z własnych aplikacji. W razie potrzeby wygenerowane pliki można modyfikować zgodnie z potrzebami. Na przykład może być konieczne dalsze zmodyfikowanie plików infrastruktury jako kodu w infra folderze, jeśli aplikacja korzysta z zasobów platformy Azure poza tymi, które zostały zidentyfikowane przez azdprogram .

7. Uruchom polecenie , azd up aby aprowizować i wdrożyć aplikację na platformie Azure.

   azd up
   

8. Po wyświetleniu monitu wybierz żądaną subskrypcję i lokalizację, aby rozpocząć proces aprowizacji i wdrażania.

9. Po zakończeniu procesu kliknij link w azd danych wyjściowych, aby otworzyć aplikację w przeglądarce.

Eksplorowanie kroków inicjowania

Po wybraniu przepływu pracy azd init Użyj kodu w bieżącym katalogu polecenie analizuje projekt i automatycznie ocenia kod na podstawie tego, co odnajduje. W poniższych sekcjach opisano szczegóły działania tego procesu i które technologie są obecnie obsługiwane.

Detection

Polecenie azd init wykrywa pliki projektu dla obsługiwanych języków znajdujących się w katalogu projektu i podkatalogach. azd Skanuje również zależności pakietów w celu zbierania informacji o strukturach internetowych lub bazach danych używanych przez aplikację. W razie potrzeby możesz ręcznie dodać lub edytować wykryte składniki, jak pokazano w wierszu polecenia podsumowania potwierdzenia.

Bieżąca logika wykrywania jest następująca:

• Obsługiwane języki:
  • Python
  • JavaScript/TypeScript
  • .NET
  • Java
• Obsługiwane bazy danych:
  • MongoDB
  • PostgreSQL
• W przypadku języków Python i JavaScript/TypeScript platformy internetowe i bazy danych są automatycznie wykrywane.
• Gdy projekt JavaScript/TypeScript używa platformy internetowej frontonu (lub po stronie klienta), jest klasyfikowany jako usługa frontonu. Jeśli usługa korzysta z platformy internetowej frontonu, która jest obecnie niewykryta, możesz wybrać opcję JQuery, aby zapewnić równoważną klasyfikację i zachowanie usługi frontonu.

Generowanie

Po potwierdzeniu wykrytych składników azd init program generuje pliki infrastruktury jako kodu potrzebne do wdrożenia aplikacji na platformie Azure.

Logika generowania jest następująca:

• Obsługiwane hosty:
  • Azure Container Apps.
• W przypadku baz danych obsługiwane mapowanie technologii bazy danych i używanej usługi:
  • MongoDB: interfejs API usługi Azure CosmosDB dla bazy danych MongoDB
  • PostgreSQL: elastyczny serwer usługi Azure Database for PostgreSQL
  • Redis: dodatek Azure Container Apps Redis
• Usługi korzystające z baz danych będą miały zmienne środowiskowe, które domyślnie zapewniają połączenie z bazą danych wstępnie skonfigurowaną.
• Po wykryciu zarówno usług frontonu, jak i zaplecza konfiguracja mechanizmu CORS na hoście platformy Azure dla usług zaplecza zostanie zaktualizowana w celu umożliwienia domyślnej domeny hostingu usług frontonu. Można to zmodyfikować lub usunąć w razie potrzeby w infrastrukturze jako plikach konfiguracji kodu.

Dodawanie obsługi kontenerów deweloperskich

Możesz również ustawić szablon zgodny z kontenerami programistycznymi i usługami Codespaces. Kontener deweloperski umożliwia używanie kontenera jako w pełni funkcjonalnego środowiska deweloperskiego. Może służyć do uruchamiania aplikacji, do oddzielania narzędzi, bibliotek lub środowisk uruchomieniowych potrzebnych do pracy z bazą kodu oraz do pomocy w ciągłej integracji i testowaniu. Kontenery deweloperskie można uruchamiać lokalnie lub zdalnie w chmurze prywatnej lub publicznej. (Źródło: https://containers.dev/)

Aby dodać obsługę kontenerów deweloperskich:

1. Utwórz folder .devcontainer w katalogu głównym projektu.

2. devcontainer.json Utwórz plik w folderze .devcontainer z żądanymi konfiguracjami. Szablon azd startowy zawiera przykładowy devcontainer.json plik, który można skopiować do projektu i zmodyfikować zgodnie z potrzebami.

Przeczytaj więcej na temat pracy z kontenerami deweloperskimi w dokumentacji programu Visual Studio Code.

Dodawanie obsługi potoku ciągłej integracji/ciągłego wdrażania

Możesz również dodać obsługę ciągłej integracji/ciągłego wdrażania w szablonie przy użyciu akcji GitHub lub usługi Azure DevOps, wykonując następujące kroki:

1. .github Dodaj folder dla funkcji GitHub Actions lub .ado folder dla usługi Azure DevOps do katalogu głównego projektu.

2. Dodaj plik przepływu pracy do nowego folderu. Szablon azd startowy zawiera przykładowy plik przepływu pracy funkcji GitHub Actions i przykładowe pliki usługi Azure DevOps Pipelines dla każdej platformy, którą można skopiować do projektu i zmodyfikować zgodnie z potrzebami.

3. Może być również konieczne zaktualizowanie main.parameters.json pliku w infra folderze przy użyciu wymaganych zmiennych środowiskowych do uruchomienia przepływu pracy.

Korzystanie z szablonu

Przepływ pracy Wybieranie szablonu umożliwia wybranie istniejącego azd szablonu do użycia jako punktu początkowego. Zawartość wybranego szablonu jest dodawana do katalogu głównego projektu. Większość szablonów udostępnia wymagany zestaw azd plików i folderów, a niektóre szablony obejmują kompletne pliki infrastruktury jako kodu w celu aprowizowania zasobów platformy Azure dla wybranego stosu aplikacji.

W tym przykładzie użyjesz szablonu Starter — Bicep , który zawiera podstawową strukturę azd szablonu i przydatny standardowy kod, aby rozpocząć pracę.

1. Aby wykonać kroki opisane przed wykonaniem kroków przy użyciu istniejącej przykładowej aplikacji, sklonuj następujący projekt startowy do pustego katalogu na komputerze:

   git clone https://github.com/Azure-Samples/msdocs-python-flask-webapp-quickstart
   

2. W wybranym narzędziu wiersza polecenia przejdź do katalogu głównego sklonowanego projektu.

3. Uruchom polecenie , azd init aby zainicjować azd szablon.

   azd init
   

4. Po wyświetleniu monitu wybierz opcję Wybierz szablon.

5. Z listy szablonów wybierz pozycję Starter — Bicep. Aby znaleźć szablon, może być konieczne przewinięcie listy przy użyciu klawiszy strzałek klawiatury.

6. Po wyświetleniu monitu wprowadź krótką nazwę środowiska, na przykład testenv.

7. Po uruchomieniu polecenia azd initdo projektu zostaną dodane następujące zasoby:

   ├── .azdo                                        [ Configures an Azure Pipeline ]
   ├── .devcontainer                                [ For DevContainer ]
   ├── .github                                      [ Configures a GitHub workflow ]
   ├── .vscode                                      [ VS Code workspace configurations ]
   ├── .azure                                       [ Stores Azure configurations and environment variables ]
   ├── infra                                        [ Contains infrastructure as code files ]
   │   ├── main.bicep/main.tf                       [ Main infrastructure file ]
   │   ├── main.parameters.json/main.tfvars.json    [ Parameters file ]
   │   └── core/modules                             [ Contains reusable Bicep/Terraform modules ]
   └── azure.yaml                                   [ Describes the app and type of Azure resources]
   

Aktualizowanie plików Bicep

Projekt zawiera teraz podstawową strukturę i zasoby szablonu azd . Jednak aby aprowizować zasoby platformy Azure dla określonego projektu, należy zaktualizować pliki Bicep w folderze infra . Do hostowania przykładowej aplikacji potrzebne są następujące zasoby:

• Plan usługi aplikacja systemu Azure
• Usługa aplikacja systemu Azure uruchomiona w systemie Linux

1. Otwórz katalog projektu najwyższego poziomu w wybranym edytorze, na przykład Visual Studio Code.

2. main.bicep Otwórz plik w edytorze. Ten plik zawiera przydatny kod standardowy do konfigurowania podstawowych zmiennych, parametrów i konwencji nazewnictwa. Pod blokiem komentarza wokół wiersza 50, który odczytuje Add resources to be provisioned below, dodaj następujący kod Bicep:

   // Creates an app service instance to host the app
   module web './core/host/appservice.bicep' = {
     name: 'web'
     scope: rg
     params: {
       name: '${abbrs.webSitesAppService}web-${resourceToken}'
       location: location
       tags: union(tags, { 'azd-service-name': 'web' })
       appServicePlanId: appServicePlan.outputs.id
       runtimeName: 'python'
       runtimeVersion: '3.8'
       scmDoBuildDuringDeployment: true
     }
   }
   
   // Create an App Service Plan to group applications under the same payment plan and SKU
   module appServicePlan './core/host/appserviceplan.bicep' = {
     name: 'appserviceplan'
     scope: rg
     params: {
       name: '${abbrs.webServerFarms}${resourceToken}'
       location: location
       tags: tags
       sku: {
         name: 'B1'
       }
     }
   }
   

   Uwaga

   • Unikatowy ciąg jest generowany na podstawie identyfikatora subskrypcji i używany jako zmienna ${resourceToken} . Ten token jest dołączany do nazwy wszystkich zasobów platformy Azure utworzonych przez azd. azd używa tagów do identyfikowania zasobów, aby można było modyfikować nazwy na podstawie konwencji nazewnictwa organizacji.
   • Tag 'azd-service-name': 'web' w usłudze app Service jest wartością azd używaną do identyfikowania hosta wdrożenia. Wartość musi być taka sama jak wartość zdefiniowana dla usługi w pliku azure.yaml .

Aktualizowanie pliku azure.yaml

Aby wdrożyć aplikację, azd należy dowiedzieć się więcej o aplikacji. Plik azure.yaml służy do definiowania lokalizacji kodu źródłowego, języka i usługi hostingu platformy Azure dla każdej usługi w aplikacji. Aby uzyskać szczegółowe informacje, zapoznaj się ze schematem azure.yaml.

1. Otwórz folder azure.yaml w katalogu głównym projektu.

2. Dodaj następujące wiersze w dolnej części pliku:

   name: msdocs-python-flask-webapp-quickstart
   services:
     web:
       project: .
       language: py
       host: appservice
   

Aprowizuj i wdróż szablon

1. Zapisz wszystkie zmiany i uruchom następujące polecenie, aby aprowizować i wdrażać zasoby aplikacji na platformie Azure:

   azd up
   

2. Po zakończeniu polecenia kliknij link w danych wyjściowych polecenia, aby przejść do wdrożonej lokacji.

Projekt jest teraz zgodny z interfejsem wiersza polecenia dla deweloperów platformy Azure i może być używany jako szablon!

Uwaga

azd Obsługuje również używanie pakietu Buildpack domyślnie konteneryzowania aplikacji. azd Jeśli szablon jest przeznaczony dla usługi Azure Container Apps lub Azure Kubernetes Service, ale nie zawiera pliku platformy Docker, azd automatycznie generuje obraz przy użyciu pakietu Buildpack.

Konfigurowanie potoku ciągłej integracji/ciągłego wdrażania

Jeśli szablon zawiera obsługę funkcji GitHub Actions lub Azure Pipelines, możesz skonfigurować potok ciągłej integracji/ciągłego wdrażania, wykonując następujące kroki:

1. Uruchom następujące polecenie, aby wypchnąć aktualizacje do repozytorium. Przepływ pracy funkcji GitHub Actions jest wyzwalany z powodu aktualizacji.

   azd pipeline config    
   

2. Korzystając z przeglądarki, przejdź do repozytorium GitHub dla projektu.

3. Wybierz pozycję Akcje , aby wyświetlić uruchomiony przepływ pracy.

Czyszczenie zasobów

Jeśli nie potrzebujesz już zasobów utworzonych w tym artykule, uruchom następujące polecenie:

azd down

Zobacz też

• Utwórz pliki Bicep za pomocą programu Visual Studio Code , aby zapoznać się z wprowadzeniem do pracy z plikami Bicep.
• Przykłady Bicep
• Jak dekompilować szablony usługi Azure Resource Manager (szablony usługi ARM) do aplikacji Bicep
• Schemat azure.yaml interfejsu wiersza polecenia platformy Azure

Zażądaj pomocy

Aby uzyskać informacje na temat tworzenia usterki, żądania pomocy lub zaproponowania nowej funkcji dla interfejsu wiersza polecenia dla deweloperów platformy Azure, odwiedź stronę rozwiązywania problemów i pomocy technicznej .

Następne kroki

Azure Developer CLI — często zadawane pytania