Nawiązywanie połączenia z zarządzanym serwerem konfiguracji platformy Spring w usłudze Azure Container Apps
Artykuł
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ą w usłudze Azure Container Apps z wystąpieniem java Config Server for 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:
Tworzenie składnika Config Server for Spring Java
Wiązanie serwera konfiguracji platformy Spring z aplikacją kontenera
Obserwowanie wartości konfiguracji przed i po połączeniu serwera konfiguracji z aplikacją
Szyfrowanie i odszyfrowywanie wartości konfiguracji przy użyciu klucza symetrycznego
Ważne
W tym samouczku są używane usługi, które mogą mieć wpływ na rachunek za korzystanie z platformy Azure. Jeśli zdecydujesz się wykonać kroki krok po kroku, upewnij się, że usunięto zasoby opisane w tym artykule, aby uniknąć nieoczekiwanych rozliczeń.
Wymagania wstępne
Konto platformy Azure z aktywną subskrypcją. Jeśli jeszcze go nie masz, możesz go utworzyć bezpłatnie.
Podczas uruchamiania w programie Config Server for Spring w usłudze Azure Container Apps należy pamiętać o następujących szczegółach:
Towar
Wyjaśnienie
Scope
Serwer konfiguracji dla platformy Spring działa w tym samym środowisku co połączona aplikacja kontenera.
Skalowanie
Aby zachować pojedyncze źródło prawdy, serwer konfiguracji dla platformy Spring nie jest skalowany. Właściwości minReplicas skalowania i maxReplicas są ustawione na 1wartość .
Zasoby
Alokacja zasobów kontenera dla serwera konfiguracji spring jest stała, liczba rdzeni procesora CPU wynosi 0,5, a rozmiar pamięci to 1Gi.
Cennik
Serwer konfiguracji dla rozliczeń platformy Spring jest objęty cenami opartymi na użyciu. Zasoby używane przez zarządzane składniki Java są rozliczane według stawek aktywnych/bezczynnych. Możesz usunąć składniki, które nie są już używane do zatrzymywania rozliczeń.
Powiązanie
Aplikacja kontenera łączy się z serwerem konfiguracji platformy Spring za pośrednictwem powiązania. Powiązanie wprowadza konfiguracje do zmiennych środowiskowych aplikacji kontenera. Po ustanowieniu powiązania aplikacja kontenera może odczytywać wartości konfiguracji ze zmiennych środowiskowych.
Ustawienia
Przed rozpoczęciem pracy z programem Config Server for Spring należy najpierw utworzyć wymagane zasoby.
Lokalizacja regionu świadczenia usługi Azure, w której tworzysz aplikację kontenera i składnik Java.
ENVIRONMENT
Nazwa środowiska usługi Azure Container Apps dla aplikacji demonstracyjnej.
RESOURCE_GROUP
Nazwa grupy zasobów platformy Azure dla aplikacji demonstracyjnej.
JAVA_COMPONENT_NAME
Nazwa składnika Java utworzonego dla aplikacji kontenera. W tym przypadku utworzysz składnik Config Server for Spring Java.
IMAGE
Obraz kontenera używany w aplikacji kontenera.
URI
Możesz zastąpić identyfikator URI adresem URL repozytorium Git, jeśli jest on prywatny, dodaj powiązane konfiguracje uwierzytelniania, takie jak spring.cloud.config.server.git.username i spring.cloud.config.server.git.password.
Zaloguj się na platformie Azure przy użyciu interfejsu wiersza polecenia platformy Azure.
az login
Utwórz grupę zasobów.
az group create --name $RESOURCE_GROUP --location $LOCATION
Na karcie Ruch przychodzący wprowadź następujący tekst i pozostaw pozostałą część formularza z ich wartościami domyślnymi.
Właściwości
Wartość
Ruch przychodzący
Wybierz pozycję Włączone.
Ruch przychodzący
Wybierz pozycję Akceptuj ruch z dowolnego miejsca.
Typ ruchu przychodzącego
Wybierz pozycję HTTP.
Port docelowy
Wprowadź wartość 8080.
Wybierz pozycję Przejrzyj i utwórz.
Po zakończeniu sprawdzania poprawności wybierz pozycję Utwórz , aby utworzyć aplikację kontenera.
To środowisko służy do hostowania zarówno składnika Config Server for Spring java, jak i aplikacji kontenera.
Tworzenie składnika Config Server for 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ą.
W tym miejscu mówisz składnikowi, gdzie można znaleźć repozytorium zawierające informacje o konfiguracji za pośrednictwem uri właściwości . Właściwość informuje usługę refresh-rate Container Apps, jak często należy sprawdzać zmiany w repozytorium Git.
Teraz, gdy masz istniejące środowisko i aplikację kontenera klienta serwera konfiguracji, możesz utworzyć wystąpienie składnika Java serwera konfiguracji dla platformy Spring.
Przejdź do środowiska aplikacji kontenera w portalu.
W menu nawigacji w kategorii Usługi wybierz pozycję Usługi.
Wybierz listę rozwijaną Konfiguruj , a następnie wybierz pozycję Składnik Java.
W panelu Konfigurowanie składnika Java wprowadź następujące wartości.
Właściwości
Wartość
Typ składnika Java
Wybierz pozycję Config Server for Spring (Serwer konfiguracji dla platformy Spring).
Nazwa składnika Java
Wprowadź wartość configserver.
W sekcji Repozytoria Git wybierz pozycję Dodaj, a następnie wprowadź następujące wartości:
To polecenie zwraca adres URL aplikacji kontenera, która korzysta z danych konfiguracji. Skopiuj adres URL do edytora tekstów, aby móc go użyć w kolejnym kroku.
Jeśli odwiedzasz aplikację w przeglądarce, connectTimeout zwracana wartość to wartość domyślna .0
Powiąż z serwerem konfiguracji spring.
Po utworzeniu aplikacji kontenera i serwera konfiguracji należy powiązać je razem z poleceniem update do aplikacji kontenera.
Parametr --bind $JAVA_COMPONENT_NAME tworzy połączenie między aplikacją kontenera a składnikiem konfiguracji.
Przejdź do środowiska aplikacji kontenera w portalu.
W menu nawigacji w kategorii Usługi wybierz pozycję Usługi.
Z listy wybierz pozycję configserver.
W obszarze powiązania wybierz listę rozwijaną Nazwa aplikacji, a następnie wybierz pozycję my-config-client.
Wybierz kartę Przegląd .
Wybierz Konfiguruj.
Wróć do aplikacji kontenera w portalu i skopiuj adres URL aplikacji do edytora tekstów, aby móc go użyć w kolejnym kroku.
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 to .10000 Ta wartość pochodzi z repozytorium Git ustawionego $URI w zmiennej pierwotnie ustawionej jako źródło składnika konfiguracji. W szczególności ta wartość jest pobierana z connectionTimeout właściwości 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:
Jeśli chcesz dostosować własny SPRING_CONFIG_IMPORTelement , możesz odwołać się do zmiennej środowiskowej SPRING_CLOUD_CONFIG_COMPONENT_URI — na przykład możesz zastąpić 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
Przejdź do środowiska aplikacji kontenera w portalu.
W menu nawigacji w kategorii Usługi wybierz pozycję Usługi.
Z listy wybierz pozycję configserver.
W obszarze Powiązania znajdź wiersz dla my-config-client, a następnie wybierz pozycję Usuń.
Wybierz Dalej.
Wybierz kartę Przegląd .
Wybierz Konfiguruj.
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 platformę 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:
Flaga wskazująca, że repozytorium powinno wymusić ściąganie. W przypadku truepolecenia odrzuć jakiekolwiek zmiany lokalne i przejmij je z repozytorium zdalnego.
Domyślna etykieta używana w usłudze Git jest główna. Jeśli nie ustawiono spring.cloud.config.server.git.default-label i gałąź o nazwie main nie istnieje, serwer konfiguracji domyślnie próbuje również wyewidencjonować gałąź o nazwie master. Jeśli chcesz wyłączyć zachowanie gałęzi rezerwowej, możesz ustawić wartość spring.cloud.config.server.git.tryMasterBranchfalse.
Flaga wskazująca, że repozytorium powinno zostać sklonowane podczas uruchamiania, a nie na żądanie. Zazwyczaj prowadzi do wolniejszego uruchamiania, ale szybszego pierwszego zapytania.
ssh-dssJeden z , , ssh-ed25519ssh-rsa, ecdsa-sha2-nistp256ecdsa-sha2-nistp384lub ecdsa-sha2-nistp521. Należy ustawić wartość , jeśli host-key jest również ustawiona.
Format wzorca to rozdzielona przecinkami lista {application}/{profile} nazw z symbolami wieloznacznymi. Jeśli {application}/{profile} nie pasuje do żadnego z wzorców, używa domyślnego identyfikatora URI zdefiniowanego w obszarze.
Poniższa lista zawiera opis typowych konfiguracji:
Wszelkie inne konfiguracje w logging.* przestrzeni nazw powinny być zabronione — na przykład zapisywanie plików dziennika przy użyciu logging.file polecenia powinno być zabronione.
spring.cloud.config.server.overrides
Dodatkowa mapa źródła właściwości do wysłania do wszystkich klientów bezwarunkowo.
spring.cloud.config.override-none
Priorytet wszystkich przesłonięć w kliencie można zmienić tak, aby był bardziej podobny do wartości domyślnych, umożliwiając aplikacjom dostarczanie własnych wartości w zmiennych środowiskowych 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, umieszczając dwie właściwości w konfiguracji aplikacji pochodzącej z serwera konfiguracji.
spring.cloud.config.server.health.*
Możesz skonfigurować wskaźnik kondycji, aby sprawdzić więcej aplikacji wraz z profilami niestandardowymi i etykietami niestandardowymi.
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 wartość , aby false wyłączyć odszyfrowywanie po stronie serwera.
Odśwież
Usługi, które korzystają z właściwości, muszą wiedzieć o zmianie przed jej wykonaniem. Domyślna metoda powiadamiania dla serwera konfiguracji platformy Spring obejmuje ręczne wyzwolenie zdarzenia odświeżania, takie jak odświeżanie według wywołania https://<YOUR_CONFIG_CLIENT_HOST_NAME>/actuator/refresh, co może nie być możliwe, jeśli istnieje wiele wystąpień aplikacji.
Zamiast tego można automatycznie odświeżać wartości z serwera konfiguracji, pozwalając klientowi konfiguracji sondować pod kątem zmian na podstawie wewnętrznego odświeżania. Wykonaj następujące kroki, aby automatycznie odświeżyć wartości z serwera konfiguracji:
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));
}
}
}
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 ustawiona wartość false i refresh-interval jest ustawiona na 60 sekund.
Możesz użyć odszyfrowywania po stronie klienta właściwości, wykonując następujące kroki:
Dodaj zaszyfrowaną właściwość w pliku properties w repozytorium Git.
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 <> wartościami.
W aplikacji klienckiej dodaj klucz ENCRYPT_KEY=randomKey odszyfrowywania jako zmienną środowiskową.
Alternatywnie, jeśli uwzględnisz spring-cloud-starter-bootstrap element w elemecie classpath, lub ustawisz spring.cloud.bootstrap.enabled=true jako właściwość systemową, ustaw wartość w elembootstrap.properties.encrypt.key
Przed uruchomieniem następującego polecenia zastąp symbole zastępcze otoczone <> wartościami.
Dołącz do serii meetup, aby tworzyć skalowalne rozwiązania sztucznej inteligencji oparte na rzeczywistych przypadkach użycia z innymi deweloperami i ekspertami.