Konfigurera en Spring Cloud Config Server instans för din tjänst

Den här artikeln gäller för: ✔️ Java ✔️ C #

Den här artikeln visar hur du ansluter en Spring Cloud Config Server-instans till din Azure Spring Cloud tjänst.

Spring Cloud Config ger stöd på server- och klientsidan för en externaliserad konfiguration i ett distribuerat system. Med Config Server instansen har du en central plats där du kan hantera externa egenskaper för program i alla miljöer. Mer information finns i Spring Cloud Config Server referens.

Förutsättningar

• En Azure-prenumeration. Om du inte har någon Azure-prenumeration kan du skapa ett kostnadsfritt konto innan du börjar.
• En redan etablerad och Azure Spring Cloud tjänst. Om du vill konfigurera och starta en Azure Spring Cloud-tjänst kan du gå till Snabbstart: Starta ett Java Spring-program med hjälp av Azure CLI.

Begränsning

Det finns vissa begränsningar när du använder Config Server med en Git-backend. Vissa egenskaper matas automatiskt in i programmiljön för att få åtkomst Config Server och Tjänstidentifiering. Om du även konfigurerar dessa egenskaper Config Server filer kan det uppstå konflikter och oväntat beteende. Egenskaperna är:

eureka.client.service-url.defaultZone
eureka.client.tls.keystore
server.port
spring.cloud.config.tls.keystore
spring.application.name
spring.jmx.enabled

Skapa dina Config Server filer

Azure Spring Cloud har stöd för Azure DevOps, GitHub, GitLab och Bitbucket för att lagra Config Server filer. När du har din lagringsplats klar skapar du konfigurationsfilerna med följande instruktioner och lagrar dem där.

Dessutom är vissa konfigurerbara egenskaper endast tillgängliga för vissa typer. I följande underavsnitt visas egenskaperna för varje typ av lagringsplats.

Offentlig lagringsplats

När du använder en offentlig lagringsplats är de konfigurerbara egenskaperna mer begränsade.

Alla konfigurerbara egenskaper som används för att konfigurera den offentliga Git-lagringsplatsen visas i följande tabell:

Privat lagringsplats med SSH-autentisering

Alla konfigurerbara egenskaper som används för att konfigurera en privat Git-lagringsplats med SSH visas i följande tabell:

Privat lagringsplats med grundläggande autentisering

Alla konfigurerbara egenskaper som används för att konfigurera en privat Git-lagringsplats med grundläggande autentisering visas nedan.

Ytterligare Git-lagringsplatsen

Alla konfigurerbara egenskaper som används för att konfigurera Git-lagringsplatsen med mönster visas nedan.

I följande tabell visas några exempel för avsnittet Ytterligare lagringsplatsen. Mer information finns i Mönstermatchning och Flera lagringsplatsen i Spring-dokumentationen.

Bifoga din Config Server till Azure Spring Cloud

Nu när konfigurationsfilerna har sparats i en lagringsplats måste du ansluta Azure Spring Cloud till den.

1. Logga in på Azure-portalen.

2. Gå till sidan Azure Spring Cloud översikt.

3. Välj Config Server i det vänstra navigeringsfönstret.

4. I avsnittet Standarddatabas anger du URI till " https://github.com/Azure-Samples/piggymetrics-config ".

5. Välj Verifiera.

   

6. När verifieringen är klar väljer du Använd för att spara ändringarna.

   

7. Det kan ta några minuter att uppdatera konfigurationen.

   

8. Du bör få ett meddelande när konfigurationen är klar.

Ange lagringsplatsinformation direkt till Azure Portal

Standarddatabas

• Offentlig lagringsplats: I avsnittet Standarddatabas i rutan URI klistrar du in lagringsplatsens URI. Ange etikett för att konfigurera. Kontrollera att autentiseringsinställningen är Offentlig och välj sedan Använd för att slutföra.

• Privat lagringsplats: Azure Spring Cloud stöder grundläggande lösenords-/tokenbaserad autentisering och SSH.

  • Grundläggande autentisering: I avsnittet Standarddatabas i rutan URI klistrar du in lagringsplatsens URI och väljer sedan knappen Autentisering ("pennikonen"). I fönstret Redigera autentisering i listrutan Autentiseringstyp väljer du HTTP Basic och anger sedan ditt användarnamn och lösenord/token för att bevilja åtkomst till Azure Spring Cloud. Välj OK och välj sedan Tillämpa för att slutföra Config Server instansen.

  

  Varning

  Vissa Git-lagringsplatsservrar använder en personlig token eller en åtkomsttoken, till exempel ett lösenord, för grundläggande autentisering. Du kan använda den typen av token som ett lösenord i Azure Spring Cloud, eftersom den aldrig upphör att gälla. Men för andra Git-lagringsservrar, till exempel Bitbucket och Azure DevOps Server, upphör åtkomsttoken att gälla om en eller två timmar. Det innebär att alternativet inte är praktiskt när du använder dessa lagringsplatsservrar med Azure Spring Cloud. Github har tagit bort stödet för lösenordsautentisering, så du måste använda en personlig åtkomsttoken i stället för lösenordsautentisering för Github. Mer information finns i Tokenautentisering.

  • SSH: I avsnittet Standarddatabas i rutan URI klistrar du in lagringsplatsens URI och väljer sedan knappen Autentisering ("pennikonen"). I fönstret Redigera autentisering i listrutan Autentiseringstyp väljer du SSH och anger sedan din privata nyckel. Du kan också ange din värdnyckel och värdnyckelalgoritmen. Se till att inkludera din offentliga nyckel i din Config Server lagringsplats. Välj OK och välj sedan Tillämpa för att slutföra Config Server instansen.

  

Ytterligare lagringsplatsen

Om du vill använda en valfri ytterligare lagringsplats för att konfigurera din tjänst anger du URI och autentisering på samma sätt som standarddatabasen. Se till att inkludera ett Namn för mönstret och välj sedan Tillämpa för att koppla det till din instans.

Ange lagringsplatsinformation i en YAML-fil

Om du har skrivit en YAML-fil med dina lagringsplatsinställningar kan du importera filen direkt från den lokala datorn till Azure Spring Cloud. En enkel YAML-fil för en privat lagringsplats med grundläggande autentisering skulle se ut så här:

spring:
    cloud:
        config:
            server:
                git:
                    uri: https://github.com/azure-spring-cloud-samples/config-server-repository.git
                    username: <username>
                    password: <password/token>

Välj knappen Importera inställningar och välj sedan YAML-filen från projektkatalogen. Välj Importera så visas async en åtgärd från meddelandena. Efter 1–2 minuter bör det rapportera att det lyckades.

Informationen från YAML-filen ska visas i Azure Portal. Välj Tillämpa för att slutföra.

Använda Azure-lagringsplatsen Azure Spring Cloud konfiguration

Azure Spring Cloud kan komma åt Git-lagringsplatser som är offentliga, som skyddas av SSH eller som skyddas med hjälp av grundläggande HTTP-autentisering. Vi använder det sista alternativet eftersom det är enklare att skapa och hantera med Azure Repos.

Hämta lagringsplatsens URL och autentiseringsuppgifter

1. I Azure Repos-portalen för projektet väljer du knappen Klona:

   

2. Kopiera klon-URL:en från textrutan. Den här URL:en visas vanligtvis i följande format:

   https://<organization name>@dev.azure.com/<organization name>/<project name>/_git/<repository name>
   

   Ta bort allt https:// efter och före , inklusive dev.azure.com @ . Den resulterande URL:en ska ha följande format:

   https://dev.azure.com/<organization name>/<project name>/_git/<repository name>
   

   Spara den här URL:en för användning i nästa avsnitt.

3. Välj Generera Git-autentiseringsuppgifter. Ett användarnamn och lösenord visas. Spara dessa för användning i nästa avsnitt.

Konfigurera Azure Spring Cloud för åtkomst till Git-lagringsplatsen

1. Logga in på Azure-portalen.

2. Gå till sidan Azure Spring Cloud översikt.

3. Välj den tjänst som ska konfigureras.

4. I den vänstra rutan på tjänstsidan, under Inställningar, väljer du Config Server fliken. Konfigurera den lagringsplats som vi skapade tidigare:

   • Lägg till lagringsplatsens URL som du har sparat från föregående avsnitt.
   • Välj Autentisering och sedan HTTP Basic.
   • Användarnamnet är det användarnamn som sparades från föregående avsnitt.
   • Lösenordet är det lösenord som sparades från föregående avsnitt.
   • Välj Tillämpa och vänta sedan tills åtgärden har lyckats.

   

Ta bort konfigurationen

Du kan välja knappen Återställ som visas på fliken Config Server för att radera dina befintliga inställningar helt. Ta bort konfigurationsserverinställningarna om du vill ansluta din Config Server till en annan källa, till exempel flytta från GitHub till Azure DevOps.

Config Server Uppdatera

När egenskaper ändras måste tjänster som förbrukar dessa egenskaper meddelas innan ändringar kan göras. Standardlösningen för Spring Cloud Config är att utlösa uppdateringshändelsen manuellt,vilket kanske inte är möjligt om det finns många appinstanser. Alternativt kan du Azure Spring Cloud uppdatera värden automatiskt från konfigurationsservern genom att låta konfigurationsklienten avse ändringar baserat på en intern uppdatering.

• Ta först med spring-cloud-starter-azure-spring-cloud-client i beroendeavsnittet i pom.xml.

  <dependency>
      <groupId>com.microsoft.azure</groupId>
      <artifactId>spring-cloud-starter-azure-spring-cloud-client</artifactId>
      <version>2.4.0</version>
  </dependency>
  

• För det andra aktiverar du automatisk uppdatering och anger lämpligt uppdateringsintervall i application.yml. I det här exemplet avsöker klienten konfigurationsändringar var femte sekund, vilket är det minsta värde som du kan ange för uppdateringsintervall. Som standard är automatisk uppdatering inställt på falskt och uppdateringsintervallet är inställt på 60 sekunder.

  spring:
    cloud:
      config:
        auto-refresh: true
        refresh-interval: 5
  

• Lägg slutligen @refreshScope till i koden. I det här exemplet uppdateras variabeln connectTimeout automatiskt var femte sekund.

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

Nästa steg

I den här artikeln har du lärt dig hur du aktiverar och konfigurerar Spring Cloud Config Server instans. Mer information om hur du hanterar ditt program finns i Skala ett program i Azure Spring Cloud.