リリースノート
Red Hat 3scale API Management 2.5
Red Hat 3scale API Management 2.5 向け
概要
本書は、Red Hat 3scale API Management 2.5 のリリースノートです。
パート I. Red Hat 3scale API Management 2.5.1: パッチリリース
第1章 新たな機能
1.1. 主要な機能
- 弊社が公式にサポートするコマンドラインインターフェイス (CLI) で OpenAPI Specification 定義をインポートし、API サービスを作成または更新できるようになりました (JIRA #1656)。
サービスをコピーおよび更新する際に、以下のサービス設定を使用できるようになりました。
- ActiveDocs (JIRA #1542)
- 標準ポリシー (JIRA #1534)
- remote を設定して 3scale インスタンスのセットを管理できるようになりました (JIRA #1655)。
1.2. その他の機能
- レスポンスヘッダーおよびにエラーレスポンスのボディーに Openresty のバージョン番号が表示されるのを無効にできるようになりました (JIRA #1989)。
- OpenID Connect: 3scale バックエンドに対して認証する際に、no_body オプションを設定できるようになりました (JIRA #2006)。
第2章 解決された問題
- APIcast が、異なるドメインのリクエストに対して異なる HTTPS セッションを使用するようになりました (JIRA #2205)。
- クライアントの証明書チェーンの最大長さを設定できるようになりました (JIRA #2383)。
第3章 既知の問題
- エクステンションが含まれる OpenAPI Specification (OAS) 2.0 (JIRA #2550) およびタイトルにピリオドの付いた OpenAPI Specification (OAS) 2.0 (JIRA #2628) をインポートすることはできません。
-
OAS 2.0 をインポートする際に、3scale では
operationId
の説明が表示されません (JIRA #2549)。 -
スペースが含まれる
operationId
の説明をインポートすることはできません (JIRA #2548)。 - OAS 2.0 からインポートしたサービスを使用する前に、ステージング環境を手動で更新する必要があります (JIRA #2545)。
- ディレクトリーを OAS 2.0 としてインポートすると、Toolbox にエラーメッセージが表示されます (JIRA #2524)。
パート II. Red Hat 3scale API Management 2.5 リリースノート
第4章 新たな機能
4.1. 主要な機能
APIcast API ゲートウェイ
- ゲートウェイとクライアント間の相互 TLS を可能にする、TLS クライアント証明書の新たな検証ポリシー (JIRA #1671)。
- ヘッダーに基づくコンテンツベースの新たなルーティングポリシー (JIRA #1411)。
- API ごとに許可される OAuth フローを設定する機能が追加されました。管理ポータルから API サービスが更新されると、対応するフローが RH-SSO 側でも有効になります (JIRA #774)。
- 最初のマッピングルールが一致したら、残りのマッピングルールの処理を中止する新たなオプションが追加されました (JIRA #1344)。
- API ゲートウェイの認証設定に Basic 認証 のオプションが追加されたので、API の認証情報を HTTP 認証ヘッダーに渡せるようになりました (JIRA #430)。
4.2. その他の機能
- アプリケーションプランでより多くの値を更新できるようになりました (JIRA #1868)。
- スイスフラン (CHF) およびサウジリヤル (SAR) がサポートされる通貨リストに追加されました (JIRA #1594)。
- プロバイダーは、API を使用してユーザーのアクセス権限をプログラム的に設定できるようになりました。2 つの新たなエンドポイント User Permissions Read および User Permissions Update が、アカウント管理 API に追加されました (JIRA #484)。
- Account Management API に Access token create という新しいエンドポイントが追加されました。アクセストークンをプログラム的に作成し、特定のユースケースに必要なスコープを割り当てられるようになりました (JIRA #1112)。さらに、アクセストークン API エンドポイントを検索、表示、および削除できるようになりました (JIRA #1766)。
第5章 解決された問題
- 月の最終日にサブスクライブした場合に、後払いモードで請求書が正常に生成されるようになりました (JIRA #534)。
- 再度追加されたサービスが 3scale で検出された場合に、サービスの削除が確実に機能するようになりました (JIRA #1194)。
- フォワードプロキシーを経由して POST リクエストが正常に HTTPS API バックエンドに送付されるようになりました (JIRA #1781)。
- ユーザーキーで検索した場合の結果が、Accounts セクションに表示されるようになりました (JIRA #996)。
- reCAPTCHA を設定できるようになりました (JIRA #1108)。
- システムの請求機能が正常になり、正の値の請求書だけが残るようになりました (JIRA #1420)。
- OpendID Connect 認証モードで 3scale Batcher ポリシーが機能するようになりました (JIRA #1515)。
- 新しい APIcast にアップグレード後に、APIcast 設定が正しく更新されるようになりました (JIRA #1549)。
- Internet Explorer 11 の使用時に、ポリシーが 3scale で正しく表示されるようになりました (JIRA #1711).
- デベロッパーポータルの Quickstart Guide へのリンクが修正されました (JIRA #2078)。
第6章 ドキュメント
APIcast API ゲートウェイ
- 3scale Istio Adapter
- Provisioning 3scale services and configurations via the operator (Capabilities)
- OAuth 2.0 supported flows
- Mapping rules: 最初のマッピングルールが一致したら、残りのマッピングルールの処理を中止する新たなオプションに関する詳細
- 3scale API Management 2.4 to 2.5 upgrade guide
第7章 テクノロジープレビューの機能
- Istio Adapter: Service Mesh に API 管理機能を追加できるようになりました (JIRA #1689)。
3scale にリソースをインストールし同期するための新たな 3scale operator (JIRA #1798):
- 3scale API Management ソリューションのインストール時にその設定を行う高度なオプション
- カスタムリソースを使用した、3scale テナント、API、プラン、制限、メトリクスの定義および 3scale インストールに関するその他の定義
- 高可用性 (HA) OpenShift テンプレートおよび評価用 (Eval) OpenShift テンプレート JIRA #1168)。
- 特定の条件が満たされた時にだけポリシーチェーンを実行する Conditional policy。このポリシーを設定するためのユーザーインターフェイスはないので、JASON を使用して設定する必要があります。
第8章 既知の問題
- ダッシュボードストリームおよびメール通知が、ユーザーのパーミッションに応じてフィルターされない (JIRA #629)。
- backend-listener が backend-redis に再接続されない (JIRA #608)。
- Android モバイルデバイスでは、デベロッパーポータルの Active Docs セクションで、全画面モードで開いたメニューを閉じることができない。メニューを閉じるには、ページをリフレッシュする必要がある (JIRA #1067)。
-
Sentinel 機能を使用した Redis HA と System コンポーネントのバックエンドの組み合わせは、現在
system-redis
またはbackend-redis
との接続ではサポートされない (JIRA #1132)。
第9章 3scale 2.5 での変更点
9.1. 非推奨の機能
- 本リリースでは、Microsoft Internet Explorer 11 (IE11) との互換性が非推奨になりました。この Web ブラウザーは、3scale の今後のリリースではサポートされない予定です。
- 非 CDB アーキテクチャーの Oracle Database は、Oracle Database 12c では非推奨になりました。3scale データベースの一部にこのアーキテクチャーを使用している場合には、この変更の影響を受けます。Oracle の推奨事項との整合性から、CDB アーキテクチャーの使用を推奨します。非 CDB の設定は、今後のリリースではサポートされない予定です。詳細は、Deprecation of Non-CDB Architecture を参照してください。
9.2. 廃止された機能
- End User Plans 機能が廃止されました。この機能は、エッジ流量制御用の APIcast ポリシーを使用してエンドユーザーの流量制御を定義する機能に置き換えられています。詳細は、Edge Limiting policy を参照してください。
- latest transactions ページは利用できなくなりました (JIRA #1767).
9.3. ドキュメントの変更
- 3scale 2.5 では、ドキュメントの設定が変更されています。詳細は、3scale ドキュメントライブラリーの再設定 を参照してください。
9.4. 今後の変更
- インストールプロセスが、テンプレートベースから operator ベースに変更される計画です。本リリースでは、テクノロジープレビューとして新たな 3scale operator を追加しています。今後のリリースでは、operator を使用したインストールが、3scale API Management ソリューションをデプロイする標準のメカニズムになる予定です。
- 製品のイメージにアクセスするための、新たなレジストリー (registry.redhat.io) が利用可能になりました。従来のレジストリー (registry.access.redhat.com) とは異なり、このレジストリーにアクセスするには認証が必要です。移行措置として、3scale 2.5 のイメージは両方のレジストリーに公開されています。ただし、2.6 では認証の必要なレジストリーにのみ公開される計画です。詳細は、Transitioning the Red Hat container registry および Red Hat コンテナーレジストリーの認証 を参照してください。
第10章 3scale ドキュメントライブラリーの再設定
本項では、3scale ドキュメントライブラリーの再設定について説明します。この再設定の主目的は、コンテンツを再配置して使い易さとアクセス性を向上させることです。
まず、従来の設定と再設定されたドキュメント構造のマッピングを示します。次に、それぞれの新しいドキュメントカテゴリーについて、従来のドキュメントから再設定されたライブラリーへのマッピングの概要を説明します。
参考資料:
- Blue box → カテゴリー名
- Pink box → 再利用ブック
- Green box → 新規ブック