Настройка шлюза VMware Spring Cloud

Статья
02/02/2024

Примечание.

Azure Spring Apps — это новое название службы Azure Spring Cloud. Старое название будет еще некоторое время встречаться в наших материалах, пока мы не обновим ресурсы, такие как снимки экрана, видео и схемы.

Эта статья относится к:❌ Basic/Standard ✔️ Enterprise

В этой статье показано, как настроить шлюз VMware Spring Cloud для VMware Tanzu с планом Azure Spring Apps Enterprise.

VMware Spring Cloud Gateway — это коммерческий компонент VMware Tanzu на основе проекта Шлюза Spring Cloud с открытым исходным кодом. Шлюз VMware Spring Cloud для Tanzu обрабатывает перекрестные проблемы для команд разработки API, таких как единый вход (SSO), управление доступом, ограничение скорости, устойчивость и безопасность. Вы можете ускорить доставку API с помощью современных облачных шаблонов в выборе языка программирования для разработки API.

Экземпляр шлюза VMware Spring Cloud направляет трафик в соответствии с правилами. Он поддерживает масштабирование в/вне и вверх и вниз для удовлетворения динамической нагрузки трафика.

Шлюз VMware Spring Cloud включает следующие функции:

Динамическая конфигурация маршрутизации, независимо от отдельных приложений, которую можно применять и изменять без повторной компиляции
Фильтры маршрутов коммерческого API для переноса авторизованных утверждений веб-маркера JSON (JWT) в службы приложений
Авторизация сертификата клиента
Подходы к ограничению скорости
Конфигурация разбиения цепи
Поддержка доступа к службам приложений с помощью учетных данных проверки подлинности HTTP Basic

Чтобы интегрироваться с порталом API для VMware Tanzu, VMware Spring Cloud Gateway автоматически создает документацию OpenAPI версии 3 после любых добавлений или изменений конфигурации маршрута. Дополнительные сведения см. на портале API для VMware Tanzu.

Необходимые компоненты

Уже подготовленный экземпляр службы плана Azure Spring Apps Enterprise с включенным шлюзом VMware Spring Cloud. Дополнительные сведения см . в кратком руководстве по созданию и развертыванию приложений в Azure Spring Apps с помощью плана Enterprise.
Azure CLI версии 2.0.67 или более поздней. Используйте следующую команду, чтобы установить расширение Azure Spring Apps: az extension add --name spring

Включение или отключение шлюза VMware Spring Cloud

Вы можете включить или отключить шлюз VMware Spring Cloud после создания экземпляра службы с помощью портал Azure или Azure CLI. Прежде чем отключить шлюз VMware Spring Cloud, необходимо отменить назначение конечной точки и удалить все конфигурации маршрутов.

Портал Azure
Azure CLI

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

Перейдите к ресурсу службы и выберите Spring Cloud Gateway.
Выберите Управление.
Выберите или снимите флажок Enable Spring Cloud Gateway проверка box, а затем нажмите кнопку "Сохранить".

Теперь можно просмотреть состояние шлюза Spring Cloud на странице Spring Cloud Gateway .

Используйте следующие команды Azure CLI, чтобы включить или отключить шлюз VMware Spring Cloud:

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

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

Перезапуск шлюза VMware Spring Cloud

После завершения действия перезапуска экземпляры VMware Spring Cloud Gateway перезагружаются на последовательной основе.

Портал Azure
Azure CLI

Выполните следующие действия, чтобы перезапустить шлюз VMware Spring Cloud с помощью портал Azure:

Перейдите к ресурсу службы и выберите Spring Cloud Gateway.
Выберите Перезапустить.
Нажмите кнопку "ОК ", чтобы подтвердить перезагрузку.

Чтобы перезапустить шлюз, используйте следующую команду Azure CLI:

az spring gateway restart \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-service-instance-name>

Назначение общедоступной конечной точки шлюзу VMware Spring Cloud

В этом разделе описывается, как назначить общедоступную конечную точку шлюзу VMware Spring Cloud и настроить его свойства.

Портал Azure
Azure CLI

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

Откройте экземпляр Azure Spring Apps.
Выберите Spring Cloud Gateway на панели навигации и выберите " Обзор".
Задайте для конечной точки значение "Да".

Через несколько минут URL-адрес настроенной конечной точки. Сохраните URL-адрес для дальнейшего использования.

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

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --assign-endpoint true

Настройка метаданных шлюза VMware Spring Cloud

Метаданные шлюза VMware Spring Cloud автоматически создают документацию по OpenAPI версии 3. Метаданные VMware Spring Cloud Gateway можно настроить для отображения групп маршрутов на портале API для VMware Tanzu. Дополнительные сведения см. на портале API для VMware Tanzu.

В следующей таблице описываются доступные параметры метаданных:

Свойство	Description
`title`	Заголовок, описывающий контекст API, доступных в экземпляре шлюза VMware Spring Cloud. Значение по умолчанию — `Spring Cloud Gateway for K8S`.
`description`	Подробное описание API, доступных в экземпляре шлюза VMware Spring Cloud. Значение по умолчанию — `Generated OpenAPI 3 document that describes the API routes configured for '[Gateway instance name]' Spring Cloud Gateway instance deployed under '[namespace]' namespace.*.`.
`documentation`	Расположение документации по API, доступной в экземпляре VMware Spring Cloud Gateway.
`version`	Версия API, доступная в этом экземпляре шлюза VMware Spring Cloud. Значение по умолчанию — `unspecified`.
`serverUrl`	Базовый URL-адрес для доступа к API на экземпляре шлюза VMware Spring Cloud. Это свойство является обязательным, если вы хотите интегрироваться с порталом API.

Для изменения свойств метаданных можно использовать портал Azure или Azure CLI.

Портал Azure
Azure CLI

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

Откройте экземпляр Azure Spring Apps.
Выберите Spring Cloud Gateway на панели навигации и выберите "Конфигурация".
Укажите значения свойств, перечисленных для API.
Выберите Сохранить.

Используйте следующую команду, чтобы настроить свойства метаданных для шлюза VMware Spring Cloud. Вам нужен URL-адрес конечной точки, полученный при завершении работы общедоступной конечной точки в разделе "Назначение общедоступной конечной точки для шлюза VMware Spring Cloud".

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --api-description "<api-description>" \
    --api-title "<api-title>" \
    --api-version "v0.1" \
    --server-url "<gateway-endpoint-URL>" \
    --allowed-origins "*"

Настройка единого входа

VMware Spring Cloud Gateway поддерживает проверку подлинности и авторизацию через единый вход с помощью поставщика удостоверений OpenID. Поставщик поддерживает протокол обнаружения Подключение OpenID. В следующей таблице описаны свойства единого входа:

Свойство	Обязательное?	Description
`issuerUri`	Да	Универсальный код ресурса (URI), который утверждается в качестве идентификатора издателя. Например, если `issuerUri` это `https://example.com`так, выполняется `https://example.com/.well-known/openid-configuration`запрос конфигурации поставщика OpenID. В ответе ожидается конфигурация поставщика OpenID.
`clientId`	Да	Идентификатор клиента OpenID Подключение от поставщика удостоверений.
`clientSecret`	Да	Секрет клиента OpenID Подключение от поставщика удостоверений.
`scope`	Да	Список областей для включения в маркеры идентификации JWT. Этот список должен основываться на область, разрешенных поставщиком удостоверений.

Сведения о настройке единого входа с идентификатором Microsoft Entra см. в статье Настройка единого входа с помощью идентификатора Microsoft Entra для Spring Cloud Gateway и портала API.

Для изменения свойств единого входа можно использовать портал Azure или Azure CLI.

Портал Azure
Azure CLI

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

Откройте экземпляр Azure Spring Apps.
Выберите Spring Cloud Gateway на панели навигации и выберите "Конфигурация".
Укажите значения свойств, перечисленных для единого входа.
Выберите Сохранить.

Используйте следующую команду, чтобы настроить свойства единого входа для шлюза VMware Spring Cloud:

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --client-id <client-id> \
    --client-secret <client-secret> \
    --issuer-uri <issuer-uri> \
    --scope <scope>

VMware Spring Cloud Gateway поддерживает только серверы авторизации, поддерживающие протокол обнаружения OpenID Подключение. Кроме того, не забудьте разрешить перенаправление обратно в шлюз на внешнем сервере авторизации. Ознакомьтесь с документацией по серверу авторизации и добавьте https://<gateway-external-url>/login/oauth2/code/sso в список разрешенных URI перенаправления.

Если вы настроите неправильное свойство единого входа, например неправильный пароль, необходимо удалить все свойство единого входа и добавить правильную конфигурацию.

После настройки единого входа не забудьте задать ssoEnabled: true маршруты шлюза VMware Spring Cloud.

Настройка выхода единого входа

Экземпляры службы VMware Spring Cloud Gateway предоставляют конечную точку API по умолчанию для выхода из текущего сеанса единого входа. Путь к этой конечной точке ./scg-logout Выход приводит к одному из следующих результатов в зависимости от способа вызова конечной точки выхода:

Выход из сеанса и перенаправление к выходу поставщика удостоверений (IdP).
Выход из сеанса экземпляра службы.

Выход из сеанса поставщика удостоверений и единого входа

При отправке GET запроса в /scg-logout конечную точку конечная точка отправляет 302 ответ перенаправления на URL-адрес выхода поставщика удостоверений. Чтобы получить конечную точку, чтобы вернуть пользователя в путь к экземпляру службы шлюза, добавьте параметр перенаправления в GET запрос с конечной /scg-logout точкой. Например, вы можете использовать значение ${server-url}/scg-logout?redirect=/home.

Значение параметра перенаправления должно быть допустимым путем в экземпляре службы VMware Spring Cloud Gateway. Вы не можете перенаправить внешний URL-адрес.

Ниже описан пример реализации функции в микрослужбах:

Получите конфигурацию маршрута для маршрутизации запроса на выход в приложение. Пример см. в конфигурации маршрута в репозитории спасения животных на GitHub.
Добавьте в приложение любую логику выхода. В конце концов вам потребуется GET запрос к конечной точке шлюза /scg-logout , как показано в return значении getActionButton метода в репозитории спасения животных.

Выход из сеанса единого входа

При отправке запроса в GET/scg-logout конечную точку с помощью XMLHttpRequest302 перенаправления можно проглотить и не обрабатываться в обработчике ответа. В этом случае пользователь будет выходить только из сеанса единого входа в экземпляре службы VMware Spring Cloud Gateway. Пользователь по-прежнему будет иметь допустимый сеанс поставщика удостоверений. Как правило, если пользователь пытается войти снова, он автоматически отправляется в шлюз, как прошедший проверку подлинности из поставщика удостоверений.

Необходимо настроить маршрут для маршрутизации запроса выхода в приложение, как показано в следующем примере. Этот код делает сеанс единого входа только для шлюза.

const req = new XMLHttpRequest();
req.open("GET", "/scg-logout);
req.send();

Совместное использование ресурсов между источниками (CORS) позволяет запрашивать ограниченные ресурсы на веб-странице из другого домена за пределами домена, из которого был обработан первый ресурс. В следующей таблице описаны доступные параметры конфигурации CORS.

Свойство	Description
`allowedOrigins`	Разрешенные источники для создания межсайтовых запросов.
`allowedOriginPatterns`	Разрешенные шаблоны источников для выполнения запросов между сайтами
`allowedMethods`	Разрешенные методы HTTP для межсайтовых запросов.
`allowedHeaders`	Разрешенные заголовки в межсайтовых запросах
`maxAge`	Сколько времени в секундах клиенты кэшируют ответ из предварительного запроса
`allowCredentials`	Поддерживаются ли учетные данные пользователя при межсайтовых запросах.
`exposedHeaders`	Заголовки HTTP-ответов, которые будут предоставляться для межсайтовых запросов.

Убедитесь, что у вас есть правильная конфигурация CORS, если вы хотите интегрировать с порталом API. Дополнительные сведения см. в разделе "Назначение общедоступной конечной точки шлюзу VMware Spring Cloud ".

Использование масштабирования служб

Вы можете настроить выделение ресурсов для экземпляров шлюза VMware Spring Cloud, включая виртуальный ЦП, память и число экземпляров.

Для обеспечения высокой доступности не рекомендуется использовать одну реплика.

В следующей таблице описано использование ресурсов по умолчанию.

Наименование компонента	Число экземпляров	Количество виртуальных ЦП на экземпляр	Объем памяти на экземпляр
Шлюз VMware Spring Cloud	2	1 ядро	2 ГиБ
Оператор шлюза VMware Spring Cloud	2	1 ядро	2 ГиБ

Настройка TLS между шлюзом и приложениями

Чтобы повысить безопасность и защитить конфиденциальную информацию от перехвата неавторизованными сторонами, можно включить протокол TLS между VMware Spring Cloud Gateway и приложениями.

Перед настройкой TLS необходимо иметь приложение с поддержкой TLS и сертификат TLS. Чтобы подготовить сертификат TLS, создайте сертификат из доверенного центра сертификации (ЦС). Сертификат проверяет удостоверение сервера и устанавливает безопасное подключение.

После запуска приложения с поддержкой TLS в Azure Spring Apps отправьте сертификат в Azure Spring Apps. Дополнительные сведения см . в разделе "Импорт сертификата " в разделе "Использование TLS/SSL-сертификатов" в приложении в Azure Spring Apps.

При обновлении сертификата до Azure Spring Apps можно настроить сертификат TLS для шлюза и включить проверку сертификата. Сертификат можно настроить в портал Azure или с помощью Azure CLI.

Портал Azure
Azure CLI

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

В экземпляре Azure Spring Apps выберите Spring Cloud Gateway на панели навигации.
На странице Spring Cloud Gateway выберите управление сертификатами.
Выберите "Включить проверку сертификата".
Выберите сертификат TLS в сертификатах.
Выберите Сохранить.

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

Используйте следующую команду, чтобы включить или отключить проверку сертификата с помощью Azure CLI. Замените <value> заполнитель true на включение или false отключение проверки.

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --enable-cert-verify <value> \
    --certificate-names <certificate-name-in-Azure-Spring-Apps>

Подготовка конфигурации маршрута

Необходимо указать протокол в качестве HTTPS в конфигурации маршрута. Следующий объект JSON указывает VMware Spring Cloud Gateway использовать протокол HTTPS для всего трафика между шлюзом и приложением.

Создайте файл с именем test-tls-route.json со следующим содержимым:

{
    "routes": [
      {
        "title": "Test TLS app",
        "predicates": [
          "Path=/path/to/your/app",
          "Method=GET"
        ]
      }
     ],
    "uri": "https://<app-custom-domain-name>"
}

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

az spring gateway route-config create \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --name test-tls-app \
    --routes-file test-tls-route.json

Теперь можно проверить, включено ли приложение TLS с конечной точкой шлюза. Дополнительные сведения см. в разделе "Настройка маршрутов" в разделе "Использование шлюза Spring Cloud".

Ротация сертификатов

По истечении срока действия сертификатов необходимо сменить сертификаты в VMware Spring Cloud Gateway, выполнив следующие действия.

Создайте новые сертификаты из доверенного ЦС.
Импортируйте сертификаты в Azure Spring Apps. Дополнительные сведения см . в разделе "Импорт сертификата " в разделе "Использование TLS/SSL-сертификатов" в приложении в Azure Spring Apps.
Синхронизируйте сертификаты с помощью портал Azure или Azure CLI.

VMware Spring Cloud Gateway перезапускается, чтобы шлюз использовал новый сертификат для всех подключений.

Портал Azure
Azure CLI

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

В экземпляре Azure Spring Apps выберите Spring Cloud Gateway на панели навигации.
На странице Spring Cloud Gateway нажмите кнопку "Перезапустить", а затем подтвердите операцию.

Чтобы синхронизировать сертификат для шлюза VMware Spring Cloud, используйте следующую команду перезапуска:

az spring gateway restart \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name>

Настройка параметров автомасштабирования

Вы можете задать режимы автомасштабирования для шлюза VMware Spring Cloud.

Портал Azure
Azure CLI

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

Параметр масштабирования вручную поддерживает фиксированное число экземпляров. Вы можете масштабировать до не более 10 экземпляров. Это значение изменяет количество отдельных запущенных экземпляров шлюза Spring Cloud.
Параметр настраиваемого автомасштабирования масштабируется по любому расписанию на основе любых метрик.

В портал Azure выберите способ масштабирования. На следующем снимках экрана показан параметр настраиваемого автомасштабирования и параметры режима:

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

az monitor autoscale create \
    --resource-group <resource-group-name> \
    --name <autoscale-setting-name> \
    --resource /subscriptions/<subscription-id>/resourcegroups/<resource-group-name>/providers/Microsoft.AppPlatform/Spring/<service-instance-name>/gateways/default \
    --min-count 1 \
    --max-count 5 \
    --count 1

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

az monitor autoscale rule create \
    --resource-group <resource-group-name> \
    --autoscale-name <autoscale-setting-name> \
    --scale out 1 \
    --cooldown 1 \
    --condition "GatewayHttpServerRequestsSecondsCount > 100 avg 1m"

Дополнительные сведения о доступных метриках см . в разделе "Параметры пользовательских метрик " в разделе "Метрики" для Azure Spring Apps.

Настройка кэша ответов

Конфигурация кэша ответов позволяет определить кэш ответа HTTP, который можно применять глобально или на уровне маршрута.

Глобальное включение кэша ответов

После глобального включения кэша ответов кэш отклика автоматически включается для всех применимых маршрутов.

Портал Azure
Azure CLI

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

В экземпляре Azure Spring Apps выберите Spring Cloud Gateway на панели навигации.
На странице Spring Cloud Gateway выберите "Конфигурация".
В разделе "Кэш ответов" выберите "Включить кэш ответов", а затем задайте область для экземпляра.
Задайте размер и время жизни для кэша ответов.
Выберите Сохранить.

Чтобы отключить кэш ответов, выполните следующие действия.

В экземпляре Azure Spring Apps выберите Spring Cloud Gateway на панели навигации.
На странице Spring Cloud Gateway выберите "Конфигурация".
В разделе "Кэш ответов" снимите флажок "Включить кэш ответов".
Выберите Сохранить.

Используйте следующую команду, чтобы глобально включить кэш ответов:

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name>
    --enable-response-cache \
    --response-cache-scope Instance \
    --response-cache-size {Examples are 1GB, 100MB, 100KB} \
    --response-cache-ttl {Examples are 1h, 30m, 50s}

Используйте следующую команду, чтобы отключить кэш ответов:

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --enable-response-cache false

Включение кэша ответов на уровне маршрута

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

{
   "filters": [
      "<other-app-level-filter-of-route>",
   ],
   "routes": [
      {
        "predicates": [
            "Path=/api/**",
            "Method=GET"
         ],
         "filters": [
            "<other-filter-of-route>",
            "LocalResponseCache=3m, 1MB"
         ],
      }
   ]
}

Дополнительные сведения см. в разделе LocalResponseCache о том, как использовать фильтры маршрутов шлюза VMware Spring Cloud с планом Azure Spring Apps Enterprise и LocalResponseCache в документации по VMware.

Вместо настройки size и timeToLive для каждого LocalResponseCache фильтра можно настроить эти параметры на уровне Spring Cloud Gateway. Этот параметр позволяет использовать LocalResponseCache фильтр без первоначального указания этих значений, сохраняя гибкость, чтобы переопределить их позже.

Портал Azure
Azure CLI

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

В экземпляре Azure Spring Apps выберите Spring Cloud Gateway на панели навигации.
На странице Spring Cloud Gateway выберите "Конфигурация".
В разделе "Кэш ответов" выберите "Включить кэш ответов", а затем задайте область "Маршрут".
Задайте размер и время жизни для кэша ответов.
Выберите Сохранить.

Выполните следующие действия, чтобы отключить кэш ответов на уровне маршрута, который очищает size и timeToLive:

В экземпляре Azure Spring Apps выберите Spring Cloud Gateway на панели навигации.
На странице Spring Cloud Gateway выберите "Конфигурация".
В разделе "Кэш ответов" снимите флажок "Включить кэш ответов".
Выберите Сохранить.

Используйте следующую команду, чтобы включить кэш ответов на уровне маршрута и задать size и timeToLive:

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --enable-response-cache \
    --response-cache-scope Route \
    --response-cache-size {Examples are 1GB, 100MB, 100KB} \
    --response-cache-ttl {Examples are 1h, 30m, 50s}

Используйте следующую команду, чтобы отключить кэш ответов на уровне маршрута, который очищает size и timeToLive:

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --enable-response-cache false

В следующем примере показано, как использовать LocalResponseCache фильтр при size установке на timeToLive уровне шлюза Spring Cloud:

{
   "filters": [
      "<other-app-level-filter-of-route>",
   ],
   "routes": [
      {
        "predicates": [
            "Path=/api/path1/**",
            "Method=GET"
         ],
         "filters": [
            "<other-filter-of-route>",
            "LocalResponseCache"
         ],
      },
      {
        "predicates": [
            "Path=/api/path2/**",
            "Method=GET"
         ],
         "filters": [
            "<other-filter-of-route>",
            "LocalResponseCache=3m, 1MB"
         ],
      }
   ]
}

Настройка переменных среды

Служба Azure Spring Apps управляет и настраивает шлюз VMware Spring Cloud. Кроме вариантов использования, которые настраивают мониторинг производительности приложений (APM) и уровень журнала, обычно не требуется настраивать VMware Spring Cloud Gateway с переменными среды.

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

Портал Azure
Azure CLI

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

В экземпляре Azure Spring Apps выберите Spring Cloud Gateway на панели навигации и выберите "Конфигурация".
Заполните пары "ключ-значение" для переменных среды в разделах "Свойства и секреты ". В раздел "Секреты" можно включить переменные с конфиденциальной информацией.
Выберите Сохранить, чтобы сохранить изменения.

Используйте следующую команду, чтобы настроить переменные среды с помощью Azure CLI. Можно включить переменные с конфиденциальной --secrets информацией с помощью параметра.

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --properties <key=value> \
    --secrets <key=value>

После обновления переменных среды VMware Spring Cloud Gateway перезапускается.

Настройка мониторинга производительности приложений

Чтобы отслеживать VMware Spring Cloud Gateway, можно настроить APM. В следующей таблице перечислены пять типов агентов APM Java, предоставляемых шлюзом VMware Spring Cloud, а также необходимые переменные среды.

Агент Java	Обязательные переменные среды
Application Insights	`APPLICATIONINSIGHTS_CONNECTION_STRING`
Dynatrace	`DT_TENANT` `DT_TENANTTOKEN` `DT_CONNECTION_POINT`
New Relic	`NEW_RELIC_LICENSE_KEY` `NEW_RELIC_APP_NAME`
AppDynamics	`APPDYNAMICS_AGENT_APPLICATION_NAME` `APPDYNAMICS_AGENT_TIER_NAME` `APPDYNAMICS_AGENT_NODE_NAME` `APPDYNAMICS_AGENT_ACCOUNT_NAME` `APPDYNAMICS_AGENT_ACCOUNT_ACCESS_KEY` `APPDYNAMICS_CONTROLLER_HOST_NAME` `APPDYNAMICS_CONTROLLER_SSL_ENABLED` `APPDYNAMICS_CONTROLLER_PORT`
Эластичная APM	`ELASTIC_APM_SERVICE_NAME` `ELASTIC_APM_APPLICATION_PACKAGES` `ELASTIC_APM_SERVER_URL`

Другие поддерживаемые переменные среды см. в следующих источниках:

Настройка интеграции APM на уровне экземпляра службы (рекомендуется)

Чтобы включить мониторинг APM в шлюзе VMware Spring Cloud, можно создать конфигурацию APM на уровне экземпляра службы и привязать ее к Spring Cloud Gateway. Таким образом, можно удобно настроить APM только один раз и привязать один и тот же APM к Spring Cloud Gateway и к вашим приложениям.

Портал Azure
Azure CLI

Выполните следующие действия, чтобы настроить APM с помощью портал Azure:

Настройте APM на уровне экземпляра службы с именем, типом и свойствами APM. Дополнительные сведения см. в разделе "Управление API" на уровне экземпляра службы (рекомендуется) в разделе "Настройка сертификатов интеграции APM и ЦС".
Выберите Spring Cloud Gateway на панели навигации и выберите APM.
Выберите имя APM в списке ссылочных имен APM. Список содержит все имена APM, настроенные на шаге 1.
Выберите "Сохранить", чтобы привязать имена ссылок APM к Spring Cloud Gateway. Шлюз перезапускается, чтобы включить мониторинг APM.

Выполните следующие действия, чтобы настроить APM в Spring Cloud Gateway с помощью Azure CLI:

Настройте APM на уровне экземпляра службы с именем, типом и свойствами APM. Дополнительные сведения см. в разделе "Управление API" на уровне экземпляра службы (рекомендуется) в разделе "Настройка сертификатов интеграции APM и ЦС".
Используйте следующую команду, чтобы обновить шлюз с именами ссылок APM:
```
az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --apms <APM-reference-name>
```
Значением является --apms разделенный пробелами список ссылочных имен APM, который вы создали на шаге 1.

Примечание.

Spring Cloud Gateway не рекомендует типы APM. Используйте имена ссылок APM для настройки APM в шлюзе.

Управление APM в VMware Spring Cloud Gateway (не рекомендуется)

Вы можете использовать портал Azure или Azure CLI для настройки APM в VMware Spring Cloud Gateway. Кроме того, можно указать типы агентов Java APM для использования и соответствующие переменные среды APM, которые они поддерживают.

Портал Azure
Azure CLI

Выполните следующие действия, чтобы настроить APM с помощью портал Azure:

В экземпляре Azure Spring Apps выберите Spring Cloud Gateway на панели навигации и выберите "Конфигурация".
Выберите тип APM в списке APM , чтобы отслеживать шлюз.
Заполните пары "ключ-значение" для переменных среды APM в разделах "Свойства и секреты ". Переменные можно поместить с конфиденциальной информацией в секреты.
Выберите Сохранить, чтобы сохранить изменения.

Используйте следующую команду, чтобы настроить APM с помощью Azure CLI:

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --apm-types <APM-type> \
    --properties <key=value> \
    --secrets <key=value>

Допустимые значения--apm-types: ApplicationInsights, , AppDynamicsDynatrace, NewRelicи ElasticAPM. Следующая команда показывает использование приложения Аналитика в качестве примера:

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --apm-types ApplicationInsights \
    --properties APPLICATIONINSIGHTS_CONNECTION_STRING=<your-Application-Insights-connection-string> APPLICATIONINSIGHTS_SAMPLE_RATE=10

Можно также поместить переменные среды в --secrets параметр, а не --properties. Это делает переменную среды более безопасной в сетевой передаче и хранилище данных в внутренней части.

Примечание.

Azure Spring Apps обновляет агент APM и развертывает приложения с той же частотой, чтобы обеспечить совместимость агентов между Шлюзом VMware Spring Cloud и Azure Spring Apps.

По умолчанию Azure Spring Apps выводит журналы агента STDOUTJava APM в . Эти журналы включены в журналы шлюза VMware Spring Cloud. Вы можете проверка версию агента APM, используемую в журналах. Эти журналы можно запросить в Log Analytics, чтобы устранить неполадки.

Чтобы агенты APM работали правильно, увеличьте объем ЦП и памяти шлюза VMware Spring Cloud.

Настройка уровней ведения журнала

Уровни журналов шлюза VMware Spring Cloud можно настроить следующим образом, чтобы получить дополнительные сведения или уменьшить количество журналов:

Уровни журнала можно задать для TRACE, DEBUG, , INFO, WARNERRORили OFF. Уровень журнала по умолчанию для шлюза VMware Spring Cloud.INFO
Вы можете отключить журналы, задав для этого уровни журналов OFF.
Если для уровня журнала задано WARNзначение , ERRORили OFFвам может потребоваться изменить его для INFO запроса поддержки от команды Azure Spring Apps. Это изменение приводит к перезапуску шлюза VMware Spring Cloud.
Если задан TRACE уровень журнала или DEBUGможет повлиять на производительность шлюза VMware Spring Cloud. Попробуйте избежать этих параметров в рабочей среде.
Вы можете задать уровни журналов для root средства ведения журнала или для определенных средств ведения журнала, например io.pivotal.spring.cloud.gateway.

Следующие средства ведения журнала могут содержать ценные сведения об устранении неполадок на TRACE уровне и DEBUG уровнях.

Ведение журнала	Description
`io.pivotal.spring.cloud.gateway`	Фильтры и предикаты, включая пользовательские расширения
`org.springframework.cloud.gateway`	Шлюз API
`org.springframework.http.server.reactive`	Взаимодействие с HTTP-сервером
`org.springframework.web.reactive`	Реактивные потоки шлюза API
`org.springframework.boot.autoconfigure.web`	Автоматическая настройка шлюза API
`org.springframework.security.web`	Сведения о проверке подлинности и авторизации
`reactor.netty`	Реактор Netty

Чтобы получить ключи переменной среды, добавьте logging.level. префикс и задайте уровень журнала, настроив среду logging.level.{loggerName}={logLevel}. В следующих примерах показаны шаги для портал Azure и Azure CLI.

Портал Azure
Azure CLI

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

В экземпляре Azure Spring Apps выберите Spring Cloud Gateway на панели навигации и выберите "Конфигурация".
Заполните пары "ключ-значение" для переменных среды уровней журнала в разделах "Свойства и секреты ". Если уровень журнала является конфиденциальной информацией в вашем случае, его можно включить с помощью раздела "Секреты ".
Выберите Сохранить, чтобы сохранить изменения.

Общие команды CLI для указания переменных среды см. в разделе "Настройка переменных среды". В следующем примере показано, как настроить уровни журналов с помощью Azure CLI:

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --properties \
      logging.level.root=INFO \
      logging.level.io.pivotal.spring.cloud.gateway=DEBUG \
      logging.level.org.springframework.cloud.gateway=DEBUG \
      logging.level.org.springframework.boot.autoconfigure.web=TRACE \
      logging.level.org.springframework.security.web=ERROR

Если уровень журнала является конфиденциальной информацией в вашем случае, его можно включить с помощью --secrets параметра.

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

Функция настройки надстройки позволяет настраивать определенные свойства шлюза VMware Spring Cloud с помощью строки формата JSON. Эта функция полезна, если необходимо настроить свойства, которые не предоставляются через REST API.

Конфигурация надстройки — это объект JSON с парами "ключ-значение", которые представляют нужную конфигурацию. В следующем примере показана структура формата JSON:

{
    "<addon-key-name>": {
        "<addon-key-name>": "<addon-value>"
        ...
    },
    "<addon-key-name>": "<addon-value>",
    ...
}

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

Конфигурация единого входа:
- Имя ключа: sso
- Тип значения: Object
- Свойства
  - RolesAttributeName (Строка): указывает имя атрибута, содержащего роли, связанные с сеансом единого входа.
  - InactiveSessionExpirationInMinutes (Целое число): указывает время окончания срока действия в минутах для неактивных сеансов единого входа. Значение означает, что сеанс никогда 0 не истекает.
- Пример:
```
{
    "sso": {
        "rolesAttributeName": "roles",
        "inactiveSessionExpirationInMinutes": 1
    }
}
```
Конфигурация метаданных:
- Имя ключа: api
- Тип значения: Object
- Свойства
  - groupId (Строка): уникальный идентификатор группы API, доступной в экземпляре VMware Spring Cloud Gateway. Значение может содержать только строчные буквы и цифры.
- Пример:
```
{
    "api": {
        "groupId": "id1"
    }
}
```

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

Портал Azure
Azure CLI

В экземпляре Azure Spring Apps выберите Spring Cloud Gateway на панели навигации и выберите "Конфигурация".
Укажите значение JSON для Addon Configs.
Выберите Сохранить.

Подготовьте JSON-файл для конфигураций надстройки (<file-name-of-addon-configs-json>.json) со следующим содержимым:
```
{
    "sso": {
        "rolesAttributeName": "roles",
        "inactiveSessionExpirationInMinutes": 1
    },
    "api": {
        "groupId": "id1"
    }
}
```

Используйте следующую команду, чтобы обновить конфигурации надстройки для шлюза VMware Spring Cloud:

az spring gateway update \
    --resource-group <resource-group-name> \
    --service <Azure-Spring-Apps-instance-name> \
    --addon-configs-file <file-name-of-addon-configs-json>.json

Следующие шаги

Использование Spring Cloud Gateway