Настройка управляемого Spring Cloud Config Server в Azure Spring Apps

Эта статья относится к:✅ Java ✅ C#

Эта статья относится к:✅ стандартное потребление и выделенная (предварительная версия) ✅ Basic/Standard ✅ Enterprise

В этой статье показано, как настроить управляемый сервер конфигурации Spring Cloud в Azure Spring Apps.

Spring Cloud Config Server предоставляет поддержку на стороне сервера и клиента для внешней конфигурации в распределенной системе. Экземпляр сервера конфигурации Spring Cloud предоставляет центральное место для управления внешними свойствами для приложений во всех средах. Дополнительные сведения см. в разделе Spring Cloud Config.

Требования

• Подписка Azure. Если у вас еще нет подписки Azure, создайте бесплатную учетную запись, прежде чем начинать работу.

• Git.

Ограничения

При использовании сервера конфигурации с серверной частью Git есть некоторые ограничения. Следующие свойства автоматически внедряются в среду приложения для доступа к серверу конфигурации и обнаружению служб. Настроив эти свойства из файлов сервера конфигурации, вы можете столкнуться с конфликтами и непредвиденным поведением.

• eureka.client.service-url.defaultZone
• eureka.client.tls.keystore
• eureka.instance.preferIpAddress
• eureka.instance.instance-id
• server.port
• spring.cloud.config.tls.keystore
• spring.config.import
• spring.application.name
• spring.jmx.enabled
• management.endpoints.jmx.exposure.include

Создание файлов сервера конфигурации

Azure Spring Apps поддерживает Azure DevOps Server, GitHub, GitLab и Bitbucket для хранения файлов сервера конфигурации. Когда репозиторий готов, вы можете создать файлы конфигурации и сохранить их там.

Некоторые настраиваемые свойства доступны только для определенных типов. В следующих разделах описаны свойства для каждого типа репозитория.

Общедоступный репозиторий

При использовании общедоступный репозиторий настраиваемые свойства являются более ограниченными, чем в частном репозитории.

В следующей таблице перечислены настраиваемые свойства, которые можно использовать для настройки общедоступного репозитория Git:

Частный репозиторий с проверкой подлинности SSH

В следующей таблице перечислены настраиваемые свойства, которые можно использовать для настройки частного репозитория Git с помощью SSH:

Частный репозиторий с обычной проверкой подлинности

В следующей таблице перечислены настраиваемые свойства, которые можно использовать для настройки частного репозитория Git с базовой проверкой подлинности:

Другие репозитории Git

В следующей таблице перечислены настраиваемые свойства, которые можно использовать для настройки репозиториев Git с помощью шаблона:

В следующей таблице показаны некоторые примеры шаблонов для настройки службы с дополнительным репозиторием. Дополнительные сведения см. в разделе "Дополнительные репозитории" в этой статье и разделе "Сопоставление шаблонов" и "Несколько репозиториев" в spring Cloud Config.

Настройка репозитория Git для сервера конфигурации

После сохранения файлов конфигурации в репозитории выполните следующие действия, чтобы подключить Azure Spring Apps к репозиторию:

1. Войдите на портал Azure.

2. Перейдите на страницу Обзор Azure Spring Apps.

3. Выберите Spring Cloud Config Server в области навигации.

4. В разделе Репозиторий по умолчанию задайте для URI значение https://github.com/Azure-Samples/piggymetrics-config.

5. Выберите Проверить.

   

   

6. После завершения проверки нажмите Применить, чтобы сохранить изменения.

   

   

На обновление конфигурации может потребоваться несколько минут. После завершения настройки вы получите уведомление.

Введение данных репозитория непосредственно на портал Azure

Вы можете ввести сведения о репозитории по умолчанию и, при необходимости, для дополнительных репозиториев.

Репозиторий по умолчанию

В этом разделе показано, как ввести сведения о репозитории для общедоступного или частного репозитория. Для частного репозитория можно использовать обычную проверку подлинности или SSH.

Чтобы ввести сведения о репозитории для общедоступного репозитория, выполните следующие действия.

1. В разделе Репозиторий по умолчанию вставьте URI репозитория в поле URI.
2. В поле Метка введите config.
3. Убедитесь, что параметр проверки подлинности является общедоступным.
4. Выберите Применить.

Чтобы ввести сведения о репозитории для частного репозитория, выполните следующие действия, используя обычную проверку подлинности на основе пароля или токена:

1. В разделе Репозиторий по умолчанию вставьте URI репозитория в поле URI.

2. В разделе "Проверка подлинности" выберите "Изменить проверку подлинности".

3. В области Изменить проверку подлинности, в раскрывающемся списке Тип проверки подлинности, выберите HTTP Basic.

4. Введите имя пользователя и пароль или маркер, чтобы предоставить доступ к Azure Spring Apps.

5. Выберите ОК, а затем Применить, чтобы завершить настройку экземпляра сервера конфигурации.

   

   Примечание.

   Многие серверы репозитория Git поддерживают использование маркеров, а не паролей для базовой проверки подлинности HTTP. Некоторые репозитории позволяют сохранять токены в течение неограниченного времени. Однако на некоторых серверах репозитория Git, включая Azure DevOps Server, срок действия токенов может заканчиваться через несколько часов. Репозитории, на которые истекает срока действия токенов, не должны использовать проверку подлинности на основе токенов в Azure Spring Apps. Если вы используете такой маркер, не забудьте обновить его до истечения срока действия.

   GitHub удалил поддержку проверки подлинности паролей, поэтому вместо проверки подлинности паролей для GitHub необходимо использовать личный маркер доступа. Дополнительные сведения см. в разделе «Требования к аутентификации токена для операций Git».

Чтобы ввести сведения о репозитории для частного репозитория с помощью SSH, выполните следующие действия.

1. В разделе Репозиторий по умолчанию вставьте URI репозитория в поле URI.

2. В разделе "Проверка подлинности" выберите "Изменить проверку подлинности".

3. На панели Изменить проверку подлинности в раскрывающемся списке Тип проверки подлинности выберите SSH.

4. Введите закрытый ключ. При необходимости укажите ключ узла и алгоритм ключа узла.

5. Включите открытый ключ в репозиторий сервера конфигурации.

6. Нажмите ОК, а затем Применить, чтобы завершить настройку экземпляра сервера конфигурации.

   

Дополнительные репозитории

Если вы хотите настроить службу с необязательным дополнительным репозиторием, выполните следующие действия.

1. Укажите параметры URI и проверки подлинности, как и для репозитория по умолчанию. Не забудьте включить параметр имени для шаблона.
2. Выберите Применить, чтобы присоединить репозиторий к вашему экземпляру.

Настройка репозитория Git путем импорта YAML-файла

Если вы написали ФАЙЛ YAML с параметрами репозитория, вы можете импортировать файл непосредственно с локального компьютера в Azure Spring Apps. В следующем примере показан простой ФАЙЛ YAML для частного репозитория с базовой проверкой подлинности:

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

Чтобы импортировать YAML-файл, выполните следующие действия.

1. Выберите параметры импорта и выберите ФАЙЛ YAML из каталога проекта. Выберите Импорт.

   

   

   В панели уведомлений отображается async операция. Сервер конфигурации должен сообщать об успешном выполнении через 1–2 минуты. Сведения из файла YAML отображаются в портале Azure.

2. Нажмите кнопку Применить, чтобы завершить импорт.

Настройка Azure Repos для сервера конфигурации

Azure Spring Apps может получить доступ к общедоступным репозиториям Git, защищенным с помощью SSH или обычной проверки подлинности HTTP. Обычная проверка подлинности HTTP — это самый простой из вариантов создания репозиториев и управления ими с помощью Azure Repos.

Получение URL-адреса репозитория и учетных данных

Чтобы получить URL-адрес и учетные данные репозитория, выполните следующие действия.

1. На портале Azure Repos для вашего проекта выберите Клонировать.

2. Скопируйте URL-адрес клона из текстового поля. Этот URL-адрес обычно находится в следующей форме:

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

   Удалите все после https:// и до dev.azure.comэтого, включая @ символ. Результирующий URL-адрес должен находиться в следующей форме:

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

   Сохраните этот URL-адрес для последующего использования.

3. Выберите "Создать учетные данные Git" , чтобы отобразить имя пользователя и пароль. Сохраните это имя пользователя и пароль для использования в следующем разделе.

Настройка репозитория Git для сервера конфигурации

Чтобы настроить репозиторий, выполните следующие действия.

1. Войдите на портал Azure.

2. Перейдите на страницу Обзор Azure Spring Apps.

3. Выберите службу для настройки.

4. В левой области страницы службы в разделе "Параметры" выберите вкладку "Сервер конфигурации Spring Cloud".

5. Чтобы настроить созданный репозиторий, выполните следующие действия.

   • Добавьте URI репозитория, сохраненный ранее.
   • Выберите параметр в разделе "Проверка подлинности", чтобы открыть панель "Изменить проверку подлинности".
   • Для типа проверки подлинности выберите HTTP Basic.
   • Для имени пользователя укажите имя пользователя, сохраненное ранее.
   • В поле "Пароль" укажите пароль, сохраненный ранее.
   • Нажмите кнопку "ОК", а затем дождитесь завершения операции.

   

az spring config-server bind \
    --resource-group <resource-group> \
    --service <service-name> \
    --app <app-name>

az spring app create \ 
    --resource-group <resource-group> \ 
    --service <service-name> \ 
    --name <app-name> \ 
    --bind-config-server

Удалите свою конфигурацию

Выберите "Сброс" на вкладке "Сервер конфигурации Spring Cloud", чтобы удалить существующие параметры. Удалите параметры сервера конфигурации, если вы хотите подключить экземпляр сервера конфигурации к другому источнику, например при переходе с GitHub на сервер Azure DevOps Server.

Обновление сервера конфигурации

При изменении свойств службы, используемые этими свойствами, должны быть уведомлены перед внесением изменений. Решение по умолчанию для Сервера конфигурации Spring Cloud — вручную активировать событие обновления, которое может оказаться невозможным при наличии большого количества экземпляров приложения. Дополнительные сведения см. в разделе "Централизованная конфигурация"

Вместо этого можно автоматически обновить значения из сервера конфигурации, предоставив клиенту конфигурации опрос изменений на основе внутреннего обновления.

Выполните следующие действия для автоматического обновления значений с сервера конфигурации.

1. Зарегистрируйте запланированную задачу для обновления контекста в заданном интервале, как показано в следующем примере:

   @ConditionalOnBean({RefreshEndpoint.class})
   @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 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(), refreshInterval * 1000);
           }
       }
   }
   

2. Включите autorefresh и задайте соответствующий интервал обновления в файле application.yml . В следующем примере клиент опрашивает изменения конфигурации каждые 60 секунд, что является минимальным значением, которое можно задать для интервала обновления.

   По умолчанию для параметра autorefresh задано false значение, а интервал обновления имеет значение 60 seconds.

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

3. Добавьте @RefreshScope в код. В следующем примере переменная connectTimeout автоматически обновляется каждые 60 секунд.

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

Дополнительные сведения см. в примере config-client-polling.

az spring config-server create \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-service-instance-name>

az spring config-server delete \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-service-instance-name>

Связанный контент

Azure Spring Apps