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

Red Hat 3scale API Management 2.10

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

概要

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

前書き

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

第1章 新たな機能

1.1. 主要な機能

  • ゼロダウンタイムアップグレードがサポートされるようになりました (JIRA #4722 および JIRA #4723)
  • operator の追加機能拡張: Grafana および Prometheus を使用した System および Zync コンポーネントのリソース監視が追加されました (JIRA #4743 および JIRA #4744)。
  • OpenShift 4.x デプロイメントにおいて、外部データベースとして Oracle がサポートされるようになりました (JIRA #2998)。
  • APIcast ゲートウェイで、SSL/TLS および HTTP/2 トラフィックの復号化および暗号化に関連する全操作専用に、FIPS 140-2 対応の検証済み暗号モジュールがサポートされるようになりました (JIRA #5337)。
  • リクエストおよびレスポンスのペイロードサイズに制限を設定できるようになりました (JIRA #5244)。
  • APIcast の IP Check ポリシーで PROXY プロトコルがサポートされるようになりました (JIRA #5366)。
  • 更新された Dashboard およびプロダクトおよびバックエンドのスタンドアロンページにおいて、ユーザーエクスペリエンスおよびユーザーインターフェースが改善されました。

1.2. その他の機能

  • シングルサインオンがアカウントに適用される場合、ユーザーが自動的にリダイレクトされるようになりました (JIRA #2795)。
  • ActiveDocs を読み取るための GET エンドポイントが Account Management API に追加されました (JIRA #5826)。
  • プロキシー設定 および /admin/api/service.json エンドポイントのパフォーマンスが向上し、サービスが多数ある場合に迅速に設定を取得できるようになりました(JIRA #4528)。
  • 特定コンポーネントのデバッグを行うためのリソース監視が追加されました (JIRA #4801)
  • 3scale operator にストレージ領域の設定機能が追加されました (JIRA #3652)。
  • APIcast operator でリソース要件をカスタマイズできるようになりました (JIRA #5964)。
  • Caching ポリシーのデフォルト値が空になりました (JIRA #1514)。
  • URL Rewriting with Captures ポリシーの機能が拡張されました (JIRA #6270)。
  • 3scale 管理ポータルで Account Settings がコンテキストスイッチャーに表示されるようになりました (JIRA #6241)。
  • インストールの完了後、namespace の OpenShift Dashboard で 3scale マスターアカウントポータルへのリンクを取得できるようになりました (JIRA #5444)。

第2章 テクノロジープレビューの機能

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

第3章 解決された問題

  • Stripe および Braintree 支払いゲートウェイとのインテグレーションに変更が加えられました。

    • 3scale を 2.10 にアップグレードする 前に、これらの支払いゲートウェイとのインテグレーションの影響を理解するようにしてください。これらの影響については、「3scale の変更点: 3scale と支払いゲートウェイのインテグレーション」で説明します。

    • Stripe とのインテグレーションによる請求機能の使用:

      • 強力な顧客認証 (SCA) が適用される場合にクレジットカードに課金できない問題が解決されました (JIRA #6515)。
      • これらの修正により、課金失敗 の電子メール応答の文章が更新されました (JIRA #6767)。

      • 3scale に Stripe を設定する手順に関するドキュメントは、まもなく利用可能になります。

    • Braintree とのインテグレーションによる請求機能の使用:

  • デベロッパーポータルで、OpenAPI Specification 3.0 のオートコンプリート機能が動作しません (JIRA #6088)。
  • OpenShift 4 では、APIcast へのカスタムポリシーの追加に失敗します (JIRA #5515)。
  • YAML ファイルで定義されるマッピングルールの位置が考慮されません (JIRA #5747)。
  • API へのアクセスが許可されないユーザータイプのメンバーであっても、ActiveDocs を表示および変更することができます (JIRA #952)。
  • プライベートベース URL に API の完全なドメイン名を指定することができます (JIRA #4752)。
  • Trash 内のメッセージを表示または復元することができません (JIRA #1503)。
  • マッピングルールの Search 機能が正しく機能しません (JIRA #5817)。
  • OAS 3.0.2 仕様をインポートする際、3scale toolbox はバックエンド定義のカスタムポートをデフォルトのプロトコルに変換します (JIRA #6192)。
  • operator の概要ページで、3scale-operator バージョンが正しくありません(JIRA #5631)。
  • 同じ OCP プロジェクトに複数の apicast- サービスがあると、APIcast エラーが発生します(JIRA #6315)。

第4章 既知の問題

  • Braintree とのインテグレーション: 3DS バージョン 2 が有効ではない Braintree アカウントと統合した状態で 3scale 2.10 にアップグレードした場合、支払いインテグレーションは機能しません。この問題への対応策は 2 つあります。

    • 3DS バージョン 2 が有効な Braintree アカウントと 3scale を統合する。
    • 3DS が有効ではない Braintree と統合するためのソリューションが利用可能になるまで、3scale 2.10 にアップグレードしないことを検討する。
  • Prometheus および Grafana を使用した 3scale の監視が、誤った値を表示します (JIRA #6446 および JIRA #6403)。
  • クラス名で検索した場合、Sphinx 検索は既存のレコードをすべて返します (JIRA #6405)。
  • 新しく作成されたサービスおよびバックエンドが次の日にインデックス化されるまで、これらの項目を検索することはできません (JIRA #6205)。
  • 3scale のデプロイ時に、System/Zync がルートの作成に失敗することがあります (JIRA #6391)。

  • 3scale のユーザー名は 40 文字以下である必要があります。ユーザー名が 40 文字を超える場合、3scale は通常切り捨てます。以下のいずれかを行う場合は、これを考慮してください。

    • 開発者アカウントを作成します。
    • マスターとしてプロバイダーアカウントを作成します。
    • プロバイダーまたはマスターとして、ユーザーをプロバイダーアカウントに追加します。
    • デベロッパーポータルまたは管理ポータルで、開発者アカウントにユーザーを追加します。

    Red Hat Single Sign-On を使用して管理ポータルまたはデベロッパーポータルへのアクセスを認証する場合、ユーザー名は 40 文字以下である必要があります。

第5章 ドキュメント

サポートされる構成

セキュリティーアップデート

エラータ

アップグレードガイド

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

第6章 3scale の変更点

本セクションでは、3scale 2.10 の現在および今後の変更を説明します。

6.1. 3scale と支払いゲートウェイのインテグレーション

  • 3scale 2.10 では、Stripe および Braintree 支払いゲートウェイとのインテグレーションに変更が加えられ、強力な顧客認証 (SCA) 規格をサポートするようになりました。これらの支払いゲートウェイインテグレーションのいずれかを使用している場合、3scale を 2.10 にアップグレードする前に、以下の点について理解するようにしてください。

    • Stripe とのインテグレーション: 3scale に Stripe を設定する手順に関するドキュメントは、まもなく利用可能になります。コンテンツが利用可能になったら、この通知を更新します。

    • Braintree とのインテグレーション: 3scale 2.10 と Braintree を統合する場合、Braintree アカウントが 3DS バージョン 2 に対応するようにしてください。

6.2. 非推奨の機能

  • RHEL7 および Docker のコンテナーとして実行される APIcast デプロイメントのサポートは非推奨になりました。今後のリリースでは、RHEL8 のみがサポートされます。Self-managed APIcast をコンテナーとして実行している場合は、RHEL8 および Podman に移行することを推奨します。

6.3. 廃止された機能

  • Oracle 12c に対するサポートが Oracle 19c に置き換えられました。

6.4. 今後の変更

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

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。まずは、マスター (master)、スレーブ (slave)、ブラックリスト (blacklist)、ホワイトリスト (whitelist) の 4 つの用語の置き換えから始めます。この取り組みは膨大な作業を要するため、今後の複数のリリースで段階的に用語の置き換えを実施して参ります。詳細は、CTO である Chris Wright のメッセージ をご覧ください。