Använda Application Configuration Service for Tanzu

Den här artikeln gäller för:❌ Basic/Standard ✔️ Enterprise

Den här artikeln visar hur du använder Application Configuration Service för VMware Tanzu med Azure Spring Apps Enterprise-planen.

Application Configuration Service för VMware Tanzu är en av de kommersiella VMware Tanzu-komponenterna. Det möjliggör hantering av Kubernetes-inbyggda ConfigMap resurser som fylls i från egenskaper som definierats i en eller flera Git-lagringsplatser.

Med Application Configuration Service har du en central plats för att hantera externa egenskaper för program i alla miljöer. Information om skillnaderna från Spring Cloud Config Server i Basic- och Standard-abonnemangen finns i avsnittet Använd programkonfigurationstjänst för extern konfiguration i Migrera en Azure Spring Apps Basic- eller Standard-planinstans till Enterprise-planen.

Programkonfigurationstjänsten erbjuds i två versioner: Gen1 och Gen2. Gen1-versionen betjänar främst befintliga kunder i bakåtkompatibilitetssyfte och stöds endast fram till den 30 april 2024. Nya tjänstinstanser bör använda Gen2. Gen2-versionen använder flux som serverdel för att kommunicera med Git-lagringsplatser och ger bättre prestanda jämfört med Gen1.

I följande tabell visas underkomponentrelationerna:

I följande tabell visas några benchmark-data för din referens. Storleken på Git-lagringsplatsen är dock en nyckelfaktor med betydande inverkan på prestandadata. Vi rekommenderar att du endast lagrar de nödvändiga konfigurationsfilerna på Git-lagringsplatsen för att hålla den liten.

Gen2 ger också fler säkerhetsverifieringar när du ansluter till en fjärransluten Git-lagringsplats. Gen2 kräver en säker anslutning om du använder HTTPS och verifierar rätt värdnyckel och värdalgoritm när du använder en SSH-anslutning.

Du kan välja version av Application Configuration Service när du skapar en Azure Spring Apps Enterprise-tjänstinstans. Standardversionen är Gen1. Du kan också uppgradera till Gen2 när instansen har skapats, men nedgradering stöds inte. Uppgraderingen är noll stilleståndstid, men vi rekommenderar ändå att du testar i en mellanlagringsmiljö innan du flyttar till en produktionsmiljö.

Förutsättningar

• En redan etablerad Azure Spring Apps Enterprise-planinstans med Application Configuration Service aktiverad. Mer information finns i Snabbstart: Skapa och distribuera appar till Azure Spring Apps med hjälp av Enterprise-planen.

Hantera inställningar för programkonfigurationstjänsten

Application Configuration Service stöder Azure DevOps, GitHub, GitLab och Bitbucket för lagring av konfigurationsfiler.

Om du vill hantera tjänstinställningarna öppnar du avsnittet Inställningar . I det här avsnittet kan du konfigurera följande viktiga aspekter:

• Generation: Uppgradera tjänstgenereringen.
• Uppdateringsintervall: Justera frekvensen med vilken tjänsten söker efter uppdateringar från Git-lagringsplatser.
• Lagringsplatser: Lägg till nya poster eller ändra befintliga. Med den här funktionen kan du styra vilka lagringsplatser som tjänstövervakarna använder för att hämta data.

Om din nuvarande tjänstgenerering är Gen1 kan du uppgradera till Gen2 för bättre prestanda. Mer information finns i avsnittet Uppgradera från Gen1 till Gen2 .

Uppdateringsintervallet anger frekvensen (i sekunder) för att kontrollera uppdateringar på lagringsplatsen. Minimivärdet är 0, vilket inaktiverar automatisk uppdatering. För optimal prestanda anger du det här intervallet till ett lägsta värde på 60 sekunder.

I följande tabell beskrivs egenskaperna för varje lagringsplatspost:

Mönster

Konfiguration hämtas från Git-serverdelar med det du definierar i ett mönster. Ett mönster är en kombination av {application}/{profile} enligt beskrivningen i följande riktlinjer.

• {application} – Namnet på ett program vars konfiguration du hämtar. Värdet application anses vara standardprogrammet och innehåller konfigurationsinformation som delas mellan flera program. Andra värden refererar till ett specifikt program och innehåller egenskaper för både det specifika programmet och delade egenskaper för standardprogrammet.
• {profil} -Valfri. Namnet på en profil vars egenskaper du kan hämta. Ett tomt värde, eller värdet default, innehåller egenskaper som delas mellan profiler. Värden som inte är standard innehåller egenskaper för den angivna profilen och egenskaperna för standardprofilen.

Autentisering

Följande skärmbild visar de tre typerna av lagringsplatsautentisering som stöds av Application Configuration Service.

I följande lista beskrivs de tre autentiseringstyperna:

• Offentlig lagringsplats.

  Du behöver ingen extra autentiseringskonfiguration när du använder en offentlig lagringsplats. Välj Offentlig i formuläret Autentisering .

  I följande tabell visas den konfigurerbara egenskap som du kan använda för att konfigurera en offentlig Git-lagringsplats:

  Property	Obligatoriskt?	beskrivning
  CA certificate	Nej	Krävs endast när ett självsignerat certifikat används för Git-lagringsplatsens URL.

• Privat lagringsplats med grundläggande autentisering.

  I följande tabell visas de konfigurerbara egenskaper som du kan använda för att konfigurera en privat Git-lagringsplats med grundläggande autentisering:

  Property	Obligatoriskt?	beskrivning
  username	Ja	Användarnamnet som används för att komma åt lagringsplatsen.
  password	Ja	Lösenordet som används för att komma åt lagringsplatsen.
  CA certificate	Nej	Krävs endast när ett självsignerat certifikat används för Git-lagringsplatsens URL.

• Privat lagringsplats med SSH-autentisering.

  I följande tabell visas de konfigurerbara egenskaper som du kan använda för att konfigurera en privat Git-lagringsplats med SSH:

  Property	Obligatoriskt?	beskrivning
  Private key	Ja	Den privata nyckel som identifierar Git-användaren. Lösenfraskrypterade privata nycklar stöds inte.
  Host key	Nej för Gen1 Ja för Gen2	Värdnyckeln för Git-servern. Om du ansluter till servern via Git på kommandoraden finns värdnyckeln i filen .ssh/known_hosts . Inkludera inte algoritmprefixet eftersom det anges i Host key algorithm.
  Host key algorithm	Nej för Gen1 Ja för Gen2	Algoritmen för hostKey: en av ssh-dss, ssh-rsa, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384och ecdsa-sha2-nistp521. (Krävs om du Host keyanger ).
  Strict host key checking	Nej	Valfritt värde som anger om serverdelen ska ignoreras om det uppstår ett fel när du använder den angivna Host key. Giltiga värden är true och false. Standardvärdet är true.

Om du vill verifiera åtkomsten till mål-URI:n väljer du Verifiera. När valideringen har slutförts väljer du Använd för att uppdatera konfigurationsinställningarna.

Uppgradera från Gen1 till Gen2

Application Configuration Service Gen2 ger bättre prestanda jämfört med Gen1, särskilt när du har ett stort antal konfigurationsfiler. Vi rekommenderar att du använder Gen2, särskilt eftersom Gen1 snart dras tillbaka. Uppgraderingen från Gen1 till Gen2 är noll stilleståndstid, men vi rekommenderar ändå att du testar i en mellanlagringsmiljö innan du flyttar till en produktionsmiljö.

Gen2 kräver fler konfigurationsegenskaper än Gen1 när du använder SSH-autentisering. Du måste uppdatera konfigurationsegenskaperna i ditt program för att det ska fungera med Gen2. I följande tabell visas de egenskaper som krävs för Gen2 när du använder SSH-autentisering:

Använd följande steg för att uppgradera från Gen1 till Gen2:

1. I Azure-portalen går du till sidan Programkonfigurationstjänst för din Azure Spring Apps-tjänstinstans.

2. Välj avsnittet Inställningar och välj sedan Gen2 i listrutan Generation .

   

3. Välj Verifiera för att verifiera åtkomsten till mål-URI:n. När valideringen har slutförts väljer du Använd för att uppdatera konfigurationsinställningarna.

   

Stöd för flerspråkiga

Programkonfigurationstjänsten fungerar sömlöst med Spring Boot-program. Egenskaperna som genereras av tjänsten importeras som externa konfigurationer av Spring Boot och matas in i bönorna. Du behöver inte skriva extra kod. Du kan använda värdena med hjälp av anteckningen @Value , som nås via Spring's Environment-abstraktion eller så kan du binda dem till strukturerade objekt med hjälp av anteckningen @ConfigurationProperties .

Programkonfigurationstjänsten stöder också flerspråkiga appar som dotNET, Go, Python och så vidare. Om du vill komma åt konfigurationsfiler som du anger ska läsas in under polyglotappdistributionen i apparna kan du försöka komma åt en filsökväg som du kan hämta via en miljövariabel med ett namn som AZURE_SPRING_APPS_CONFIG_FILE_PATH. Du kan komma åt alla dina avsedda konfigurationsfiler under den sökvägen. Om du vill komma åt egenskapsvärdena i konfigurationsfilerna använder du de befintliga läs-/skrivfilbiblioteken för din app.

Uppdatera strategier

När du ändrar och checkar in dina konfigurationer på en Git-lagringsplats ingår flera steg innan dessa ändringar återspeglas i dina program. Den här processen omfattar, även om den är automatiserad, följande distinkta steg och komponenter, var och en med sin egen tidsinställning och sitt eget beteende:

• Avsökning efter programkonfigurationstjänst: Programkonfigurationstjänsten avsöker regelbundet git-lagringsplatserna för serverdelen för att identifiera eventuella ändringar. Den här avsökningen sker med en angiven frekvens som definieras av uppdateringsintervallet. När en ändring identifieras uppdaterar Programkonfigurationstjänsten Kubernetes ConfigMap.
• ConfigMap uppdatering och interaktion med kubelet cache: I Azure Spring Apps monteras detta ConfigMap som en datavolym till det relevanta programmet. Det finns dock en naturlig fördröjning i den här processen på grund av den frekvens med vilken kubelet uppdaterar sin cache för att identifiera ändringar i ConfigMap.
• Programmet läser den uppdaterade konfigurationen: Ditt program som körs i Azure Spring Apps-miljön har åtkomst till de uppdaterade konfigurationsvärdena. De befintliga bönorna i Spring Context uppdateras inte automatiskt för att använda de uppdaterade konfigurationerna.

Dessa steg sammanfattas i följande diagram:

Du kan justera avsökningsuppdateringsintervallet för programkonfigurationstjänsten så att det överensstämmer med dina specifika behov. För att tillämpa de uppdaterade konfigurationerna i ditt program krävs en omstarts- eller uppdateringsåtgärd.

I Spring-program lagras eller refereras egenskaper som bönor i Spring Context. Om du vill läsa in nya konfigurationer bör du överväga att använda följande metoder:

• Starta om programmet. Om du startar om programmet läses alltid den nya konfigurationen in.

• Anropa slutpunkten /actuator/refresh som exponeras på konfigurationsklienten via Spring Actuator.

  Om du vill använda den här metoden lägger du till följande beroende i konfigurationsklientens pom.xml-fil .

  <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-actuator</artifactId>
  </dependency>
  

  Du kan också aktivera aktuatorslutpunkten genom att lägga till följande konfiguration:

  management.endpoints.web.exposure.include=refresh, bus-refresh, beans, env
  

  När du har läst in egenskapskällorna igen genom att anropa /actuator/refresh slutpunkten uppdateras attributen som är bundna med @Value i bönorna med anteckningen @RefreshScope .

  @Service
  @Getter @Setter
  @RefreshScope
  public class MyService {
     @Value
     private Boolean activated;
  }
  

  Använd curl med programslutpunkten för att uppdatera den nya konfigurationen, som du ser i följande exempel:

  curl -X POST http://{app-endpoint}/actuator/refresh
  

• Använd FileSystemWatcher för att se hur filen ändras och uppdatera kontexten på begäran. FileSystemWatcher är en klass som levereras med spring-boot-devtools som bevakar specifika kataloger för filändringar, eller så kan du använda ett annat verktyg med liknande funktion. Föregående alternativ kräver att användarna initierar uppdateringen aktivt, medan den senare kan övervaka filändringar och automatiskt anropa uppdateringen när uppdateringar identifieras. Du kan hämta filsökvägen med hjälp av miljövariabeln AZURE_SPRING_APPS_CONFIG_FILE_PATH, enligt beskrivningen i avsnittet Polyglot-support .

Konfigurera inställningar för programkonfigurationstjänsten

az spring application-configuration-service git repo add \
    --name <entry-name> \
    --patterns <patterns> \
    --uri <git-backend-uri> \
    --label <git-branch-name>

Konfigurera TLS-certifikatet för åtkomst till Git-serverdelen med ett självsignerat certifikat för Gen2

Steget är valfritt. Om du använder ett självsignerat certifikat för Git-serverdelen måste du konfigurera TLS-certifikatet för åtkomst till Git-serverdelen.

Du måste ladda upp certifikatet till Azure Spring Apps först. Mer information finns i avsnittet Importera ett certifikat i Använda TLS/SSL-certifikat i ditt program i Azure Spring Apps.

az spring application-configuration-service git repo add \
    --name <entry-name> \
    --patterns <patterns> \
    --uri <git-backend-uri> \
    --label <git-branch-name> \
    --ca-cert-name <ca-certificate-name>

Använda Programkonfigurationstjänst med program

När du använder Application Configuration Service med en Git-serverdel och använder de centraliserade konfigurationerna måste du binda appen till Application Configuration Service.

az spring application-configuration-service bind --app <app-name>
az spring app deploy \
    --name <app-name> \
    --artifact-path <path-to-your-JAR-file> \
    --config-file-pattern <config-file-pattern>

Binda en app till programkonfigurationstjänsten

Nu kan du välja att binda programmet till programkonfigurationstjänsten när du skapar en ny app.

az spring app create \ 
    --resource-group <resource-group> \ 
    --service <service-name> \ 
    --name <app-name> \ 
    --bind-application-configuration-service 

Aktivera/inaktivera programkonfigurationstjänsten när tjänsten har skapats

Du kan aktivera och inaktivera programkonfigurationstjänsten när tjänsten har skapats med hjälp av Azure-portalen eller Azure CLI. Innan du inaktiverar Programkonfigurationstjänsten måste du avbinda alla dina appar från den.

az spring application-configuration-service create \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-service-instance-name>

az spring application-configuration-service delete \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-service-instance-name>

Granska konfigurationsfilen i ConfigMap

I följande avsnitt visas hur du undersöker innehållet i konfigurationsfilen som hämtas av Application Configuration Service från överordnade Git-lagringsplatser i relaterade Kubernetes ConfigMap. Mer information finns i avsnittet Uppdatera strategier i den här artikeln.

Tilldela en Azure-roll

Först måste du ha azure-rollen Azure Spring Apps Application Configuration Service Config File Pattern Reader Role tilldelad till dig.

az role assignment create \
    --role "Azure Spring Apps Application Configuration Service Config File Pattern Reader Role" \
    --scope "<service-instance-resource-id>" \
    --assignee "<your-identity>"

Granska konfigurationsfilen med Azure CLI

Använd följande kommando för att visa innehållet i konfigurationsfilen efter mönster:

az spring application-configuration-service config show \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --config-file-pattern <pattern>

Det här kommandot genererar JSON-utdata som liknar följande exempel:

{
  "configurationFiles": {
    "application.properties": [
      "example.property.application.name: example-service",
      "example.property.cloud: Azure"
    ]
  },
  "metadata": {
    "gitRevisions": "[{\"url\":\"{gitRepoUrl}\",\"revision\":\"{revisionInfo}\"}]"
  }
}

Du kan också använda det här kommandot med parametern --export-path {/path/to/target/folder} för att exportera konfigurationsfilen till den angivna mappen. Den stöder både relativa sökvägar och absoluta sökvägar. Om du inte anger sökvägen använder kommandot sökvägen till den aktuella katalogen som standard.

Granska konfigurationsfilen i appen

När du har bindat appen till programkonfigurationstjänsten och angett mönstret för appdistributionen, enligt beskrivningen i avsnittet Använd programkonfigurationstjänst med program i den här artikeln, ska den ConfigMap som innehåller konfigurationsfilen för mönstret monteras på programcontainern. Använd följande steg för att kontrollera konfigurationsfilerna i varje instans av appdistributionen:

1. Anslut till en av programinstanserna. Mer information finns i Ansluta till en appinstans för felsökning.

2. echo $AZURE_SPRING_APPS_CONFIG_FILE_PATH Använd kommandot för att hitta mapparna som innehåller konfigurationsfilerna. En lista över platser visas avgränsade med kommatecken, som du ser i följande exempel:

     $ echo $AZURE_SPRING_APPS_CONFIG_FILE_PATH
     /etc/azure-spring-cloud/configmap/acs-default-payment-default-e9d46,/etc/azure-spring-cloud/configmap/acs-default-catalog-default-616f4
   

3. Kontrollera innehållet i konfigurationsfilen med hjälp av kommandon som cat.

Kontrollera loggar

I följande avsnitt visas hur du visar programloggar med hjälp av antingen Azure CLI eller Azure-portalen.

Använda loggströmning i realtid

Du kan strömma loggar i realtid med Azure CLI. Mer information finns i Strömma azure Spring Apps-hanterade komponentloggar i realtid. I följande exempel visas hur du kan använda Azure CLI-kommandon för att kontinuerligt strömma nya loggar för application-configuration-service och flux-source-controller underkomponenter.

Använd följande kommando för att strömma loggar för application-configuration-service:

az spring component logs \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --name application-configuration-service \
    --all-instances \
    --follow

Använd följande kommando för att strömma loggar för flux-source-controller:

az spring component logs \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --name flux-source-controller \
    --all-instances \
    --follow

Använda Log Analytics

I följande avsnitt visas hur du aktiverar och visar systemloggar med Log Analytics.

Diagnostikinställningar för Log Analytics

Du måste aktivera systemloggar och skicka loggarna till Log Analytics-instansen innan du kör frågor mot loggarna för Application Configuration Service. Använd följande steg för att aktivera systemloggar i Azure-portalen:

1. Öppna din Azure Spring Apps-instans.

2. I navigeringsfönstret väljer du Diagnostikinställningar.

3. Välj Lägg till diagnostikinställning eller välj Redigera inställning för en befintlig inställning.

4. I avsnittet Loggar väljer du kategorin Systemloggar.

5. I avsnittet Målinformation väljer du Skicka till Log Analytics-arbetsyta och sedan din arbetsyta.

6. Välj Spara för att uppdatera inställningen.

Kontrollera loggar i Log Analytics

Om du vill kontrollera loggarna application-configuration-service för och flux-source-controller använda Azure-portalen använder du följande steg:

1. Kontrollera att du har aktiverat systemloggar. Mer information finns i avsnittet Diagnostikinställningar för Log Analytics .

2. Öppna din Azure Spring Apps-instans.

3. I navigeringsmenyn väljer du Loggar och sedan Översikt.

4. Använd följande exempelfrågor i frågeredigeringsfönstret. Justera tidsintervallet och välj sedan Kör för att söka efter loggar.

   • Om du vill visa loggarna för application-configuration-serviceanvänder du följande fråga:

     AppPlatformSystemLogs
     | where LogType in ("ApplicationConfigurationService")
     | project TimeGenerated , ServiceName , LogType, Log , _ResourceId
     | limit 100
     

     

   • Om du vill visa loggarna för flux-source-controlleranvänder du följande fråga:

     AppPlatformSystemLogs
     | where LogType in ("Flux")
     | project TimeGenerated , ServiceName , LogType, Log , _ResourceId
     | limit 100
     

     

Granska Git-revisioner av konfigurationsfilerna

Du hittar Git-revisionen av konfigurationsfilen för mönstret i loggarna för Application Configuration Service. Följande exempellogg anger att konfigurationsfilen för payment/default mönstret hämtas från example-commit-id -grenen main av lagringsplatsen https://github.com/Azure-Samples/acme-fitness-store-config . Du kan lära dig hur du frågar efter loggar i avsnittet Kontrollera loggar .

Applied ConfigMap ({config-map-name}) for content (payment/default) from Git repositories https://github.com/Azure-Samples/acme-fitness-store-config@main@sha1:{example-commit-id}

Du kan också hitta Git-revisionen med hjälp av Azure CLI. Mer information finns i avsnittet Granska konfigurationsfilen med Azure CLI .

Felsöka kända problem

Om de senaste ändringarna inte återspeglas i programmen kontrollerar du följande objekt baserat på avsnittet Uppdatera strategier :

• Kontrollera att Git-lagringsplatsen har uppdaterats korrekt genom att kontrollera följande objekt:
  • Bekräfta att grenen av de önskade konfigurationsfiländringarna har uppdaterats.
  • Kontrollera att mönstret som konfigurerats i programkonfigurationstjänsten matchar de uppdaterade konfigurationsfilerna.
  • Bekräfta att programmet är bundet till programkonfigurationstjänsten.
• Bekräfta att Programkonfigurationstjänsten använder rätt Git-revisioner enligt beskrivningen i avsnittet Granska Git-revisioner av konfigurationsfilerna .
• Bekräfta att den ConfigMap som innehåller konfigurationsfilen för det mönster som används av programmet har uppdaterats, enligt beskrivningen i avsnittet Granska konfigurationsfilen i ConfigMap i den här artikeln. Om den inte uppdateras skapar du ett ärende.
• Bekräfta att ConfigMap är monterat på programmet som en fil, enligt beskrivningen i avsnittet Granska konfigurationsfilen i appavsnittet i den här artikeln. Om filen inte uppdateras väntar du på Kubernetes uppdateringsintervall (1 minut) eller framtvingar en uppdatering genom att starta om programmet.

När du har kontrollerat dessa objekt bör programmen kunna läsa de uppdaterade konfigurationerna. Om programmen fortfarande inte uppdateras skapar du ett ärende.

Relaterat innehåll

Azure Spring Apps