Monetization Services のインストール

Edge for Private Cloud v. 4.16.09

Monetization Services は Apigee Edge の拡張機能であるため、スタンドアロン プロセスとして実行されません。既存の Apigee Edge 設定内で実行されます。

収益化の要件

  • 13 ノードのインストールなど、複数の Management Server ノードを使用する Edge トポロジに Monetization をインストールする場合は、Monetization をインストールする前に両方の Edge Management Server ノードをインストールする必要があります。
  • Edge のインストールに複数の Postgres ノードがある Edge に Monetization をインストールするには、Postgres ノードをマスター/スタンバイ モードで構成する必要があります。複数の Postgres マスターノードがある場合、Edge に Monetization をインストールすることはできません。詳細については、Postgres のマスター / スタンバイ レプリケーションを設定するをご覧ください。

インストールの概要

既存の Apigee Edge インストールに Monetization Services を追加する手順は次のとおりです。

  • apigee-setup ユーティリティを使用して Apigee Management Server ノードを更新し、収益化サービス（カタログ管理、上限と通知の構成、請求、レポートなど）を有効にします。

    13 ノードのインストールなど、複数の Management Server ノードがある場合は、Monetization をインストールする前に両方の Edge Management Server ノードをインストールする必要があります。
  • apigee-setup ユーティリティを使用して Apigee Message Processor を更新し、Monetization Services のランタイム コンポーネント（トランザクション記録ポリシーや制限の適用など）を有効にします。複数の Message Processor がある場合は、すべての Message Processor に Monetization をインストールします。
  • Edge 組織の Monetization オンボーディング プロセスを実行します。
  • 収益化をサポートするようにデベロッパー サービス ポータルを構成します。詳細については、http://apigee.com/docs/monetization/content/configure-monetization-developer-portal をご覧ください。

Monetization 用のサイレント構成ファイルを作成する

以下に、Monetization のインストール用のサイレント構成ファイルの例を示します。構成に応じて、必要に応じてこのファイルを編集します。このファイルを含めるには、setup.sh で -f オプションを使用します。

注: 通常、これらのプロパティは、ノードに Edge コンポーネントをインストールするで説明されているように、Edge のインストールに使用した構成ファイルに追加します。

# Edge configuration properties
# Specify IP address or DNS name of node.
IP1=192.168.1.1  # Management Server, OpenLDAP, UI, ZooKeeper, Cassandra
IP2=192.168.1.2  # ZooKeeper, Cassandra
IP3=192.168.1.3  # ZooKeeper, Cassandra
IP4=192.168.1.4  # Router, Message Processor
IP5=192.168.1.5  # Router, Message Processor
IP6=192.168.1.6  # Qpid
IP7=192.168.1.7  # Qpid
IP8=192.168.1.8  # Postgres
IP9=192.168.1.9  # Postgres

# Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost.
HOSTIP=$(hostname -i)

# Edge sys admin credentials
ADMIN_EMAIL=your@email.com
APIGEE_ADMINPW=yourPassword    # If omitted, you are prompted for it.

# Specify the Management Server port.
APIGEE_PORT_HTTP_MS=8080

#
# Monetization configuration properties.
#
# Postgres credentials from Edge installation.
PG_USER=apigee    # Default from Edge installation
PG_PWD=postgres    # Default from Edge installation

# Specify Postgres server.
MO_PG_HOST="$IP8"    # Only specify one Postgres node.

# Create a Postgres user for Monetization.
# Default username is "postgre". 
# If you specify a different user, that user must already exist.
MO_PG_USER=postgre     
MO_PG_PASSWD=moUserPWord

# Specify one ZooKeeper host.
# Ensure this is a ZooKeeper leader node in a multi-datacenter environment.
ZK_HOSTS="$IP2"

# Specify Cassandra information.
# Ensure CASS_HOSTS is set to the same value as when you installed Edge.
# Must use IP addresses for CASS_HOSTS, not DNS names.
CASS_HOSTS="$IP1:1,1 $IP2:1,1 $IP3:1,1"

# Default is "Apigee", unless it was changed during Edge install.  
CASS_CLUSTERNAME=Apigee

# Cassandra uname/pword required only if you enabled Cassandra authentication. 
# CASS_USERNAME= 
# CASS_PASSWORD= 

# Specify the region. 
# Default is dc-1 unless you are in a multi-datacenter environment. 
REGION=dc-1 

# If your Edge config file did not specify SMTP information, add it. 
# Monetization requires an SMTP server. 
SMTPHOST=smtp.gmail.com 
SMTPPORT=465 
SMTPUSER=your@email.com 
SMTPPASSWORD=yourEmailPassword 
SMTPSSL=y
注:
  • Edge 構成ファイルに SMTP 情報が指定されていない場合は追加します。Monetization には、SMTP サーバーが必要です。
  • 単一のデータセンターのインストールでは、すべての ZooKeeper ノードがデフォルトでリーダーとして構成されます。複数のデータセンターにわたって Edge をインストールする場合は、一部の ZooKeeper ノードがオブザーバーとして構成されます。上記の ZK_HOSTS プロパティにより、複数データセンター インストールにおけるリーダーノードが指定されていることを確認してください。
  • Cassandra 認証を有効にする場合は、次のプロパティを使用して Cassandra のユーザー名とパスワードを渡すことができます。
    CASS_USERNAME
    CASS_PASSWORD

Monetization Services をすべての Management Server と統合する

Management Server ノードで収益化を統合するには、次の手順を行います。

  1. 複数の Management Server ノードを使用する Edge トポロジ（13 ノードのインストールなど）に Monetization をインストールする場合は、Monetization をインストールする前に両方の Management Server ノードがインストールされていることを確認してください。
  2. Management Server ノードで、設定スクリプトを実行します。
    > /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    「-p mo」オプションは、収益化を統合することを指定します。

    構成ファイルは、「apigee」ユーザーがアクセスまたは読み取り可能である必要があります。
  3. 複数の Management Server ノードに Monetization をインストールする場合は、2 番目の Management Server ノードでステップ 2 を繰り返します。

構成が正常に完了すると、収益化サービスの RDBMS スキーマが PostgreSQL データベースに作成されます。これで、Monetization Services とそれに関連するコンポーネントの Postgres Server との統合が完了しました。

Monetization Services をすべての Message Processor と統合する

すべての Message Processor ノードで収益化を統合するには、次の手順を行います。

  1. 最初の Message Processor ノードのコマンド プロンプトで、設定スクリプトを実行します。
    > /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    「-p mo」オプションは、Monetization を統合することを指定します。

    構成ファイルは、「apigee」ユーザーがアクセスまたは読み取り可能である必要があります。
  2. すべての Message Processor ノードでこの手順を繰り返します。

構成が正常に完了すると、Message Processor が Monetization Services で更新されます。これで、Monetization Services とそれに関連するコンポーネントの Message Processor との統合が完了します。

収益化のオンボーディング

収益化が有効な新しい組織を作成するには、まず、新しい組織を作成する場合と同様に組織を作成します。詳細については、組織のオンボーディングをご覧ください。

組織で収益化を有効にするための追加のオンボーディング

組織の収益化のオンボーディングを完了するには、次の操作を行う必要があります。

  1. 収益化グループ mxgroup を作成します。
  2. Qpid をグループに追加します。
  3. 組織の収益化を有効にします。
  4. 組織の通知設定を有効にします。
  5. 収益化を有効にするすべての組織に対して、このプロセスを繰り返します。

これらのタスクをすべて実行するには、enable-monetization コマンドを使用します。このスクリプトは、次のプロパティを含む構成ファイルを受け取ります。

MSIP=IPorDNSofManagementServer
APIGEE_PORT_HTTP_MS=8080    # Default is 8080.
ADMIN_EMAIL=your@email.com
APIGEE_ADMINPW=yourPassword    # If omitted, you are prompted for it.
# Must use IP addresses for CASS_HOSTS, not DNS names.
CASS_HOSTS="$IP1:1,1 $IP2:1,1 $IP3:1,1"
# Space-separated list IP/DNS names of all Qpid nodes in the data center being configured.
QPID_HOST="$IP6 $IP7"    
QPID_PORT=8083     # Default is 8083.
REGION=dc-1
ORG_NAME=myorg    # The Edge org where you want to enable monetization. 
MX_GROUP=mxgroup    # Default Monetization group.

注:

  • CASS_HOSTS と REGION を、Monetization のインストール時に使用した値と同じ値に設定します。
  • マルチデータセンター構成で Monetization を有効にする場合:
    • 各データセンターの Management Server でオンボーディング プロセスを繰り返す必要があります。
    • 構成ファイルには、構成するデータセンターの Qpid ノードのみをリストする必要があります。

このスクリプトを実行するには、次のようにします。

  1. スクリプトを呼び出します。
    > /opt/apigee/apigee-service/bin/apigee-service apigee-provision enable-monetization -f configFile

    構成ファイルは、「apigee」ユーザーがアクセスまたは読み取り可能である必要があります。

    複数の Management Server がある場合は、そのうちの 1 つでこのスクリプトを実行するだけで済みます。

    このスクリプトは、組織、プロダクト、デベロッパー、アプリケーションを Cassandra データベースから Monetization PostgreSQL データベースに複製します。Monetization Services のインストールが正常に完了すると、データは自動的に同期されます。
  2. 収益化を有効にする組織ごとに、この手順を繰り返します。
  3. 複数のデータセンター環境を使用している場合は、他のデータセンターの Management Server でこのプロセスを繰り返します。構成ファイルには、構成するデータセンターの Qpid ノードのみがリストされていることを確認します。

次に Edge UI にログインすると、組織の最上位メニューに [Monetization] エントリが表示されます。

デベロッパー サービス ポータルを構成する

収益化をサポートするように Developer Services ポータルを構成するには、http://apigee.com/docs/monetization/content/configure-monetization-developer-portal をご覧ください。

Monetization インストールに Management Server ノードを追加する

既存の Edge インストールに Management Server を追加する場合は、新しい Management Server に Monetization サービスを追加し、すべての Management Server が通信できるように構成する必要があります。

Management Server を追加するには:

  1. 新しい Management Server をインストールします。
  2. 新しい Management Server に Monetization をインストールします。
  3. 元の Management Server で、次のコマンドを呼び出します。
    > /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  4. 元の Management Server を再起動します。
    > /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
  5. 新しい Management Server で、次のコマンドを呼び出します。
    > /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  6. 新しい Management Server を再起動します。
    > /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart

追加構成

PDF ファイルとして請求書を提供する

Monetization では、エンドユーザーに HTML 形式で請求ドキュメントが表示されます。請求書を PDF ファイルとして提供するには、PDF 生成機能を提供する課金システムと Monetization を統合するか、サポートされているサードパーティの PDF ライブラリのライセンスを取得します。

組織の設定を構成する

バックエンド設定: 次の表に、mint 組織の構成に使用できる組織レベルの属性を示します。PUT 呼び出しを使用して、以下に示すようにこれらの属性を追加または更新できます。

> curl -u ${ADMIN_EMAIL}:${ADMINPW} -v http://<management-ip>:8080/v1/organizations/{orgId} -d '{org object with attributes}' -X PUT

たとえば、上記の CURL コマンドの出力は次のようになります。

{
...
    "displayName": "Orgnization name",
    "name": "org4",
    "properties": {
        "property": [
...
            {
                "name": "MINT_CURRENCY",
                "value": "USD"
            },
            {
                "name": "MINT_COUNTRY",
                "value": "US"
            },
            {
                "name": "MINT_TIMEZONE",
                "value": "GMT"
            }
        ]
    }
}

属性

説明

MINT_TAX_MODEL

指定できる値は、DISCLOSED、

UNDISCLOSED、HYBRID（デフォルトは null）

MINT_CURRENCY

ISO 通貨コード（デフォルトは null）

MINT_TAX_NEXUS

税務上のネクサス（デフォルトは null）

MINT_DEFAULT_PROD_TAX_CATEGORY

デフォルトの商品の税のカテゴリ（デフォルトは null）

MINT_IS_GROUP_ORG

IS グループ組織（デフォルトは false）

MINT_HAS_BROKER

破損している（デフォルトは false）

MINT_TIMEZONE

タイムゾーン（デフォルトは null）

MINT_TAX_ENGINE_EXTERNAL_ID

税金エンジンの ID（デフォルトは null）

MINT_COUNTRY

組織の国（デフォルトは null）

MINT_REG_NO

組織の登録番号。英国では納税者番号とは異なる番号が割り当てられます（デフォルトは null）

MINT_BILLING_CYCLE_TYPE

PRORATED、CALENDAR_MONTH（デフォルトは CALENDAR_MONTH）

MINT_SUPPORTED_BILLING_TYPE

PREPAID/POSTPAID/BOTH（デフォルトは PREPAID）

MINT_IS_SEPARATE_INV_FOR_FEES

別の料金請求書を生成するかどうかを示します（デフォルトは false）。

MINT_ISSUE_NETTING_STMT

ネッティング明細書を発行するかどうかを示します（デフォルトは false）

MINT_NETTING_STMT_PER_CURRENCY

ネッティング明細書を通貨ごとに生成するかどうかを示します（デフォルトは false）。

MINT_HAS_SELF_BILLING

組織にセルフビリングがあるかどうかを示します（デフォルトは false）

MINT_SELF_BILLING_FOR_ALL_DEV

組織がすべてのデベロッパーに対してセルフ請求を行うかどうかを示します（デフォルトは false）。

MINT_HAS_SEPARATE_INV_FOR_PROD

組織にプロダクトごとに個別の請求書があるかどうかを示します（デフォルトは false）。

MINT_HAS_BILLING_ADJUSTMENT

組織が請求額の調整をサポートしているかどうかを示します（デフォルトは false）

features.isMonetizationEnabled

収益化固有のメニューを表示するために管理 UI によって使用されます（デフォルトは false）。

ui.config.isOperator

プロバイダを運営者と組織のどちらとして表示するかを決定するために管理 UI によって使用されます。

（デフォルトは true です）

管理 UI を使用してビジネス組織の設定を構成する場合は、http://apigee.com/docs/monetization-services/content/get-started-using-monetization-services をご覧ください。

注: 収益化サービスの制限と通知機能を使用している場合は、アクセス トークン検証ポリシーの後にプロキシフローに制限ポリシーを適用するようデベロッパーに指示してください。

制限ポリシーは、特定の制限に達した場合に API 呼び出しをブロックするように設計された明示的なポリシーです。このポリシーはビジネスの上限をチェックし、構成された値を超える上限がある場合はエラーを発生させます。これは、障害発生ポリシーの拡張ですが、条件はビジネス変数から派生します。

プロキシ デベロッパー向けの管理 UI には、UI テンプレートが用意されています。プロキシ デベロッパーは、メッセージ フローに mint ポリシーを接続する必要があります。このポリシーが実行されると、ポリシーに従って障害レスポンスとともに障害が発生します。ContinueOnError が true に設定されている場合、障害は発生せず、フロー変数「mint.limitsViolated」、「mint.isDeveloperSuspended」、「mint.limitsPolicyError」が設定されます。これらの変数は、必要に応じて、さらに例外処理に使用できます。