Menyambungkan ke Server Konfigurasi terkelola untuk Spring di Azure Container Apps

Config Server for Spring menyediakan lokasi terpusat untuk membuat data konfigurasi tersedia untuk beberapa aplikasi. Dalam artikel ini, Anda belajar menyambungkan aplikasi yang dihosting di Azure Container Apps ke Java Config Server untuk instans Spring.

Komponen Config Server for Spring Java menggunakan repositori GitHub sebagai sumber untuk pengaturan konfigurasi. Nilai konfigurasi tersedia untuk aplikasi kontainer Anda melalui pengikatan antara komponen dan aplikasi kontainer Anda. Saat nilai berubah di server konfigurasi, nilai tersebut secara otomatis mengalir ke aplikasi Anda, semuanya tanpa mengharuskan Anda untuk mengkombinasi ulang atau menyebarkan ulang aplikasi Anda.

Dalam tutorial ini, Anda mempelajari caranya:

Prasyarat

• Akun Azure dengan langganan aktif. Jika Anda belum memilikinya, Anda dapat membuatnya secara gratis.
• Azure CLI.

Pertimbangan

Saat berjalan di Config Server for Spring di Azure Container Apps, ketahui detail berikut:

Siapkan

Sebelum Anda mulai bekerja dengan Config Server untuk Spring, Anda harus terlebih dahulu membuat sumber daya yang diperlukan.

Lingkungan ini digunakan untuk menghosting komponen Config Server for Spring java dan aplikasi kontainer Anda.

Membuat komponen Config Server for Spring Java

Setelah memiliki lingkungan Container Apps, Anda dapat membuat aplikasi kontainer dan mengikatnya ke komponen java Config Server for Spring. Saat Anda mengikat aplikasi kontainer, nilai konfigurasi secara otomatis disinkronkan dari komponen Config Server ke aplikasi Anda.

Mengikat aplikasi kontainer Anda ke komponen Config Server for Spring Java

Setelah aplikasi kontainer dan komponen Config Server terikat bersama, perubahan konfigurasi secara otomatis disinkronkan ke aplikasi kontainer.

Saat Anda mengunjungi URL aplikasi lagi, nilainya connectTimeout sekarang 10000. Nilai ini berasal dari repositori Git yang ditetapkan dalam variabel yang $URI awalnya ditetapkan sebagai sumber komponen konfigurasi. Secara khusus, nilai ini diambil dari connectionTimeout properti dalam file application.yml repositori.

Permintaan pengikatan menyuntikkan pengaturan konfigurasi ke dalam aplikasi sebagai variabel lingkungan. Nilai-nilai ini sekarang tersedia untuk kode aplikasi yang akan digunakan saat mengambil pengaturan konfigurasi dari server konfigurasi.

Dalam hal ini, variabel lingkungan berikut tersedia untuk aplikasi:

SPRING_CLOUD_CONFIG_URI=http://[JAVA_COMPONENT_INTERNAL_FQDN]:80
SPRING_CLOUD_CONFIG_COMPONENT_URI=http://[JAVA_COMPONENT_INTERNAL_FQDN]:80
SPRING_CONFIG_IMPORT=optional:configserver:$SPRING_CLOUD_CONFIG_URI

Jika Anda ingin menyesuaikan sendiri SPRING_CONFIG_IMPORT, Anda dapat merujuk ke variabel SPRING_CLOUD_CONFIG_COMPONENT_URI lingkungan - misalnya, Anda dapat mengambil alih berdasarkan argumen baris perintah, seperti Java -Dspring.config.import=optional:configserver:${SPRING_CLOUD_CONFIG_COMPONENT_URI}?fail-fast=true.

Anda juga dapat menghapus pengikatan dari aplikasi Anda.

(Opsional) Batalkan ikatan aplikasi kontainer Anda dari komponen Config Server for Spring Java

az containerapp update \
    --name $APP_NAME \
    --unbind $JAVA_COMPONENT_NAME \
    --resource-group $RESOURCE_GROUP

Saat Anda mengunjungi URL aplikasi lagi, nilai connectTimeout perubahan menjadi kembali ke 0.

Membersihkan sumber daya

Sumber daya yang dibuat dalam tutorial ini berpengaruh pada tagihan Azure Anda. Jika Anda tidak akan menggunakan layanan ini dalam jangka panjang, jalankan perintah berikut untuk menghapus semua yang dibuat dalam tutorial ini.

az group delete --resource-group $RESOURCE_GROUP

Opsi konfigurasi

Perintah az containerapp update menggunakan --configuration parameter untuk mengontrol bagaimana Config Server for Spring dikonfigurasi. Anda dapat menggunakan beberapa parameter sekaligus selama dipisahkan oleh spasi. Untuk informasi selengkapnya, lihat Spring Cloud Config Server.

Tabel berikut ini menjelaskan nilai konfigurasi backend Git yang berbeda yang tersedia:

Daftar berikut ini menjelaskan konfigurasi umum:

• Konfigurasi terkait pengelogan:

  • logging.level.*
  • logging.group.*
  • Konfigurasi lain di bawah logging.* namespace harus dilarang - misalnya, menulis file log dengan menggunakan logging.file harus dilarang.

• spring.cloud.config.server.overrides

  • Peta tambahan untuk sumber properti yang akan dikirim ke semua klien secara tanpa syarat.

• spring.cloud.config.override-none

  • Anda dapat mengubah prioritas semua penimpaan di klien menjadi lebih seperti nilai default, memungkinkan aplikasi menyediakan nilainya sendiri dalam variabel lingkungan atau properti Sistem, dengan mengatur spring.cloud.config.override-none=true bendera - defaultnya adalah false - di repositori jarak jauh.

• spring.cloud.config.allow-override

  • Jika Anda mengaktifkan bootstrap pertama konfigurasi, Anda dapat mengizinkan aplikasi klien untuk mengambil alih konfigurasi dari server konfigurasi dengan menempatkan dua properti dalam konfigurasi aplikasi yang berasal dari server konfigurasi.

• spring.cloud.config.server.health.*

  • Anda dapat mengonfigurasi Indikator Kesehatan untuk memeriksa lebih banyak aplikasi bersama dengan profil kustom dan label kustom.

• spring.cloud.config.server.accept-empty

  • Anda dapat mengatur spring.cloud.config.server.accept-empty ke false sehingga server mengembalikan status HTTP 404 jika aplikasi tidak ditemukan. Secara default, bendera ini diatur ke true.

• Enkripsi dan dekripsi (simetris):

  • encrypt.key
    • Nyaman saat Anda menggunakan kunci konten karena merupakan nilai properti tunggal untuk dikonfigurasi.
  • spring.cloud.config.server.encrypt.enabled
    • Atur properti ini ke false untuk menonaktifkan dekripsi sisi server.

Refresh

Layanan yang menggunakan properti perlu mengetahui tentang perubahan sebelum terjadi. Metode pemberitahuan default untuk Config Server for Spring melibatkan pemicu peristiwa refresh secara manual, seperti refresh dengan panggilan https://<YOUR_CONFIG_CLIENT_HOST_NAME>/actuator/refresh, yang mungkin tidak layak jika ada banyak instans aplikasi.

Sebagai gantinya, Anda dapat secara otomatis menyegarkan nilai dari Config Server dengan membiarkan polling klien konfigurasi untuk perubahan berdasarkan refresh internal. Gunakan langkah-langkah berikut untuk menyegarkan nilai secara otomatis dari Config Server:

1. Daftarkan tugas terjadwal untuk merefresh konteks dalam interval tertentu, seperti yang ditunjukkan dalam contoh berikut:

   @Configuration
   @AutoConfigureAfter({RefreshAutoConfiguration.class, RefreshEndpointAutoConfiguration.class})
   @EnableScheduling
   public class ConfigClientAutoRefreshConfiguration implements SchedulingConfigurer {
       @Value("${spring.cloud.config.refresh-interval:60}")
       private long refreshInterval;
       @Value("${spring.cloud.config.auto-refresh:false}")
       private boolean autoRefresh;
       private final RefreshEndpoint refreshEndpoint;
       public ConfigClientAutoRefreshConfiguration(RefreshEndpoint refreshEndpoint) {
           this.refreshEndpoint = refreshEndpoint;
       }
       @Override
       public void configureTasks(ScheduledTaskRegistrar scheduledTaskRegistrar) {
           if (autoRefresh) {
               // set minimal refresh interval to 5 seconds
               refreshInterval = Math.max(refreshInterval, 5);
               scheduledTaskRegistrar.addFixedRateTask(refreshEndpoint::refresh,  Duration.ofSeconds(refreshInterval));
           }
       }
   }
   

2. Aktifkan autorefresh dan atur interval refresh yang sesuai dalam file application.yml . Dalam contoh berikut, klien melakukan polling untuk perubahan konfigurasi setiap 60 detik, yang merupakan nilai minimum yang dapat Anda atur untuk interval refresh.

   Secara default, autorefresh diatur ke false dan refresh-interval diatur ke 60 detik.

   spring:
       cloud:
           config:
           auto-refresh: true
           refresh-interval: 60
   management:
       endpoints:
           web:
           exposure:
               include:
               - refresh
   

3. Tambahkan @RefreshScope dalam kode Anda. Dalam contoh berikut, variabel connectTimeout secara otomatis di-refresh setiap 60 detik:

   @RestController
   @RefreshScope
   public class HelloController {
       @Value("${timeout:4000}")
       private String connectTimeout;
   }
   

Enkripsi dan dekripsi dengan kunci konten

Dekripsi sisi server

Secara default, enkripsi sisi server diaktifkan. Gunakan langkah-langkah berikut untuk mengaktifkan dekripsi di aplikasi Anda:

1. Tambahkan properti terenkripsi di file .properties Anda di repositori Git Anda.

   File Anda harus menyerupai contoh berikut:

   message={cipher}f43e3df3862ab196a4b367624a7d9b581e1c543610da353fbdd2477d60fb282f
   

2. Perbarui komponen Config Server for Spring Java untuk menggunakan repositori Git yang memiliki properti terenkripsi dan atur kunci enkripsi.

   Sebelum Anda menjalankan perintah berikut, ganti tempat penampung yang dikelilingi dengan <> nilai Anda.

   az containerapp env java-component config-server-for-spring update \
       --environment <ENVIRONMENT_NAME> \
       --resource-group <RESOURCE_GROUP> \
       --name <JAVA_COMPONENT_NAME> \
       --configuration spring.cloud.config.server.git.uri=<URI> encrypt.key=randomKey
   

Dekripsi sisi klien

Anda dapat menggunakan dekripsi sisi klien properti dengan mengikuti langkah-langkah berikut:

1. Tambahkan properti terenkripsi di file .properties Anda di repositori Git Anda.

2. Perbarui komponen Config Server for Spring Java untuk menggunakan repositori Git yang memiliki properti terenkripsi dan menonaktifkan dekripsi sisi server.

   Sebelum Anda menjalankan perintah berikut, ganti tempat penampung yang dikelilingi dengan <> nilai Anda.

   az containerapp env java-component config-server-for-spring update \
       --environment <ENVIRONMENT_NAME> \
       --resource-group <RESOURCE_GROUP> \
       --name <JAVA_COMPONENT_NAME> \
       --configuration spring.cloud.config.server.git.uri=<URI> spring.cloud.config.server.encrypt.enabled=false
   

3. Di aplikasi klien Anda, tambahkan kunci ENCRYPT_KEY=randomKey dekripsi sebagai variabel lingkungan.

   Atau, jika Anda menyertakan spring-cloud-starter-bootstrap pada classpath, atau ditetapkan spring.cloud.bootstrap.enabled=true sebagai properti sistem, atur encrypt.key dalam bootstrap.properties.

   Sebelum Anda menjalankan perintah berikut, ganti tempat penampung yang dikelilingi dengan <> nilai Anda.

   az containerapp update \
       --name <APP_NAME> \
       --resource-group <RESOURCE_GROUP> \
       --set-env-vars "ENCRYPT_KEY=randomKey"
   

   encrypt:
     key: somerandomkey