4.15.07.00 - Apigee Edge для частного облака: примечания к выпуску

Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация

8 сентября 2015 г. мы выпустили крупное обновление Apigee Edge для частного облака.

С момента выхода предыдущей квартальной версии Edge для частного облака (4.15.04.00) были выпущены следующие версии, которые включены в эту квартальную версию:

• Облако: 15.04.15, 15.04.29, 15.05.27, 15.06.10 и 15.06.24
• Private Cloud: 4.15.04.01

На какие версии Edge можно перейти 4.15.07.00

В зависимости от текущей версии Edge вы можете:

• Как перейти на версию 4.15.07.00
• Постепенно, то есть сначала нужно перейти с текущей версии на другую версию Edge, а затем на версию 4.15.07.00.

Подробнее о том, какие версии Edge для частного облака можно обновить до версии 4.15.07.00…

Подготовка к обновлению с версии 4.15.01.x или более ранней

1. Проверьте версию SSTable Cassandra:
   1. Перейдите в каталог /<install-root>/apigee4/data/cassandra/data.
   2. Выполните команду поиска:
      > find . -name *-ic-*
      Если вы используете Cassandra 1 .2 SSTable, в результатах поиска должен быть набор файлов.db.
   3. Выполните следующую команду:
      > find . -name *-hf-*
      Результаты должны быть пустыми, то есть в формате hf нет файлов .db. Если файлов в формате hf нет, можно переходить к версии 4.15.07.00.
      
      Формат hf предназначен для таблиц SSTable Cassandra 1.0. Если у вас есть файлы *.db в формате hf, вам нужно обновить SSTable, как описано в остальной части этой процедуры.
2. Если вы обнаружите файлы *.db в формате hf, обновите SSTable, выполнив следующую команду на каждом узле Cassandra, пока не обновите все узлы Cassandra:
   > /<install-root>/apigee4/share/apache-cassandra/bin/nodetool -h localhost upgradesstables -a
3. Повторите шаг 1, чтобы убедиться, что все файлы *.db имеют формат ic для Cassandra версии 1.2.
4. Повторите шаги 1–3 на каждом узле Cassandra в установке Edge.
5. Перейдите на Edge 4.15.07.00.
6. После обновления до версии 4.15.07.00 проверьте файлы *.db, чтобы убедиться, что они были обновлены до стиля sstable C* 2.0:
   > cd /<install-root>/apigee4/data/cassandra/data
   > find . -name *-jb-*
   Если вы используете Cassandra 2 .0, эта команда должна вернуть набор файлов.db.

Новые функции и улучшения

Ниже перечислены новые функции и улучшения в этом выпуске.

Установка и обновление

Выборочное обновление и удаление компонентов

Скрипты apigee-upgrade.sh и apigee-uninstall.sh теперь позволяют выбирать компоненты Edge, которые нужно обновить или удалить. Раньше он обновлял или удалял все компоненты на узле. (OPDK-1377, OPDK-1175)

Откат обновления

Если во время обновления скрипт apigee-upgrade.sh завершится с ошибкой, вы можете использовать скрипт apigee-rollback.sh, чтобы отменить обновление. После того как вы устраните все проблемы, снова запустите процесс преобразования. (OPDK-1275)

Параметры сокращенного скрипта установщика

Установочные скрипты больше не принимают длинные формы параметров, например --help. Теперь они принимают только однобуквенные параметры, например -h. (OPDK-1356)

Установка SmartDocs

При установке SmartDocs с помощью скрипта setup-smartdocs.sh вам будет предложено ввести организацию, среду и виртуальный хост, чтобы SmartDocs был установлен в нужное место. Ранее эти значения были жестко заданы в скрипте. (OPDK-1310)

Запуск update-cass-pwd-in-config.sh без запросов

Скрипт update-cass-pwd-in-config.sh можно запустить без запросов, если задать переменные среды ENABLE_CASS_AUTH, CASS_USERNAME и CASS_PASSWORD. (OPDK-1309)

Платформа Edge

Ниже перечислены новые функции платформы Edge, добавленные в этом выпуске.

Поддержка OpenJDK 1.7 в Edge Private Cloud

В этой версии Edge поддерживаются Oracle JDK 1.7 и OpenJDK 7, а поддержка JDK 1.6 прекращена. (OPDK-1187)

Поддержка ОС

Теперь Apigee Edge для частного облака поддерживает следующие операционные системы: Red Hat Enterprise Linux 6.6 и 7.0 (64-разрядная версия), CentOS 6.5, 6.6 и 7.0 (64-разрядная версия) и Oracle Linux 6.5.

Cassandra 2.0.15 включена в OPDK 15.07

В этом выпуске устанавливается Cassandra 2.0.15. Если вы обновляете предыдущую версию, ваша версия Cassandra будет обновлена. (OPDK-1197)

Поддержка SHA2 для хеширования токенов OAuth

Чтобы лучше защитить токены OAuth в случае нарушения безопасности базы данных, Edge поддерживает алгоритмы SHA2 для хеширования токенов OAuth (в дополнение к SHA1). Новые свойства на уровне организации позволяют включить и настроить хеширование для новых токенов, а также сохранить прежнее хеширование для токенов, созданных до появления этой функции. Ранее в Edge для частного облака свойство hash.oauth.tokens.enabled в файле keymanagement.properties (на сервере управления и процессорах сообщений) позволяло автоматически хешировать токены OAuth с помощью алгоритма SHA1. Это свойство больше не поддерживается.

Если вы ранее использовали свойство hash.oauth.tokens.enabled, чтобы включить хеширование SHA1, скрипт обновления для этой версии автоматически создаст для вас новые свойства на уровне организации. Чтобы проверить обновление, выполните запрос GET в качестве системного администратора с помощью следующего API: https://{host}:{port}/v1/o/{your_org}.

• Информацию о том, как включить хеширование токенов в организации с помощью новых свойств, можно найти в разделе "Хеширование токенов в базе данных" статьи Как запросить токены доступа.
• Информацию о массовом хешировании существующих токенов можно найти в Руководстве по эксплуатации Edge для частного облака. (APIRT-1389)

Плоская структура каталогов для файлов журналов

Вы можете настроить Edge так, чтобы файлы журналов хранились в плоской структуре каталогов. Для этого задайте для нового свойства enable.flat.directory.structure значение true в файле message-logging.properties. Подробнее о правилах ведения журналов сообщений… (APIRT-1394)

Производительность кеша среды

Чтобы улучшить управление кешем в памяти и его использование, настройки "Максимальное количество элементов в памяти" в ресурсах кеша среды были признаны устаревшими. Общее количество элементов во всех ресурсах кеша (включая кеш по умолчанию) зависит от общего объема памяти, выделенного для кеша. По умолчанию общий объем памяти, выделенной для кеширования в памяти на определенном процессоре сообщений, составляет 40% от общего объема доступной памяти, определяемого настройками свойства кеша в файле cache.properties процессора сообщений. Элементы удаляются из кеша в памяти только при нехватке памяти или по истечении срока действия.

Чтобы вернуться к прежнему поведению, при котором для управления кешем используется свойство "Максимальное количество элементов в памяти", задайте свойство overrideMaxElementsInCacheResource=false в файле cache.properties. (APIRT-1140)

Сервисы API

Ниже перечислены новые функции API Services, добавленные в этом выпуске.

Новый редактор прокси-серверов по умолчанию

Новый редактор прокси-серверов API включен по умолчанию в интерфейсе управления. Новый редактор включает множество улучшений, в том числе более полные представления условных потоков и конечных точек на странице "Обзор", все настройки на странице "Разработка", более интуитивное добавление условных потоков, конечных точек и правил, более полные представления XML вместо небольших фрагментов, поиск по именам файлов и тексту и многое другое. (MGMT-2279)

Новое правило "Удалить информацию OAuth v2.0"

Новые правила "Удаление информации OAuth v2.0" позволяют удалять токены доступа OAuth v2 и коды авторизации. Правило заменяет функцию, ранее предоставлявшуюся API управления. Подробнее о правиле Delete OAuthV2 Info… (MGMT-2257)

Новые правила "Удалить информацию о OAuth v1.0"

Новое правило "Удалить информацию OAuth v1.0" позволяет удалять токены запросов, токены доступа и коды подтверждения OAuth v1.0. Правило заменяет функцию, ранее предоставлявшуюся API управления. Подробнее о правилах в отношении удаления информации OAuth V1… (APIRT-1351)

Правила контроля доступа

Правило "Контроль доступа" было улучшено, чтобы обеспечить более точную оценку IP-адресов для белых и черных списков, когда IP-адреса содержатся в HTTP-заголовке X-FORWARDED-FOR.

Если в заголовке включена проверка нескольких IP-адресов (обратитесь в службу поддержки, чтобы задать значение feature.enableMultipleXForwardCheckForACL), новый элемент <ValidateBasedOn> в правиле позволяет проверять первый IP-адрес, последний IP-адрес или все IP-адреса в заголовке. Подробнее о правилах контроля доступа…

Новые объекты в правилах доступа к объектам

Правило "Объект доступа" предоставляет доступ к следующим новым объектам: consumerkey-scopes, authorizationcode, requesttoken и verifier. Подробнее о правилах в отношении объектов доступа…

Правило "Сборщик статистики": автоматическое преобразование названия статистики в нижний регистр

При создании специального сбора данных аналитики в редакторе прокси-сервера API (страница "Разработка" > "Инструменты" > "Специальный сбор данных аналитики") переменная сборщика (статистика) "Название" должна быть написана строчными буквами. Если вы введете название с заглавными буквами, инструмент автоматически преобразует его в нижний регистр в правиле "Сборщик статистики". (MGMT-740)

Удаление классической трассировки из редактора прокси-сервера API

Новейшая версия функции трассировки в редакторе прокси-сервера API перешла с бета-версии на общую доступность. Доступ к классической версии трассировки по ссылке "Перейти к классической версии трассировки" больше не предоставляется.

Доступ к сообществу Apigee из меню "Справка" в интерфейсе управления

Сообщество Apigee доступно в меню "Справка" в интерфейсе управления.

Сообщения об ошибках в интерфейсе управления

Ниже перечислены улучшения сообщений об ошибках в интерфейсе управления:

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

Улучшения в работе интерфейса и исправленные ошибки

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

Гиперссылки на роли на странице "Пользователи организации" в интерфейсе управления

На странице "Пользователи организации" в интерфейсе управления (Администратор > Пользователи организации) названия ролей теперь являются гиперссылками, позволяющими быстро переходить на страницы ролей. (MGMT-1055)

Новые целевые переменные в потоке сообщений

Новые переменные в потоках сообщений предоставляют более полную информацию об URL для целевых конечных точек и целевых серверов:

• TargetEndpoint: request.url заменяет target.basepath.with.query.
• TargetServer: loadbalancing.targetserver заменяет targetserver.name. Кроме того, target.basepath заполняется только в том случае, если элемент <Path> используется в элементе HTTPTargetConnection <LoadBalancer> TargetEndpoint.

Поддержка указания имени сервера (SNI)

Edge поддерживает использование функции SNI (указание имени сервера) в южном направлении (от процессора сообщений к целевым конечным точкам). Если вы хотите использовать SNI, обратитесь в службу поддержки Apigee Edge.

Требуется Java 1.7.

SNI – это расширение TLS/SSL, которое позволяет обслуживать несколько целей HTTPS с одного IP-адреса и порта, не требуя, чтобы все эти цели использовали один и тот же сертификат.

Настраивать Edge не нужно. Если в вашей среде настроена поддержка SNI для исходящего трафика (по умолчанию в облаке Edge), Edge будет ее поддерживать.

Edge автоматически извлекает имя хоста из URL запроса и добавляет его в запрос на установление подключения по протоколу SSL. Например, если целевой хост – https://example.com/request/path, то Edge добавляет расширение server_name, как показано ниже:

Подробнее http://en.wikipedia.org/wiki/Server_Name_Indication…

"Алгоритм подписи" в сведениях о сертификатах SSL

В сведения о сертификате SSL добавлено новое поле "Алгоритм подписи". Его можно посмотреть в интерфейсе управления (Администратор > Сертификаты SSL) и в API управления (Получение сведений о сертификате из хранилища ключей или доверенного хранилища). В этом поле указано "sha1WithRSAEncryption" или "sha256WithRSAEncryption" в зависимости от типа алгоритма хеширования, использованного для создания сертификата.

Показывает сертификаты SSL, срок действия которых скоро истечет

На странице "Сертификаты SSL" в интерфейсе управления (Администратор > Сертификаты SSL) указывается, когда срок действия сертификатов SSL истекает в течение 10, 15, 30 или 90 дней в зависимости от того, что вы выберете в новом раскрывающемся списке.

Ошибка конфигурации защиты от угроз

По умолчанию Edge возвращает код статуса HTTP 500 (Внутренняя ошибка сервера) и ошибку ExecutionFailed, если сообщение не проходит проверку правилом защиты от угроз JSON или XML. Вы можете изменить это поведение с помощью нового свойства на уровне организации. Если задать для свойства org значение features.isPolicyHttpStatusEnabled, произойдет следующее:

• Запрос: если к любому потоку запросов прикреплено правило защиты от угроз, недопустимые сообщения возвращают код статуса 400 вместе с соответствующим сообщением об ошибке правила.
• Ответ. Если к любому потоку ответов прикреплено правило защиты от угроз, недействительные сообщения по-прежнему возвращают код статуса 500, и возникает одно из соответствующих сообщений об ошибке правила (а не просто ExecutionFailed).

Клиенты облачной версии должны обратиться в службу поддержки Apigee Edge, чтобы задать свойство организации. Эта функция станет доступна клиентам Edge Private Cloud в следующем квартальном выпуске Private Cloud.

Обновленные схемы для конечных точек, прокси-серверов и других объектов

Схемы были обновлены для объектов, не связанных с правилами, таких как TargetEndpoint, ProxyEndpoint, APIProxy и многих других. Подробнее: https://github.com/apigee/api-platform-samples/tree/master/schemas. (APIRT-1249)

Сервисы для разработчиков

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

Общая доступность SmartDocs

Функция SmartDocs переходит из бета-версии в общую доступность. Обновления и новые функции:

• Поддержка Swagger 2.0, в том числе импорт по файлу или URL, а также поддержка объектов безопасности с пользовательскими названиями.
• Улучшения визуального дизайна в шаблонах, на основе которых создаются умные документы.
• Улучшения удобства использования и рабочего процесса на портале для разработчиков, доступные через меню "Контент > SmartDocs" в Drupal.
• Аутентификация с помощью специального токена теперь называется аутентификацией с помощью ключа API.
• Объекты аутентификации "security", определенные на уровне версии.
• Настройка аутентификации клиента на уровне шаблона. Новые версии больше не сбрасывают предварительно настроенные учетные данные клиента SmartDocs.

Подробнее о функциях рассказывается в записи в блоге.

Документацию по SmartDocs можно найти в статье Как использовать SmartDocs для документирования API.

Название приложения разработчика, которое показывается в интерфейсе управления.

У приложений разработчика в Edge есть внутреннее название, которое нельзя изменить, и отображаемое название, которое можно изменить. На странице приложения разработчика в интерфейсе управления (Publish > Developer Apps > [название приложения]) внутреннее название приложения отображается вместе с названием, которое видят пользователи. Это позволяет легко находить приложения по внутренним названиям при устранении неполадок и управлении API.

Сервисы аналитики

Ниже перечислены новые функции сервисов Аналитики, добавленные в этом выпуске.

Срок хранения данных

При создании отчетов Аналитики с помощью интерфейса управления или API по умолчанию недоступны данные, которые старше шести месяцев с текущей даты. Если вам нужны данные старше шести месяцев, обратитесь в службу поддержки Apigee Edge.

Удаление классической версии специальных отчетов из интерфейса управления

В интерфейсе управления больше не доступна классическая версия пользовательских отчетов.

Эффективность виджета "Взаимодействие с разработчиком"

Виджет воронки на главной панели управления аналитикой (в разделе "Вовлеченность разработчиков") был улучшен, чтобы повысить его эффективность.

Монетизация

Ниже перечислены новые функции монетизации, добавленные в этом выпуске.

Уведомления по электронной почте о тарифных планах

Новый тип уведомлений по электронной почте "Тарифный план" позволяет сообщать разработчикам, когда они достигают определенного лимита транзакций или суммы в долларах в рамках приобретенных ими тарифных планов с пакетами или с учетом объема. Подробнее о том, как настроить уведомления с помощью шаблонов уведомлений…

Синхронизация периодов взимания регулярной комиссии и агрегации

В тарифном плане могут действовать два разных периода времени:

• Период взимания регулярной комиссии, который настраивается на вкладке "Комиссии" тарифного плана и определяет, когда с разработчиков взимается регулярная комиссия.
• Период агрегирования, указанный в тарифном плане с пакетами или с градацией по объему, который определяет, когда для разработчиков сбрасывается использование пакетов.

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

Если периодическая комиссия не взимается, пакеты сбрасываются на основе принципа агрегирования, определенного в тарифной карте. Например, если разработчик начинает использовать тарифную карту 19 числа месяца, а в качестве основы агрегирования выбрано "Каждый месяц", то использование пакета сбрасывается через месяц после 19 числа.

Параметр "Основа агрегирования" больше не поддерживается и будет удален из монетизации в будущем релизе. Подробнее о том, как указать сведения о тарифном плане…

Специальные атрибуты в сводных отчетах о доходе

Правила регистрации транзакций позволяют при необходимости собирать данные настраиваемых атрибутов транзакций, и теперь вы можете добавлять эти настраиваемые атрибуты в сводные отчеты о доходах. Добавив в организацию свойство MINT.SUMMARY_CUSTOM_ATTRIBUTES, вы можете указать, какие специальные атрибуты будут добавлены в таблицы базы данных для использования в отчетах.

Клиенты Apigee Edge для частного облака могут установить флаг с помощью следующего вызова API и учетных данных системного администратора.

curl -u email:password -X PUT -H "Content-type:application/xml" http://host:8080/v1/o/myorg -d \
"<Organization type="trial" name="MyOrganization">
    <Properties>
        <Property name="features.isMonetizationEnabled">true</Property>
        <Property name="MINT.SUMMARY_CUSTOM_ATTRIBUTES">[&quot;my_attribute_1&quot;,&quot;my_attribute_2&quot;]</Property>
        <Property name="features.topLevelDevelopersAreCompanies">false</Property>
    </Properties>
</Organization>"

Обратите внимание, что массив специальных атрибутов в вызове API закодирован в URL.

Процесс обновления SmartDocs

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

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

Обратите внимание, что, хотя вы можете отрисовывать и публиковать SmartDocs на своем портале для разработчиков, они генерируются на основе модели API, которая находится в сервисах управления API Apigee Edge. Все изменения, внесенные в модель API в Edge, будут одинаковыми во всех средах Pantheon (по аналогии с тем, как разработчики существуют в средах Pantheon).

Как перейти с бета-версии SmartDocs на общую доступность

1. Обновите и протестируйте версию 15.05.27 в разработочной или тестовой среде на платформе Pantheon.
2. Создайте новую модель, чтобы заменить существующую модель API.
   • Если вы импортировали документы Swagger или WADL, импортируйте их снова в новую версию.
   • Если вы поддерживали модель API с помощью модуля SmartDocs, экспортируйте ее как JSON SmartDocs и импортируйте в новую модель, используя прикрепленный файл.
3. Задайте свойства безопасности для версии модели. На странице Контент > SmartDocs > модель выберите Настройки безопасности.
   
4. Проверьте предварительно настроенную аутентификацию на странице настроек модели (Контент > SmartDocs), нажав Настройки в столбце "Операции".
   
5. Обновите все собственные шаблоны, чтобы в них использовались объекты CSS и JS версии 6, а также внесите изменения, связанные с новыми названиями объектов, например authSchemes и apiSchema. Информацию о том, как обновить шаблоны SmartDocs, можно найти в статье Как использовать SmartDocs для документирования API.
6. Заново отрисуйте и опубликуйте измененную модель.
7. После проверки новой документации обновите рабочий портал до версии 15.05.27.

Если вы корпоративный клиент Edge и у вас есть вопросы или проблемы, связанные с процессом обновления, отправьте электронное письмо на адреса marsh@apigee.com и cnovak@apigee.com. В остальных случаях рекомендуем обратиться к сообществу Apigee.

Будущие изменения и улучшения функций

В этом разделе описаны ожидаемые изменения и улучшения функций:

Изменение поведения правил кеширования ответов

В будущем выпуске (дата пока не определена) поведение по умолчанию элемента <ExcludeErrorResponse> правила кеширования ответов изменится.

Текущее поведение. По умолчанию элемент <ExcludeErrorResponse> в правиле кеширования ответов имеет значение false. Это означает, что по умолчанию ответы с любым возможным кодом статуса HTTP (включая 3xx) кешируются правилом "Кеш ответов".

Будущее поведение. Значение элемента <ExcludeErrorResponse> в правиле кеширования ответов по умолчанию будет равно true. Это означает, что по умолчанию кешируются только ответы с кодами статуса HTTP 200–205. Чтобы переопределить это поведение и кешировать ответы для всех кодов статуса, вам нужно явно задать для элемента <ExcludeErrorResponse> значение true.

Временное решение. Если вы используете версию Private Cloud 4.15.07.00 или более раннюю и хотите кешировать ответы только с кодами статуса 200–205, необходимо явно задать для элемента <ExcludeErrorResponse> значение true.

Исправлены ошибки

В этой версии исправлены следующие ошибки:

Известные проблемы

В этом выпуске есть следующие известные проблемы.

> source /{install-dir}/apigee4/bin/apigee-env.sh

> VER=`basename $(find $SHARE_DIR/installer/monetization -name "mint-*.zip") | cut -d "-" -f 2,3,4`

> sed -i "s/^MONETIZATION_VERSION=.*/MONETIZATION_VERSION=$VER/" /install-dir/apigee4/bin/apigee-env.sh

> rm /install-dir/apigee4/share/monetization

**************************************
In order to complete the monetization upgrade please run:
sudo /opt/apigee4/share/monetization/schema/migration/MOPDK4.15.04.00/
365-create-notification-condition.sh
**************************************

connect.ranges.denied=10.0.0.0/8,192.168.0.0/16,127.0.0.1/32

<install_dir>/apigge4/bin/apigee-service message-processor restart