Membuat proyek Anda kompatibel dengan Azure Developer CLI

Artikel
11/16/2023

Azure Developer CLI (azd) memungkinkan pengembang untuk membuat perancah aplikasi mereka untuk cloud menggunakan templat yang dihosting di GitHub. Microsoft menyediakan beberapa templat untuk memulai. Dalam artikel ini, Anda mempelajari cara membuat aplikasi azd Anda sendiri kompatibel.

Memahami arsitektur templat

Diagram berikut memberikan gambaran umum singkat tentang proses untuk membuat azd templat:

Diagram of Azure Developer CLI template workflow.

Semua azd templat memiliki struktur file yang sama, berdasarkan azd konvensi. Hierarki berikut menunjukkan struktur direktori yang akan Anda bangun dalam tutorial ini.

├── .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]

Menginisialisasi templat

Perintah azd init ini digunakan untuk menginisialisasi aplikasi Anda untuk menyediakan dan menyebarkan sumber daya aplikasi di Azure. Perintah ini meminta Anda untuk memilih antara dua alur kerja yang berbeda untuk menginisialisasi templat yang diuraikan di bagian berikut.

Gunakan kode dalam direktori saat ini: Pilih opsi ini untuk menginstruksikan azd untuk menganalisis kode di direktori Anda ke identitas teknologi mana yang digunakannya, seperti bahasa pemrograman, kerangka kerja, dan sistem database. azd kemudian akan secara otomatis menghasilkan aset templat untuk Anda, seperti azure.yaml file definisi layanan dan infra folder dengan file infrastruktur sebagai kode.
Pilih templat: Pilih opsi ini untuk menggunakan templat yang sudah ada sebagai titik awal. Secara default, azd memungkinkan Anda menelusuri templat dari galeri AZD Yang Mengagumkan, tetapi Anda juga dapat mengonfigurasi galeri templat Anda sendiri. Saat Anda memilih templat, aset templat tersebut akan ditambahkan ke direktori proyek yang sudah ada.

Detail masing-masing alur kerja ini diuraikan dalam bagian di bawah ini.

Menggunakan kode dalam direktori
Menggunakan templat

Anda dapat mengikuti langkah-langkah di depan menggunakan proyek Anda sendiri. Namun, jika Anda lebih suka mengikuti menggunakan aplikasi sampel, kloning repositori pemula berikut ke direktori kosong di komputer Anda:
```
git clone https://github.com/Azure-Samples/msdocs-python-flask-webapp-quickstart
```
Buka alat baris perintah pilihan Anda ke direktori akar proyek.
Jalankan azd init perintah untuk menginisialisasi templat.
```
azd init
```
Saat diminta, pilih opsi untuk Menggunakan kode di direktori saat ini. azd menganalisis proyek dan menyediakan ringkasan layanan yang terdeteksi dan sumber daya hosting Azure yang direkomendasikan.
Pilih Konfirmasi dan lanjutkan menginisialisasi aplikasi saya. azd menghasilkan aset berikut dalam direktori akar proyek:
- File azure.yaml dengan definisi layanan yang sesuai.
- Folder infra dengan file infrastruktur sebagai kode untuk memprovisikan dan menyebarkan proyek ke Azure.
- .azure Folder dengan variabel lingkungan yang .env diatur dalam file.
Detail selengkapnya tentang proses deteksi dan pembuatan ini disediakan nanti di artikel.
File yang dihasilkan berfungsi apa adanya untuk aplikasi sampel yang disediakan dan mungkin juga untuk aplikasi Anda sendiri. Jika perlu, file yang dihasilkan dapat dimodifikasi agar sesuai dengan kebutuhan Anda. Misalnya, Anda mungkin perlu memodifikasi lebih lanjut file infrastruktur sebagai kode di infra folder jika aplikasi Anda bergantung pada sumber daya Azure di luar yang diidentifikasi oleh azd.
Jalankan azd up perintah untuk memprovisikan dan menyebarkan aplikasi Anda ke Azure.
```
azd up
```
Saat diminta, pilih langganan dan lokasi yang diinginkan untuk memulai proses provisi dan penyebaran.
Saat proses selesai, klik tautan di azd output untuk membuka aplikasi di browser.

Menjelajahi langkah-langkah inisialisasi

Saat Anda memilih Gunakan kode di alur kerja direktori saat ini, azd init perintah menganalisis proyek Anda dan membuat kode secara otomatis berdasarkan apa yang ditemukannya. Bagian di bawah ini menjelaskan detail cara kerja proses ini dan teknologi mana yang saat ini didukung.

Detection

Perintah mendeteksi azd init file proyek untuk bahasa yang didukung yang terletak di direktori proyek dan subdirektori Anda. azd juga akan memindai dependensi paket untuk mengumpulkan informasi tentang kerangka kerja web atau database yang digunakan aplikasi Anda. Jika diperlukan, Anda dapat menambahkan atau mengedit komponen yang terdeteksi secara manual seperti yang disajikan dalam prompt ringkasan konfirmasi.

Logika deteksi saat ini adalah sebagai berikut:

Bahasa yang didukung:
- Python
- JavaScript/TypeScript
- .NET
- Java
Database yang didukung:
- MongoDB
- PostgreSQL
Untuk Python dan JavaScript/TypeScript, kerangka kerja web dan database terdeteksi secara otomatis.
Saat proyek JavaScript/TypeScript menggunakan kerangka kerja web front-end (atau sisi klien), proyek tersebut diklasifikasikan sebagai layanan front-end. Jika layanan Anda menggunakan kerangka kerja web front-end yang saat ini tidak terdeteksi, Anda dapat memilih JQuery untuk memberikan klasifikasi dan perilaku layanan front-end yang setara.

Generation

Setelah Anda mengonfirmasi komponen yang terdeteksi, azd init menghasilkan file infrastruktur sebagai kode yang diperlukan untuk menyebarkan aplikasi Anda ke Azure.

Logika pembuatannya adalah sebagai berikut:

Host yang didukung:
- Azure Container Apps.
Untuk database, pemetaan yang didukung antara teknologi database dan layanan yang digunakan:
- MongoDB: Api Azure CosmosDB untuk MongoDB
- PostgreSQL: Server fleksibel Azure Database for PostgreSQL
- Redis: Add-on Azure Container Apps Redis
Layanan yang menggunakan database akan memiliki variabel lingkungan yang menyediakan koneksi ke database yang telah dikonfigurasi sebelumnya secara default.
Ketika layanan front-end dan back-end terdeteksi, konfigurasi CORS pada host Azure untuk layanan back-end akan diperbarui untuk memungkinkan domain hosting default layanan front-end. Ini dapat dimodifikasi atau dihapus seperlunya dalam file konfigurasi Infrastruktur sebagai Kode.

Menambahkan dukungan untuk kontainer dev

Anda juga dapat membuat templat Anda kompatibel dengan kontainer pengembangan dan Codespace. Kontainer pengembangan memungkinkan Anda menggunakan kontainer sebagai lingkungan pengembangan berfungsi lengkap. Ini dapat digunakan untuk menjalankan aplikasi, untuk memisahkan alat, pustaka, atau runtime yang diperlukan untuk bekerja dengan basis kode, dan untuk membantu integrasi dan pengujian berkelanjutan. Kontainer dev dapat dijalankan secara lokal atau jarak jauh, di cloud privat atau publik. (Sumber: https://containers.dev/)

Untuk menambahkan dukungan untuk kontainer dev:

Buat folder .devcontainer di akar proyek Anda.
Buat devcontainer.json file di .devcontainer dalam folder dengan konfigurasi yang diinginkan. Templat azd pemula menyediakan file sampel devcontainer.json yang dapat Anda salin ke dalam proyek Anda dan memodifikasi sesuai kebutuhan.

Baca selengkapnya tentang bekerja dengan kontainer dev pada dokumentasi Visual Studio Code.

Menambahkan dukungan untuk alur CI/CD

Anda juga dapat menambahkan dukungan untuk CI/CD di templat Anda menggunakan tindakan GitHub atau Azure DevOps menggunakan langkah-langkah berikut:

.github Tambahkan folder untuk tindakan GitHub atau .ado folder untuk Azure DevOps ke akar proyek Anda.
Tambahkan file alur kerja ke folder baru. Templat azd pemula menyediakan file alur kerja Tindakan GitHub Sampel dan file Alur Azure DevOps Sampel untuk setiap platform yang dapat Anda salin ke dalam proyek Anda dan memodifikasi sesuai kebutuhan.
Anda mungkin juga perlu memperbarui main.parameters.json file di folder Anda infra dengan variabel lingkungan yang diperlukan agar alur kerja Anda berjalan.

Alur kerja Pilih templat memungkinkan Anda memilih templat yang sudah ada azd untuk digunakan sebagai titik awal. Konten templat yang dipilih ditambahkan ke direktori akar proyek Anda. Sebagian besar templat menyediakan sekumpulan azd file dan folder yang diperlukan, dan beberapa templat menyertakan file infrastruktur sebagai kode lengkap untuk memprovisikan sumber daya Azure untuk tumpukan aplikasi yang dipilih.

Dalam contoh ini, Anda akan menggunakan templat Starter - Bicep , yang mencakup struktur penting templat dan beberapa kode boilerplate yang azd berguna untuk memulai.

Untuk mengikuti langkah-langkah di depan menggunakan aplikasi sampel yang ada, kloning proyek pemula berikut ke direktori kosong di komputer Anda:
```
git clone https://github.com/Azure-Samples/msdocs-python-flask-webapp-quickstart
```
Di alat baris perintah pilihan Anda, navigasikan ke direktori akar proyek kloning.
Jalankan azd init perintah untuk menginisialisasi azd templat.
```
azd init
```
Saat diminta, pilih opsi untuk Memilih templat.
Dari daftar templat, pilih Starter - Bicep. Anda mungkin perlu menggulir daftar menggunakan tombol panah keyboard Anda untuk menemukan templat.
Saat diminta, masukkan nama lingkungan singkat, seperti testenv.

Setelah Anda menjalankan azd init, aset berikut ditambahkan ke proyek Anda:

├── .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]

Memperbarui file Bicep

Proyek Anda sekarang berisi struktur inti dan aset azd templat. Namun, untuk menyediakan sumber daya Azure untuk proyek spesifik Anda, file Bicep di infra folder perlu diperbarui. Untuk menghosting aplikasi sampel, Anda memerlukan sumber daya berikut:

Paket Azure App Service
Azure App Service yang berjalan di Linux

Buka direktori proyek tingkat atas di editor pilihan Anda, seperti Visual Studio Code.
main.bicep Buka file di editor Anda. File ini berisi kode boilerplate yang berguna untuk mengatur variabel penting, parameter, dan konvensi penamaan. Di bawah blok komentar di sekitar baris 50 yang berbunyi Add resources to be provisioned below, tambahkan Bicep berikut:
```
// 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'
    }
  }
}
```
Catatan
- String unik dihasilkan berdasarkan ID langganan dan digunakan sebagai ${resourceToken} variabel. Token ini ditambahkan ke nama semua sumber daya Azure yang dibuat oleh azd. azd menggunakan tag untuk mengidentifikasi sumber daya sehingga Anda dapat memodifikasi nama berdasarkan konvensi penamaan organisasi Anda.
- Tag 'azd-service-name': 'web' pada layanan aplikasi adalah nilai azd yang digunakan untuk mengidentifikasi host penyebaran. Nilai harus sama dengan apa yang didefinisikan untuk layanan dalam file azure.yaml .

Memperbarui file azure.yaml

Untuk menyebarkan aplikasi, azd perlu mengetahui lebih lanjut tentang aplikasi Anda. File azure.yaml digunakan untuk menentukan lokasi kode sumber, bahasa, dan layanan hosting Azure untuk setiap layanan di aplikasi Anda. Untuk detail selengkapnya, lihat skema azure.yaml.

Buka di azure.yaml akar proyek.

Tambahkan baris berikut ke bagian bawah file:

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

Memprovisikan dan menyebarkan templat

Simpan semua perubahan Anda dan jalankan perintah berikut untuk menyediakan dan menyebarkan sumber daya aplikasi di Azure:
```
azd up
```
Setelah perintah selesai, klik tautan dalam output perintah untuk menavigasi ke situs yang disebarkan.

Proyek Anda sekarang kompatibel dengan Azure Developer CLI dan dapat digunakan sebagai templat!

Catatan

azd juga mendukung penggunaan Buildpack untuk membuat kontainer aplikasi Anda secara default. Jika templat Anda azd menargetkan Azure Container Apps atau Azure Kubernetes Service tetapi tidak menyertakan file Docker, azd secara otomatis menghasilkan gambar menggunakan Buildpack.

Mengonfigurasi alur CI/CD

Jika templat Anda menyertakan dukungan untuk GitHub Actions atau Azure Pipelines, Anda dapat mengonfigurasi alur CI/CD menggunakan langkah-langkah berikut:

Jalankan perintah berikut untuk mendorong pembaruan ke repositori. Alur kerja GitHub Actions dipicu karena pembaruan.
```
azd pipeline config    
```
Menggunakan browser Anda, buka repositori GitHub untuk proyek Anda.
Pilih Tindakan untuk melihat alur kerja berjalan.

Membersihkan sumber daya

Saat Anda tidak lagi memerlukan sumber daya yang dibuat dalam artikel ini, jalankan perintah berikut:

azd down

Meminta bantuan

Untuk informasi tentang cara mengajukan bug, meminta bantuan, atau mengusulkan fitur baru untuk Azure Developer CLI, silakan kunjungi halaman pemecahan masalah dan dukungan .

Langkah berikutnya

FAQ Azure Developer CLI