Portal installieren

Edge for Private Cloud v4.18.05

Bevor Sie das Apigee Developer Services-Portal (oder einfach das Portal) installieren, stellen Sie Folgendes sicher:

  1. Sie installieren Postgres vor der Installation des Portals. Sie können Postgres entweder als Teil der Edge-Installation oder eigenständige Postgres zur Verwendung durch das Portal installieren.
    • Wenn Sie die eigenständige Postgres-Version installieren, kann sie sich auf demselben Knoten wie das Portal befinden.
    • Wenn Sie eine Verbindung zu Postgres herstellen, der als Teil von Edge installiert ist, und Postgres im Master-/Standby-Modus konfiguriert ist, geben Sie die IP-Adresse des Postgres-Master-Servers an.
  2. Sie führen die Installation mit der 64-Bit-Version einer unterstützten Version von Red Hat Enterprise Linux, CentOS oder Oracle durch. 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 zum Installieren anderer bereitgestellter 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. Vor Versionen von PHP entfernen
  3. Postgres installieren
  4. Portal installieren
  5. Prüfen, ob der Update-Manager aktiviert ist
  6. (Optional) Apache Solr konfigurieren
  7. Optional: SmartDocs installieren
  8. Optional: JQuery konfigurieren

Einstellung der SMTPSSL-Eigenschaft

In früheren Releases haben Sie das Attribut SMTPSSL verwendet, um das Protokoll festzulegen, das vom SMTP-Server verwendet wurde, der mit dem Portal verbunden war. Diese Eigenschaft 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“.

Portalkonfigurationsdatei erstellen

Unten sehen Sie ein Beispiel einer stillen Konfigurationsdatei für eine Portalinstallation. Bearbeiten Sie diese Datei nach Bedarf für Ihre Konfiguration. Verwenden Sie die Option „-f“ für setup.sh, um diese Datei einzubeziehen.

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 möchten, und dem Edge-Verwaltungsserver. Führen Sie dazu den folgenden curl-Befehl auf dem Portalserver aus:

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 für Ihre Edge-Installation an. 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 ist, 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. Entfernen von früheren Versionen von PHP

Das Installationsskript prüft das System auf ältere Versionen von PHP, bevor es die Installation startet. Wenn ältere Versionen von PHP 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 entweder Postgres im Rahmen der Installation von Edge installieren oder Postgres eigenständig zur Verwendung durch das Portal installieren.

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

Informationen zum Installieren von Postgres als Teil der Edge-Installation finden Sie unter Edge-Komponenten auf einem Knoten installieren.

So installieren Sie Postgres eigenständig:

  1. Installieren Sie das Edge-Dienstprogramm apigee-setup mit dem Internet- oder Nicht-Internet-Verfahren auf dem Knoten. Weitere Informationen finden Sie unter Edge-Dienstprogramm für Apigee-Einrichtung 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 über die Eingabeaufforderung das Einrichtungsskript 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 Postgre installiert werden soll. Die Konfigurationsdatei muss für den „apigee“-Benutzer zugänglich oder lesbar sein.

4. Portal installieren

Bevor Sie das Portal installieren können, müssen Sie die unter 3. Installieren Sie Postgres:

  1. Installieren Sie das Edge-Dienstprogramm apigee-setup auf dem Knoten des Portals
  2. Postgres installieren, entweder eigenständige Postgres oder als Teil der Edge-Installation

So installieren Sie das Portal:

  1. Führen Sie über die 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 Skript setup an, das Portal zu installieren.

So überprüfen Sie, ob die Installation des Portals erfolgreich war:

  1. Gehen Sie zur Startseite des Portals unter http://localhost:8079 oder zum DNS-Namen Ihres Portals.
  2. Melden Sie sich im Portal mit den Administratoranmeldedaten an, die Sie in der Konfigurationsdatei des Portals festgelegt haben.
  3. Wählen Sie im Drupal-Menü Berichte > Statusbericht aus, damit Sie den aktuellen Status des Portals sehen können.
  4. Prüfen Sie, ob die Verbindung zum Verwaltungsserver hergestellt wurde. Falls nicht:
    1. Rufen Sie im Portal die Seite „Verbindungskonfiguration“ auf (z. B. http://portal_IP:8079/admin/config/devconnect).
    2. Klicken Sie auf die Schaltfläche Test Connection (Verbindung testen). Wenn die Verbindung erfolgreich hergestellt wurde, sind Sie fertig. Wenn die Verbindung fehlschlägt, fahren Sie fort.
    3. Prüfen Sie die Endpunkt- und Authentifizierungseinstellungen:
      • Endpunkt-URL der Management API:Prüfen Sie, ob das Protokoll (HTTP oder HTTPS), der IP- oder 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 Organisationsadministrators.

      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. Nutzername und Passwort sollten außerdem mit den Werten der Attribute USER_NAME und USER_PWD in der Konfigurationsdatei für die Onboarding-Konfiguration oder mit den Anmeldedaten eines Nutzers mit der Rolle „Organisationsadministrator“ übereinstimmen.

    4. Nachdem Sie eine Verbindung zum Verwaltungsserver hergestellt haben, klicken Sie unten auf der Seite auf die Schaltfläche Konfiguration speichern, um die Änderungen zu speichern.

5. Das Update-Manager-Modul muss aktiviert sein

Um Benachrichtigungen über Drupal-Updates zu erhalten, muss das Drupal-Update-Manager-Modul aktiviert sein. Wählen Sie im Drupal-Menü Module (Module) aus und scrollen Sie nach unten zum Modul Update Manager (Aktualisierungsmanager). Ist dies nicht der Fall, aktivieren Sie es.

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 vom Stammverzeichnis der Website aus ausführen. Standardmäßig wird das Portal unter /opt/apigee/apigee-drupal/wwwroot installiert. Ändern Sie daher zuerst das Verzeichnis in /opt/apigee/apigee-drupal/wwwroot, bevor Sie den Befehl ausführen. Wenn Sie das Portal nicht im Standardverzeichnis installiert haben, wechseln Sie zu Ihrem 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 legen Sie die Häufigkeit der Suche nach Updates fest.

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 keine Drupal Solr-Module.

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 Berechtigungen zum Erstellen von Inhalten an.
  2. Wählen Sie im Drupal-Menü die Option Module (Module) aus.
  3. Aktivieren Sie die Module 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 so im Portal dokumentieren, dass die API-Dokumentation vollständig interaktiv wird. Wenn Sie SmartDocs mit dem Portal verwenden möchten, müssen Sie jedoch zuerst SmartDocs 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 für eine Private Cloud-Installation verbinden, müssen Sie dafür sorgen, dass SmartDocs in Edge installiert ist. Weitere Informationen zum Installieren 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 SmartDocs zum Dokumentieren von APIs verwenden.

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

Wenn Sie das JQuery Update-Modul in einer Nicht-Internetinstallation installieren und verwenden, müssen Sie das Modul für die Verwendung der lokalen Version von JQuery konfigurieren. Wenn du das Modul so konfigurierst, dass ein CDN für eine Installation ohne Internet verwendet wird, versucht es, auf das CDN zuzugreifen, und verursacht Verzögerungen beim Laden der Seite. 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 Berechtigungen zum Erstellen von Inhalten an.
  2. Wählen Sie im Drupal-Menü Configuration > Development > JQuery Update (Konfiguration > Entwicklung > JQuery-Update) aus.
  3. Klicken Sie im linken Navigationsbereich auf Leistung.
  4. Wählen Sie im CDN-Drop-down-Menü für die JQuery- und JQuery-UI die Option Keine 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. Außerdem finden Sie Links zur Apigee-Dokumentation mit weiteren Informationen:

Aufgabe Beschreibung

Design anpassen

Das Design definiert die Darstellung des Portals, einschließlich Farben, Stile und anderer visueller Aspekte.

Erscheinungsbild anpassen

Die Startseite enthält das Hauptmenü, die Willkommensnachricht, die Kopfzeile, die Fußzeile und den Titel.

Nutzerkonten hinzufügen und verwalten

Im Rahmen der Registrierung wird gesteuert, wie neue Entwickler ein Konto im Portal registrieren. Erhalten neue Entwickler beispielsweise sofort Zugriff auf das Portal oder müssen sie von einem Administrator bestätigt werden? Mit diesem Prozess wird auch gesteuert, wie ein Portaladministrator bei der Erstellung eines neuen Kontos benachrichtigt wird.

E-Mail konfigurieren

Das Portal sendet E-Mails als Reaktion auf bestimmte Ereignisse. Dies ist beispielsweise der Fall, wenn sich ein neuer Entwickler im Portal registriert und ein Entwickler sein Passwort verliert.

Nutzerkonten hinzufügen und verwalten

Füge eine Seite mit Nutzungsbedingungen hinzu, die Entwickler akzeptieren müssen, bevor sie auf das Portal zugreifen können.

Nutzerkonten hinzufügen und verwalten

Das Portal implementiert ein rollenbasiertes Autorisierungsmodell. Bevor Entwickler sich registrieren können, müssen Sie die vom Portal verwendeten Berechtigungen und Rollen definieren.

Blog- und Forenbeiträge hinzufügen

Das Portal verfügt über eine integrierte Unterstützung für Blogs und Foren mit Unterhaltungsthreads. Legen Sie die Berechtigungen fest, die zum Ansehen, Hinzufügen, Bearbeiten und Löschen von Blog- und Forumsbeiträgen erforderlich sind.

Achten Sie darauf, dass Sie Datenbanksicherungen ausführen

Stellen Sie sicher, dass Sie die Drupal-Datenbank sichern. Da jede Installation anders ist, müssen Sie selbst bestimmen, wie die Datenbank am besten gesichert werden soll.

Weitere Informationen finden Sie unter Sicherungen durchführen.

Hostnamen einrichten

Wenn du auf deinem DNS-Server keinen Hostnamen einrichtest, kannst du jederzeit über die IP-Adresse des Servers auf die Website zugreifen. Wenn Sie einen Hostnamen verwenden möchten, können Sie das DNS für den Server konfigurieren. Dies sollte auch ohne weitere Konfiguration mit einer grundlegenden Einrichtung ordnungsgemäß funktionieren.

Wenn du einen Load-Balancer einrichtest oder aus einem anderen Grund falsche URLs auf deiner Website erhältst, kannst du $base_url für Drupal festlegen. Gehe dazu so vor:

  1. Erstellen Sie das Verzeichnis /opt/apigee/data/apigee-drupal-devportal/sites/default/includes, falls es noch nicht vorhanden ist.
  2. Erstellen Sie in diesem Verzeichnis eine Datei mit dem Namen settings.php.
  3. Fügen Sie der Datei settings.php Folgendes hinzu:
    /**
    * Base URL (optional).
    *
    * If Drupal is generating incorrect URLs on your site, which could
    * be in HTML headers (links to CSS and JS files) or visible links
    * on pages (such as in menus), uncomment the Base URL statement
    * below (remove the leading hash sign) and fill in the absolute URL
    * to your Drupal installation.
    *
    * You might also want to force users to use a given domain.
    * See the .htaccess file for more information.
    *
    * Examples:
    *   $base_url = 'http://www.example.com';
    *   $base_url = 'http://www.example.com:8888';
    *   $base_url = 'http://www.example.com/drupal';
    *   $base_url = 'https://www.example.com:8888/drupal';
    *
    * It is not allowed to have a trailing slash; Drupal will add it
    * for you.
    */
    # $base_url = 'http://www.example.com/';  // NO trailing slash!
    $base_url = ‘http://www.example.com’;
    
  4. Ändern Sie die letzte $base_url-Zeile in den Hostnamen Ihrer Website.
  5. Speichere die Datei.

Beachten Sie, dass Sie alle anderen Einstellungen aus /opt/apigee/data/apigee-drupal-devportal/ sites/default/default.settings.php in diese Datei einfügen können.

Weitere Informationen zum Attribut $base_url finden Sie hier:

Benutzerdefinierte Entwicklung Sie können die Funktionen des Portals auch mit benutzerdefiniertem Code außerhalb Ihres Designs erweitern. Erstellen Sie dazu Ihr eigenes Drupal-Modul, wie in den Drupal-Themen zur Modulentwicklung beschrieben, und platzieren Sie das Modul im Verzeichnis /sites/all/modules.