Portal installieren

Edge for Private Cloud v4.18.05

Bevor Sie das Apigee Developer Services-Portal (oder einfach das Portal) installieren, müssen Sie Folgendes tun:

1. Sie installieren Postgres, bevor Sie das Portal installieren. Sie können Postgres entweder im Rahmen der Installation von Edge oder eigenständig für die Verwendung durch das Portal installieren.
   • Wenn Sie Postgres eigenständig installieren, kann es sich auf demselben Knoten wie das Portal befinden.
   • Wenn Sie eine Verbindung zu Postgres herstellen, das als Teil von Edge installiert ist, und Postgres im Master-/Standby-Modus konfiguriert ist, geben Sie die IP-Adresse des Master-Postgres-Servers an.
2. Sie führen die Installation auf der 64-Bit-Version einer unterstützten Version von Red Hat Enterprise Linux, CentOS oder Oracle aus. Eine Liste der unterstützten Versionen finden Sie unter Unterstützte Software und unterstützte Versionen.
3. Yum ist installiert.

Das Installationsprogramm enthält nur von Drupal bereitgestellte Module, die für das Apigee Developer Services-Portal (oder einfach das Portal) erforderlich sind. Informationen zur Installation anderer beigesteuerter Module finden Sie unter Drupal 7 erweitern.

Installation

Führen Sie die folgenden Schritte aus, um das Portal zu installieren. Jeder dieser Schritte wird in den folgenden Abschnitten ausführlicher beschrieben.

1. Verbindung testen
2. PHP-Versionen vor 7.0 entfernen
3. Postgres installieren
4. Portal installieren
5. Update Manager aktivieren
6. Optional: Apache Solr konfigurieren
7. (Optional) SmartDocs installieren
8. (Optional) JQuery konfigurieren

Einstellung der Unterstützung für das Attribut „SMTPSSL“

In früheren Versionen haben Sie das Attribut SMTPSSL verwendet, um das Protokoll festzulegen, das vom SMTP-Server verwendet wird, der mit dem Portal verbunden ist. Diese Property wurde eingestellt.

Sie verwenden jetzt das Attribut SMTP_PROTOCOL anstelle des Attributs SMTPSSL, um das Protokoll festzulegen, das vom SMTP-Server verwendet wird, der mit dem Portal verbunden ist. Gültige Werte sind „standard“, „ssl“ oder „tls“.

Portal-Konfigurationsdatei erstellen

Hier sehen Sie eine Beispielkonfigurationsdatei für eine Portalinstallation im Hintergrund. Bearbeiten Sie diese Datei nach Bedarf für Ihre Konfiguration. Verwenden Sie die Option „-f“ für setup.sh, um diese Datei einzuschließen.

IP1=IPorDNSnameOfNode

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

# Specify the name of the portal database in Postgres.
PG_NAME=devportal

# Specify the Postgres admin credentials.
# The portal connects to Postgres by using the 'apigee' user.
# If you changed the Postgres password from the default of 'postgres'
# then set PG_PWD accordingly.
# If connecting to a Postgres node installed with Edge,
# contact the Edge sys admin to get these credentials.
PG_USER=apigee
PG_PWD=postgres

# The IP address of the Postgres server.
# If it is installed on the same node as the portal, specify that IP.
# If connecting to a remote Postgres server,specify its IP address.
PG_HOST=$IP1

# The Postgres user credentials used by the portal
# to access the Postgres database,
# This account is created if it does not already exist.
DRUPAL_PG_USER=drupaladmin
DRUPAL_PG_PASS=portalSecret

# Specify 'postgres' as the database.
DEFAULT_DB=postgres

# Specify the Drupal admin account details.
# DO NOT set DEVPORTAL_ADMIN_USERNAME=admin.
# The installer creates this user on the portal.
DEVPORTAL_ADMIN_FIRSTNAME=firstName
DEVPORTAL_ADMIN_LASTNAME=lastName
DEVPORTAL_ADMIN_USERNAME=userName
DEVPORTAL_ADMIN_PWD=PORTAL_ADMIN_PASSWORD
DEVPORTAL_ADMIN_EMAIL=foo@bar.com

# Edge connection details.
# If omitted, you can set them in the portal UI.
# Specify the Edge organization associated with the portal.
EDGE_ORG=edgeOrgName

# Specify the URL of the Edge management API.
# For a Cloud based installation of Edge, the URL is:
# https://api.enterprise.apigee.com/v1
# For a Private Cloud installation, it is in the form:
# http://ms_IP_or_DNS:8080/v1 or
# https://ms_IP_or_DNS:TLSport/v1
MGMT_URL=https://api.enterprise.apigee.com/v1

# The org admin credentials for the Edge organization in the form
# of Edge emailAddress:pword.
# The portal uses this information to connect to Edge.
DEVADMIN_USER=orgAdmin@myCorp.com
DEVADMIN_PWD=ORG_ADMIN_PASSWORD

# The PHP port.
# If omitted, it defaults to 8888.
PHP_FPM_PORT=8888

# Optionally configure the SMTP server used by the portal.
# If you do, the properties SMTPHOST and SMTPPORT are required.
# The others are optional with a default value as notated below.
# SMTP hostname. For example, for the Gmail server, use smtp.gmail.com.
SMTPHOST=smtp.gmail.com

# Set the SMTP protocol as "standard", "ssl", or "tls",
# where "standard" corresponds to HTTP.
# Note that in previous releases, this setting was controlled by the
# SMTPSSL property. That property has been deprecated.
SMTP_PROTOCOL="standard"

# SMTP port (usually 25).
# The value can be different based on the selected encryption protocol.
# For example, for Gmail, the port is 465 when using SSL and 587 for TLS.
SMTPPORT=25

# Username used for SMTP authentication, defaults is blank.
SMTPUSER=your@email.com

# Password used for SMTP authentication, default is blank.
SMTPPASSWORD=YOUR_EMAIL_PASSWORD

1. Verbindung zu Apigee Edge testen

Testen Sie die Verbindung zwischen dem Server, auf dem Sie das Portal installieren, und dem Edge-Verwaltungsserver, indem Sie den folgenden curl-Befehl auf dem Portalserver ausführen:

curl -u EMAIL:PASSWORD http://ms_IP_or_DNS:8080/v1/organizations/ORGNAME

oder

curl -u EMAIL:PASSWORD https://ms_IP_or_DNS:TLSPort/v1/organizations/ORGNAME

Dabei sind EMAIL und PASSWORD die E-Mail-Adresse und das Passwort des Administrators für ORGNAME.

Geben Sie den Hostnamen und die Portnummer an, die für Ihre Edge-Installation spezifisch sind. Port 8080 ist der von Edge verwendete Standardport. Wenn Sie eine Verbindung zu einer Organisation in der Cloud herstellen, lautet die Anfrage-URL: https://api.enterprise.apigee.com/v1/organizations/ORGNAME.

Wenn der Vorgang erfolgreich war, gibt curl eine Antwort ähnlich der folgenden zurück:

{
  "createdAt" : 1348689232699,
  "createdBy" : "USERNAME",
  "displayName" : "cg",
  "environments" : [ "test", "prod" ],
  "lastModifiedAt" : 1348689232699,
  "lastModifiedBy" : "foo@bar.com",
  "name" : "cg",
  "properties" : {
    "property" : [ ]
  },
  "type" : "trial"
}

2. PHP-Versionen vor 7.0 entfernen

Das Installationsskript prüft vor Beginn der Installation, ob auf dem System PHP-Versionen vor 7.0 vorhanden sind. Wenn PHP-Versionen vor 7.0 vorhanden sind, wird die folgende Warnmeldung angezeigt:

The following packages present on your system conflict with software we are
about to install. You will need to manually remove each one, then re-run this install script.

php
php-cli
php-common
php-gd
php-mbstring
php-mysql
php-pdo
php-pear
php-pecl-apc
php-process
php-xml

Entfernen Sie die PHP-Pakete mit dem folgenden Befehl:

yum remove package_name

Wenn Sie nicht sicher sind, ob PHP auf Ihrem Server installiert ist, verwenden Sie den folgenden Befehl:

rpm -qa | grep -i php

3. Postgres installieren

Für das Portal muss Postgres installiert sein, bevor Sie das Portal installieren können. Sie können Postgres entweder im Rahmen der Installation von Edge oder eigenständig für die Verwendung durch das Portal installieren.

• Wenn Sie eine Verbindung zu Postgres herstellen, das als Teil von Edge installiert ist, und Postgres im Master-/Standby-Modus konfiguriert ist, geben Sie die IP-Adresse des Master-Postgres-Servers an.
• Wenn Sie Postgres eigenständig installieren, kann es sich auf demselben Knoten wie das Portal befinden.

Informationen zur Installation von Postgres im Rahmen der Installation von Edge finden Sie unter Edge-Komponenten auf einem Knoten installieren.

So installieren Sie Postgres eigenständig:

1. Installieren Sie das Edge-Dienstprogramm apigee-setup auf dem Knoten mithilfe des Internet- oder Nicht-Internet-Verfahrens. Weitere Informationen finden Sie unter Edge-Dienstprogramm „apigee-setup“ installieren.
2. Erstellen Sie eine Postgres-Konfigurationsdatei, wie im folgenden Beispiel gezeigt:

   # Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost
   HOSTIP=$(hostname -i)
   
   # The pod and region of Postgres. Use the default values shown below.
   MP_POD=gateway
   REGION=dc-1
   
   # Set the Postgres password. The default value is 'postgres'.
   PG_PWD=postgres

3. Führen Sie in der Eingabeaufforderung das Setupscript aus, um Postgres zu installieren:

   /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f postgres_config_file

   Mit der Option -p pdb wird angegeben, dass PostgreSQL installiert werden soll. Die Konfigurationsdatei muss für den Nutzer „apigee“ zugänglich oder lesbar sein.

4. Portal installieren

Bevor Sie das Portal installieren können, müssen Sie die folgenden Schritte ausführen, wie unter 3. Postgres installieren:

1. Installieren Sie das Edge-Dienstprogramm apigee-setup auf dem Knoten des Portals.
2. Postgres installieren, entweder Postgres eigenständig oder im Rahmen der Installation von Edge

So installieren Sie das Portal:

1. Führen Sie in der Eingabeaufforderung das Skript setup aus:

   /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

   Wobei:

   • configFile ist die Portalkonfigurationsdatei, wie unter Portalkonfigurationsdatei erstellen beschrieben.
   • -p dp weist das setup-Skript an, das Portal zu installieren.

So prüfen Sie, ob die Portalinstallation erfolgreich war:

1. Rufen Sie die Startseite des Portals unter http://localhost:8079 oder den DNS-Namen Ihres Portals auf.
2. Melden Sie sich im Portal mit den Administratoranmeldedaten an, die Sie in der Portalkonfigurationsdatei festgelegt haben.
3. Wählen Sie im Drupal-Menü Berichte > Statusbericht aus, um den aktuellen Status des Portals zu sehen.
4. Prüfen Sie, ob die Verbindung zum Verwaltungsserver erfolgreich hergestellt wurde. Falls nicht:
   1. Rufen Sie die Seite „Verbindungskonfiguration“ des Portals auf (z. B. http://portal_IP:8079/admin/config/devconnect).
   2. Klicken Sie auf den Button Verbindung testen. Wenn die Verbindung erfolgreich ist, sind Sie fertig. Wenn die Verbindung fehlschlägt, fahre mit dem nächsten Schritt fort.
   3. Prüfen Sie die Endpunkt- und Authentifizierungseinstellungen:
      • Management API-Endpunkt-URL: Prüfen Sie, ob das Protokoll (HTTP oder HTTPS), die IP-Adresse oder der DNS-Name und die Portnummer korrekt sind. Beispiel:

        http://10.10.10.10:8080/v1

      • Endpunkt-authentifizierter Nutzer: Der Nutzername des Organisationsadministrators.
      • Passwort des authentifizierten Nutzers: Das Passwort des Administrators der Organisation.

      Die Standardwerte entsprechen den Einstellungen in der Portalkonfigurationsdatei, die Sie während der Installation erstellt haben.

      Diese Werte sollten mit den Werten für ms_IP_or_DNS, email und password übereinstimmen, die Sie in Schritt 1: Verbindung zu Apigee Edge testen verwendet haben. Der Nutzername und das Passwort sollten auch mit den Werten der Attribute USER_NAME und USER_PWD in der Onboarding-Konfigurationsdatei oder den Anmeldedaten eines Nutzers mit der Rolle „Organization Administrator“ übereinstimmen.

   4. Nachdem Sie eine Verbindung zum Management Server hergestellt haben, klicken Sie unten auf der Seite auf den Button Konfiguration speichern, um die Änderungen zu speichern.

5. Prüfen Sie, ob das Update Manager-Modul aktiviert ist.

Wenn Sie Benachrichtigungen zu Drupal-Updates erhalten möchten, muss das Drupal Update Manager-Modul aktiviert sein. Wählen Sie im Drupal-Menü Module aus und scrollen Sie nach unten zum Modul Update Manager. Wenn sie nicht aktiviert ist, aktivieren Sie sie.

Nach der Aktivierung können Sie die verfügbaren Updates über den Menüpunkt Berichte > Verfügbare Updates aufrufen. Sie können auch den folgenden Drush-Befehl verwenden:

drush pm-info update

Sie müssen diesen Befehl im Stammverzeichnis der Website ausführen. Standardmäßig wird das Portal unter /opt/apigee/apigee-drupal/wwwroot installiert. Daher sollten Sie zuerst das Verzeichnis in /opt/apigee/apigee-drupal/wwwroot ändern, bevor Sie den Befehl ausführen. Wenn Sie das Portal nicht im Standardverzeichnis installiert haben, wechseln Sie in Ihr Installationsverzeichnis.

Verwenden Sie den Menüpunkt Berichte > Verfügbare Updates > Einstellungen, um das Modul so zu konfigurieren, dass Sie per E-Mail benachrichtigt werden, wenn Updates verfügbar sind, und um die Häufigkeit der Suche nach Updates festzulegen.

6. Apache Solr-Suchmaschine konfigurieren (optional)

Standardmäßig sind die Drupal-Module, die eine Verbindung zur Apache Solr-Suchmaschine herstellen, bei der Installation des Portals deaktiviert. Die meisten Portale verwenden die interne Drupal-Suchmaschine und benötigen daher die Drupal-Solr-Module nicht.

Wenn Sie Solr als Suchmaschine verwenden möchten, müssen Sie Solr lokal auf Ihrem Server installieren und dann die Drupal-Solr-Module im Portal aktivieren und konfigurieren.

So aktivieren Sie die Drupal Solr-Module:

1. Melden Sie sich in Ihrem Portal als Nutzer mit Administrator- oder Erstellungsberechtigungen an.
2. Wählen Sie im Drupal-Menü Module aus.
3. Aktivieren Sie das Modul Apache Solr Framework und das Modul Apache Solr Search.
4. Speichern Sie die Änderungen.
5. Konfigurieren Sie Solr wie unter https://drupal.org/node/1999280 beschrieben.

7. SmartDocs installieren (optional)

Mit SmartDocs können Sie Ihre APIs im Portal so dokumentieren, dass die API-Dokumentation vollständig interaktiv ist. Wenn Sie SmartDocs mit dem Portal verwenden möchten, müssen Sie SmartDocs zuerst in Edge installieren.

• Wenn Sie das Portal mit einer Edge Cloud-Installation verbinden, ist SmartDocs bereits installiert und es ist keine weitere Konfiguration erforderlich.
• Wenn Sie das Portal mit einer Edge for Private Cloud-Installation verbinden, müssen Sie dafür sorgen, dass SmartDocs auf Edge installiert ist. Weitere Informationen zur Installation von Edge und SmartDocs finden Sie unter SmartDocs installieren.

Außerdem müssen Sie SmartDocs im Portal aktivieren. Weitere Informationen zu SmartDocs finden Sie unter APIs mit SmartDocs dokumentieren.

8. JQuery-Update-Modul für Installationen ohne Internet konfigurieren (optional)

Wenn Sie das JQuery Update-Modul in einer Installation ohne Internetzugriff installieren und verwenden, müssen Sie das Modul so konfigurieren, dass die lokale Version von JQuery verwendet wird. Wenn Sie das Modul so konfigurieren, dass ein CDN für eine Installation ohne Internet verwendet wird, versucht es, auf das CDN zuzugreifen, was zu Verzögerungen beim Seitenaufbau führt. Weitere Informationen zum JQuery Update-Modul finden Sie unter https://www.drupal.org/project/jquery_update.

So konfigurieren Sie das JQuery Update-Modul für die Verwendung der lokalen Version von JQuery:

1. Melden Sie sich in Ihrem Portal als Nutzer mit Administrator- oder Erstellungsberechtigungen an.
2. Wählen Sie im Drupal-Menü Configuration > Development > JQuery Update aus.
3. Klicken Sie im linken Navigationsbereich auf Leistung.
4. Wählen Sie im Drop-down-Menü „JQuery and JQuery UI CDN“ die Option None aus.
5. Klicken Sie auf Save configuration (Konfiguration speichern).

9. Nächste Schritte

In der folgenden Tabelle sind einige der häufigsten Aufgaben aufgeführt, die Sie nach der Installation ausführen, sowie Links zur Apigee-Dokumentation mit weiteren Informationen: