Installation von Entwicklerdiensten im Portal

Edge for Private Cloud Version 4.17.09

Prüfen Sie vor der Installation Folgendes:

  • Sie installieren Postgres vor der Installation des Portals. Sie können Postgres entweder als Teil oder Postgres zur Verwendung durch das Portal installieren.
    • Wenn Sie die eigenständige Version von Postgres installieren, kann es sich auf demselben Knoten wie das Portal befinden.
    • Wenn Sie eine Verbindung zu Postgres herstellen, das als Teil von Edge installiert wurde, und Postgres konfiguriert ist Geben Sie im Master/Standby-Modus die IP-Adresse des Master-Postgres-Servers an.
  • Du führst die Installation mit der 64-Bit-Version einer unterstützten Version von Red Hat durch. Enterprise Linux, CentOS oder Oracle. Eine Liste der unterstützten Versionen finden Sie unter Unterstützte Software und unterstützte Versionen.
  • Yum ist installiert.

Das Installationsprogramm enthält nur von Drupal bereitgestellte Module, die für die Apigee Developer Services-Portal (oder einfach das Portal). Informationen zum Installieren weiterer Module finden Sie unter Verlängerung von Drupal 7

Installation

Nachdem Sie das Edge-Dienstprogramm apigee-setup auf einem Knoten installiert haben, um das Portal auf dem Knoten zu installieren. Das Dienstprogramm apigee-setup hat die Form:

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

Übergeben Sie eine Konfigurationsdatei an das Dienstprogramm apigee-setup, das die Informationen zur Installation. Wenn in der Konfigurationsdatei erforderliche Informationen, das Apigee-Setup werden Sie aufgefordert, sie in die Befehlszeile einzugeben.

Die einzige Anforderung besteht darin, dass die Konfigurationsdatei für den Nutzer „Apigee“ Nutzer.

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

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

Siehe Edge-Apigee-Setup-Dienstprogramm installieren finden Sie weitere Informationen.

Konfigurationsdatei erstellen

Unten sehen Sie ein Beispiel für eine Konfigurationsdatei im Hintergrund für eine Portalinstallation. Diese Datei bearbeiten 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=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 ausführen über eine Eingabeaufforderung auf dem Portalserver:

> 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 steht EMAIL und PASSWORD für die E-Mail-Adresse. E-Mail-Adresse und Passwort des Administrators für ORGNAME.

Achten Sie darauf, den Hostnamen und die Portnummer für Ihre Edge-Installation anzugeben. Port 8080 ist der von Edge standardmäßig verwendete Port. Wenn Sie eine Verbindung zu einer Organisation in der Cloud herstellen, dann lautet die Anfrage-URL: https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}.

Bei Erfolg gibt dieser Befehl eine Antwort wie diese 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 PHP-Versionen vor 7.0

Das Installationsskript sucht auf dem System nach PHP-Versionen vor 7.0, bevor das Installation. Wenn ältere PHP-Versionen als 7.0 vorliegen, 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>

3. Postgres installieren

Für das Portal muss Postgres installiert sein, bevor Sie das Portal installieren können. Sie haben folgende Möglichkeiten: Postgres im Rahmen der Installation von Edge installieren oder Postgres eigenständig zur Verwendung durch die

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

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

So installieren Sie die eigenständige Postgres-App:

  1. Installieren Sie das Edge-Dienstprogramm apigee-setup auf dem Knoten mithilfe der Verfahren außerhalb des Internets. Siehe Installieren des Edge-Apigee-Setup-Dienstprogramms für mehr.
  2. Erstellen Sie eine Konfigurationsdatei für Postgres, wie unten gezeigt:

    # Muss in IP-Adresse oder DNS aufgelöst werden Name des Hosts – nicht auf 127.0.0.1 oder localhost.
    HOSTIP=$(Hostname -i)

    # 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
  3. Führen Sie in der Eingabeaufforderung das Setupskript aus, um Postgres zu installieren:
    &gt; /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f configFile

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

    Die Konfigurationsdatei muss vom „Apigee“ zugänglich oder lesbar sein Nutzer.

4. Portal installieren

So installieren Sie das Portal:

  1. Installieren Sie das Edge-Dienstprogramm apigee-setup auf mit dem Internet oder Nicht-Internet. Siehe Installieren des Edge-Apigee-Setup-Dienstprogramms für mehr.
  2. Stellen Sie sicher, dass Sie Postgres installiert haben, entweder als eigenständiges Produkt oder als Teil wenn Sie Edge installieren.
  3. Führen Sie in der Eingabeaufforderung das Setupskript aus:
    &gt; /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

    Die Option „-p dp“ gibt an, dass das Portal installiert werden soll.

    Die Konfigurationsdatei muss vom „Apigee“ zugänglich oder lesbar sein Nutzer.
  4. Gehen Sie zur Startseite des Portals unter http://localhost:8079 oder zum DNS-Namen von Ihr Portal.
  5. Melden Sie sich mit den Administratoranmeldedaten, die Sie in der Konfigurationsdatei festgelegt haben, im Portal an. um sicherzustellen, dass das Portal ordnungsgemäß funktioniert.
  6. Wählen Sie Berichte > Statusbericht im Drupal-Menü, um sicherzustellen, können Sie den aktuellen Status des Portals sehen.

5. Stellen Sie sicher, dass das Update-Manager-Modul aktiviert

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

Nach der Aktivierung können Sie die verfügbaren Updates über die Schaltfläche Berichte > Verfügbar Updates. Sie können auch den folgenden Drush-Befehl verwenden:

> drush pm-info update

Sie müssen diesen Befehl vom Stammverzeichnis der Website ausführen. Standardmäßig weist der Entwickler Das Portal ist unter /opt/apigee/apigee-drupal/wwwroot installiert. Dementsprechend wird Sie sollten das Verzeichnis zuerst in /opt/apigee/apigee-drupal/wwwroot ändern, bevor Sie das Verzeichnis verwenden. und führen den Befehl aus. Wenn Sie das Portal nicht im Standardverzeichnis installiert haben, wechseln Sie zu Ihrem .

Verwenden Sie den Tab Berichte > Verfügbare Updates > Menüpunkt für Einstellungen, der konfiguriert werden soll das Modul, um Sie per E-Mail zu informieren, wenn Updates verfügbar sind, und um festzulegen, wie oft nach Updates gesucht werden soll. Aktualisierungen.

6. Apache Solr-Suchmaschine konfigurieren Optional:

Standardmäßig sind die Drupal-Module, die eine Verbindung zur Apache Solr-Suchmaschine herstellen, deaktiviert, wenn installieren Sie das Portal. Die meisten Portale nutzen die interne Drupal-Suchmaschine und verwenden daher die Drupal Solr-Module benötigen.

Wenn Sie Solr als Suchmaschine verwenden möchten, müssen Sie Solr lokal auf Ihrem Server installieren. Aktivieren und konfigurieren Sie dann die Drupal Solr-Module im Portal.

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 Modules im Drupal-Menü aus.
  3. Modul Apache Solr Framework und Apache Solr aktivieren Search-Modul.
  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 Developer Services-Portal so dokumentieren, dass das Die API-Dokumentation ist vollständig interaktiv. Wenn Sie SmartDocs mit dem Portal verwenden möchten, müssen Sie jedoch zuerst und installieren Sie SmartDocs in Edge.

  • Wenn Sie das Portal mit einer Edge Cloud-Installation verbinden, wird 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 sicherstellen, 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 Verwenden von SmartDocs zur Dokumentation APIs

8. Konfigurieren Sie die JQuery-Update-Modul für Installationen außerhalb des Internets (optional)

Wenn Sie das JQuery Update-Modul in einer Installation außerhalb des Internets installieren und verwenden, müssen Sie Konfigurieren Sie das Modul für die Verwendung der lokalen Version von JQuery. Wenn Sie das Modul für die Verwendung eines CDN konfigurieren Bei einer Installation außerhalb des Internets wird versucht, auf das CDN zuzugreifen, und es kommt zu Verzögerungen wird geladen. 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 in Ihrem Portal als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten an.
  2. Wählen Sie Konfiguration > Entwicklung > JQuery Update im Drupal-Menü.
  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ächster Schritt

Die nächsten Schritte nach der Installation des Developer Services-Portals sind die Konfiguration und Anpassung 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. und enthält Links zur Apigee-Dokumentation, in der Sie weitere Informationen finden:

Aufgabe Beschreibung

Design anpassen

Das Design definiert das Aussehen des Portals, einschließlich Farben, Stilen und anderen visuelle Aspekte zu berücksichtigen.

Passen Sie die Aussehen

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

Hinzufügen und Nutzerkonten verwalten

Der Registrierungsprozess bestimmt, wie neue Entwickler ein Konto auf der Erhalten z. B. neue Entwickler sofortigen Zugriff auf das Portal oder geben sie müssen von einem Administrator überprüft werden. Dieser Prozess steuert auch, wie ein Portal -Administrator wird benachrichtigt, wenn ein neues Konto erstellt wird.

Konfigurieren E-Mail

Das Portal sendet E-Mails als Reaktion auf bestimmte Ereignisse. Wenn z. B. eine neue sich im Portal registriert und wenn ein Entwickler sein Passwort verliert.

Hinzufügen und Nutzerkonten verwalten

Bedingungen und hinzufügen Seite mit Bedingungen, die Entwickler akzeptieren müssen, bevor sie dürfen auf das Portal zugreifen können.

Hinzufügen und Nutzerkonten verwalten

Das Portal implementiert ein rollenbasiertes Autorisierungsmodell. Bevor Entwickler Registrieren Sie die vom Portal verwendeten Berechtigungen und Rollen.

Blog hinzufügen und Forenbeiträge

Das Portal unterstützt Blogs und Foren mit Threads. Berechtigungen definieren erforderlich, um Blog- und Forenbeiträge anzusehen, hinzuzufügen, zu bearbeiten und zu löschen.

Achten Sie darauf, dass Sie Datenbanksicherungen ausführen

Stellen Sie sicher, dass Sie die Drupal-Datenbank sichern. Da jedes die Installation unterschiedlich ist, müssen Sie selbst entscheiden, Datenbank.

Hinweis: Das Modul „Back-up & Migrate“ ist nicht mit Postgres kompatibel. Datenbanken.

Weitere Informationen finden Sie unter Portal sichern.

Hostnamen einrichten

Wenn Sie keinen Hostnamen in Ihrem DNS-Server einrichten, können Sie die Website jederzeit über die IP-Adresse des Servers. Wenn Sie einen Hostnamen verwenden möchten, können Sie DNS für was ohne weitere Konfiguration in einer grundlegenden Konfiguration problemlos funktionieren sollte.

Wenn Sie ein Lastenausgleichsmodul einrichten oder für einige aus anderen Gründen können Sie $base_url in der folgenden Datei festlegen:

/opt/apigee/apigee-drupal-devportal-opdk_version/source/conf/settings.php

Dieser Wert wird überschrieben, wenn Sie das Portal aktualisieren.

Benutzerdefinierte Entwicklung Sie können die Funktionen Ihres Portals auch durch benutzerdefinierten Code außerhalb Ihres aus. Erstellen Sie dazu Ihr eigenes Drupal-Modul, wie im Drupal-Modul beschrieben. Themen für die Entwicklung und platzieren Sie das Modul im /sites/all/modules. -Verzeichnis.