Pengaturan push ke App Configuration dengan Azure Pipelines

  • Artikel

Tugas Azure App Configuration Push mendorong kunci-nilai dari file konfigurasi ke penyimpanan App Configuration. Tugas ini mengaktifkan fungsi lingkaran penuh di dalam alur karena sekarang Anda dapat menarik pengaturan dari penyimpanan App Configuration serta mendorong pengaturan ke penyimpanan App Configuration.

Prasyarat

Membuat koneksi layanan

Koneksi layanan memberi Anda akses ke sumber daya di langganan Azure Anda dari proyek Azure DevOps Anda.

  1. Di Azure DevOps, buka proyek yang berisi slur target Anda. Di sudut kiri bawah, pilih Pengaturan proyek.

  2. Pada Alur, pilih Koneksi layanan. Di sudut kanan atas, pilih Koneksi layanan baru.

  3. Di Koneksi layanan baru, pilih Azure Resource Manager.

    Cuplikan layar memperlihatkan memilih Azure Resource Manager dari daftar menurun Koneksi layanan baru.

  4. Dalam dialog Metode autentikasi, pilih Perwakilan layanan (otomatis) untuk membuat perwakilan layanan baru atau pilih Perwakilan layanan (manual) untuk menggunakan perwakilan layanan yang ada.

  5. Masukkan langganan, grup sumber daya, dan nama untuk koneksi layanan Anda.

Jika Anda membuat perwakilan layanan baru, temukan nama perwakilan layanan yang ditetapkan ke koneksi layanan. Anda akan menambahkan penetapan peran baru ke perwakilan layanan ini pada langkah berikutnya.

  1. Buka Pengaturan Proyek>Koneksi layanan.

  2. Pilih koneksi layanan baru.

  3. Pilih Kelola Perwakilan Layanan.

  4. Perhatikan nilai dalam Nama tampilan.

    Cuplikan layar memperlihatkan nama tampilan perwakilan layanan.

Menambahkan penetapan peran

Tetapkan penetapan peran Azure App Configuration yang tepat ke informasi masuk yang digunakan dalam tugas sehingga tugas dapat mengakses penyimpanan Azure App Configuration.

  1. Buka penyimpanan Azure App Configuration target Anda.

  2. Di menu sebelah kiri, pilih Kontrol akses (IAM) .

  3. Di panel kanan, pilih Tambahkan penetapan peran.

    Cuplikan layar memperlihatkan tombol Tambahkan penetapan peran.

  4. Di bawahPeran, pilih Pemilik Data Azure App Configuration. Peran ini memungkinkan tugas untuk membaca dari dan menulis ke penyimpanan Azure App Configuration.

  5. Pilih prinsipal perwakilan layanan yang terkait dengan koneksi layanan yang Anda buat di bagian sebelumnya.

    Cuplikan layar yang memperlihatkan dialog Tambahkan penetapan peran.

  6. Pilih Tinjau + tetapkan.

Menggunakan dalam build

Bagian ini akan membahas cara menggunakan tugas Azure App Configuration Push dalam alur build Azure DevOps.

  1. Buka halaman alur build dengan mengeklik Alur>Alur. Dokumentasi untuk alur build dapat ditemukan di sini.
    • Jika Anda membuat alur build baru, pada langkah terakhir proses yaitu pada tab Tinjau, pilih Tampilkan asisten di sisi kanan alur.

      Cuplikan layar menunjukkan tombol Perlihatkan asisten untuk alur baru.

    • Jika Anda menggunakan alur build yang sudah ada, klik tombol Edit di kanan atas.

      Cuplikan layar menunjukkan tombol Edit untuk alur yang sudah ada.

  2. Cari Tugas Azure App Configuration Push.

    Cuplikan layar menunjukkan dialog Tambahkan Tugas dengan Pendorongan Azure App Configuration di kotak pencarian.

  3. Konfigurasikan parameter yang diperlukan untuk tugas mendorong kunci-nilai dari file konfigurasi ke penyimpanan App Configuration. Penjelasan parameter tersedia di bagian Parameter di bawah ini, dan di tipsalat di samping setiap parameter.

    Cuplikan layar menunjukkan parameter tugas pendorongan konfigurasi aplikasi.

  4. Menyimpan dan mengantrekan build. Log build akan menampilkan kegagalan yang terjadi selama pelaksanaan tugas.

Menggunakan dalam rilis

Bagian ini akan membahas cara menggunakan tugas Azure App Configuration Push dalam alur rilis Azure DevOps.

  1. Buka halaman alur rilis dengan memilih Alur>Rilis. Dokumentasi untuk alur rilis dapat ditemukan di sini.
  2. Pilih alur rilis yang ada. Jika Anda tidak memiliki alur rilis yang ada, pilih + Baru untuk membuat alur rilis baru.
  3. Pilih tombol Edit di pojok kanan atas untuk mengedit alur rilis.
  4. Dari menu drop-down Tugas, pilih Tahap yang ingin Anda tambahkan tugasnya. Informasi lebih lanjut tentang tahap dapat ditemukan di sini.

    Cuplikan layar menunjukkan tahap yang dipilih di menu drop-down Tugas.

  5. Klik + di samping Pekerjaan yang ingin ditambahkan tugas barunya.

    Cuplikan layar menunjukkan tombol plus di samping pekerjaan.

  6. Dalam dialog Tambahkan tugas, ketik Azure App Configuration Push ke dalam kotak pencarian dan pilih.
  7. Konfigurasikan parameter yang diperlukan dalam tugas untuk mendorong kunci-nilai Anda dari file konfigurasi ke penyimpanan App Configuration Anda. Penjelasan parameter tersedia di bagian Parameter di bawah ini, dan di tipsalat di samping setiap parameter.
  8. Menyimpan dan mengantrekan rilis. Log rilis akan menampilkan kegagalan yang dialami selama pelaksanaan tugas.

Parameter

Parameter berikut digunakan oleh tugas Azure App Configuration Push:

  • Langganan Azure: Menu drop-down yang berisi koneksi layanan Azure Anda yang tersedia. Untuk memperbarui dan me-refresh daftar koneksi layanan Azure yang tersedia, tekan tombol Refresh Azure subscription di sebelah kanan kotak teks.
  • App Configuration Titik Akhir: Drop-down yang memuat titik akhir penyimpanan konfigurasi yang tersedia di bawah langganan yang dipilih. Untuk memperbarui dan merefresh daftar titik akhir penyimpanan konfigurasi yang tersedia, tekan tombol Refresh App Configuration Titik Akhir di sebelah kanan kotak teks.
  • Jalur File Konfigurasi: Jalur ke file konfigurasi Anda. Parameter Jalur File Konfigurasi dimulai pada akar repositori file. Anda dapat menelusuri artefak build untuk memilih file konfigurasi. (tombol ... di sebelah kanan kotak teks). Format file yang didukung bergantung pada profil konten file. Untuk profil default, format file yang didukung adalah yaml, json, dan properti. Untuk profil KvSet, format file yang didukung adalah json.
  • Profil Konten File: Profil konten File Konfigurasi. Nilai defaultnya adalah Default.
    • Default: Mengacu pada format file konfigurasi konvensional yang secara langsung dapat dikonsumsi oleh aplikasi.
    • Kvset: Mengacu pada skema file yang berisi semua properti nilai kunci App Configuration, termasuk kunci, nilai, label, jenis konten, dan tag. Parameter tugas 'Pemisah', 'Label', 'Jenis konten', 'Awalan', 'Tag', dan 'Kedalaman' tidak berlaku saat menggunakan profil Kvset.
  • Mode Impor: Nilai defaultnya adalah Semua. Menentukan perilaku saat mengimpor nilai kunci.
    • Semua: Mengimpor semua nilai kunci dalam file konfigurasi ke App Configuration.
    • Ignore-Match: Mengimpor hanya pengaturan yang tidak memiliki nilai kunci yang cocok dalam App Configuration. Nilai kunci yang cocok dianggap sebagai nilai kunci dengan kunci, label, nilai, jenis konten, dan tag yang sama.
  • Dry Run: Nilai default tidak dicentang.
    • Dicentang: Tidak ada pembaruan yang akan dilakukan untuk App Configuration. Sebaliknya, pembaruan apa pun yang akan dilakukan dalam eksekusi normal akan dicetak ke konsol untuk ditinjau.
    • Tidak dicentang: Melakukan pembaruan apa pun untuk App Configuration dan tidak mencetak ke konsol.
  • Pemisah: Pemisah yang digunakan untuk meratakan file .json dan .yml.
  • Kedalaman: Kedalaman file .json dan .yml akan diratakan.
  • Prefiks: String yang ditambahkan ke awal setiap kunci yang didorong ke penyimpanan App Configuration.
  • Label: String yang ditambahkan ke setiap kunci-nilai sebagai label di dalam penyimpanan App Configuration.
  • Jenis Konten: String yang ditambahkan ke setiap kunci-nilai sebagai jenis konten dalam penyimpanan App Configuration.
  • Tag: Objek JSON dalam format {"tag1":"val1", "tag2":"val2"} yang menentukan tag yang ditambahkan ke setiap kunci-nilai yang didorong ke penyimpanan App Configuration Anda.
  • Hapus kunci-nilai yang tidak disertakan dalam file konfigurasi: Nilai default Tidak Dicentang. Perilaku opsi ini tergantung pada profil konten file konfigurasi.
    • Diperiksa:
      • Profil konten default: Menghapus semua nilai kunci di penyimpanan App Configuration yang cocok dengan awalan dan label yang ditentukan sebelum mendorong nilai kunci baru dari file konfigurasi.
      • Profil konten Kvset: Menghapus semua nilai kunci di penyimpanan App Configuration yang tidak disertakan dalam file konfigurasi sebelum mendorong nilai kunci baru dari file konfigurasi.
    • Tidak dicentang: Mendorong semua kunci-nilai dari file konfigurasi ke penyimpanan App Configuration dan membiarkan lainnya tetap utuh di penyimpanan App Configuration.

Pemecahan Masalah

Jika terjadi kesalahan tak terduga, log debug dapat diaktifkan dengan mengatur variabel alur system.debug ke true.

FAQ

Bagaimana cara mengunggah beberapa file konfigurasi?

Buat beberapa instans tugas Azure App Configuration Push dalam alur yang sama untuk mendorong beberapa file konfigurasi ke penyimpanan App Configuration.

Bagaimana cara membuat referensi Key Vault atau bendera fitur menggunakan tugas ini?

Bergantung pada profil konten file yang Anda pilih, silakan lihat contoh dalam dukungan Azure App Configuration untuk file konfigurasi.

Mengapa saya menerima pesan kesalahan 409 saat mencoba mendorong kunci-nilai ke penyimpanan konfigurasi saya?

Pesan kesalahan Konflik 409 akan terjadi jika tugas mencoba menghapus atau menimpa kunci-nilai yang dikunci di penyimpanan App Configuration.