Installation von Entwicklerdiensten im Portal

Entwicklerdienstportal Version 4.16.05

Folgen Sie dieser Anleitung, um das Entwicklerportal für Channeldienste zu installieren.

Erstelle eine Sicherung deines gesamten Drupal-Webstammverzeichnisses, bevor du mit der Installation fortfährst. Der standardmäßige Installationspfad ist /var/www/html. Möglicherweise haben Sie ihn aber bereits bei der Installation geändert. Nachdem Sie die unten beschriebenen Installationsschritte ausgeführt haben, können Sie Ihre Anpassungen aus der Sicherung wiederherstellen.

1. Channel Services-Paket für Entwickler 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 Developer Channel Services auf eine der folgenden beiden Arten anzufordern:

  • Zugriff auf das Downloadverzeichnis für Edge für Private Cloud anfordern.
  • Fordern Sie eine URL zur TAR-Datei der Channel Services-Entwicklerversion 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. Führen Sie die Installation mit der 64-Bit-Version einer unterstützten Version von Red Hat Enterprise Linux, CentOS oder Oracle durch. Hier finden Sie eine Liste der unterstützten Versionen.
  2. Prüfen Sie, ob Yum installiert ist.
  3. (Bei einer Installation auf einem Server ohne Internetverbindung) Laden Sie zuerst alle erforderlichen Dateien als einzelne .tar.gz-Datei auf einen Server mit einer Internetverbindung herunter. Anschließend kopieren Sie diese TAR.GZ-Datei ohne Internetverbindung auf den Server, um die Installation durchzuführen.
    1. Melden Sie sich auf einem Server mit einer Internetverbindung als Root oder als Superuser an.
    2. Erstellen Sie ein Verzeichnis für die Installationsdateien, z. B. portal_tar.
    3. in das neue Verzeichnis auf und laden Sie die Developer Channel Services-Datei DeveloperServices_x.y.z.tar herunter, wobei x.y.z der Versionsnummer des Portals entspricht.
    4. Extrahieren Sie den Inhalt der TAR-Datei der Developer Channel Services-Datei mit dem folgenden Befehl:
      > tar -xvf <tar file>
    5. CD in DeveloperServices-4.x.y.z.
    6. Erstellen Sie mit folgendem Befehl die .tar.gz-Datei des Portals:
      > ./non-networked-install.sh

      Mit diesem Befehl werden alle erforderlichen Dateien und sie in eine einzelne .tar.gz-Datei heruntergeladen. Anschließend kopieren Sie diese TAR.GZ-Datei auf den Server, der keine Internetverbindung hat, um die Installation abzuschließen.
  4. Testen Sie die Verbindung zum Edge-Verwaltungsserver. Führen Sie dazu den folgenden cURL-Befehl über eine Eingabeaufforderung auf dem Portalserver aus:
    > curl -u {EMAIL}:{PASSWORT} https://{hostname}:8080/v1/organizations/{ORGNAME}

    Dabei sind EMAIL und EMAIL die E-Mail-Adresse für und PASSWORT für die E-Mail-Adresse und PASSWORT.

    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}

    Bei Erfolg gibt dieser Befehl eine Antwort ähnlich der folgenden zurück:
    {
    "createdAt" : 1348689232699,
    "createName": "trial",
    "createName" : "trial",
    "Erstellt-Name" : "







3. Developer Channel Services mit dem automatischen Installationsskript installieren

Folgen Sie der Anleitung unten, um das Portal mithilfe des automatisierten Installationsskripts zu installieren. Dieses Verfahren funktioniert für Server mit oder ohne externe Internetverbindung.

  1. Melden Sie sich auf dem Server als Root oder als Superuser an.
  2. Erstellen Sie ein Verzeichnis für die Installationsdateien, z. B. portal.
  3. Auf einem Server mit einer Internetverbindung:
    1. auf das neue Portal-Verzeichnis herunter und laden Sie die DeveloperService Channel Services-Datei DeveloperServices_x.y.z.tar herunter, wobei x.y.z der Versionsnummer des Portals entspricht.

      Sie können eine Datei über den Link herunterladen, den Sie von Apigee in einem Browser erhalten haben. Alternativ können Sie sie kopieren und dann dem folgenden cURL-Befehl hinzufügen:
      > curl -kOL <Link hier einfügen>
    2. Extrahieren Sie den Inhalt der TAR-Datei der Developer Channel Services-Datei mit dem folgenden Befehl:
      > tar -xvf <tar file>
    3. CD in 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 oben in Abschnitt 2 erstellte TAR-GZ-Datei. Prüfen Sie, ob Ihr System die Systemanforderungen erfüllt.
    2. Extrahieren Sie den Inhalt der TAR.GZ-Datei mit folgendem Befehl:
      > tar -xvf <tar file>
    3. in das mit dem Befehl „tar“ erstellte Verzeichnis ein.
    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 Skript install-from-rpm-bundle.sh mit folgendem Befehl aus:
      > ./install-from-rpm-bundle.sh
  5. Beantworte die Aufforderungen.
  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 ein DNS konfiguriert haben, rufen Sie http://IP_address oder http://DNS_name auf.

    Sie werden zur Konfigurationsseite der Datenbank mit dem Apigee-Profil weitergeleitet.

    Hinweis: In der Regel haben Sie bereits einen Hostnamen konfiguriert und bei Ihrem DNS-Server registriert, sodass Sie http://localhost nicht verwenden müssen.
  7. Konfigurieren Sie die Verbindung zu MySQL. Wenn sich MySQL auf einem Remote-Computer befindet, maximieren Sie den Abschnitt Advanced Options (Erweiterte Optionen), geben Sie die Verbindungsinformationen zu diesem Computer ein. Wählen Sie dann Save and fortfahren aus.
  8. Konfigurieren Sie die Verbindung zum Apigee-Endpunkt. Geben Sie dazu die folgenden Informationen ein und wählen Sie dann Speichern aus:
    Weitere Informationen zu diesen Werten finden Sie unter „Erforderliche Informationen vor der Installation“ unter Anforderungen des Entwicklerdienstes.
    1. Organisation des Entwicklerportals
    2. Endpunkt-URL des Dev-Portals
    3. Endpunkt authentifizierter Nutzer
    4. Passwort der authentifizierten Nutzer
  9. Wenn Sie dazu aufgefordert werden, wählen Sie die Schaltfläche Beispiel-SmartDocs-WADL installieren aus, um die SmartDocs-WADL-Beispieldatei zu installieren. Wenn Sie diesen Schritt überspringen, wird die Beispiel-SmartDocs API nicht in Ihrem Portal angezeigt.
    Hinweis: Wenn Ihr Portal eine Verbindung zu einer Installation von Apigee Edge für Private Cloud herstellt und diese Edge-Installation keine externe Internetverbindung hat, müssen Sie eine zusätzliche Konfiguration des SmartDocs-Moduls ausführen, 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 zum Senden von E-Mail-Nachrichten aus dem Portal konfigurieren.
    Weitere Informationen finden Sie unter http://apigee.com/docs/developer-services/content/configuring-email.
  11. Konfigurieren Sie den Administrator, indem Sie die folgenden Informationen eingeben, und wählen Sie dann „Speichern“ aus. Beachten Sie, dass Drupal standardmäßig einen Administrator namens „admin“ erstellt. Verwenden Sie also nicht „admin“ als Nutzernamen.
    Wenn Sie diesen Schritt überspringen, können Sie trotzdem mit Drush einen Administrator erstellen, wie unten unter 4 beschrieben. Erstellen Sie einen Administrator.
    1. Vor- und Nachname des Entwicklers
    2. Nutzername des Entwicklerportals
    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. Gehen Sie zur Startseite des Portals unter http://localhost/ oder zum DNS-Namen Ihres Portals.
  14. Melden Sie sich mit den Administratoranmeldedaten im Portal an.

4. Administrator erstellen

Erstellen Sie mit Drush einen Nutzer mit Administratorzugriff für die Installation von Developer Channel Services. Drupal erstellt standardmäßig automatisch einen Administrator namens „admin“. Verwenden Sie also nicht „admin“ als Nutzernamen.

  1. CD 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/. Mit dem folgenden Befehl sorgen Sie dafür, dass der Inhaber und die Gruppe in dieses Verzeichnis schreiben können:
    chmod -R g+w dirPathAndName
    chmod -R o+r dirPathAndName
  3. Geben Sie die folgenden Befehle ein, um einen Administrator zu erstellen, und ersetzen Sie die Befehle in „< >“ durch Ihre Werte:
    > drush user-create <username> --mail="<email-address>" --password="<password>"
    > drush user-add-role Administrator <Nutzername>
  4. Melden Sie sich im Entwicklerportal als Administrator mit dem oben angegebenen Nutzernamen und Passwort an.

5. MySQL-Root-Passwort festlegen

Wenn Sie MySQL als Teil der Portalinstallation installiert haben, behält das Installationsskript den Standardwert für das MySQL-Root-Passwort bei, der leer ist.

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

> mysqladmin -u root password NEWPASSWORD

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

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

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

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

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.

7. Optional – Auf einem Produktionsserver bereitstellen

Wenn Sie das Portal auf einem Produktionsserver bereitstellen, sollten Sie unter anderem die folgenden zusätzlichen Sicherheitsmaßnahmen ergreifen:

  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 lokalen Host zu beschränken und die standardmäßig erstellten Testdatenbanken und den anonymen Nutzer zu entfernen. Für Produktionsserver wird dringend empfohlen, dieses Skript auszuführen.
  2. Aktivieren und konfigurieren Sie SELinux, falls 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 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.

9. Optional: Installieren Sie mod_ssl, um HTTPS zu unterstützen

Das Modul mod_ssl wird von 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 auf dem Portal für Entwicklerdienste so 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 zur Installation von Edge und SmartDocs finden Sie unter SmartDocs installieren.

Weitere Informationen zu SmartDocs finden Sie unter SmartDocs zum Dokumentieren von APIs verwenden.

11. Was kann ich jetzt für Sie tun?

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

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:

Task (Aufgabe)

Beschreibung

Design anpassen

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

Darstellung 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-Mails 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.

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 Sie einen Load-Balancer eingerichtet haben oder aus einem anderen Grund falsche URLs auf Ihrer Website erhalten, können Sie $base_url in der Datei settings.php des Entwicklerportals festlegen. Diese befindet sich standardmäßig im Verzeichnis /var/www/html/sites/default.