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

現在、Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご確認ください。 情報

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
• プライベート クラウド: 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] をタップします。-name *-ic-*
      Cassandra 1.2 SSTable を実行している場合、結果には一連の .db ファイルが返されます。
   3. 次の検索コマンドを実行します。
      > [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 localhostupgradestables -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 スタイルの安定版にアップグレードされていることを確認します。
   > 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 では、（SHA1 に加えて）OAuth トークンをハッシュ化する SHA2 アルゴリズムがサポートされています。新しい組織レベルのプロパティを使用すると、新しいトークンのハッシュを有効にして構成できます。また、この新機能の前に存在していたトークンのレガシー ハッシュを保持することもできます。以前の Edge for Private Cloud では、keymanagement.properties ファイル（管理サーバーと Message Processor 上）にある hash.oauth.tokens.enabled というプロパティによって、OAuth トークンの自動 SHA1 ハッシュが有効になっていました。このプロパティは非推奨になりました。

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

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

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

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

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

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

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

API サービス

以下は、このリリースに含まれる新しい API サービスの機能です。

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

新しい 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）

アクセス制御ポリシー

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

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

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

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 のヘルプメニューからアクセスできます。

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

管理 UI で次のエラー メッセージが強化されています。

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

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

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

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

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

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

メッセージ フローの新しい変数を使用すると、ターゲット エンドポイントとターゲット サーバーのより完全な URL 情報を取得できます。

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

Server Name Indication（SNI）のサポート

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

Java 1.7 が必要です。

TLS/SSL の拡張である SNI を使用すると、複数の HTTPS ターゲットを同じ IP アドレスとポートから提供でき、すべてのターゲットで同じ証明書を使用する必要はありません。

Edge 固有の構成は必要ありません。環境がサウスバウンド SNI（デフォルトでは Edge クラウド）で構成されている場合、Edge はそれをサポートします。

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

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

SSL 証明書の詳細の「署名アルゴリズム」

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

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

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

脅威対策のエラー構成

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

• リクエスト: リクエスト フローに脅威保護ポリシーが適用されている場合、無効なメッセージに対して 400 ステータス コードと、対応するポリシー エラー メッセージが返されます。
• レスポンス: 脅威保護ポリシーが任意のレスポンス フローに接続されている場合でも、無効なメッセージに対しては 500 ステータス コードが返され、単に ExecutionFailed ではなく、対応するポリシー エラー メッセージがスローされます。

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

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

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 キー」に名称変更されました。
• リビジョン レベルで定義されている認証「security」オブジェクト。
• テンプレート レベルでのクライアント認証の構成。新しいリビジョンで、事前構成された SmartDocs クライアント認証情報がリセットされなくなります。

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

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

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

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

分析サービス

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

データの保持時間の上限

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

従来のバージョンのカスタム レポートを管理 UI から削除

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

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

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

収益化

以下は、このリリースに含まれる新しい収益化機能です。

料金プランに関するメール通知

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

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

料金プランでは、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. モデルの設定ページ（[Content] > [SmartDocs]）で事前構成済みの認証を確認します。それには、[Operations] 列の [設定] をクリックします。
   
5. CSS アセットと JS アセットの v6 を使用するようにカスタム テンプレートを更新し、authSchemes や apiSchema などの新しいオブジェクト名を反映するように変更を加えます。SmartDocs テンプレートの更新については、SmartDocs を使用した API のドキュメント化をご覧ください。
6. モデル リビジョンを再レンダリングして公開します。
7. 新しいドキュメントを検証したら、本番環境ポータルを 15.05.27 リリースに更新します。

Edge Enterprise をご利用で、アップグレード プロセスについて質問や懸念がある場合は、marsh@apigee.com または cnovak@apigee.com にメールでお問い合わせください。それ以外の場合は、Apigee コミュニティをご利用ください。

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

このセクションでは、今後予定されている機能変更と機能強化をプレビューします。

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

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

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

今後の動作: 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