Monetarisierungsdienste installieren

Edge for Private Cloud v. 4.16.05

Monetization Services ist eine Erweiterung von Apigee Edge und wird daher nicht als eigenständiger Prozess ausgeführt. Sie wird in jeder vorhandenen Apigee Edge-Einrichtung ausgeführt.

Voraussetzungen für die Monetarisierung

• Wenn Sie die Monetarisierung in einer Edge-Topologie installieren, die mehrere Management Server-Knoten verwendet, z. B. eine Installation mit 13 Knoten, müssen Sie beide Edge Management Server-Knoten installieren, bevor Sie die Monetarisierung installieren.
• Wenn Sie Monetization on Edge installieren möchten, wobei die Edge-Installation mehrere Postgres-Knoten hat, müssen die Postgres-Knoten im Master-/Standby-Modus konfiguriert sein. Sie können die Monetarisierung nicht auf Edge installieren, wenn Sie mehrere Postgres-Masterknoten haben. Weitere Informationen finden Sie unter Master-Standby-Replikation für Postgres einrichten.

Installation

In den folgenden Schritten wird gezeigt, wie Sie Monetarisierungsdienste zu einer vorhandenen Apigee Edge-Installation hinzufügen:

• Verwenden Sie das Dienstprogramm apigee-setup, um den Apigee Management Server-Knoten zu aktualisieren und die Monetarisierungsdienste zu aktivieren, z. B. Katalogverwaltung, Konfiguration von Limits und Benachrichtigungen, Abrechnung und Berichterstellung.
  
  Wenn Sie mehrere Management Server-Knoten haben, z. B. eine Installation mit 13 Knoten, müssen Sie beide Edge Management Server-Knoten installieren, bevor Sie die Monetarisierung installieren.
• Verwenden Sie das Dienstprogramm apigee-setup, um den Apigee Message Processor zu aktualisieren und die Laufzeitkomponenten der Monetarisierungsdienste zu aktivieren, z. B. die Richtlinie zur Transaktionsaufzeichnung und die Durchsetzung von Limits. Wenn Sie mehrere Message Processors haben, installieren Sie die Monetarisierung auf allen.
• Führen Sie den Monetarisierungs-Onboarding-Prozess für Ihre Edge-Organisationen durch.
• Konfigurieren Sie das Entwicklerportal so, dass die Monetarisierung unterstützt wird. Weitere Informationen finden Sie unter http://apigee.com/docs/monetization/content/configure-monetization-developer-portal.

Konfigurationsdatei für die unbeaufsichtigte Installation für die Monetarisierung erstellen

Hier sehen Sie eine Beispielkonfigurationsdatei für die unbeaufsichtigte Installation einer Monetarisierungsinstallation. Bearbeiten Sie diese Datei nach Bedarf für Ihre Konfiguration. Verwenden Sie die Option „-f“ für „setup.sh“, um diese Datei einzubinden.

Hinweis: Normalerweise fügen Sie diese Attribute derselben Konfigurationsdatei hinzu, die Sie für die Installation von Edge verwendet haben, wie unter Edge-Komponenten auf einem Knoten installieren beschrieben.

# 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

• Wenn in Ihrer Edge-Konfigurationsdatei keine SMTP-Informationen angegeben sind, fügen Sie sie hinzu. Für die Monetarisierung ist ein SMTP-Server erforderlich.
• In einer Installation mit einem einzelnen Rechenzentrum werden alle ZooKeeper-Knoten standardmäßig als Leader konfiguriert. Wenn Sie Edge in mehreren Rechenzentren installieren, werden einige ZooKeeper-Knoten als Beobachter konfiguriert. Achten Sie darauf, dass das Attribut ZK_HOSTS oben einen Leader-Knoten in einer Installation mit mehreren Rechenzentren angibt.
• Wenn Sie die Cassandra-Authentifizierung aktivieren, können Sie den Cassandra-Nutzernamen und das Passwort mit den folgenden Attributen übergeben:
  CASS_USERNAME
  CASS_PASSWORD

Monetarisierungsdienste in alle Verwaltungsserver einbinden

Gehen Sie so vor, um die Monetarisierung auf Management Server-Knoten zu integrieren.

1. Wenn Sie die Monetarisierung in einer Edge-Topologie installieren, die mehrere Management Server-Knoten verwendet, z. B. eine Installation mit 13 Knoten, müssen Sie beide Management Server-Knoten installieren, bevor Sie die Monetarisierung installieren.
2. Führen Sie auf dem Management Server-Knoten das Setupscript aus:
   > /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
   
   Mit der Option „-p mo“ wird die Monetarisierung eingebunden.
   
   Die Konfigurationsdatei muss für den „apigee“-Nutzer zugänglich oder lesbar sein. Legen Sie die Datei beispielsweise im Verzeichnis /tmp auf dem Knoten ab.
3. Wenn Sie die Monetarisierung auf mehreren Management Server-Knoten installieren, wiederholen Sie Schritt 2 auf dem zweiten Management Server-Knoten.

Nach erfolgreicher Konfiguration wird in der PostgreSQL-Datenbank ein RDBMS-Schema für Monetization Services erstellt. Damit ist die Integration von Monetization Services und den zugehörigen Komponenten in Postgres Server abgeschlossen.

Monetarisierungsdienste in alle Message Processors einbinden

Gehen Sie so vor, um die Monetarisierung auf allen Message Processor-Knoten zu integrieren.

1. Führen Sie auf dem ersten Message Processor-Knoten in der Eingabeaufforderung das Setupscript aus:
   > /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
   
   Mit der Option „-p mo“ wird die Monetarisierung eingebunden.
   
   Die Konfigurationsdatei muss für den „apigee“-Nutzer zugänglich oder lesbar sein. Legen Sie die Datei beispielsweise im Verzeichnis /tmp auf dem Knoten ab.
2. Wiederholen Sie diesen Vorgang auf allen Message Processor-Knoten.

Nach erfolgreicher Konfiguration wird der Message Processor mit Monetization Services aktualisiert. Damit ist die Einbindung von Monetization Services und den zugehörigen Komponenten in die Message Processors abgeschlossen.

Onboarding für die Monetarisierung

Wenn Sie eine neue Organisation mit aktivierter Monetarisierung erstellen möchten, erstellen Sie die Organisation zuerst wie jede neue Organisation. Weitere Informationen finden Sie unter Organisation einrichten.

Zusätzliches Onboarding, um die Monetarisierung für eine Organisation zu aktivieren

So schließen Sie das Monetarisierungs-Onboarding einer Organisation ab:

1. Erstellen Sie die Monetarisierungsgruppe: mxgroup.
2. Fügen Sie Qpid der Gruppe hinzu.
3. Aktivieren Sie die Monetarisierung für die Organisation.
4. Benachrichtigungseinstellungen für die Organisation aktivieren.
5. Wiederholen Sie diesen Vorgang für alle Organisationen, für die Sie die Monetarisierung aktivieren möchten.

Verwenden Sie den Befehl enable-monetization, um alle diese Aufgaben auszuführen. Dieses Script verwendet eine Konfigurationsdatei mit den folgenden Attributen:

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.

Hinweise:

• Legen Sie für CASS_HOSTS und REGION dieselben Werte fest, die Sie bei der Installation der Monetarisierung verwendet haben.
• Wenn Sie die Monetarisierung in einer Konfiguration mit mehreren Rechenzentren aktivieren:
  • Sie müssen den Onboarding-Prozess auf dem Management Server in jedem Rechenzentrum wiederholen.
  • In der Konfigurationsdatei sollten nur die Qpid-Knoten im zu konfigurierenden Rechenzentrum aufgeführt sein.

So führen Sie das Skript aus:

1. Rufen Sie das Skript auf:
   > /opt/apigee/apigee-service/bin/apigee-service apigee-provision enable-monetization -f configFile
   
   Die Konfigurationsdatei muss für den Nutzer „apigee“ zugänglich oder lesbar sein. Legen Sie die Datei beispielsweise im Verzeichnis /tmp auf dem Knoten ab.
   
   Wenn Sie mehrere Management Server haben, müssen Sie dieses Script nur auf einem davon ausführen.
   
   Dieses Script repliziert die Organisation, Produkte, Entwickler und Anwendungen aus der Cassandra-Datenbank in die Monetarisierungs-PostgreSQL-Datenbank. Nach der erfolgreichen Installation von Monetization Services werden die Daten automatisch synchronisiert.
2. Wiederholen Sie diesen Vorgang für jede Organisation, für die Sie die Monetarisierung aktivieren möchten.
3. Wenn Sie sich in einer Umgebung mit mehreren Rechenzentren befinden, wiederholen Sie diesen Vorgang auf dem Management Server im anderen Rechenzentrum. Achten Sie darauf, dass in der Konfigurationsdatei nur die Qpid-Knoten im zu konfigurierenden Rechenzentrum aufgeführt sind.

Wenn Sie sich das nächste Mal in der Edge-Benutzeroberfläche anmelden, wird der Eintrag „Monetarisierung“ im Menü der obersten Ebene für die Organisation angezeigt:

Developer Services-Portal konfigurieren

Informationen zum Konfigurieren des Developer Services-Portals für die Monetarisierung finden Sie unter http://apigee.com/docs/monetization/content/configure-monetization-developer-portal.

Management Server-Knoten zu einer Monetarisierungsinstallation hinzufügen

Wenn Sie einer vorhandenen Edge-Installation einen Management Server hinzufügen, müssen Sie dem neuen Management Server Monetarisierungsdienste hinzufügen und alle Management Server so konfigurieren, dass sie kommunizieren können.

So fügen Sie einen Management Server hinzu:

1. Installieren Sie den neuen Management Server.
2. Installieren Sie die Monetarisierung auf dem neuen Management Server.
3. Rufen Sie auf dem ursprünglichen Management Server Folgendes auf:
   > /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
4. Starten Sie den ursprünglichen Management Server neu:
   > /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
5. Rufen Sie auf dem neuen Management Server Folgendes auf:
   > /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
6. Starten Sie den neuen Management Server neu:
   > /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart

Zusätzliche Konfiguration

Abrechnungsdokumente als PDF-Dateien bereitstellen

In der Monetarisierung werden Endnutzern Abrechnungsdokumente im HTML-Format angezeigt. Wenn Sie Abrechnungsdokumente als PDF-Dateien bereitstellen möchten, können Sie die Monetarisierung in ein Abrechnungssystem einbinden, das die PDF-Generierung ermöglicht, oder eine unterstützte PDF-Bibliothek eines Drittanbieters lizenzieren.

Organisationseinstellungen konfigurieren

Backend-Einstellungen: In der folgenden Tabelle sind die Attribute auf Organisationsebene aufgeführt, die zum Konfigurieren einer Mint-Organisation verfügbar sind. Sie können einen PUT-Aufruf verwenden, um diese Attribute wie unten gezeigt hinzuzufügen oder zu aktualisieren:

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

Die Ausgabe des obigen CURL-Befehls sieht beispielsweise so aus:

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

Informationen zum Konfigurieren der Einstellungen für die Unternehmensorganisation über die Verwaltungs-UI finden Sie unter http://apigee.com/docs/monetization-services/content/get-started-using-monetization-services.

Hinweis: Wenn Sie die Funktionen für Limits und Benachrichtigungen von Monetarisierungsdiensten verwenden, weisen Sie Ihre Entwickler an, im Proxy-Fluss nach der Richtlinie zur Validierung des Zugriffstokens eine Limitrichtlinie anzuhängen.

Die Limitrichtlinie ist eine explizite Richtlinie, die einen API-Aufruf blockiert, wenn ein bestimmtes Limit erreicht wurde. Die Richtlinie prüft Geschäftslimits und löst einen Fehler aus, wenn Limits den konfigurierten Wert überschreiten. Dies ist eine Erweiterung der Richtlinie „Fehler auslösen“, die Bedingungen werden jedoch von Geschäftsvariablen abgeleitet.

In der Verwaltungs-UI ist eine UI-Vorlage für Proxy-Entwickler verfügbar. Der Proxy-Entwickler sollte die Mint-Richtlinie im Nachrichtenfluss anhängen. Bei der Ausführung dieser Richtlinie wird der Fehler mit der Fehlerantwort gemäß der Richtlinie ausgelöst. Wenn ContinueOnError auf „true“ gesetzt ist, wird der Fehler nicht ausgelöst und die Ablaufvariablen „mint.limitsViolated“, „mint.isDeveloperSuspended“ und „mint.limitsPolicyError“ werden festgelegt. Diese können bei Bedarf für die weitere Ausnahmebehandlung verwendet werden.