Diese Seite wurde von der Cloud Translation API übersetzt.

Installation von Entwicklerdiensten im Portal

Edge for Private Cloud Version 4.17.01

Bevor Sie mit der Installation beginnen, müssen folgende Voraussetzungen erfüllt sein:

Sie installieren Postgres vor der Installation des Portals. Sie können Postgres entweder im Rahmen der Installation von Edge installieren oder Postgres im eigenständigen Portal zur Verwendung durch das Portal installieren.
- Wenn Sie Postgres als eigenständiges System installieren, kann es sich auf demselben Knoten wie das Portal befinden.
- Wenn Sie eine Verbindung zu Postgres herstellen, das im Rahmen von Edge installiert wurde, und Postgres im Master/Standby-Modus konfiguriert ist, geben Sie die IP-Adresse des Master-Postgres-Servers an.
Sie führen die Installation auf 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.
Yum ist installiert.

Installation

Nachdem Sie das apigee-setup-Hilfsprogramm auf einem Edge-Knoten installiert haben, können Sie damit das Portal auf dem Knoten installieren. Das Dienstprogramm apigee-setup hat folgendes Format:

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p component -f configFile

Übergeben Sie dem Dienstprogramm apigee-setup eine Konfigurationsdatei mit den Informationen zur Installation. Wenn in der Konfigurationsdatei erforderliche Informationen fehlen, werden Sie vom Dienstprogramm apigee-setup aufgefordert, sie in der Befehlszeile einzugeben.

Die einzige Voraussetzung ist, dass der Nutzer „apigee“ auf die Konfigurationsdatei zugreifen oder sie lesen kann.

Verwenden Sie beispielsweise den folgenden Befehl, um das Portal zu installieren:

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p dp -f myConfig

Weitere Informationen finden Sie unter Installieren Sie das Hilfsprogramm für das Edge-Apigee-Setup.

Konfigurationsdatei erstellen

Unten sehen Sie ein Beispiel für eine stumme 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.

Hinweis:Legen Sie nicht DEVPORTAL_ADMIN_USERNAME=admin fest. Das Nutzerkonto admin wird standardmäßig erstellt. Andernfalls wird eine Fehlermeldung zurückgegeben, in der Sie aufgefordert werden, einen anderen Nutzernamen zu konfigurieren.

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=pWord 
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=pWord 

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

# You must configure the SMTP server used by the portal. 
# 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 

# Use SSL for SMTP: 'y' or 'n' (default). 
SMTPSSL="n" 

# 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=yourEmailPassword

1. Verbindung zu Apigee Edge testen

Testen Sie Ihre Verbindung zum Edge-Verwaltungsserver, indem Sie den folgenden cURL-Befehl über eine Eingabeaufforderung 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 Standardport, der von Edge verwendet wird. 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 dieser Befehl eine Antwort zurück, die in etwa so aussieht:

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

2. Versionen von PHP vor 7.0 entfernen

Das Installationsskript sucht vor Beginn der Installation auf dem System nach PHP-Versionen vor 7.0. Wenn PHP-Versionen vor 7.0 vorhanden sind, wird die folgende Warnung 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 unter CentOS und RedHat Enterprise Linux (RHEL) die PHP-Pakete mit dem folgenden Befehl:

yum remove <package-name>

3. Postgres installieren

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

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

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

So installieren Sie Postgres als eigenständige Version:

Installieren Sie das Edge-Hilfsprogramm apigee-setup auf dem Knoten über das Internet oder ohne Internetverbindung. Weitere Informationen finden Sie unter Edge-Apigee-Setup-Dienstprogramm installieren.
Erstellen Sie eine Konfigurationsdatei für Postgres, wie unten dargestellt:

# Der Pod und die Region von Postgres. Verwenden Sie die unten aufgeführten Standardwerte.
MP_POD=gateway
REGION=dc-1

# Legen Sie das Postgres-Passwort fest. Der Standardwert ist „postgres“.
PG_PWD=postgres
Führen Sie über die Eingabeaufforderung das Setup-Skript aus, um Postgres zu installieren:
> /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f configFile

Die Option „-p pdb“ gibt an, dass Postgres installiert werden soll.

Der Nutzer „apigee“ muss auf die Konfigurationsdatei zugreifen oder sie lesen können.

4. Portal installieren

So installieren Sie das Portal:

Installieren Sie das Edge-Hilfsprogramm apigee-setup auf dem Knoten über das Internet oder ohne Internetverbindung. Weitere Informationen finden Sie unter Installieren Sie das Hilfsprogramm für das Edge-Apigee-Setup.
Sie müssen Postgres installiert haben, entweder als eigenständige Version oder im Rahmen der Installation von Edge.
Führen Sie das Einrichtungsskript an der Eingabeaufforderung aus:
> /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

Mit der Option „-p dp“ wird die Installation des Portals angegeben.

Der Nutzer „apigee“ muss auf die Konfigurationsdatei zugreifen oder sie lesen können.
Rufen Sie die Startseite des Portals unter http://localhost:8079 oder den DNS-Namen Ihres Portals auf.
Melden Sie sich mit den Administratoranmeldedaten an, die Sie in der Konfigurationsdatei festgelegt haben.

5. Prüfen, ob das Modul „Update Manager“ aktiviert ist

Damit Sie Benachrichtigungen zu Drupal-Updates erhalten, muss das Modul „Drupal Update Manager“ aktiviert sein. Wählen Sie im Drupal-Menü Module aus und scrollen Sie nach unten zum Modul Update Manager. Aktivieren Sie sie, falls sie deaktiviert ist.

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 aus dem Stammverzeichnis der Website ausführen. Standardmäßig wird das Entwicklerportal unter /opt/apigee/apigee-drupal installiert. Daher sollten Sie zuerst das Verzeichnis zu /opt/apigee/apigee-drupal wechseln, bevor Sie den Befehl ausführen. Wenn Sie das Portal nicht im Standardverzeichnis installiert haben, wechseln Sie zu Ihrem Installationsverzeichnis.

Über das Menü Berichte > Verfügbare Updates > Einstellungen können Sie das Modul so konfigurieren, dass Sie per E-Mail benachrichtigt werden, wenn Updates verfügbar sind. Außerdem können Sie festlegen, wie oft nach Updates gesucht werden soll.

6. Apache Solr-Suchmaschine konfigurieren (optional)

Die Drupal-Module, die eine Verbindung zur Apache Solr-Suchmaschine herstellen, sind beim Installieren des Portals standardmäßig 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:

Melden Sie sich im Portal als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten an.
Wählen Sie im Drupal-Menü Module aus.
Aktivieren Sie das Modul Apache Solr Framework und das Modul Apache Solr Search.
Speichern Sie die Änderungen.
Konfigurieren Sie Solr wie unter https://drupal.org/node/1999280 beschrieben.

7. SmartDocs installieren (optional)

Mit SmartDocs können Sie Ihre APIs im Entwickler Services-Portal so dokumentieren, dass die API-Dokumentation interaktiv ist. Wenn Sie SmartDocs jedoch 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, muss SmartDocs auf Edge installiert sein. 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 Mit SmartDocs APIs dokumentieren.

8. Nächster Schritt

Nachdem Sie das Entwicklerdienste-Portal installiert haben, müssen Sie es konfigurieren und an Ihre spezifischen Anforderungen anpassen. Die Dokumentation auf der Apigee-Website enthält alle Informationen zum Konfigurieren, Stylen 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. Außerdem finden Sie Links zur Apigee-Dokumentation, in der Sie weitere Informationen erhalten:

Aufgabe	Beschreibung
Design anpassen	Das Design definiert die Darstellung des Portals, einschließlich der Farben, des Stils und anderer visueller Aspekte.
Darstellung anpassen	Die Startseite enthält das Hauptmenü, die Willkommensnachricht, die Kopf-, Fußzeile und den Titel.
Nutzerkonten hinzufügen und verwalten	Über den Registrierungsprozess wird festgelegt, wie neue Entwickler ein Konto im Portal registrieren. Erhalten neue Entwickler beispielsweise sofortigen Zugriff auf das Portal oder müssen sie von einem Administrator bestätigt werden? Dieser Prozess steuert auch, wie ein Portaladministrator benachrichtigt wird, wenn ein neues Konto erstellt wird.
E-Mails konfigurieren	Das Portal sendet E-Mails bei bestimmten Ereignissen. Beispielsweise, wenn sich ein neuer Entwickler im Portal registriert oder sein Passwort verliert.
Nutzerkonten hinzufügen und verwalten	Fügen Sie 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 festlegen.
Blog- und Forumsbeiträge hinzufügen	Das Portal bietet integrierte Unterstützung für Blogs und Foren mit Threads. Definieren Sie die Berechtigungen, die zum Ansehen, Hinzufügen, Bearbeiten und Löschen von Blog- und Forumsbeiträgen erforderlich sind.
Datenbanksicherungen durchführen	Sichern Sie die Drupal-Datenbank. Da jede Installation anders ist, müssen Sie selbst festlegen, wie die Datenbank am besten gesichert werden soll. Hinweis: Das Modul „Sichern und migrieren“ ist nicht mit Postgres-Datenbanken kompatibel. Weitere Informationen finden Sie unter Sicherung durchführen.
Hostnamen einrichten	Wenn Sie keinen Hostnamen in Ihrem DNS-Server einrichten, können Sie 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. Bei einer einfachen Einrichtung sollte es dann ohne weitere Konfiguration funktionieren. Wenn Sie einen Load-Balancer einrichten oder auf Ihrer Website aus einem anderen Grund falsche URLs erhalten, können Sie $base_url in der Datei settings.php des Entwicklerportals festlegen, die sich standardmäßig im Verzeichnis /opt/apigee/apigee-drupal/sites/default befindet.
Benutzerdefinierte Entwicklung	Sie können die Funktionen Ihres Portals auch mit benutzerdefiniertem Code außerhalb Ihres Designs erweitern. Erstellen Sie dazu ein eigenes Drupal-Modul wie in den Themen zur Modulentwicklung von Drupal beschrieben und legen Sie es im Verzeichnis `/sites/all/modules` ab.