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

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

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

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

• Облако: 15.04.15 , 15.04.29 , 15.05.27 , 15.06.10 , и 15.06.24
• Частное облако: 4.15.04.01

Какие версии Edge можно обновить до 4.15.07.00?

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

• Непосредственно обновление до 4.15.07.00
• Поэтапное обновление, то есть вам придется обновиться с текущей версии до другой версии Edge, а затем обновиться до 4.15.07.00.

Для получения дополнительной информации см. раздел Какие версии Edge for Private Cloud можно обновить до 4.15.07.00 .

Перед обновлением с версии 4.15.01.x или с предыдущей версии

1. Проверьте версию Cassandra SSTable:
   1. Измените каталог на /<install-root>/apigee4/data/cassandra/data .
   2. Выполните команду find,
      > найти . -имя *-ic-*
      Если вы используете Cassandra 1.2 SSTable, результаты должны вернуть набор файлов .db.
   3. Выполните следующую команду поиска:
      > найти . -имя *-hf-*
      Результаты должны быть пустыми, то есть файлы .db в формате hf отсутствуют. Если вы не видите файлов в формате hf , обновление завершено и можно переходить на версию 4.15.07.00.
      
      Формат hf предназначен для Cassandra 1.0 SSTables. Если у вас есть файлы *.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
   > найти . -имя *-jb-*
   Эта команда должна вернуть набор файлов .db, если вы используете Cassandra 2.0.

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

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

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

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

Скрипты 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, включенные в этот выпуск.

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 for Private Cloud Operations Guide (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 управления. Подробнее см. в разделе «Политика удаления информации OAuthV2» . (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-адресам в заголовке. Подробнее см. в разделе Политика контроля доступа .

Новые сущности в политике Access Entity

Политика Access Entity предоставляет доступ к следующим новым сущностям: consumerkey-scopes, authorizationcode, requesttoken и verifier. Подробнее см. в разделе Политика Access Entity .

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

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

Удаление Classic Trace в редакторе прокси API

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

Доступ к сообществу 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 поддерживает использование указания имени сервера (Server Name Indication) в южном направлении (от обработчика сообщений до целевых конечных точек). Если вы хотите использовать 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 , как показано ниже:

Более подробную информацию о SNI можно найти на сайте 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 Internal Server Error и ошибку ExecutionFailed, если сообщение не проходит политику защиты от угроз JSON или XML. Вы можете изменить это поведение с помощью нового свойства на уровне организации. При установке свойства организации features.isPolicyHttpStatusEnabled в значение true происходит следующее:

• Запрос: Если к любому потоку запросов прикреплена политика защиты от угроз, недействительные сообщения возвращают код статуса 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)

Услуги разработчиков

Ниже перечислены новые функции Developer Services, включенные в этот выпуск.

SmartDocs общедоступны

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

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

Более подробное описание функций смотрите в этой записи блога .

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

Имя приложения разработчика отображается в пользовательском интерфейсе управления

Приложения для разработчиков в Edge имеют как внутреннее имя, которое не меняется, так и отображаемое имя, которое можно изменить. На странице приложения для разработчиков в интерфейсе управления (Публикация > Приложения для разработчиков > Имя приложения) внутреннее имя приложения отображается вместе с отображаемым именем, что упрощает визуальную идентификацию приложений по их внутренним именам для устранения неполадок и управления API.

Аналитические услуги

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

Ограничение по времени сохранения данных

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

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

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

Производительность виджета «Вовлеченность разработчиков»

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

Монетизация

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

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

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

Синхронизация периодов регулярной платы и агрегации

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

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

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

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

Метод Aggregation Basis устарел и будет исключен из монетизации в будущем выпуске. Подробнее см. в разделе «Укажите детали тарифного плана» .

Пользовательские атрибуты в сводных отчетах о доходах

Политики регистрации транзакций позволяют вам при необходимости собирать данные о настраиваемых атрибутах транзакций, и теперь вы можете включать эти атрибуты в сводные отчёты о доходах. Добавив свойство 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 Edge от Apigee. Любые изменения, вносимые вами в модель API в Edge, будут применяться во всех ваших средах Pantheon (аналогично тому, как разработчики работают в средах Pantheon).

Чтобы перейти с бета-версии SmartDocs на общедоступную версию

1. Обновите и протестируйте релиз 15.05.27 в ваших средах разработки или тестирования на Pantheon.
2. Создайте новую модель для замены любой существующей модели API, которую вы использовали.
   • Если вы импортировали документы Swagger или WADL, импортируйте их снова в новую версию.
   • Если вы поддерживали свою модель API через модуль SmartDocs, экспортируйте ее как SmartDocs JSON и импортируйте в новую модель, используя вложение файла.
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