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 にアップグレードする必要があります。

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

バージョン 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 /<インストール ルート>/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 を使用して GET を実行します。https://{host}:{port}/v1/o/{your_org}。

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

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

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

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

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

キャッシュ管理に「Maximum Elements in Memory」プロパティを使用する以前の動作に戻すには、cache.properties ファイルでプロパティ overrideMaxElementsInCacheResource=false を設定します。（APIRT-1140）

API サービス

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

新しいプロキシ エディタがデフォルトに

新しい API プロキシ エディタは、管理 UI でデフォルトで有効になっています。新しいエディタには、概要ページの条件付きフローとエンドポイントの包括的なビュー、開発ページのすべての構成、条件付きフロー、エンドポイント、ポリシーの直感的な追加、小さなスニペットではなく完全な 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）

アクセス制御ポリシー

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

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

Access Entity ポリシーの新しいエンティティ

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

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

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

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

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

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

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

管理 UI に表示されるエラー メッセージ

管理 UI のエラー メッセージの改善点は次のとおりです。

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

UI のパフォーマンスとエラーの改善

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

管理 UI の [組織ユーザー] ページのロールのハイパーリンク

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

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

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

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

Server Name Indication（SNI）のサポート

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

Java 1.7 が必要です。

TLS/SSL の拡張機能である SNI を使用すると、複数の HTTPS ターゲットが、同じ証明書を使用せずに同じ IP アドレスとポートからサービスを提供できます。

Edge 固有の構成は必要ありません。環境が下り（南向き）SNI 用に構成されている場合（Edge Cloud はデフォルト）、Edge は SNI をサポートします。

Edge はリクエスト URL からホスト名を自動的に抽出し、SSL handshake リクエストに追加します。たとえば、ターゲット ホストが https://example.com/request/path の場合、Edge は次のように server_name 拡張機能を追加します。

SNI の詳細については、http://en.wikipedia.org/wiki/Server_Name_Indication をご覧ください。

SSL 証明書の詳細の [署名アルゴリズム]

SSL 証明書の詳細に新しい [署名アルゴリズム] フィールドが追加されました。このフィールドは、管理 UI（[Admin] > [SSL Certificates]）と管理 API（キーストアまたはトラストストアからの証明書詳細の取得）で確認できます。このフィールドには、証明書の生成に使用されたハッシュ アルゴリズムのタイプに応じて、「sha1WithRSAEncryption」または「sha256WithRSAEncryption」が表示されます。

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

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

脅威対策のエラー構成

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

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

Cloud のお客様は、Apigee Edge サポートに連絡して組織のプロパティを設定する必要があります。この機能は、次の Private Cloud 四半期リリースで Edge Private Cloud のお客様にご利用いただけるようになります。

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

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

デベロッパー サービス

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

SmartDocs の一般提供

SmartDocs がベータ版から一般提供に移行します。更新情報と新機能は次のとおりです。

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

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

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

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

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

分析サービス

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

保持されたデータの上限時間

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

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

カスタム分析レポートのオプションのクラシック バージョンは、管理 UI で使用できなくなりました。

Developer Engagement ウィジェットのパフォーマンス

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

収益化

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

料金プランのメール通知

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

Recurring Fee と Aggregation Basis の期間の同期

レートプランでは、有効な期間が 2 つある可能性があります。

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

これで、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 Management Services 内にある 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. [Operations] 列の [Settings] をクリックして、モデル設定ページ（[Content] > [SmartDocs]）で事前構成済みの認証を確認します。
   
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 に設定する必要があります。

現在の回避策: Private Cloud 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