4.15.07.00 - Apigee Edge for Private Cloud リリースノート

Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントに移動します。 info

2015 年 9 月 8 日（火曜日）に、Apigee Edge for Private Cloud のメジャー フィーチャー リリースをリリースしました。

前回の Edge for Private Cloud 四半期リリース（4.15.04.00）以降、次のリリースが行われ、この四半期リリースに含まれています。

• Cloud: 15.04.15、15.04.29、15.05.27、15.06.10、15.06.24
• Private Cloud: 4.15.04.01

4.15.07.00 にアップグレードできる Edge のバージョン

現在の Edge のバージョンに応じて、次のいずれかを行います。

• 4.15.07.00 に直接アップグレードする
• 段階的にアップグレードします。つまり、現在のバージョンから別のバージョンの Edge にアップグレードしてから、4.15.07.00 にアップグレードする必要があります。

詳細については、4.15.07.00 にアップグレードできる Edge for Private Cloud のバージョンをご覧ください。

バージョン 4.15.01.x 以前のバージョンからアップグレードする前に

1. Cassandra SSTable のバージョンを確認します。
   1. ディレクトリを /<install-root>/apigee4/data/cassandra/data に変更します。
   2. find コマンドを実行します。
      > find . -name *-ic-*
      Cassandra 1.2 SSTable を実行している場合、結果には一連の .db ファイルが返されます。
   3. 次の find コマンドを実行します。
      > find . -name *-hf-*
      結果は空になります。つまり、hf 形式の .db ファイルはありません。hf 形式のファイルが表示されない場合は、4.15.07.00 にアップグレードできます。
      
      hf 形式は、Cassandra 1.0 SSTable 用です。hf 形式の *.db ファイルがある場合は、この手順の残りの部分で説明されているように SSTable をアップグレードする必要があります。
2. hf 形式の *.db ファイルが見つかった場合は、すべての Cassandra ノードがアップグレードされるまで、すべての Cassandra ノードで次のコマンドを実行して SSTable をアップグレードします。
   > /<install-root>/apigee4/share/apache-cassandra/bin/nodetool -h localhost upgradesstables -a
3. ステップ 1 を繰り返して、すべての *.db ファイルが Cassandra 1.2 バージョンの ic 形式であることを確認します。
4. Edge インストールのすべての Cassandra ノードで、手順 1 ～ 3 を繰り返します。
5. Edge 4.15.07.00 にアップグレードします。
6. 4.15.07.00 へのアップグレード後、*.db ファイルをチェックして、すべてが C* 2.0 スタイルの sstable にアップグレードされていることを確認します。
   > cd /<install-root>/apigee4/data/cassandra/data
   > find . -name *-jb-*
   Cassandra 2.0 を実行している場合、このコマンドは一連の .db ファイルを返します。

新機能と拡張機能

このリリースにおける新機能と改善点は次のとおりです。

インストールとアップグレード

コンポーネントの選択的なアップグレードとアンインストール

apigee-upgrade.sh スクリプトと apigee-uninstall.sh スクリプトで、アップグレードまたはアンインストールする Edge コンポーネントを選択できるようになりました。以前は、ノード上のすべてのコンポーネントをアップグレードまたはアンインストールしていました。（OPDK-1377、OPDK-1175）

アップグレードのロールバック

アップグレード中に apigee-upgrade.sh が失敗した場合、apigee-rollback.sh スクリプトを使用してアップグレードをロールバックできるようになりました。アップグレードの問題を修正したら、アップグレードを再試行できます。（OPDK-1275）

短縮されたインストーラ スクリプトのオプション

インストール スクリプトは、--help などの長い形式のオプションを受け取らなくなりました。現在は、-h などの 1 文字のオプションのみを受け入れます。（OPDK-1356）

SmartDocs のインストール

setup-smartdocs.sh スクリプトを使用して SmartDocs をインストールすると、組織、環境、仮想ホストの入力を求められます。これにより、SmartDocs が想定された場所にインストールされます。以前は、これらの値はスクリプトにハードコードされていました。（OPDK-1310）

プロンプトなしで update-cass-pwd-in-config.sh を実行する

ENABLE_CASS_AUTH、CASS_USERNAME、CASS_PASSWORD の環境変数を設定すると、update-cass-pwd-in-config.sh スクリプトをプロンプトなしで実行できます。（OPDK-1309）

エッジ プラットフォーム

このリリースに含まれる新しい Edge プラットフォーム機能は次のとおりです。

Edge Private Cloud でサポートされている OpenJDK 1.7

このリリースの Edge は Oracle JDK 1.7 と OpenJDK 7 をサポートしています。JDK 1.6 のサポートは終了しました。（OPDK-1187）

OS サポート

Apigee Edge for Private Cloud のオペレーティング システム サポートが拡張され、Red Hat Enterprise Linux 6.6 および 7.0（64 ビット）、CentOS 6.5、6.6、および 7.0（64 ビット）、Oracle Linux 6.5 が含まれるようになりました。

OPDK 15.07 に含まれる Cassandra 2.0.15

このリリースでは、Cassandra 2.0.15 がインストールされます。以前のリリースからアップグレードする場合は、Cassandra のバージョンが更新されます。（OPDK-1197）

OAuth トークン ハッシュの SHA2 サポート

データベースのセキュリティ侵害が発生した場合に OAuth トークンをより適切に保護するため、Edge は OAuth トークンのハッシュ化に SHA2 アルゴリズムをサポートしています（SHA1 に加えて）。新しい組織レベルのプロパティを使用すると、新しいトークンのハッシュを有効にして構成できるだけでなく、この新機能より前に存在していたトークンで以前のハッシュを保持することもできます。以前の Edge for Private Cloud では、keymanagement.properties ファイル（Management Server と Message Processor 上）の hash.oauth.tokens.enabled というプロパティにより、OAuth トークンの自動 SHA1 ハッシュが有効になっていました。このプロパティは非推奨になりました。

以前に hash.oauth.tokens.enabled プロパティを使用して SHA1 ハッシュを有効にしていた場合、このリリースのアップグレード スクリプトによって、新しい組織レベルのプロパティが自動的に生成されます。アップグレード後に確認するには、システム管理者として、API（https://{host}:{port}/v1/o/{your_org}）を使用して GET を実行します。

• 新しいプロパティを使用して組織でトークン ハッシュを有効にする方法については、アクセス トークンのリクエスト トピックの「データベースでのトークンのハッシュ」をご覧ください。
• 既存のトークンを一括ハッシュ化する方法については、Edge for Private Cloud 運用ガイドをご覧ください。（APIRT-1389）

ログファイルのフラットなディレクトリ構造

message-logging.properties ファイルで新しい enable.flat.directory.structure プロパティを true に設定することで、フラットなディレクトリ構造にログファイルを保存するように Edge を構成できます。詳細については、Message Logging ポリシーをご覧ください。（APIRT-1394）

環境キャッシュのパフォーマンス

インメモリ キャッシュの管理と利用を改善するため、環境キャッシュ リソースの「メモリ内の最大要素数」設定は非推奨になりました。すべてのキャッシュ リソース（デフォルトのキャッシュを含む）に存在する要素の合計数は、キャッシュに割り当てられたメモリ割り当ての合計によって異なります。デフォルトでは、特定の Message Processor でメモリ内キャッシュに割り当てられる合計メモリは、Message Processor の cache.properties ファイルのキャッシュ プロパティ設定によって決定される、使用可能な合計メモリの 40% です。要素は、キャッシュ メモリが不足している場合、または要素の有効期限が切れた場合にのみ、メモリ内キャッシュから削除されます。

キャッシュ管理に「メモリ内の最大要素数」プロパティを使用する以前の動作に戻すには、cache.properties ファイルでプロパティ overrideMaxElementsInCacheResource=false を設定します。（APIRT-1140）

API サービス

このリリースに含まれる新しい API Services の機能は次のとおりです。

新しいプロキシ エディタをデフォルトとして設定

新しい API プロキシ エディタは、管理 UI でデフォルトで有効になっています。新しいエディタには、[Overview] ページでの条件付きフローとエンドポイントのより包括的なビュー、[Develop] ページでのすべての構成、条件付きフロー、エンドポイント、ポリシーのより直感的な追加、小さなスニペットではなくより完全な XML ビュー、ファイル名とテキストをクロールする検索など、多くのユーザビリティの改善が含まれています。（MGMT-2279）

新しい Delete OAuth v2.0 Info ポリシー

新しい「Delete OAuth v2.0 Info」ポリシーを使用すると、OAuth v2 アクセス トークンと認証コードを削除できます。このポリシーは、以前に Management API で提供されていた機能を置き換えるものです。詳細については、Delete OAuthV2 Info ポリシーをご覧ください。（MGMT-2257）

新しい Delete OAuth v1.0 Info ポリシー

新しい「Delete OAuth v1.0 Info」ポリシーを使用すると、OAuth v1.0 のリクエスト トークン、アクセス トークン、検証コードを削除できます。このポリシーは、以前に Management API で提供されていた機能を置き換えるものです。詳細については、Delete OAuth V1 Info ポリシーをご覧ください。（APIRT-1351）

アクセス制御ポリシー

アクセス制御ポリシーが拡張され、IP アドレスが X-FORWARDED-FOR HTTP ヘッダーに含まれている場合に、許可リストと拒否リストの IP アドレスをよりきめ細かく評価できるようになりました。

ヘッダーで複数の IP アドレスのチェックが有効になっている場合（feature.enableMultipleXForwardCheckForACL を設定するには、サポートにお問い合わせください）、ポリシーの新しい <ValidateBasedOn> 要素を使用すると、ヘッダーの最初の IP、最後の IP、またはすべての IP をチェックできます。詳細については、アクセス制御ポリシーをご覧ください。

アクセス エンティティ ポリシーの新しいエンティティ

Access Entity ポリシーは、consumerkey-scopes、authorizationcode、requesttoken、verifier という新しいエンティティへのアクセスを提供します。詳細については、Access Entity ポリシーをご覧ください。

Statistics Collector ポリシー: 統計情報名の小文字への自動変換

API プロキシ エディタ（[Develop] ページ > [Tools] > [Custom Analytics Collection]）でカスタム分析コレクションを作成する場合、コレクタ変数（統計）の「Name」は小文字にする必要があります。大文字で名前を入力すると、Statistics Collector ポリシーで統計情報名が自動的に小文字に変換されます。（MGMT-740）

API プロキシ エディタでの従来のトレースの削除

API プロキシ エディタの Trace 機能の最新バージョンがベータ版から一般提供に移行しました。[従来のバージョンのトレースにアクセスする] リンクを使用した「従来のトレース」へのアクセスはできなくなりました。

管理 UI のヘルプメニューから Apigee コミュニティにアクセス

Apigee コミュニティには、管理 UI の [Help] メニューからアクセスできます。

管理 UI のエラー メッセージ

管理 UI のエラー メッセージの機能強化は次のとおりです。

• 管理 UI では、ログイン セッション全体ですべてのエラー メッセージがグループ化され、UI に表示されていました（ユーザーがエラー メッセージを閉じた場合を除く）。この更新により、エラー メッセージが発生したページから移動すると、エラー メッセージが自動的に消去されるようになりました。（MGMT-2254）
• 管理 UI で、重複するエラー メッセージが抑制されなくなりました。（MGMT-2242）

UI のパフォーマンスとエラー処理の強化

ページ表示のパフォーマンスやエラー メッセージのクリーンアップなど、管理 UI のさまざまな領域が全般的に改善されました。

管理 UI の [Organization Users] ページにあるロールのハイパーリンク

管理 UI の [Organization Users] ページ（[Admin] > [Organization Users]）で、ロール名がハイパーリンクになり、ロールページにすばやく移動できるようになりました。（MGMT-1055）

メッセージ フローの新しいターゲット変数

メッセージ フローの新しい変数により、ターゲット エンドポイントとターゲット サーバーのより完全な URL 情報が提供されます。

• TargetEndpoint: request.url が target.basepath.with.query に置き換わります。
• TargetServer: loadbalancing.targetserver が targetserver.name に置き換わります。また、target.basepath は、TargetEndpoint の HTTPTargetConnection <LoadBalancer> 要素で <Path> 要素が使用されている場合にのみ入力されます。

Server Name Indication（SNI）のサポート

Edge は、サウスバウンド（Message Processor からターゲット エンドポイント）の Server Name Indication の使用をサポートしています。SNI を使用する場合は、Apigee Edge サポートにお問い合わせください。

Java 1.7 が必要です。

TLS / SSL の拡張機能である SNI を使用すると、複数の 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 証明書の詳細に新しい「Signature Algorithm」フィールドが追加されました。このフィールドは、管理 UI（[Admin] > [SSL Certificates]）と Management API（キーストアまたはトラストストアから証明書の詳細を取得する）で確認できます。このフィールドには、証明書の生成に使用されたハッシュ アルゴリズムの種類に応じて、「sha1WithRSAEncryption」または「sha256WithRSAEncryption」が表示されます。

有効期限が近づいている SSL 証明書を表示しています

管理 UI の [SSL Certificates] ページ（[Admin] > [SSL Certificates]）には、新しい有効期限のプルダウン フィールドでの選択に応じて、SSL 証明書の有効期限が 10 日、15 日、30 日、または 90 日以内に切れることが示されます。

脅威対策のエラー構成

デフォルトでは、メッセージが JSON または XML の脅威対策ポリシーに一致しない場合、Edge は HTTP 500 Internal Server Error（内部サーバーエラー）のステータス コードと ExecutionFailed エラーをスローします。このエラー動作を変更するには、新しい組織レベルのプロパティを使用します。組織プロパティ features.isPolicyHttpStatusEnabled を true に設定すると、次のように動作します。

• リクエスト: リクエスト フローに脅威保護ポリシーが関連付けられている場合、無効なメッセージは 400 ステータス コードと、対応するポリシー エラー メッセージを返します。
• レスポンス: レスポンス フローに適用された脅威対策ポリシーにより、無効なメッセージであっても 500 ステータス コードが返され、ExecutionFailed だけでなく、対応するポリシー エラー メッセージのいずれかがスローされます。

Cloud のユーザーは、Apigee Edge サポートに連絡して組織のプロパティを設定する必要があります。この機能は、次の Private Cloud 四半期リリースで Edge プライベート クラウドのお客様に提供される予定です。

エンドポイント、プロキシ、その他のエンティティのスキーマを更新

TargetEndpoint、ProxyEndpoint、APIProxy などのポリシー以外のエンティティのリファレンス スキーマが更新されました。https://github.com/apigee/api-platform-samples/tree/master/schemas をご覧ください。（APIRT-1249）

デベロッパー サービス

このリリースに含まれるデベロッパー サービスの新機能は次のとおりです。

SmartDocs の一般提供

SmartDocs はベータ版を終了し、一般提供を開始しました。更新内容と新機能は次のとおりです。

• Swagger 2.0 のサポート（ファイルまたは URL によるインポート、カスタム名のセキュリティ オブジェクトのサポートなど）。
• SmartDocs を生成するテンプレートのビジュアル デザインを改善しました。
• デベロッパー ポータルのユーザビリティとワークフローの強化。Drupal の [Content] > [SmartDocs] メニューから利用できます。
• これまで「カスタム トークン」認証と呼ばれていたものが、「API キー」と呼ばれるようになりました。
• リビジョン レベルで定義された認証「セキュリティ」オブジェクト。
• テンプレート レベルでのクライアント認証の構成。新しいリビジョンでは、事前構成済みの SmartDocs クライアント認証情報がリセットされなくなりました。

その他の機能の説明については、こちらのブログ投稿をご覧ください。

SmartDocs のドキュメントについては、SmartDocs を使用した API のドキュメント化をご覧ください。

管理 UI に表示されるデベロッパー アプリ名

Edge のデベロッパー アプリには、変更できない内部名と、変更可能な表示名があります。管理 UI の [Developer App] ページ（[Publish] > [Developer Apps] > アプリ名）では、アプリの内部「名前」が「表示名」とともに表示されるため、トラブルシューティングや API 管理のために内部名でアプリを視覚的に識別しやすくなります。

分析サービス

このリリースに含まれる新しい Analytics Services 機能は次のとおりです。

保持データの期限

管理 UI または API を使用して分析レポートを生成する場合、デフォルトでは、現在の日付から 6 か月以上前のデータにアクセスできません。6 か月以上前のデータにアクセスする必要がある場合は、Apigee Edge サポートにご連絡ください。

管理 UI から削除されるカスタム レポートのクラシック バージョン

管理 UI で、カスタム分析レポートの従来のバージョン（オプション）を使用できなくなりました。

デベロッパー エンゲージメント ウィジェットのパフォーマンス

メインの分析ダッシュボード（[Developer Engagement] セクション）のファネル ウィジェットが、パフォーマンスを向上させるために強化されました。

収益化

このリリースに含まれる新しい収益化機能は次のとおりです。

料金プランのメール通知

新しい料金プランのメール通知タイプを使用すると、デベロッパーが購入したボリューム バンドまたはバンドル料金プランで、特定のトランザクションまたは金額の上限に達したときに、デベロッパーに通知できます。詳細については、通知テンプレートを使用して通知を設定するをご覧ください。

定期的な料金と集計基準期間の同期

料金プランでは、2 つの異なる期間が有効になる可能性があります。

• 料金プランの [Fees] タブで構成される定期料金期間。デベロッパーに定期料金が請求されるタイミングを決定します。
• ボリューム バンドル プランまたはバンドルプランの料金表で定義されている集計基準期間。デベロッパーのバンドル使用量がリセットされるタイミングを決定します。

この 2 つの期間が同期されました。ゼロ以外の定期料金と、ボリューム バンドまたはバンドル料金表の両方が料金プランに存在する場合、定期料金の期間が両方に使用されます。たとえば、月額料金がある場合、料金表バンドルも毎月（デフォルトでは月初に）リセットされます。

定期的な料金がない場合、バンドルは料金表で定義された集計基準に基づいてリセットされます。たとえば、デベロッパーが月の 19 日に料金表の使用を開始し、集計基準が毎月の場合、バンドルの使用量は 19 日の 1 か月後にリセットされます。

集計基準は非推奨となり、今後のリリースで収益化から削除される予定です。詳細については、料金表プランの詳細を指定するをご覧ください。

収益レポートのカスタム属性

トランザクション記録ポリシーを使用すると、必要に応じてトランザクションからカスタム属性データをキャプチャできます。また、これらのカスタム トランザクション属性を収益概要レポートに含めることができるようになりました。組織に MINT.SUMMARY_CUSTOM_ATTRIBUTES プロパティを追加すると、レポートで使用するためにデータベース テーブルに追加するカスタム属性を指定できます。

Apigee Edge for Private Cloud のお客様は、次の 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 はデベロッパー ポータル内でレンダリングして公開できますが、SmartDocs は Apigee の Edge API 管理サービス内にある API モデルから生成されることに注意してください。Edge で API モデルに加えた変更は、すべての Pantheon 環境で同じになります（開発者が Pantheon 環境全体に存在するのと同様です）。

SmartDocs ベータ版から一般提供版にアップグレードするには

1. Pantheon の dev 環境または test 環境で 15.05.27 リリースを更新してテストします。
2. 使用している既存の API モデルを置き換える新しいモデルを作成します。
   • Swagger または WADL ドキュメントをインポートしている場合は、新しいリビジョンに再度インポートします。
   • SmartDocs モジュールを使用して API モデルを管理している場合は、SmartDocs JSON としてエクスポートし、ファイルの添付を使用して新しいモデルにインポートします。
3. モデルのリビジョンのセキュリティ プロパティを設定します。[Content] > [SmartDocs] > [model] ページで、[Security Settings] を選択します。
   
4. モデル設定ページ（[Content] > [SmartDocs]）で、[Operations] 列の [Settings] をクリックして、事前構成済みの認証を確認します。
   
5. CSS と JS アセットの v6 を使用するようにカスタム テンプレートを更新し、authSchemes や apiSchema などの新しいオブジェクト名を反映するように変更します。SmartDocs テンプレートの更新については、SmartDocs を使用した API のドキュメント化をご覧ください。
6. モデル リビジョンを再レンダリングして公開します。
7. 新しいドキュメントを検証したら、本番環境ポータルを 15.05.27 リリースに更新します。

Edge エンタープライズのお客様で、アップグレード プロセスについてご質問やご不明な点がある場合は、marsh@apigee.com と cnovak@apigee.com までメールでお問い合わせください。それ以外の場合は、Apigee コミュニティをご利用ください。

今後の機能変更と機能強化

このセクションでは、今後予定されている機能の変更と拡張機能について説明します。

Response Cache ポリシーの動作の変更

今後のリリース（未定）で、Response Cache ポリシーの <ExcludeErrorResponse> 要素のデフォルトの動作が変更されます。

現在の動作: レスポンス キャッシュ ポリシーの <ExcludeErrorResponse> 要素は、デフォルトで false です。つまり、デフォルトでは、任意の HTTP ステータス コード（3xx を含む）を含むレスポンスが Response Cache ポリシーによってキャッシュに保存されます。

今後の動作: Response Cache ポリシーの <ExcludeErrorResponse> 要素のデフォルト値は true になります。つまり、デフォルトでは、HTTP ステータス コードが 200 ～ 205 のレスポンスのみがキャッシュに保存されます。この動作をオーバーライドして、すべてのステータス コードのレスポンスをキャッシュに保存するには、<ExcludeErrorResponse> 要素を明示的に true に設定する必要があります。

現在の回避策: プライベート クラウド 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