Portal installieren

Edge for Private Cloud v4.19.01

Bevor Sie das Apigee Developer Services-Portal (oder einfach das Portal) installieren, müssen folgende Voraussetzungen erfüllt sein:

1. Sie installieren Postgres vor der Installation des Portals. 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 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.
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 vom Apigee Developer Services-Portal (oder einfach dem Portal) benötigt werden. Informationen zum Installieren anderer von Nutzern erstellter Module finden Sie unter Drupal 7 erweitern.

Installation

Führen Sie die folgenden Schritte aus, um das Portal zu installieren. Die einzelnen Schritte werden in den folgenden Abschnitten ausführlicher beschrieben.

1. Verbindung testen
2. Vorgängerversionen von PHP 7.0 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 des Attributs „SMTPSSL“

In früheren Releases haben Sie die Property SMTPSSL verwendet, um das Protokoll festzulegen, das vom SMTP-Server verwendet wird, der mit dem Portal verbunden ist. Dieses Attribut wird nicht mehr unterstützt.

Sie verwenden jetzt die Property SMTP_PROTOCOL anstelle der Property 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 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 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 möchten, 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.

Achten Sie darauf, den Hostnamen und die Portnummer für Ihre Edge-Installation anzugeben. 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.

Bei Erfolg gibt curl 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. Entfernen von PHP-Versionen vor 7.0

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

Im Portal wird die PHP-Version 4.18.01-0.0.49 verwendet. Diese Versionsnummer entspricht nicht der Versionsnummer von Apigee Edge for Private Cloud.

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 oder als eigenständige Installation für die 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:

1. Installieren Sie das Edge-apigee-setup-Dienstprogramm auf dem Knoten mithilfe des Internet- oder Nicht-Internet-Verfahrens. Weitere Informationen finden Sie unter Installieren Sie das Hilfsprogramm für das Edge-Apigee-Setup.
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 an der Eingabeaufforderung das Einrichtungsskript aus, um Postgres zu installieren:

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

   Die Option -p pdb gibt an, dass Postgre installiert werden soll. Der Nutzer „apigee“ muss auf die Konfigurationsdatei zugreifen oder sie lesen können.

4. Portal installieren

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

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

So installieren Sie das Portal:

1. Führen Sie an der Eingabeaufforderung das setup-Script 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-Script 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 mit den Administratoranmeldedaten an, die Sie in der Konfigurationsdatei des Portals 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 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 die Schaltfläche Verbindung testen. Wenn die Verbindung 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

      • Endpunktauthentifizierter Nutzer:Der Nutzername des Administrators der Organisation.
      • Passwort des authentifizierten Nutzers: Das Passwort des Administrators der Organisation.

      Die Standardwerte spiegeln die Einstellungen in Ihrer Portalkonfigurationsdatei wider, die Sie während der Installation erstellt haben.

      Diese Werte sollten mit den Werten 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 müssen auch mit den Werten der Eigenschaften 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 Verwaltungsserver hergestellt haben, klicken Sie unten auf der Seite auf die Schaltfläche Konfiguration speichern, um die Änderungen zu speichern.

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 das Menü 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 Portal unter /opt/apigee/apigee-drupal/wwwroot installiert. Sie sollten daher zuerst das Verzeichnis zu /opt/apigee/apigee-drupal/wwwroot wechseln, bevor Sie den Befehl ausführen. Wenn Sie das Portal nicht im Standardverzeichnis installiert haben, wechseln Sie in Ihr 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:

1. Melden Sie sich in Ihrem Portal als Nutzer mit Administratorberechtigungen oder Berechtigungen zum Erstellen von Inhalten an.
2. Wählen Sie im Drupal-Menü Module aus.
3. Aktivieren Sie die Module Apache Solr Framework und 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 wird. 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 Installation von Edge für die private Cloud 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.

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

8. Modul für JQuery-Aktualisierung für Installationen außerhalb des Internets konfigurieren (optional)

Wenn Sie das JQuery-Update-Modul in einer Installation ohne Internetverbindung 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 außerhalb des Internets verwendet wird, wird versucht, auf das CDN zuzugreifen, was zu Verzögerungen beim Laden der Seite führt. Weitere Informationen zum Modul „JQuery Update“ 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 im 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 in der Drop-down-Liste „CDN“ der JQuery- und JQuery-UI 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. 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ü, eine Begrüßungsnachricht, einen Header, einen Footer und einen Titel.
Nutzerkonten hinzufügen und verwalten	Der Registrierungsprozess steuert, 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? Außerdem wird damit festgelegt, wie ein Portal-Administrator benachrichtigt wird, wenn ein neues Konto erstellt wird.
E-Mail konfigurieren	Das Portal sendet E-Mails bei bestimmten Ereignissen. Das ist beispielsweise der Fall, wenn sich ein neuer Entwickler im Portal registriert und ein Entwickler 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 unterschiedlich ist, müssen Sie selbst entscheiden, wie Sie die Datenbank am besten sichern. Weitere Informationen finden Sie unter Sicherung durchführen.
Hostnamen einrichten	Wenn Sie keinen Hostnamen auf 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 aus einem anderen Grund falsche URLs auf Ihrer Website erhalten, können Sie $base_url für Drupal festlegen. Gehen Sie dazu so vor: Erstellen Sie das Verzeichnis /opt/apigee/data/apigee-drupal-devportal/sites/default/includes, falls es noch nicht vorhanden ist. Erstellen Sie in diesem Verzeichnis eine Datei mit dem Namen settings.php. 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’; Ändern Sie die letzte Zeile $base_url in den Hostnamen Ihrer Website. Speichern Sie die Datei. Sie können auch alle anderen Einstellungen aus /opt/apigee/data/apigee-drupal-devportal/ sites/default/default.settings.php in diese Datei einfügen. Weitere Informationen zum Attribut $base_url finden Sie unter: https://codeburst.io/security-for-drupal-and-related-server-software-3c979b041595 https://www.drupal.org/node/1992030
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 Drupal-Themen zur Modulentwicklung beschrieben und legen Sie es im Verzeichnis /sites/all/modules ab.