Nawiązywanie połączenia z zarządzanym serwerem konfiguracji dla platformy Spring w Azure Container Apps

Serwer konfiguracji dla platformy Spring udostępnia scentralizowaną lokalizację, która udostępnia dane konfiguracji wielu aplikacjom. Z tego artykułu dowiesz się, jak połączyć aplikację hostowaną na platformie Azure Container Apps z instancją serwera konfiguracyjnego Java dla Spring.

Składnik Config Server for Spring Java używa repozytorium GitHub jako źródła ustawień konfiguracji. Wartości konfiguracji są udostępniane aplikacji kontenera za pośrednictwem powiązania między składnikiem a aplikacją kontenera. Gdy wartości zmieniają się na serwerze konfiguracji, automatycznie przepływają do aplikacji bez konieczności ponownego kompilowania lub ponownego wdrażania aplikacji.

Z tego samouczka dowiesz się, jak wykonywać następujące czynności:

Wymagania wstępne

• Konto Azure z aktywną subskrypcją. Jeśli jeszcze go nie masz, możesz go utworzyć bezpłatnie.
• Azure CLI.

Kwestie wymagające rozważenia

Podczas uruchamiania w środowisku Config Server for Spring w Azure Container Apps należy pamiętać o następujących szczegółach:

Ustawienia

Przed rozpoczęciem pracy z programem Config Server for Spring należy najpierw utworzyć wymagane zasoby.

To środowisko służy do hostowania zarówno składnika Config Server for Spring java, jak i aplikacji kontenera.

Utwórz składnik Config Server dla Spring Java

Teraz, gdy masz środowisko usługi Container Apps, możesz utworzyć aplikację kontenera i powiązać ją ze składnikiem Config Server for Spring Java. Po powiązaniu aplikacji kontenera wartości konfiguracji są automatycznie synchronizowane ze składnika serwera konfiguracji z aplikacją.

Wiązanie aplikacji kontenera ze składnikiem Config Server for Spring Java

Po połączeniu aplikacji kontenera i składnika serwera konfiguracji zmiany konfiguracji są automatycznie synchronizowane z aplikacją kontenera.

Gdy ponownie odwiedzisz adres URL aplikacji, wartość connectTimeout jest teraz 10000. Ta wartość pochodzi z repozytorium Git ustawionego w zmiennej $URI pierwotnie ustawionej jako źródło składnika konfiguracji. W szczególności ta wartość jest pobierana z connectionTimeout w pliku application.yml repozytorium.

Żądanie powiązania wprowadza ustawienie konfiguracji do aplikacji jako zmienne środowiskowe. Te wartości są teraz dostępne dla kodu aplikacji do użycia podczas pobierania ustawień konfiguracji z serwera konfiguracji.

W takim przypadku następujące zmienne środowiskowe są dostępne dla aplikacji:

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

Jeśli chcesz dostosować własną SPRING_CONFIG_IMPORT, możesz odwołać się do zmiennej środowiskowej SPRING_CLOUD_CONFIG_COMPONENT_URI - na przykład możesz zastąpić ją argumentami wiersza polecenia, takimi jak Java -Dspring.config.import=optional:configserver:${SPRING_CLOUD_CONFIG_COMPONENT_URI}?fail-fast=true.

Można również usunąć powiązanie z aplikacji.

(Opcjonalnie) Odłącz aplikację kontenera od składnika Config Server for Spring Java

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

Gdy ponownie odwiedzisz adres URL aplikacji, wartość connectTimeout zmienia się z powrotem na 0.

Czyszczenie zasobów

Zasoby utworzone w tym samouczku mają wpływ na rachunek za Azure. Jeśli nie zamierzasz korzystać z tych usług długoterminowych, uruchom następujące polecenie, aby usunąć wszystkie elementy utworzone w tym samouczku.

az group delete --resource-group $RESOURCE_GROUP

Opcje konfiguracji

Polecenie az containerapp update używa parametru --configuration do kontrolowania sposobu konfigurowania serwera konfiguracji dla platformy Spring. Można używać wielu parametrów jednocześnie, o ile są one oddzielone spacją. Aby uzyskać więcej informacji, zobacz Spring Cloud Config Server.

W poniższej tabeli opisano różne dostępne wartości konfiguracji zaplecza Git:

Poniższa lista zawiera opis typowych konfiguracji:

• Rejestrowanie powiązanych konfiguracji:

  • logging.level.*
  • logging.group.*
  • Wszelkie inne konfiguracje w logging.* przestrzeni nazw powinny być zabronione — na przykład zapisywanie plików dziennika przy użyciu logging.file powinno być zabronione.

• spring.cloud.config.server.overrides

  • Dodatkowa mapa właściwości źródła do wysłania do wszystkich klientów bezwarunkowo.

• spring.cloud.config.override-none

  • Priorytet wszystkich przesłonięć w kliencie można zmienić, aby był bliższy wartościom domyślnym, co pozwala aplikacjom na dostarczanie własnych wartości poprzez zmienne środowiskowe lub właściwości systemu, ustawiając flagę spring.cloud.config.override-none=true — wartość domyślna to false — w repozytorium zdalnym.

• spring.cloud.config.allow-override

  • Jeśli włączysz konfigurację podczas pierwszego uruchamiania, możesz zezwolić aplikacjom klienckim na zastąpienie konfiguracji z serwera konfiguracji. Nadpisanie odbywa się przez umieszczenie dwóch właściwości w konfiguracji aplikacji, które pochodzą z serwera konfiguracji.

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

  • Możesz skonfigurować wskaźnik kondycji, aby sprawdzał więcej aplikacji oraz niestandardowe profile i etykiety.

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

  • Można ustawić spring.cloud.config.server.accept-empty wartość na false , aby serwer zwracał stan HTTP 404 , jeśli aplikacja nie zostanie znaleziona. Domyślnie ta flaga jest ustawiona na true.

• Szyfrowanie i odszyfrowywanie (symetryczne):

  • encrypt.key
    • Wygodne w przypadku używania klucza symetrycznego, ponieważ jest to pojedyncza wartość właściwości do skonfigurowania.
  • spring.cloud.config.server.encrypt.enabled
    • Ustaw tę właściwość na false aby wyłączyć odszyfrowywanie po stronie serwera.

Odśwież

Usługi, które wykorzystują właściwości, muszą znać zmianę, zanim nastąpi. Domyślny sposób powiadamiania w Config Server for Spring polega na ręcznym wywoływaniu zdarzenia odświeżania, takiego jak odświeżanie za pomocą wywołania https://<YOUR_CONFIG_CLIENT_HOST_NAME>/actuator/refresh, co może być niepraktyczne, jeśli istnieje wiele instancji aplikacji.

Zamiast tego można automatycznie odświeżać wartości z serwera konfiguracji, pozwalając klientowi konfiguracji sprawdzać zmiany na podstawie interwału odświeżania. Wykonaj następujące kroki, aby automatycznie odświeżyć wartości z serwera konfiguracji:

1. Zarejestruj zaplanowane zadanie, aby odświeżyć kontekst w danym interwale, jak pokazano w poniższym przykładzie:

   @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. Włącz autorefresh i ustaw odpowiedni interwał odświeżania w pliku application.yml . W poniższym przykładzie klient sonduje zmianę konfiguracji co 60 sekund, czyli minimalną wartość, którą można ustawić dla interwału odświeżania.

   Domyślnie autorefresh jest ustawiony na false, a refresh-interval jest ustawiony na 60 sekund.

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

3. Dodaj @RefreshScope do swojego kodu. W poniższym przykładzie zmienna connectTimeout jest automatycznie odświeżona co 60 sekund:

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

Szyfrowanie i odszyfrowywanie przy użyciu klucza symetrycznego

Odszyfrowywanie po stronie serwera

Domyślnie szyfrowanie po stronie serwera jest włączone. Aby włączyć odszyfrowywanie w aplikacji, wykonaj następujące czynności:

1. Dodaj zaszyfrowaną właściwość w pliku properties w repozytorium Git.

   Plik powinien przypominać następujący przykład:

   message={cipher}f43e3df3862ab196a4b367624a7d9b581e1c543610da353fbdd2477d60fb282f
   

2. Zaktualizuj składnik Config Server for Spring Java, aby użyć repozytorium Git z zaszyfrowaną właściwością i ustawić klucz szyfrowania.

   Przed uruchomieniem następującego polecenia, zastąp symbole zastępcze w nawiasach <> swoimi wartościami.

   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
   

Odszyfrowywanie po stronie klienta

Możesz użyć odszyfrowywania po stronie klienta właściwości, wykonując następujące kroki:

1. Dodaj zaszyfrowaną właściwość w pliku properties w repozytorium Git.

2. Zaktualizuj składnik Config Server for Spring Java, aby użyć repozytorium Git z zaszyfrowaną właściwością i wyłączyć odszyfrowywanie po stronie serwera.

   Przed uruchomieniem następującego polecenia zastąp symbole zastępcze otoczone przez <> własnymi wartościami.

   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. W aplikacji klienckiej dodaj klucz ENCRYPT_KEY=randomKey odszyfrowywania jako zmienną środowiskową.

   Alternatywnie, jeśli uwzględnisz spring-cloud-starter-bootstrap w elemencie classpath lub ustawisz spring.cloud.bootstrap.enabled=true jako właściwość systemową, ustaw encrypt.key w bootstrap.properties.

   Przed uruchomieniem następującego polecenia zastąp symbole zastępcze ujęte w <> Twoimi wartościami.

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

   encrypt:
     key: somerandomkey