Instalowanie usług zarabiania

Edge dla chmury prywatnej w wersji 4.17.01

Usługi zarabiania są rozszerzeniem Apigee Edge, więc nie działają jako samodzielny proces. Działa w ramach dowolnej istniejącej konfiguracji Apigee Edge.

Wymagania dotyczące zarabiania

• Jeśli instalujesz Zarabianie w topologii Edge, która korzysta z wielu węzłów serwera zarządzania, np. w instalacji z 13 węzłami, przed zainstalowaniem Zarabiania musisz zainstalować oba węzły serwera zarządzania Edge.
• Aby zainstalować Zarabianie w Edge, gdy instalacja Edge ma wiele węzłów Postgres, węzły Postgres muszą być skonfigurowane w trybie Master/Standby. Jeśli masz wiele węzłów głównych Postgres, nie możesz zainstalować funkcji Zarabianie w Edge. Więcej informacji znajdziesz w artykule Instalowanie narzędzia apigee-setup w Edge.

Omówienie instalacji

Poniżej znajdziesz instrukcje dodawania usług zarabiania do istniejącej instalacji Apigee Edge:

• Użyj narzędzia apigee-setup, aby zaktualizować węzeł serwera zarządzania Apigee i włączyć usługi zarabiania, takie jak zarządzanie katalogiem, konfiguracja limitów i powiadomień, rozliczenia i raportowanie.
  
  Jeśli masz wiele węzłów serwera zarządzania, np. instalację z 13 węzłami, przed zainstalowaniem Zarabiania musisz zainstalować oba węzły serwera zarządzania Edge.
• Użyj narzędzia apigee-setup, aby zaktualizować procesor komunikatów Apigee i włączyć komponenty środowiska wykonawczego usług zarabiania, takie jak zasady rejestrowania transakcji i egzekwowanie limitów. Jeśli masz kilka procesorów komunikatów, zainstaluj Zarabianie na wszystkich z nich.
• Przeprowadź proces wprowadzenia do Zarabiania w organizacjach Edge.
• Skonfiguruj portal usług dla programistów, aby obsługiwał zarabianie. Więcej informacji znajdziesz na stronie http://apigee.com/docs/monetization/content/configure-monetization-developer-portal.

Tworzenie pliku konfiguracji cichej dla funkcji Zarabianie

Poniżej znajdziesz przykładowy plik konfiguracji instalacji cichej dla instalacji Monetization. W razie potrzeby zmodyfikuj ten plik, aby dostosować go do swojej konfiguracji. Aby uwzględnić ten plik, użyj opcji -f w setup.sh.

Uwaga: te właściwości zwykle dodaje się do tego samego pliku konfiguracji, który został użyty do zainstalowania Edge, jak opisano w artykule Instalowanie komponentów Edge w węźle.

# 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

• Jeśli plik konfiguracji Edge nie zawiera informacji o SMTP, dodaj je. Zarabianie wymaga serwera SMTP.
• W instalacji z jednym centrum danych wszystkie węzły ZooKeeper są domyślnie skonfigurowane jako liderzy. Podczas instalowania Edge w wielu centrach danych niektóre węzły ZooKeeper zostaną skonfigurowane jako obserwatorzy. Upewnij się, że właściwość ZK_HOSTS powyżej określa węzeł lidera w instalacji z wieloma centrami danych.
• Jeśli włączysz uwierzytelnianie Cassandra, możesz przekazać nazwę użytkownika i hasło Cassandra za pomocą tych właściwości:
  CASS_USERNAME
  CASS_PASSWORD

Integracja usług zarabiania ze wszystkimi serwerami zarządzania

Aby zintegrować zarabianie na węzłach serwera zarządzania, wykonaj te czynności.

1. Jeśli instalujesz Zarabianie w topologii Edge, która korzysta z wielu węzłów serwera zarządzania, np. w instalacji z 13 węzłami, przed zainstalowaniem Zarabiania upewnij się, że zainstalowano oba węzły serwera zarządzania.
2. Na węźle serwera zarządzania uruchom skrypt konfiguracyjny:
   > /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
   
   Opcja „-p mo” określa integrację z Zarabianiem.
   
   Plik konfiguracji musi być dostępny lub możliwy do odczytania przez użytkownika „apigee”.
3. Jeśli instalujesz Zarabianie na wielu węzłach serwera zarządzania, powtórz krok 2 na drugim węźle serwera zarządzania.

Po pomyślnej konfiguracji w bazie danych PostgreSQL zostanie utworzony schemat RDBMS dla usług zarabiania. To kończy integrację usług zarabiania i powiązanych z nimi komponentów z serwerem Postgres.

Integracja usług zarabiania ze wszystkimi procesorami komunikatów

Aby zintegrować zarabianie we wszystkich węzłach procesora komunikatów, wykonaj te czynności.

1. W wierszu poleceń pierwszego węzła procesora komunikatów uruchom skrypt konfiguracyjny:
   > /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
   
   Opcja „-p mo” określa integrację z Zarabianiem.
   
   Plik konfiguracji musi być dostępny lub możliwy do odczytania przez użytkownika „apigee”.
2. Powtórz tę procedurę na wszystkich węzłach procesora komunikatów.

Po pomyślnym skonfigurowaniu procesor komunikatów zostanie zaktualizowany o usługi zarabiania. W ten sposób zakończysz integrację usług zarabiania i powiązanych z nimi komponentów z procesorami komunikatów.

Wprowadzenie do zarabiania

Aby utworzyć nową organizację z włączonymi funkcjami zarabiania, najpierw utwórz organizację w taki sam sposób, jak każdą inną. Więcej informacji znajdziesz w artykule Wprowadzanie organizacji.

Dodatkowe wprowadzenie umożliwiające zarabianie w organizacji

Aby dokończyć proces wprowadzania organizacji do zarabiania, musisz:

1. Utwórz grupę zarabiania: mxgroup.
2. Dodaj Qpid do grupy.
3. Włącz zarabianie w organizacji.
4. Włącz ustawienia powiadomień dla organizacji.
5. Powtórz ten proces we wszystkich organizacjach, w których chcesz włączyć Zarabianie.

Aby wykonać wszystkie te zadania, użyj polecenia enable-monetization. Ten skrypt pobiera plik konfiguracyjny zawierający te właściwości:

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.

Uwagi:

• Ustaw CASS_HOSTS i REGION na te same wartości, które zostały użyte podczas instalowania Zarabiania.
• Jeśli włączasz Zarabianie w konfiguracji z wieloma centrami danych:
  • Musisz powtórzyć proces wprowadzania na serwerze zarządzania w każdym centrum danych.
  • Plik konfiguracji powinien zawierać tylko węzły Qpid w konfigurowanym centrum danych.

Aby uruchomić skrypt:

1. Wywołaj skrypt:
   > /opt/apigee/apigee-service/bin/apigee-service apigee-provision enable-monetization -f configFile
   
   Plik konfiguracji musi być dostępny lub możliwy do odczytania przez użytkownika „apigee”.
   
   Jeśli masz kilka serwerów zarządzania, musisz uruchomić ten skrypt tylko na jednym z nich.
   
   Ten skrypt replikuje organizację, usługi, deweloperów i aplikacje z bazy danych Cassandra do bazy danych PostgreSQL w Zarabianiu. Po pomyślnej instalacji usług zarabiania dane są synchronizowane automatycznie.
2. Powtórz tę procedurę w przypadku każdej organizacji, w której chcesz włączyć zarabianie.
3. Jeśli masz środowisko z wieloma centrami danych, powtórz ten proces na serwerze zarządzania w innym centrum danych. Upewnij się, że plik konfiguracji zawiera tylko węzły Qpid w konfigurowanym centrum danych.

Gdy następnym razem zalogujesz się w interfejsie Edge, w menu najwyższego poziomu organizacji zobaczysz pozycję Zarabianie:

Konfigurowanie portalu usług dla programistów

Aby skonfigurować portal usług dla programistów pod kątem obsługi generowania przychodu, wejdź na stronę http://apigee.com/docs/monetization/content/configure-monetization-developer-portal.

Dodawanie węzła serwera zarządzania do instalacji zarabiania

Jeśli dodasz serwer zarządzania do istniejącej instalacji Edge, musisz dodać usługi zarabiania do nowego serwera zarządzania i skonfigurować wszystkie serwery zarządzania, aby mogły się komunikować.

Aby dodać serwer zarządzania:

1. Zainstaluj nowy serwer zarządzania.
2. Zainstaluj Zarabianie na nowym serwerze zarządzania.
3. Na pierwotnym serwerze zarządzania wywołaj:
   > /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
4. Uruchom ponownie pierwotny serwer zarządzania:
   > /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
5. Na nowym serwerze zarządzania wywołaj to polecenie:
   > /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
6. Uruchom ponownie nowy serwer zarządzania:
   > /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart

Dodatkowa konfiguracja

Udostępnianie dokumentów rozliczeniowych w formacie PDF

Zarabianie wyświetla dokumenty rozliczeniowe użytkownikom w formacie HTML. Aby udostępniać dokumenty rozliczeniowe jako pliki PDF, możesz zintegrować Zarabianie z systemem rozliczeniowym, który umożliwia generowanie plików PDF, lub uzyskać licencję na obsługiwaną bibliotekę PDF innej firmy.

Konfigurowanie ustawień organizacji

Ustawienia backendu: w tabeli poniżej znajdziesz atrybuty na poziomie organizacji, które są dostępne do skonfigurowania organizacji Mint. Możesz użyć wywołania PUT, aby dodać lub zaktualizować te atrybuty, jak pokazano poniżej:

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

Na przykład dane wyjściowe powyższego polecenia CURL będą wyglądać mniej więcej tak:

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

Informacje o konfigurowaniu ustawień organizacji biznesowej za pomocą interfejsu zarządzania znajdziesz na stronie http://apigee.com/docs/monetization-services/content/get-started-using-monetization-services.

Uwaga: jeśli korzystasz z funkcji Limitów i powiadomień usług zarabiania, poproś programistów o dołączenie zasady limitu do przepływu proxy po zasadzie weryfikacji tokena dostępu.

Zasada limitu to wyraźna zasada, która blokuje wywołanie interfejsu API po osiągnięciu określonego limitu. Zasada sprawdza limity biznesowe i zgłasza błąd, jeśli któryś z nich przekracza skonfigurowaną wartość. Jest to rozszerzenie zasady zgłaszania błędów, ale warunki są określane na podstawie zmiennych biznesowych.

W interfejsie zarządzania dla deweloperów proxy dostępny jest szablon interfejsu użytkownika. Deweloper serwera proxy powinien dołączyć zasadę mint do przepływu komunikatów. Po wykonaniu tej zasady zostanie zgłoszony błąd z odpowiedzią na błąd zgodnie z zasadą. Jeśli parametr ContinueOnError ma wartość true, błąd nie zostanie zgłoszony i zostaną ustawione zmienne przepływu „mint.limitsViolated”, „mint.isDeveloperSuspended” i „mint.limitsPolicyError”, których można użyć do dalszej obsługi wyjątków, jeśli jest to wymagane.