リリースノート

Red Hat 3scale API Management 2.6

Red Hat 3scale API Management 2.6 向け

概要

Red Hat 3scale API Management 2.6 のリリースノート

はじめに

本書は、Red Hat 3scale API Management および関連のパッチリリース向けのドキュメントです。

第1章 Red Hat 3scale API Management 2.6.1 - パッチリリース

本項は、オンプレミス型 Red Hat 3scale API Management 2.6.1 向けドキュメントです。

1.1. 解決された問題

  • イメージファイルの更新により、Oracle Database を使用する 3scale のバージョン 2.5 から 2.6 へのアップグレードプロセスが、正常に実行されるようになりました (JIRA #4793)。

第2章 Red Hat 3scale API Management 2.6

本項は、オンプレミス型 Red Hat 3scale API Management 2.6 向けドキュメントです。

2.1. サポートされる設定

  • アーティクル Red Hat 3scale API Management Supported Configurations で、3scale 2.6 のサポート対象設定に関する最新情報を確認してください。
  • operator イメージは、サポートされる Operator Lifecycle Manager (OLM) のインストール手順以外を使用してインストールすることはできません。手動でのインストールは想定されていません。

2.2. 新たな機能

2.2.1. 主要な機能

  • OpenShift 4.1 に対する 3scale 2.6 の認定が導入されました (JIRA #2657)。
  • 3scale operator は OLM ベースのインストールで動作します (JIRA #2384)。
  • Redis High Availability および Disaster Recovery (HA/DR) がサポートされるようになりました (JIRA #2584)。
  • API ライフサイクルの自動化機能において、3scale toolbox および Jenkins パイプラインがサポートされます (JIRA #2201)。ただし、エクスポートされた YAML ファイルの編集には制限があります (JIRA #2350)。

  • APIcast ポリシー:

    • リトライポリシー: APIcast は、エラーを報告する前にリクエストの実行をリトライします (JIRA #2261)。
    • アップストリーム接続ポリシー: API バックエンドに応じて、NGINX ディレクティブの一部のデフォルト値を変更できるようになりました (JIRA #2450)。
  • 監査ログの処理: 既存の監査ログを標準のコンテナーおよび Pod ログに転送することができます (JIRA #2593)。
  • OpenID Connect インテグレーション機能が拡張され、Zync によるサードパーティーアイデンティティープロバイダーとのクライアント同期を容易に行うことができます (JIRA #1131)。
  • registry.redhat.io にある認証レジストリーで 3scale コンテナーイメージをホストするようになりました (JIRA #2292)。
  • 3scale によりシステムに PostgreSQL のサポートが提供されます (JIRA #2839)。

2.2.2. その他の機能

  • URL パスおよび正規表現を使用して APIcast サービスを絞り込む機能が追加されています (JIRA #2446)。
  • API レベルで Prometheus アラートを設定する際に、より多くのメトリクス情報を追加できるようになりました (JIRA #2532)。
  • OpenID および OAuth トークンの検証フローを変更して、アクセス制御を強化しています (JIRA #2262)。
  • 最適な機能を利用できるようになり、より優れたパフォーマンスが得られるように APIcast を設定することができます (JIRA #2337)。
  • 3scale toolbox を使用して、新規および既存プランの両方について、新規メソッドおよびメトリクスを有効にするか無効にするかを選択できるようになりました (JIRA #2448)。
  • マッチングの演算子がエッジ流量制御ポリシーに追加され、このポリシーを秒単位で流量を制限するマッピングルールとして使用することができます (JIRA #2590)。
  • 新たな環境変数 APICAST_PATH_ROUTING_ONLY が追加されました。変数を true に設定すると、APIcast はパスベースのルーティングを使用し、デフォルトのホストベースのルーティングにはフォールバックしません (JIRA #1150)。
  • Red Hat Single Sign On (RH-SSO) のロール確認ポリシーを使用して、異なる HTTP メソッドへのアクセスを管理できるようになりました (JIRA #2236)。
  • インテグレーションのオプションに Istio を選択した場合には、ユーザーインターフェイスから OpenID Connect (OIDC) を有効にすることができます (JIRA #2435)。
  • 上限が 0 (つまり無効) のメトリクスと上限超過エラーを区別できるように、新たな情報が追加されています (JIRA #2756)。
  • Patternfly 4 インテグレーションが導入されました (JIRA #2296)。
  • 3scale toolbox を使用して、アプリケーションプランを作成、一覧表示、表示、更新、および削除するコマンドを実行することができます (JIRA #2798)。
  • CLI 3scale toolbox に現在のアプリケーションプランを有効および無効にする操作が追加されました (JIRA #2437)。

2.3. 解決された問題

  • ダッシュボードストリームおよびメール通知が、ユーザーのパーミッションに応じてフィルターされるようになりました (JIRA #629)。
  • OpenAPI Specification の問題の原因となっていたメインレイアウトテンプレートのブートストラップ参照が修正されました (JIRA #1067)。
  • サービスの設定が正しくコピーおよび更新されるようになりました (JIRA #1537)。
  • IP 確認ポリシーの UI に関して、設定の問題が解決されました (JIRA #1692)。
  • APIcast がバックエンドの URL の大文字を正しく解釈するようになりました (JIRA #2540)。
  • バッチポリシーと組み合わせた際に、キャッシュポリシーが想定したとおりに機能するようになりました (JIRA #2705)。
  • IP 確認ポリシーを複数の x-forwarded-for ヘッダーに適用できるようになりました (JIRA #2775)。

  • 3scale toolbox を使用して、以下の操作を実施できるようになりました。

    • Self-managed APIcast の場合に、サービスをホスト型 3scale (SaaS) からオンプレミス型 3scale にコピーする (JIRA #2268)。
    • 3scale toolbox を使用してインポートした API を使用する (JIRA #2545)。
    • エクステンションを含む OpenAPI Specifications をインポートする (JIRA #2550)。
  • ポリシーが利用できない場合に、Integration settings ページにフィードバックが表示されるようになりました (JIRA #2312)。
  • APIcast が利用できない場合に、Integration settings が正しく機能するようになりました (JIRA #2327)。
  • 削除したオブジェクトの Oracle スキーマが修正されました (JIRA #2298)。
  • テナントの自動停止および削除が改善されました (JIRA #2132)。
  • メンバー権限の名前 (Developer Account - Applications) を更新しました (JIRA #2610)。
  • Zync がアカウントを正しく削除するようになりました (JIRA #1346)。
  • 改行位置を調整することで、アプリケーションページで長いメトリクス名がレイアウトを維持したまま表示されるようになりました (JIRA #1382)。
  • サービスディスカバリーによる AJAX リクエストが認証情報を取得するようになりました (JIRA #2254)。
  • operator を使用したインストールと S3 ストレージの組み合わせが正常に機能するようになりました (JIRA #2774)。
  • first*traffic_at フィールドが変更されても、アプリケーション更新のイベントが zync のトリガーにならなくなりました (JIRA #2072)。

2.4. ドキュメント

2.5. テクノロジープレビューの機能

  • 高可用性 (HA) OpenShift テンプレートおよび評価用 (Eval) OpenShift テンプレート JIRA #1168)。
  • 3scale operator の機能: カスタムリソースを使用して 3scale テナント、API、プラン、制限、メトリクス等を定義し、それらを 3scale システムに組み込むことができます (JIRA #1798)。

2.6. 既知の問題

  • 3scale toolbox を使用した API ライフサイクル管理用エンドツーエンドソリューションのサンプルパイプラインは、OCP 3.11 上でしかサポートされません (JIRA #2583)。

  • 3scale で OpenID Connect の認証フローを変更した場合に、Zync は 3scale アプリケーションの Red Hat Single Sign-On (RH-SSO) クライアントを更新しません (JIRA #3025)。この問題を回避するには、以下の代替案を使用してください。

    • 既存のアプリケーションの場合には、3scale アプリケーションを更新します (説明部分の変更など)。これが更新のトリガーとなり、アプリケーションの RH-SSO クライアントが変更されます。
    • 新規アプリケーションを作成すると、正しい認証フローで新たな RH-SSO クライアントが作成されます。

  • アプリケーションプラン機能および制限をインポートまたはエクスポートする場合には、エクスポートされた YAML ファイルの変更はサポートされません (JIRA #2350)。

    • サンプルパイプラインおよびアプリケーションは、例としてのみ提供されています。Red Hat は、パイプラインに加えた変更を直接サポートしません。サンプルパイプラインが利用するベースの API、CLI、およびインターフェイスは、Red Hat により完全にサポートされます。
  • OpenShift イメージからの 3scale toolbox を使用する場合には、カスタム証明書を追加することはできません (JIRA #3102)。

  • 3scale 2.5 から Redis Enterprise およびその他の単一論理データベース Redis デプロイメントに移行するユーザーに対応するために、Makefile が利用可能です。

    • スクリプトによりシークレットおよび DeploymentConfigs にパッチが適用されると共に、すべての system-redis キーが目的の single-db Redis インスタンスに移行されます。ただし、backend-redis に依存する Pod は対象ではありません (JIRA #2197)。また、3scale High Availability (HA) デプロイメントに適合させるための調整が必要です (JIRA #2407)。
  • Redis Sentinel を使用して 3scale HA を設定する際に、operator は backend-redis シークレットの REDIS_STORAGE_SENTINEL_HOSTS および REDIS_QUEUES_SENTINEL_HOSTS 変数を無視します (JIRA #3258)。

2.7. 3scale 2.6 での変更点

2.7.1. 廃止された機能

  • OpenShift 4.x ではワイルドカードルートが廃止されているので、3scale 2.6 でこの機能を使用することはできません。その代わりに、ルートは Zync により自動的に作成されます。ルート作成の詳細な情報は、以下のドキュメントを参照してください。

  • 3scale 2.6 では、Oracle データベースと OpenShift 4.1 の組み合わせはサポートされません。
  • 3scale 2.5 で 発表したように、2.6 以降 Microsoft Internet Explorer 11 (IE11) との互換性はサポートされません。

2.7.2. 非推奨となり廃止された機能

  • Adyen の支払いゲートウェイ。3scale 2.6 ではこのゲートウェイは廃止されましたが、既存の設定用に引き続きサポートされます。請求処理に Adyen を使用するようにアカウントが設定されている既存のシステムでは、引き続きこのゲートウェイが表示され機能します。その他の支払いゲートウェイを使用しているユーザーには Adyen は表示されないので、選択することはできません。

2.7.3. 今後の変更

  • インストールプロセスが、テンプレートベースから operator ベースに変更されています。本リリースでは、3scale operator を使用した 3scale のインストールがサポートされています。今後のリリースでは、アップグレード版の operator およびサービスのプロビジョニングに関する機能がサポートされる計画です。