Bagikan melalui

Gambaran umum lingkungan Azure Developer CLI

Azure Developer CLI (azd) memungkinkan Anda mengelola beberapa lingkungan penyebaran untuk proyek Anda, untuk memisahkan konfigurasi untuk pengembangan, pengujian, dan produksi. Artikel ini menjelaskan konsep penting tentang bagaimana Anda dapat menggunakan lingkungan untuk mengelola proses pengembangan dan penyebaran Anda.

Apa itu lingkungan?

Lingkungan di Azure Developer CLI (azd) adalah sekumpulan konfigurasi bernama untuk penyebaran aplikasi Anda, seperti dev, test, atau prod. Lingkungan yang berbeda dapat dikonfigurasi dengan nilai yang berbeda. Lingkungan melayani beberapa tujuan penting:

  • Isolasi: Pisahkan pengembangan, pengujian, dan penyebaran produksi.
  • Manajemen konfigurasi: Pertahankan pengaturan yang berbeda untuk setiap lingkungan.
  • Kolaborasi: Memungkinkan anggota tim untuk bekerja dengan lingkungan mereka sendiri.
  • Organisasi sumber daya: Mengelompokkan dan memprovisikan sumber daya Azure berdasarkan lingkungan.
  • Reproduksi: Pastikan penyebaran yang konsisten di berbagai tahap.

Setiap lingkungan memiliki grup sumber daya Azure dan pengaturan konfigurasinya sendiri. Isolasi lingkungan ini membantu mencegah perubahan dalam satu lingkungan memengaruhi lingkungan lain.

Struktur dan konfigurasi lingkungan

Lingkungan Azure Developer CLI (azd) berada dalam struktur direktori dalam proyek Anda:

├── .azure                          [Created when you run azd init or azd up]
│   ├── <environment-name-1>        [Directory for environment-specific configurations]
│   │   ├── .env                    [Environment variables for this environment]
│   │   └── config.json             [Additional configuration parameters for this environment]
│   ├── <environment-name-2>        [Another environment]
│   │   ├── .env                    
│   │   └── config.json
│   └── config.json                 [Global azd configuration]

Komponen utama struktur ini adalah:

  • .azure direktori: Direktori akar untuk semua konfigurasi lingkungan. Dikecualikan dari kontrol sumber oleh .gitignore file secara default.
  • Direktori khusus lingkungan: Direktori yang dinamai sesuai lingkungan Anda, seperti dev, , testprod.
  • .env file: Berisi variabel khusus lingkungan yang digunakan oleh aplikasi Anda dan selama penyebaran.
  • config.json: Digunakan untuk mendorong pengaturan yang memengaruhi azd perilaku dan fitur perintah. File ini tidak dimaksudkan untuk digunakan langsung oleh pengguna akhir.

Nama lingkungan

Penamaan lingkungan biasanya mengikuti pola-pola berikut:

  • Proyek tim: <project-name-[dev/int/prod]>
  • Proyek pribadi: <personal-unique-alias-[dev/int/prod]>

Konvensi penamaan ini tidak diberlakukan oleh azd dan dapat dikonfigurasi oleh pengguna.

Variabel lingkungan

Variabel Lingkungan CLI Pengembang Azure menyediakan cara untuk menyimpan pengaturan konfigurasi yang memengaruhi dan mungkin berbeda di antara lingkungan. Saat Anda menjalankan perintah Azure Developer CLI, variabel ini digunakan untuk:

  • Konfigurasikan pengaturan aplikasi Anda, seperti titik akhir untuk layanan Azure.
  • Tentukan parameter infrastruktur untuk memengaruhi proses provisi.

File .env berisi variabel ini dalam format standar:

AZURE_ENV_NAME=dev
AZURE_LOCATION=eastus
AZURE_SUBSCRIPTION_ID=00000000-0000-0000-0000-000000000000
AZURE_RESOURCE_GROUP=rg-dev-12345
SERVICE_WEB_HOSTNAME=web-dev-12345.azurewebsites.net
SERVICE_API_HOSTNAME=api-dev-12345.azurewebsites.net

Variabel lingkungan umum meliputi:

Variabel Deskripsi
AZURE_ENV_NAME Nama lingkungan saat ini
AZURE_LOCATION Wilayah Azure tempat sumber daya disebarkan
AZURE_SUBSCRIPTION_ID ID langganan Azure yang digunakan untuk lingkungan ini
AZURE_RESOURCE_GROUP Nama grup sumber daya untuk lingkungan ini

Petunjuk / Saran

Untuk variabel lingkungan umum lainnya dan contoh khusus layanan, kunjungi dokumentasi Variabel lingkungan .

Saat bekerja dengan variabel lingkungan:

  • Hindari menerapkan .env file ke kontrol sumber. Jika konfigurasi lingkungan perlu dipertahankan atau dibagikan, pengguna harus menggunakan lingkungan Jarak Jauh.
  • Gunakan penamaan yang konsisten di seluruh lingkungan.
  • azd env set Gunakan perintah untuk memperbarui variabel dengan aman.

Peringatan

Jangan pernah menyimpan rahasia dalam file Azure Developer CLI .env . File-file ini dapat dengan mudah dibagikan atau disalin ke lokasi yang tidak sah, atau diperiksa ke kontrol sumber. Gunakan layanan seperti Azure Key Vault atau Azure Role Based Access Control (RBAC) untuk solusi yang dilindungi atau tanpa rahasia.

Membandingkan lingkungan kerangka kerja lainnya

Banyak kerangka kerja dan alat pemrograman seperti Node.js, Django, atau React menggunakan .env file untuk konfigurasi. Meskipun Azure Developer CLI (azd) juga menggunakan .env file, ada perbedaan penting:

Konsep Azure Developer CLI .env File Kerangka Kerja .env
Tempat Disimpan dalam .azure/<environment-name>/.env Biasanya disimpan dalam direktori akar proyek
Dukungan Lingkungan Dukungan untuk beberapa lingkungan yang ditentukan pengguna (dev, test, prod) Seringkali memerlukan konvensi peralihan atau penamaan file manual (.env.development, .env.production)
Mekanisme Pemuatan Dimuat secara otomatis oleh azd perintah Biasanya memerlukan pemuatan eksplisit dalam kode aplikasi atau skrip build
Integrasi Terintegrasi secara mendalam dengan layanan Azure dan provisi sumber daya Konfigurasi tujuan umum, bukan khusus Azure
Manajemen Variabel Dikelola melalui azd env perintah Biasanya diedit secara manual atau melalui skrip kustom

Meskipun keduanya melayani tujuan yang sama, pendekatan Azure Developer CLI .env menambahkan struktur dan alat yang dirancang untuk mengelola beberapa lingkungan penyebaran dan sumber daya Azure.

Nota

Jika proyek Anda sudah menggunakan file khusus .env kerangka kerja, Anda dapat menyimpan kedua sistem konfigurasi tanpa konflik. azd variabel lingkungan mengambil alih variabel lingkungan sistem dengan nama yang sama untuk beberapa operasi.

Langkah selanjutnya

Bekerja dengan lingkungan

Mengelola variabel lingkungan di Azure Developer CLI

  • Last updated on