Installation von Entwicklerdiensten im Portal

Developer Services Portal v. 4.16.05

Führen Sie die folgenden Schritte aus, um das Developer Channel Services-Portal zu installieren.

Erstellen Sie vor der Installation eine Sicherung des gesamten Drupal-Webstammverzeichnisses. Der Standardinstallationsort ist /var/www/html, aber Sie haben ihn möglicherweise bei der Installation geändert. Nachdem Sie die unten beschriebenen Installationsschritte ausgeführt haben, können Sie Ihre Anpassungen aus der Sicherung wiederherstellen.

1. Developer Channel Services-Bundle herunterladen

Rufen Sie http://community.apigee.com/content/apigee-customer-support auf und wählen Sie „Login to your Support Portal“ (Im Supportportal anmelden) aus, um die TAR-Datei für die Entwicklerkanaldienste auf eine der folgenden zwei Arten anzufordern:

• Fordern Sie Zugriff auf das Downloadverzeichnis von Edge for Private Cloud an.
• Fordern Sie eine URL zur TAR-Datei der Developer Channel Services an.

2. Prüfen, ob Ihr System die Systemanforderungen erfüllt

Bevor Sie das Portal installieren, muss Ihr Server die folgenden Anforderungen erfüllen:

1. Achten Sie darauf, dass Sie die Installation auf der 64-Bit-Version einer unterstützten Version von Red Hat Enterprise Linux, CentOS oder Oracle ausführen. Hier finden Sie eine Liste der unterstützten Versionen.
2. Prüfen Sie, ob Yum installiert ist.
3. (Für eine Installation auf einem Server ohne Internetverbindung) Sie müssen zuerst alle erforderlichen Dateien als einzelne .tar.gz-Datei auf einen Server mit Internetverbindung herunterladen. Anschließend kopieren Sie diese TAR.GZ-Datei auf den Server ohne Internetverbindung, um die Installation durchzuführen.
   1. Melden Sie sich als Root- oder Superuser auf einem Server mit Internetverbindung an.
   2. Erstellen Sie ein Verzeichnis für die Installationsdateien, z. B. portal_tar.
   3. Wechseln Sie in das neue Verzeichnis und laden Sie die Developer Channel Services-Datei DeveloperServices_x.y.z.tar herunter, wobei x.y.z der Portalversionsnummer entspricht.
   4. Extrahieren Sie den Inhalt der TAR-Datei für die Developer Channel Services mit dem folgenden Befehl:
      > tar -xvf <tar-Datei>
   5. Wechseln Sie zu DeveloperServices-4.x.y.z.
   6. Erstellen Sie die .tar.gz-Datei des Portals mit dem folgenden Befehl:
      > ./non-networked-install.sh
      
      Mit diesem Befehl werden alle erforderlichen Dateien heruntergeladen und in einer einzigen .tar.gz-Datei zusammengefasst. Anschließend kopieren Sie diese TAR.GZ-Datei auf Ihren Server, der keine Internetverbindung hat, um die Installation abzuschließen.
4. Testen Sie die Verbindung zum Edge-Verwaltungsserver, indem Sie den folgenden cURL-Befehl über eine Eingabeaufforderung auf dem Portalserver ausführen:
   > curl -u {EMAIL}:{PASSWORD} https://{hostname}:8080/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 ist, gibt dieser Befehl 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"
   }

3. Developer Channel Services mit dem automatisierten Installationsskript installieren

Gehen Sie so vor, um das Portal mithilfe des automatisierten Installationsskripts zu installieren. Dieses Verfahren funktioniert für Server mit oder ohne externe Internetverbindung.

1. Melden Sie sich als Root-Nutzer oder Superuser beim Server an.
2. Erstellen Sie ein Verzeichnis für die Installationsdateien, z. B. portal.
3. Auf einem Server mit Internetverbindung:
   1. Wechseln Sie in das neue portal-Verzeichnis und laden Sie die Developer Channel Services-Datei DeveloperServices_x.y.z.tar herunter, wobei x.y.z der Portalversionsnummer entspricht.
      
      Sie können eine Datei über den Link herunterladen, den Sie von Apigee in einem Browser erhalten haben, oder indem Sie sie kopieren und dann dem folgenden cURL-Befehl hinzufügen:
      > curl -kOL <paste link here>
   2. Extrahieren Sie den Inhalt der TAR-Datei für die Developer Channel Services mit dem folgenden Befehl:
      > tar -xvf <tar-Datei>
   3. Wechseln Sie zu DeveloperServices-4.x.y.z.
   4. Führen Sie das Installationsskript mit dem folgenden Befehl aus:
      > ./networked-install.sh
4. Auf einem Server ohne Internetverbindung:
   1. Kopieren Sie die TAR.GZ-Datei, die Sie oben in Abschnitt 2 erstellt haben. Prüfen Sie, ob Ihr System die Systemanforderungen erfüllt.
   2. Extrahieren Sie den Inhalt der TAR.GZ-Datei mit dem folgenden Befehl:
      > tar -xvf <tar-Datei>
   3. Wechseln Sie in das Verzeichnis, das mit dem tar-Befehl erstellt wurde.
   4. Legen Sie die Berechtigungen für das Skript install-from-rpm-bundle.sh fest:
      > chmod 755 install-from-rpm-bundle.sh
   5. Führen Sie das Script install-from-rpm-bundle.sh mit dem folgenden Befehl aus:
      > ./install-from-rpm-bundle.sh
5. Beantworte die Fragen.
6. Rufen Sie nach Abschluss der Installation die Server-URL in einem Browser auf, z. B.
   http://localhost. Wenn Sie eine bestimmte IP-Adresse oder einen bestimmten DNS-Namen konfiguriert haben, rufen Sie http://IP_address oder http://DNS_name auf.
   
   Sie werden zur Seite „Datenbankkonfiguration“ des Apigee-Profils weitergeleitet.
   
   Hinweis: In der Regel haben Sie bereits einen Hostnamen konfiguriert und auf Ihrem DNS-Server registriert, sodass Sie nicht http://localhost verwenden müssen.
7. Konfigurieren Sie die Verbindung zu MySQL. Wenn sich MySQL auf einem Remote-Computer befindet, maximieren Sie den Abschnitt Erweiterte Optionen und geben Sie die Verbindungsinformationen für diesen Computer ein. Wählen Sie dann Speichern und fortfahren aus.
8. Konfigurieren Sie die Verbindung zum Apigee-Endpunkt, indem Sie die folgenden Informationen eingeben, und wählen Sie dann Speichern aus:
   Weitere Informationen zu diesen Werten finden Sie unter „Erforderliche Informationen vor Beginn der Installation“ unter Anforderungen für das Entwicklerdienstportal.
   1. Dev Portal Org
   2. Dev Portal Endpoint URL (URL des Entwicklerportal-Endpunkts)
   3. Endpoint Authenticated User
   4. Passwort authentifizierter Nutzer
9. Wenn Sie dazu aufgefordert werden, wählen Sie die Schaltfläche Beispiel-SmartDocs-WADL installieren aus, um die Beispiel-SmartDocs-WADL zu installieren. Wenn Sie diesen Schritt überspringen, wird die SmartDocs-Beispiel-API nicht in Ihrem Portal angezeigt.
   Hinweis: Wenn Ihr Portal mit einer Installation von Apigee Edge for Private Cloud verbunden ist und diese Edge-Installation keine externe Internetverbindung hat, müssen Sie das SmartDocs-Modul zusätzlich konfigurieren, bevor Sie SmartDocs verwenden können. Weitere Informationen zu SmartDocs finden Sie unter http://apigee.com/docs/developer-services/content/using-smartdocs-document-apis.
10. Konfigurieren Sie die SMTP-Servereinstellungen. Apigee erfordert, dass Sie einen SMTP-Server konfigurieren, um E-Mail-Nachrichten über das Portal zu senden.
    Weitere Informationen finden Sie unter http://apigee.com/docs/developer-services/content/configuring-email.
11. Konfigurieren Sie den Administratornutzer, indem Sie die folgenden Informationen eingeben, und wählen Sie dann „Speichern“ aus. Beachten Sie, dass Drupal standardmäßig einen Administrator mit dem Namen „admin“ erstellt. Verwenden Sie daher nicht „admin“ als Nutzernamen.
    Wenn Sie diesen Schritt überspringen, können Sie trotzdem Drush verwenden, um einen Administrator zu erstellen, wie unten in 4 beschrieben. Erstellen Sie einen Administrator.
    1. Vor- und Nachname des Entwicklers
    2. Nutzername im Entwicklerportal
    3. Passwort
    4. E-Mail-Adresse
12. Legen Sie nach Abschluss der Installation die Berechtigungen für die Datei settings.php fest:
    > chmod 640 /var/www/html/sites/default/settings.php
13. Rufen Sie die Startseite des Portals unter http://localhost/ oder den DNS-Namen Ihres Portals auf.
14. Melden Sie sich mit den Administratoranmeldedaten im Portal an.

4. Administrator erstellen

Verwenden Sie Drush, um einen Administrator für Ihre Developer Channel Services-Installation zu erstellen. Drupal erstellt standardmäßig automatisch einen Administrator mit dem Namen „admin“. Verwenden Sie daher nicht „admin“ als Nutzernamen.

1. Wechseln Sie in das Verzeichnis „drupal_root/sites/default“. Der Standardspeicherort für das Drupal-Stammverzeichnis ist /var/www/html:
   > cd <drupal_root>/sites/default
2. Prüfen Sie, ob Sie Schreibberechtigungen für die privaten Drupal-Dateien haben:
   > drush vget file_private_path
   
   Dieser Befehl gibt den Pfad zu den privaten Drupal-Dateien zurück, z. B.:
   file_private_path: 'sites/default/private'
   
   Entspricht /var/www/html/sites/default/private/. Verwenden Sie den folgenden Befehl, um sicherzustellen, dass dieses Verzeichnis vom Inhaber und der Gruppe beschrieben werden kann:
   chmod -R g+w dirPathAndName
   chmod -R o+r dirPathAndName
3. Geben Sie die folgenden Befehle ein, um einen Administrator zu erstellen. Ersetzen Sie dabei die Befehle in „< >“ durch Ihre Werte:
   > drush user-create <username> --mail="<email-address>" --password="<password>"
   > drush user-add-role Administrator <username>
4. Melden Sie sich mit dem oben angegebenen Nutzernamen und Passwort als Administrator im Entwicklerportal an.

5. MySQL-Root-Passwort festlegen

Wenn Sie MySQL im Rahmen der Portalinstallation installiert haben, wird das MySQL-Root-Passwort vom Installationsskript auf den Standardwert gesetzt, der leer ist.

Verwenden Sie den folgenden Befehl, um das Root-Passwort festzulegen:

> mysqladmin -u root password NEWPASSWORD

Wenn Sie das Root-Passwort bereits festgelegt haben und es ändern möchten, verwenden Sie den folgenden Befehl:

> mysqladmin -u root -p'OLDPASSWORD' password NEWPASSWORD

Sie müssen das Passwort auch in der Datei /var/www/html/sites/default/settings.php aktualisieren.

6. 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

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.

7. Optional: Auf einem Produktionsserver bereitstellen

Wenn Sie das Portal auf einem Produktionsserver bereitstellen, sollten Sie zusätzliche Sicherheitsschritte ausführen, darunter:

1. Führen Sie das folgende Skript aus, um Ihre MySQL-Installation zu sichern:
   > /usr/bin/mysql_secure_installation
   
   Dieses Skript legt das Root-Passwort fest und bietet Ihnen die Möglichkeit, den Root-Zugriff auf den Localhost zu beschränken und die standardmäßig erstellten Testdatenbanken und anonymen Nutzer zu entfernen. Die Ausführung dieses Skripts wird für Produktionsserver dringend empfohlen.
2. Aktivieren und konfigurieren Sie SELinux, wenn dies gemäß Ihren Unternehmensrichtlinien erforderlich ist.

8. Optional: Apache Solr-Suchmaschine konfigurieren

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.

9. Optional: mod_ssl zur Unterstützung von HTTPS installieren

Das Modul „mod_ssl“ wird vom Apache HTTP Server verwendet, um Webseiten über HTTPS bereitzustellen. Wenn Sie HTTPS verwenden möchten, installieren Sie mod_ssl mit dem folgenden Befehl:

> yum install mod_ssl

Weitere Informationen zum Konfigurieren des Portals für die Verwendung von SSL finden Sie unter http://apigee.com/docs/developer-services/content/using-ssl-portal.

10. Optional: SmartDocs installieren

Mit SmartDocs können Sie Ihre APIs im Developer Services-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.

Weitere Informationen zu SmartDocs finden Sie unter APIs mit SmartDocs dokumentieren.

11. Nächste Schritte

Nach der Installation des Developer Services-Portals müssen Sie es für Ihre spezifischen Anforderungen konfigurieren und anpassen. Die Dokumentation auf der Apigee-Website enthält alle Informationen zum Konfigurieren, Gestalten und Verwalten eines Portals. Die Dokumentation finden Sie unter http://apigee.com/docs/developer-services/content/what-developer-portal.

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: