Configuración de una instancia de Config Server en Spring Cloud para su servicio

Este artículo se aplica a: ✔️ Java ✔️ C#

En este tutorial se muestra cómo conectar una instancia de Config Server en Spring Cloud con el servicio Azure Spring Cloud.

Spring Cloud Config ofrece soporte técnico para servidor y cliente para las configuraciones externalizadas de un sistema distribuido. La instancia de Config Server es un lugar centralizado donde puede administrar las propiedades externas de las aplicaciones de todos los entornos. Para más información al respecto, consulte la Guía de referencia de Config Server en Spring Cloud.

Requisitos previos

• Suscripción a Azure. Si no tiene una suscripción a Azure, cree una cuenta gratuita antes de empezar.
• Un servicio de Azure Spring Cloud aprovisionado y en ejecución. Para configurar e iniciar el servicio Azure Spring Cloud, consulte Inicio rápido: Inicio de una aplicación Java Spring mediante la CLI de Azure.

Restricción

Cuando se usa Config Server con un back-end de Git, hay algunas restricciones. Algunas propiedades se insertan automáticamente en el entorno de una aplicación para acceder a Config Server y a Service Discovery. Si también configura esas propiedades desde los archivos de Config Server, pueden aparecer conflictos y un comportamiento inesperado. Estas propiedades incluyen:

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

Creación de los archivos del servidor de configuración

Azure Spring Cloud admite Azure DevOps, GitHub, GitLab y Bitbucket para almacenar los archivos del servidor de configuración. Cuando el repositorio esté preparado, cree los archivos de configuración con las siguientes instrucciones y almacénelos ahí.

Además, algunas propiedades configurables solo están disponibles para ciertos tipos. En las siguientes subsecciones se enumeran las propiedades de cada tipo de repositorio.

Repositorio público

Si se usa un repositorio público, las propiedades configurables son más limitadas.

En la siguiente tabla se enumeran todas las propiedades configurables que se usan para configurar el repositorio de Git público:

Repositorio privado con autenticación SSH

En la siguiente tabla se enumeran todas las propiedades configurables que se usan para configurar el repositorio de Git privado con SSH:

Repositorio privado con autenticación básica

A continuación se enumeran todas las propiedades configurables que se usan para configurar el repositorio de Git privado con autenticación básica.

Repositorios adicionales de Git

A continuación se enumeran todas las propiedades configurables que se usan para configurar los repositorios GIT con patrones.

En la tabla siguiente se muestran algunos ejemplos de la sección Repositorios adicionales. Para más información, consulte Coincidencia de patrones y repositorios múltiples en la documentación de Spring.

Conexión de un repositorio de Config Server a Azure Spring Cloud

Una vez que los archivos de configuración se han guardado en un repositorio, es preciso conectarlo a Azure Spring Cloud.

1. Inicie sesión en Azure Portal.

2. Vaya a la página Información general de Azure Spring Cloud.

3. Seleccione Config Server en el panel de navegación izquierdo.

4. En la sección Default repository (Repositorio predeterminado), en URI seleccione "https://github.com/Azure-Samples/piggymetrics-config".

5. Seleccione Validar.

   

6. Cuando finalice la validación, seleccione Aplicar para guardar los cambios.

   

7. La actualización de la configuración puede tardar unos minutos.

   

8. Cuando se haya completado la configuración, debería recibir una notificación.

Especificación de la información del repositorio directamente en Azure Portal

Repositorio predeterminado

• Repositorio público: en la sección Repositorio predeterminado, en el cuadro URI, pegue el identificador URI del repositorio. En el campo Etiqueta, seleccione config. Asegúrese de que el valor de Autenticación es Pública y, después, seleccione Aplicar para finalizar.

• Repositorio privado: Azure Spring Cloud admite la autenticación básica basada en contraseñas o en tokens, y SSH.

  • Autenticación básica: en la sección Default repository (Repositorio predeterminado), en el cuadro URI, pegue el identificador URI del repositorio y, después, seleccione el botón de autenticación (icono de "lápiz"). En el panel Edit Authentication (Editar autenticación), en la lista desplegable Authentication type (Tipo de autenticación), seleccione HTTP Basic (HTTP básica) y, después, escriba el nombre de usuario y la contraseña o el token para conceder acceso a Azure Spring Cloud. Seleccione OK (Aceptar) y Apply (Aplicar) para terminar de configurar la instancia de Config Server.

  

  Precaución

  Algunos servidores de repositorio de Git usan un token personal o un token de acceso, como una contraseña, para la autenticación básica. Esos tipos de token se pueden usar como contraseña en Azure Spring Cloud, ya que nunca expiran. Pero en el caso de otros servidores de repositorio de Git, como Bitbucket y Azure DevOps Server, el token de acceso expira en una o dos horas. Esto significa que la opción no es viable cuando se usan estos servidores de repositorio con Azure Spring Cloud. Github ha eliminado la compatibilidad con la autenticación de contraseña, por lo que debe usar un token de acceso personal en lugar de la autenticación de contraseña en GitHub. Para obtener más información, vea Autenticación de token.

  • SSH: en la sección Default repository (Repositorio predeterminado), en el cuadro URI, pegue el identificador URI del repositorio y, después, seleccione el botón de autenticación (icono de "lápiz"). En el panel Edit Authentication (Editar autenticación), en la lista desplegable Authentication type (Tipo de autenticación), seleccione SSH y, después, escriba su clave privada. También puede especificar los valores de Host key (Clave de host) y Host key algorithm (Algoritmo de claves de host). Asegúrese de incluir la clave pública en el repositorio de Config Server. Seleccione OK (Aceptar) y Apply (Aplicar) para terminar de configurar la instancia de Config Server.

  

Repositorios adicionales

Si quiere usar Repositorios adicionales de manera opcional para configurar el servicio, especifique el URI y la Autenticación al igual que el Repositorio predeterminado. En Name (Nombre), asigne un nombre al patrón y, después, seleccione Apply (Aplicar) para asociarlo a la instancia.

Introducción de la información del repositorio en un archivo YAML

Si ha escrito un archivo YAML con la configuración del repositorio, puede importarlo directamente desde la máquina local a Azure Spring Cloud. Un archivo YAML simple para un repositorio privado con autenticación básica tendrá un aspecto similar al siguiente:

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

Seleccione el botón Import settings (Importar configuración) y, después, seleccione el archivo YAML en el directorio del proyecto. Seleccione Import (Importar) y aparecerá una de las asyncoperaciones de Notifications (Notificaciones). Después de uno o dos minutos, debería informar de que se ha realizado correctamente.

La información del archivo YAML debería mostrarse en Azure Portal. Seleccione Apply (Aplicar) para finalizar.

Uso de Azure Repos para la configuración de Azure Spring Cloud

Azure Spring Cloud puede acceder a los repositorios de Git públicos, protegidos mediante SSH o protegidos mediante la autenticación HTTP básica. Usaremos esa última opción, ya que es más fácil de crear y administrar con Azure Repos.

Obtención de URL y credenciales del repositorio

1. En el portal de Azure Repos de su proyecto, seleccione el botón Clonar:

   

2. Copie la dirección URL de clonación del cuadro de texto. Esta dirección URL normalmente tendrá el siguiente formato:

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

   Quite todo lo que hay después de https:// y antes de dev.azure.com, incluido @. La dirección URL resultante debe tener este formato:

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

   Guarde esta dirección URL para usarla en la siguiente sección.

3. Seleccione Generar credenciales de GIT. Aparecerá un nombre de usuario y una contraseña. Guárdelos para su uso en la sección siguiente.

Configuración de Azure Spring Cloud para acceder al repositorio de GIT

1. Inicie sesión en Azure Portal.

2. Vaya a la página Información general de Azure Spring Cloud.

3. Seleccione el servicio que desea configurar.

4. En el panel izquierdo de la página del servicio, en Settings (Configuración), seleccione la pestaña Config Server (Servidor de configuraciones). Configure el repositorio que hemos creado anteriormente:

   • Agregue la dirección URL del repositorio que ha guardado en la sección anterior.
   • Seleccione Autenticación y, a continuación, Básica HTTP.
   • username es el nombre de usuario que se ha guardado en la sección anterior.
   • password es la contraseña que se ha guardado en la sección anterior.
   • Seleccione Aplicar y espere a que la operación se realice correctamente.

   

Eliminación de la configuración

Puede seleccionar el botón Restablecer que aparece en la pestaña Config Server para borrar completamente la configuración existente. Elimine la configuración de Config Server si desea conectar la instancia de Config Server a otro origen, por ejemplo, para pasarla de GitHub a Azure DevOps.

Actualización de Config Server

Cuando se cambian las propiedades, es necesario notificarlo a los servicios que las consumen antes de que se puedan realizar cambios. La solución predeterminada para Spring Cloud Config es desencadenar manualmente el evento de actualización, lo que puede no ser factible si hay muchas instancias de aplicación. Como alternativa, en Azure Spring Cloud puede actualizar automáticamente los valores del servidor de configuración al dejar que el cliente de configuración sondee los cambios en función de una actualización interna.

• En primer lugar, incluya spring-cloud-starter-azure-spring-cloud-client en la sección de dependencias del archivo pom.xml.

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

• En segundo lugar, habilite la actualización automática y establezca el intervalo de actualización adecuado en application.yml. En este ejemplo, el cliente sondeará los cambios de configuración cada 5 segundos, que es el valor mínimo que puede establecer para el intervalo de actualización. De forma predeterminada, la actualización automática se establece en false y el intervalo de actualización se establece en 60 segundos.

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

• Por último, agregue @refreshScope en el código. En este ejemplo, la variable connectTimeout se actualizará automáticamente cada 5 segundos.

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

Pasos siguientes

En este artículo, ha aprendido a habilitar y configurar una instancia de Config Server de Spring Cloud. Para más información sobre la administración de la aplicación, consulte Escalado de una aplicación en Azure Spring Cloud.