オンプレミス型 Red Hat 3scale API Management 2.9 向けリリースノート

Red Hat 3scale API Management 2.9

Red Hat 3scale API Management 2.9 向けドキュメント

概要

本書では、Red Hat 3scale API Management 2.9 で解決された問題、関連ドキュメント、および既知の問題に加えて、最新のテクノロジープレビュー機能について説明します。

前書き

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

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

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

1.1. 新たな機能

  • OpenShift 3.11 とテンプレートベースの 3scale デプロイメントの組み合わせにおいて、Oracle Database 19c がサポートされるようになりました (JIRA #3647)。

1.2. 解決した問題

  • サービスディスカバリーに サービスアカウント 認証オプションを使用する場合、インポートされた API が管理ポータルにすべて表示されるようになりました (JIRA #5089)。
  • OpenAPI Specification (OAS) 3.0 の オートコンプリート 機能が、フォーマットにかかわらず正しく動作するようになりました (JIRA #5516)。
  • APIcast 経由でトランザクションを追跡する際にリクエスト URI が含まれるようになりました (JIRA #5669)。
  • テナントを一時停止した後に、Suspend ボタンが表示されなくなりました (JIRA #5738)。
  • Batcher ポリシーと組み合わせた場合、backend-listener がダウンした場合に Auth Caching ポリシー (Allow モード) が新しいリクエストを承認するようになりました (JIRA #5753)。

1.3. 既知の問題

1.4. ドキュメント

サポートされる設定

インストールガイド

アップグレードガイド

  • 以下のデプロイメントについて、3scale インストール環境を 2.8 から 2.9.1 にアップグレードする手順を確認してください。

  • テンプレートベースの 3scale インストール環境が Oracle Database と共に動作している場合、サポートされる Oracle Database バージョンについての詳細は、Oracle データベースのサポート セクションを参照してください。

1.5. 3scale の変更点

本セクションでは、3scale 2.9.1 の変更を列記します。

1.5.1. Oracle データベースのサポート

OpenShift 3.11 とテンプレートベースの Red Hat 3scale API Management デプロイメントの組み合わせにおける Oracle Database サポートの詳細を以下に示します。

  • 3scale 2.9.1 は、Oracle 12c と 19c の両方をサポートします。
  • Oracle 12c を維持したまま、3scale インストール環境を 2.9 から 2.9.1 にアップグレードすることができます。
  • 3scale 2.10 では、Oracle 12c に対するサポートが Oracle 19c に置き換えられる予定です。Oracle DB と共に 3scale を使用している場合は、データベースのバージョンを Oracle 19c にアップグレードすることを検討してください。この設定により、お使いの 3scale インストール環境がサポート対象の設定となります。

第2章 Red Hat 3scale API Management 2.9

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

2.1. 新たな機能

2.1.1. 主要な機能

  • 新たな APIcast ポリシーが追加されました。

    • Upstream Mutual TLS: 設定で指定した証明書に基づいて、APIcast とアップストリーム API との間で相互 TLS 接続を確立することができます (JIRA #672)。詳細は、API ゲートウェイの管理の Upstream Mutual TLS を参照してください。
    • Custom Metrics: post アクションに新しいメトリクスを追加することができます。これにより、ユーザーはメトリクスアップストリームヘッダー、ステータスコード、またはその他の関連情報を報告することができます (JIRA #5098)。詳細は、API ゲートウェイの管理の Custom metrics を参照してください。
  • 3scale APIcast ゲートウェイのコンテンツキャッシュ設定により、Expires および Cache-Control ヘッダーを設定することができます (JIRA #487)。詳細は、API ゲートウェイの管理の APICAST_CACHE_MAX_TIME および APICAST_CACHE_STATUS_CODES を参照してください。
  • OpenAPI Specification (OAS) 3.0 とのより高度な連携のために、ActiveDocs 機能が拡張されました (JIRA #4212)。詳細は、デベロッパーポータルでの API の提供の OAS の設定 を参照してください。
  • 一般のインターネットにアクセスせずにオンプレミス型 3scale の操作を行うことができるようになりました (JIRA #4006)。詳細は、3scale のインストールの OLM を使用した 3scale operator のインストールと設定 を参照してください。
  • 請求用の通貨のリストを設定するオプションが追加されました (JIRA #3076)。詳細は、管理ポータルガイドの 通貨用 YAML の設定 を参照してください。
  • バックエンド API の使用状況の統計値に関する解析データのページが追加されました (JIRA #3159)。詳細は、管理ポータルガイドの バックエンドに関する解析の確認 を参照してください。

2.1.2. その他の機能

  • HTTP 流量制御ヘッダーに関する RFC の最新ドラフトがサポートされるようになりました (JIRA #3795)。
  • HTTP メソッドに基づいて URL Rewriting ポリシールールを設定できるようになりました (JIRA #5259)。
  • 管理 API のアクションに基づいて Webhook がトリガーされるようになりました (JIRA #4703)。
  • メトリクスまたはアプリケーションプランの課金ルールを削除する API エンドポイントが追加されました (JIRA #4771)
  • 指定した環境の最新プロキシー設定から取得したすべてのサービスをエクスポートする 3scale toolbox コマンドが追加されました (JIRA #669)。
  • 一貫性を確保すると共に曖昧さを排除するために、3scale toolbox のエラーの報告に標準化された手法が使用されるようになりました (JIRA #2349)。
  • 3scale toolbox のアプリケーションプラン import コマンドが改善されました (JIRA #3874)。
  • すべての PersistentVolumeClaim で、カスタムストレージクラスを設定できるようになりました (JIRA #4651)。
  • APICast の Prometheus メトリクス: status および content_caching (JIRA #5417 および JIRA #5439)。

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

  • 高可用性 (HA) OpenShift テンプレートおよび評価用 (Eval) OpenShift テンプレート JIRA #1168)。
  • 3scale operator の機能: カスタムリソースを使用して 3scale テナント、API、プラン、制限、メトリクス等を定義し、それらを 3scale インストール環境に設定することができます (JIRA #1798)。
  • 3scale operator を使用して、Prometheus および Grafana によりリソースをモニターリングすることができます (JIRA #4639 および JIRA #4641)。
  • 3scale Pod のメータリングラベルにより、メータリング operator から事前に定義されたレポートを取得し使用状況のデータを確認することができます (JIRA #5765)。
  • 3scale operator を使用したバックアップおよび復元機能が利用可能です (JIRA #4746)。

2.3. 解決された問題

  • トライアル期間に負の値が設定されるのを防ぐための検証が追加されました (JIRA #1758)。
  • Zync は 公開ベース URL の HTTP スキームおよびポート番号を参照するようになりました (JIRA #3545)。
  • SSO Integrations が垂直ナビゲーションで強調表示されるようになりました (JIRA #3548)。
  • バックエンドまたはプロダクトが多い場合のパフォーマンスが改善されました (JIRA #3592)。
  • バックエンドを持たないプロダクトのプロキシー設定が生成されるのを防ぐための検証が追加されました (JIRA #3626)。
  • フォワードプロキシーを使用して APIcast が大量のボディーの呼び出しを行う場合のパフォーマンスが改善されました (JIRA #3863)。
  • HTTP_PROXY が設定されている場合に、ホストヘッダーが設定されるようになりました (JIRA #4178)。
  • OpenID Connect 認証方法を使用する場合に、Example curl for testing が表示されなくなりました (JIRA #4384)。
  • メンバーロールの管理ユーザーがバックエンドの使用状況にアクセスできるようになりました (JIRA #4489)。
  • プロキシードメインに制限以上の文字を入力した場合のエラーメッセージが正確になりました (JIRA #4658)。
  • パスベースのルーティングが引数と一致するようになりました (JIRA #5149)。
  • IP Check ポリシーによりポートが削除されるようになりました (JIRA #5258)。

2.4. 既知の問題

  • ProxyRule が末尾のスラッシュを削除します (JIRA #3872)。
  • YAML ファイルで定義されるマッピングルールの位置が無視されます (JIRA #5747)。
  • 一部のパッケージに誤ったメタデータが存在します (JIRA #5682)。
  • 3scale 2.9.1 で解決済み: テナントがすでに一時停止されている時に Suspend ボタンが表示されます (JIRA #5738)。
  • 3scale 2.9.1 で解決済み: サービスディスカバリーに サービスアカウント 認証オプションを使用する場合、インポートされた API が管理ポータルに表示されません (JIRA #5089)。この問題を回避するには、以下のオプションがあります。

    • 最終的な APIcast の URL に 63 文字を超えるラベルが含まれないように、OpenShift のプロジェクトまたはサービスの名前を変更する。
    • 長い URL ラベルが設定されるリスクを低減するために、sandbox_proxy.yml で URL テンプレートを変更する。

2.5. ドキュメント

サポートされる設定

セキュリティー更新

アップグレードガイド

  • テンプレートベースの 3scale インストール環境が Oracle Database と共に動作している場合、サポートされる Oracle Database バージョンについての詳細は、「今後の変更」 セクションを参照してください。
  • 以下のデプロイメントについて、3scale インストール環境を 2.8 から 2.9 にアップグレードする手順を確認してください。

  • 開発者ポータルで API をプロビジョニングするためのアップグレード後の手順が追加されました。詳細は、3scale の移行 ガイドの はじめに を参照してください。

ドキュメントに関して解決された問題

2.6. 3scale の変更点

本セクションでは、3scale 2.9 の今後の変更を列記します。

2.6.1. 今後の変更

  • 3scale 2.9.1 では、Oracle 12c に対するサポートが Oracle 19c に置き換えられる予定です。Oracle DB と共に 3scale を使用している場合は、2.9.1 がリリースされるまで 3scale 2.8 を維持し、その後データベースのバージョンを Oracle 19c にアップグレードします。この設定により、お使いの 3scale インストール環境がサポート対象の設定となります。
重要

3scale 2.9.1 では、Oracle 12c のサポートに関する通知に変更が加えられています。詳細は、2.9.1 リリースノートの Oracle Database のサポート を参照してください。

  • 現在、Proxy Update を使用すると、ステージング環境用に、設定が更新された新たな APIcast 設定バージョンが作成されます。ただし、今後のリリースでは、これが変更されます。ユーザーは、この目的のために新たな Proxy Config Promote エンドポイントを使用する必要があります。
  • Redis 3.2 に対するサポートは、今後のバージョンで削除される予定です。