Azure Container Apps'te Spring için yönetilen bir Yapılandırma Sunucusuna bağlanma

Spring için Yapılandırma Sunucusu, yapılandırma verilerini birden çok uygulamanın kullanımına sunmak için merkezi bir konum sağlar. Bu makalede, Azure Container Apps'te barındırılan bir uygulamayı Spring örneği için Java Config Server'a bağlamayı öğreneceksiniz.

Spring Java için Yapılandırma Sunucusu bileşeni, yapılandırma ayarları için kaynak olarak bir GitHub deposu kullanır. Yapılandırma değerleri, bileşen ile kapsayıcı uygulamanız arasında bir bağlama aracılığıyla kapsayıcı uygulamanız için kullanılabilir hale getirilir. Yapılandırma sunucusunda değerler değiştikçe, bunlar uygulamanızı yeniden derlemenize veya yeniden dağıtmanıza gerek kalmadan uygulamanıza otomatik olarak akar.

Bu öğreticide aşağıdakilerin nasıl yapılacağını öğreneceksiniz:

Önkoşullar

• Etkin aboneliği olan bir Azure hesabı. Henüz bir hesabınız yoksa ücretsiz olarak oluşturabilirsiniz.
• Azure CLI.

Dikkat edilmesi gereken noktalar

Azure Container Apps'te Spring için Config Server'da çalışırken aşağıdaki ayrıntılara dikkat edin:

Ayarlama

Spring için Yapılandırma Sunucusu ile çalışmaya başlamadan önce gerekli kaynakları oluşturmanız gerekir.

Bu ortam hem Spring java için Yapılandırma Sunucusu bileşenini hem de kapsayıcı uygulamanızı barındırmak için kullanılır.

Spring Java için Yapılandırma Sunucusu bileşenini oluşturma

Artık bir Container Apps ortamınız olduğuna göre, kapsayıcı uygulamanızı oluşturabilir ve spring java bileşeni için bir Yapılandırma Sunucusu'na bağlayabilirsiniz. Kapsayıcı uygulamanızı bağladığınızda yapılandırma değerleri Yapılandırma Sunucusu bileşeninden uygulamanıza otomatik olarak eşitlenir.

Kapsayıcı uygulamanızı Spring Java için Yapılandırma Sunucusu bileşenine bağlama

Kapsayıcı uygulaması ve Yapılandırma Sunucusu bileşeni birbirine bağlandıktan sonra yapılandırma değişiklikleri otomatik olarak kapsayıcı uygulamasıyla eşitlenir.

Uygulamanın URL'sini yeniden ziyaret ettiğinizde değeri connectTimeout şimdi 10000olur. Bu değer, başlangıçta yapılandırma bileşeninin kaynağı olarak ayarlanan değişkende $URI ayarlanan Git deposundan gelir. Özel olarak, bu değer deponun connectionTimeoutapplication.yml dosyasındaki özelliğinden çekilir.

Bağlama isteği, uygulamaya ortam değişkenleri olarak yapılandırma ayarı ekler. Bu değerler artık yapılandırma sunucusundan yapılandırma ayarları getirilirken kullanılacak uygulama kodu tarafından kullanılabilir.

Bu durumda, aşağıdaki ortam değişkenleri uygulama tarafından kullanılabilir:

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

Kendi SPRING_CONFIG_IMPORTortamınızı özelleştirmek istiyorsanız ortam değişkenine SPRING_CLOUD_CONFIG_COMPONENT_URI başvurabilirsiniz. Örneğin, gibi Java -Dspring.config.import=optional:configserver:${SPRING_CLOUD_CONFIG_COMPONENT_URI}?fail-fast=truekomut satırı bağımsız değişkenleriyle geçersiz kılabilirsiniz.

Bağlamayı uygulamanızdan da kaldırabilirsiniz.

(İsteğe bağlı) Spring Java için Yapılandırma Sunucusu bileşeninden kapsayıcı uygulamanızın bağlantısını kaldırın

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

Uygulamanın URL'sini yeniden ziyaret ettiğinizde değeri connectTimeout olarak değişir 0.

Kaynakları temizleme

Bu öğreticide oluşturulan kaynakların Azure faturanız üzerinde etkisi vardır. Bu hizmetleri uzun süreli kullanmayacaksanız, bu öğreticide oluşturulan her şeyi kaldırmak için aşağıdaki komutu çalıştırın.

az group delete --resource-group $RESOURCE_GROUP

Yapılandırma seçenekleri

komutu, az containerapp update Spring için Yapılandırma Sunucusu'nu nasıl yapılandırıldığını denetlemek için parametresini kullanır --configuration . Bir boşlukla ayrıldığı sürece aynı anda birden çok parametre kullanabilirsiniz. Daha fazla bilgi için bkz . Spring Cloud Config Server.

Aşağıdaki tabloda, kullanılabilen farklı Git arka uç yapılandırma değerleri açıklanmaktadır:

Aşağıdaki listede yaygın yapılandırmalar açıklanmaktadır:

• İlgili yapılandırmaları günlüğe kaydetme:

  • logging.level.*
  • logging.group.*
  • Ad alanı altındaki logging.* diğer tüm yapılandırmalar yasak olmalıdır; örneğin, kullanarak logging.file günlük dosyaları yazmak yasak olmalıdır.

• spring.cloud.config.server.overrides

  • Koşulsuz olarak tüm istemcilere gönderilecek özellik kaynağı için ek eşleme.

• spring.cloud.config.override-none

  • Uzak depodaki bayrağını (varsayılan değer false) ayarlayarak spring.cloud.config.override-none=true uygulamaların ortam değişkenlerinde veya Sistem özelliklerinde kendi değerlerini sağlamasına izin vererek istemcideki tüm geçersiz kılmaların önceliğini daha çok varsayılan değerlere benzer şekilde değiştirebilirsiniz.

• spring.cloud.config.allow-override

  • Yapılandırmayı ilk bootstrap'ı etkinleştirirseniz, yapılandırma sunucusundan gelen uygulama yapılandırmasına iki özellik yerleştirerek istemci uygulamalarının yapılandırma sunucusundan yapılandırmayı geçersiz kılabilir.

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

  • Özel profiller ve özel etiketlerle birlikte daha fazla uygulamayı denetlemek için Sistem Durumu Göstergesi'ni yapılandırabilirsiniz.

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

  • Uygulama bulunamazsa sunucunun HTTP 404 durumu döndürmesi için olarak ayarlayabilirsiniz.spring.cloud.config.server.accept-emptyfalse Varsayılan olarak, bu bayrak olarak trueayarlanır.

• Şifreleme ve şifre çözme (simetrik):

  • encrypt.key
    • Yapılandırılan tek bir özellik değeri olduğundan simetrik anahtar kullandığınızda kullanışlıdır.
  • spring.cloud.config.server.encrypt.enabled
    • Sunucu tarafı şifre çözmeyi devre dışı bırakmak için bu özelliği olarak false ayarlayın.

Yenile

Özellikleri kullanan hizmetlerin değişiklik gerçekleşmeden önce bunu bilmesi gerekir. Spring için Yapılandırma Sunucusu'nun varsayılan bildirim yöntemi, yenileme olayının el ile tetiklenmesini içerir; örneğin, çağrısıyla https://<YOUR_CONFIG_CLIENT_HOST_NAME>/actuator/refreshyenileme, çok sayıda uygulama örneği varsa uygun olmayabilir.

Bunun yerine, yapılandırma istemcisinin bir yenileme iç öğesini temel alan değişiklikler için yoklamasına izin vererek yapılandırma sunucusundan değerleri otomatik olarak yenileyebilirsiniz. Yapılandırma Sunucusu'ndan değerleri otomatik olarak yenilemek için aşağıdaki adımları kullanın:

1. Aşağıdaki örnekte gösterildiği gibi belirli bir aralıkta bağlamı yenilemek için zamanlanmış bir görevi kaydedin:

   @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. application.yml dosyasında uygun yenileme aralığını etkinleştirin autorefresh ve ayarlayın. Aşağıdaki örnekte istemci, yenileme aralığı için ayarlayabileceğiniz en düşük değer olan 60 saniyede bir yapılandırma değişikliğini yoklar.

   Varsayılan olarak, autorefresh olarak ayarlanır false ve refresh-interval 60 saniye olarak ayarlanır.

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

3. Kodunuzu ekleyin @RefreshScope . Aşağıdaki örnekte değişken connectTimeout her 60 saniyede bir otomatik olarak yenilenir:

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

Simetrik anahtarla şifreleme ve şifre çözme

Sunucu tarafı şifre çözme

Varsayılan olarak, sunucu tarafı şifreleme etkinleştirilir. Uygulamanızda şifre çözmeyi etkinleştirmek için aşağıdaki adımları kullanın:

1. Şifrelenmiş özelliği Git deponuzdaki .properties dosyanıza ekleyin.

   Dosyanız aşağıdaki örneğe benzemelidir:

   message={cipher}f43e3df3862ab196a4b367624a7d9b581e1c543610da353fbdd2477d60fb282f
   

2. Spring Java için Yapılandırma Sunucusu bileşenini şifrelenmiş özelliğe sahip Git deposunu kullanacak şekilde güncelleştirin ve şifreleme anahtarını ayarlayın.

   Aşağıdaki komutu çalıştırmadan önce, ile çevrelenen <> yer tutucuları değerlerinizle değiştirin.

   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
   

İstemci tarafı şifre çözme

Aşağıdaki adımları izleyerek özelliklerin istemci tarafı şifre çözmesini kullanabilirsiniz:

1. Şifrelenmiş özelliği Git deponuzdaki .properties dosyanıza ekleyin.

2. Spring Java için Yapılandırma Sunucusu bileşenini şifrelenmiş özelliğe sahip Git deposunu kullanacak şekilde güncelleştirin ve sunucu tarafı şifre çözmeyi devre dışı bırakın.

   Aşağıdaki komutu çalıştırmadan önce, ile çevrelenen <> yer tutucuları değerlerinizle değiştirin.

   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. İstemci uygulamanızda, şifre çözme anahtarını ENCRYPT_KEY=randomKey ortam değişkeni olarak ekleyin.

   Alternatif olarak, öğesine eklerseniz spring-cloud-starter-bootstrapclasspathveya bir sistem özelliği olarak ayarlarsanızspring.cloud.bootstrap.enabled=true, içinde bootstrap.propertiesayarlayınencrypt.key.

   Aşağıdaki komutu çalıştırmadan önce, ile çevrelenen <> yer tutucuları değerlerinizle değiştirin.

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

   encrypt:
     key: somerandomkey