Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen
Apigee verwendet den Website-Verwaltungsdienst Pantheon, um cloudbasierte Versionen des Developer Services-Portals zu hosten. Pantheon ist so konzipiert, dass es mit Drupal zusammenarbeitet, damit Sie Ihr Portal in einer sicheren Umgebung entwickeln, testen und veröffentlichen können. Der Websiteverwaltungsdienst von Pantheon steht weltweit Kunden mit Hosting- und Entwicklungsanforderungen zur Verfügung.
In den folgenden Abschnitten wird beschrieben, wie Sie Pantheon zum Entwickeln und Verwalten Ihres Portals verwenden.
Auf das Pantheon-Dashboard zugreifen
Wenn Apigee Ihnen die URL Ihres Portals sendet, erhalten Sie auch die URL des Pantheon-Dashboards: https://dashboard.getpantheon.com/.
Wenn Sie sich zum ersten Mal im Pantheon-Dashboard anmelden, landen Sie auf der Seite Websites (siehe unten):
Über das Dashboard kannst du auf deine Website zugreifen, dein Konto konfigurieren und andere Aktionen ausführen.
Wählen Sie das Bild Ihrer Website aus (z. B. apigeedocs), um das Dashboard für diese Website zu öffnen:
Umgebungen verwalten
Auf dem Pantheon-Dashboard sind oben auf der Seite drei Umgebungen aufgeführt: Dev, Test und Live. Diese werden in der folgenden Tabelle beschrieben.
|
Environment |
Beschreibung |
|---|---|
|
Entwickler |
Die Dev-Umgebung ist mit Ihrem Git-Repository verbunden. Alle Änderungen, die Sie an Git übertragen, werden sofort in der Dev-Umgebung angezeigt. Die URL für diese Website hat das folgende Format, wobei org_name der Name Ihrer Organisation ist: http://dev-{org_name}.devportal.apigee.io/ |
|
Testen |
Die Test-Umgebung dient zum Testen des neuesten Codes mit einer Kopie der Daten aus der Live-Umgebung. In dieser Umgebung testen Sie Codeänderungen, bevor Sie sie in die Live-Umgebung übertragen. Die URL für diese Website hat das folgende Format, wobei org_name der Name Ihrer Organisation ist: http://test-{org_name}.devportal.apigee.io/ |
|
Live |
Die Live-Umgebung ist Ihre Produktionsumgebung, die Sie Ihren Kunden zugänglich machen. Die URL für diese Website hat das folgende Format, wobei org_name der Name Ihrer Organisation ist: http://live-{org_name}.devportal.apigee.io/ |
Portalinhalte entwickeln
In den folgenden Abschnitten wird beschrieben, wie Sie Ihre Portalinhalte entwickeln.
- Übersicht über das Git-Repository
- Zugriff auf den Code
- Code in Ihren Portalumgebungen bereitstellen
- Benutzerdefinierte Module und Designs hinzufügen
- Drupal-Profilmodule und -designs überschreiben
In den folgenden Abschnitten finden Sie weitere Informationen zum Anpassen des Portals.
|
Gewünschte Aktion |
Du kannst |
Weitere Informationen |
|---|---|---|
|
Design der Website ändern |
Einfach: Verwenden Sie den Menüeintrag Darstellung auf der Portalwebsite, um Änderungen vorzunehmen, z. B. am Logo und an den Farben der Website. |
Weitere Informationen findest du unter Darstellung anpassen: |
|
Erweitert – Erweitern Sie das Apigee Responsive-Theme, um das gesamte Design der Website anzupassen. |
Weitere Informationen finden Sie unter Design anpassen. |
|
|
Verhalten der Websitefunktionen ändern |
Einfach: Verwenden Sie die Administratoreinstellungen im Portal, um das Verhalten der Website zu ändern/konfigurieren. |
|
|
Erweitert: Erstellen Sie ein benutzerdefiniertes Modul, um das Verhalten der Website zu ändern. |
Siehe Benutzerdefinierte Module erstellen in der Drupal-Dokumentation |
Übersicht über das Git-Repository
Das Git-Repository für Ihren Drupal-Code enthält Ihren gesamten Portalcode und ist nach der folgenden Struktur strukturiert.
Hinweis: Ändern Sie nur Inhalte im Verzeichnis /sites/all. Wenn Sie Inhalte ändern, die sich außerhalb des Verzeichnisses /sites/all befinden, treten beim Upgrade auf neue Versionen Probleme auf. Außerdem können Zusammenführungskonflikte auftreten, wenn Änderungen in Git geprüft werden.
|
Ordner im Git-Repository |
Beschreibung |
|---|---|
/profiles/apigee |
Apigee hat unter anderem folgende Module und Themen gepflegt:
Hinweis: Ändern Sie keine Inhalte im Verzeichnis /profiles/apigee. Andernfalls treten beim Upgrade auf neue Versionen Probleme auf und beim Einchecken von Änderungen in Git kann es zu Zusammenführungskonflikten kommen. Best Practices für Drupal finden Sie unter Core nie hacken. |
/sites/all |
Deine benutzerdefinierten Drupal-Module und -Designs. Informationen zum Verwalten der Inhalte in diesem Ordner finden Sie unter Benutzerdefinierte Module und Designs hinzufügen und Drupal-Profilmodule und -Designs überschreiben. Hinweis: Bearbeiten Sie nur Inhalte im Verzeichnis /sites/all. |
Zugriff auf Ihren Code
Für den Zugriff auf Ihr Code-Repository in Git müssen Sie die in den folgenden Abschnitten beschriebenen Aufgaben ausführen:
Siehe auch Wie greife ich auf den Quellcode des Drupal 7-Entwicklerportals zu?
SSH-Zugriff auf Ihren Server aktivieren
Bevor Sie Ihren Drupal-Code mit Git verwalten können, müssen Sie SSH für den Zugriff auf Ihren Server aktivieren. Laden Sie dazu einen SSH-Schlüssel in Pantheon hoch.
So aktivieren Sie den SSH-Zugriff auf Ihren Server:
- Melden Sie sich unter https://dashboard.getpantheon.com/ in Pantheon an.
- Wählen Sie auf dem Dashboard Konto aus.
- Wähle im Menü auf der linken Seite SSH-Schlüssel aus.
- Fügen Sie Ihren Schlüssel hinzu und wählen Sie Schlüssel hinzufügen aus.
Wenn Sie Hilfe benötigen, wählen Sie den Link Weitere Informationen zum Generieren eines SSH-Schlüssels aus.
Auf Ihr Code-Repository in Git zugreifen
Hinweis: Eine Übersicht über die Struktur des Git-Repositorys finden Sie unter Übersicht über das Git-Repository.
So greifen Sie in Git auf Ihr Code-Repository zu:
- Melden Sie sich beim Pantheon-Dashboard an.
- Wählen Sie auf der Hauptseite von Google Sites das Symbol für Ihr Portal aus.
- Die URL des Git-Repositorys wird auf der Seite rechts neben Verbindungsmodus angezeigt, wie in der vorherigen Abbildung gezeigt.
- Kopieren Sie die URL Ihres Git-Repositorys und klonen Sie es mit dem folgenden Befehl in Ihre lokale Entwicklungsumgebung:
> git clone gitURL sitename
Beispiel:
> git clone ssh://codeserver.dev.12@codeserver.dev.12.drush.in:2222/~/repository.git devportal
Alle Codeänderungen, die Sie per Push an das Git-Repository übertragen, werden sofort in der Dev-Umgebung Ihres Portals angezeigt.
Code in Portalumgebungen bereitstellen
So programmieren Sie für Ihre Portalumgebungen:
- Übertragen Sie Ihre Codeaktualisierungen in Git, das die Dev-Umgebung sofort aktualisiert.
- Melden Sie sich in Pantheon an und wählen Sie Ihre Website aus.
- Wählen Sie die Umgebung Dev aus.
- Wählen Sie im Menü auf der linken Seite </>Code aus, um eine Nachricht über Ihre Codeänderung im Commit-Log aufzurufen:
- Wählen Sie oben auf der Seite die Umgebung Test aus.
- Wenn Sie Dev noch nicht in Test hochgeladen haben, werden Sie jetzt dazu aufgefordert.
- Wenn Sie bereits eine Test-Umgebung haben, wird eine Meldung mit dem Hinweis angezeigt, dass ein Commit von Dev zur Bereitstellung bereit ist:
- Wenn Sie eine Website bereits in die Live-Umgebung hochgeladen haben, können Sie optional das dritte Kästchen anklicken, um die Live-Datenbank und alle von Entwicklern hochgeladenen Dateien von Live nach Test zu kopieren. Dies ist nützlich, wenn du deine Codeänderungen mit den neuesten in Live verfügbaren Daten testen möchtest.
- Wählen Sie die Schaltfläche Deploy Code from Development (Code aus Entwicklung bereitstellen) aus.
- Testen Sie das Portal in der Test-Umgebung.
- Nehmen Sie Codekorrekturen in der Dev-Umgebung vor und übertragen Sie die Dateien zu Testzwecken noch einmal an Test.
- Wählen Sie nach Abschluss der Tests oben auf der Seite die Live-Umgebung aus.
- Wenn Sie den Test noch nicht in Live hochgeladen haben, werden Sie jetzt dazu aufgefordert.
- Wenn Sie bereits eine Live-Umgebung haben, wird in einer Meldung darauf hingewiesen, dass ein Commit von Test zur Bereitstellung bereit ist. Stellen Sie diese Änderungen auf die gleiche Weise bereit, wie Sie sie für Test von Dev bereitgestellt haben. Wenn Sie mit dem Testen fertig sind, übertragen Sie den Code in die Live-Umgebung.
Weitere Informationen:
- Pantheon stellt eine Reihe von Artikeln zur Veröffentlichung zu diesem Prozess bereit, die du dir ansehen kannst. Einer der wichtigsten Punkte ist der Artikel Der Pantheon-Workflow verwenden. Hier erhältst du einen Überblick darüber, wie du deine Website entwickeln, testen und veröffentlichen kannst.
Benutzerdefinierte Module und Designs hinzufügen
Sie können die Funktionen des Portals erweitern, indem Sie den in der folgenden Tabelle aufgeführten Ordnern Ihre eigenen benutzerdefinierten Module und Designs hinzufügen.
Hinweis: Bearbeiten Sie nur Inhalte im Verzeichnis /sites/all. Wenn Sie Inhalte ändern, die sich außerhalb des Verzeichnisses /sites/all befinden, kann es beim Prüfen von Änderungen in Git zu Zusammenführungskonflikten kommen.
| Modul/Thema | Ordner im Git-Repository | Weitere Informationen (Dokumentation zu Drupal) |
| Benutzerdefinierte Module | sites/all/modules/custom |
Benutzerdefinierte Module erstellen |
| Benutzerdefinierte Designs | sites/all/themes |
Design anpassen Drupal 7 als Theme festlegen |
Nachdem Sie das benutzerdefinierte Modul oder Design in der Dev-Umgebung hinzugefügt haben, können Sie es zu Testzwecken in der Testumgebung und dann in der Live-Umgebung für die Produktion bereitstellen, wie unter Code in Portalumgebungen bereitstellen beschrieben.
Drupal-Profilmodule und -designs überschreiben
Die Module und Designs in den folgenden Verzeichnissen überschreiben die von Apigee in /profiles/apigee verwalteten und verteilten Drupal-Profilmodule und Themen.
Siehe Übersicht über Ihr Git-Repository.
Sie können beispielsweise in den folgenden Szenarien ein Modul in der Apigee Drupal-Distribution überschreiben:
- Sie möchten eine andere Version eines bestimmten Moduls verwenden.
- Sie möchten vor dem nächsten geplanten Apigee-Release ein Sicherheitsupdate implementieren.
| Modul/Thema | Ordner im Git-Repository | Weitere Informationen (Dokumentation zu Drupal) |
| Von Drupal unterstützte Module |
Hinweis: Module, die an einer beliebigen Stelle unter |
Bereitgestellte Module
Hinweis: Drupal-Module in diesem Verzeichnis überschreiben äquivalente Module, die von Apigee in |
| Von Drupal unterstützte Designs | sites/all/themes |
Eingereichte Themen
Hinweis: Von Drupal bereitgestellte Themen in diesem Verzeichnis überschreiben äquivalente Module, die von Apigee in |
Informationen zur Datei settings.php
Das Drupal settings.php wird dem vorgelagerten Git-Repository von Apigee Drupal Developer Portal zugewiesen. Wenn Sie Änderungen an der Datei sites/default/settings.php vornehmen möchten, bearbeiten Sie die Datei nicht direkt.
Erstellen Sie stattdessen eine Datei mit dem Namen sites/default/settings.local.php und platzieren Sie dort Ihren benutzerdefinierten Code. sites/default/settings.local.php ist in der Datei settings.php enthalten.
Wenn Sie beispielsweise eine benutzerdefinierte Domain für eine Live-Website mit der Anleitung von Pantheon einrichten, anstatt die Datei settings.php direkt zu ändern, fügen Sie die erforderlichen Aktualisierungen in sites/default/settings.local.php hinzu.
Absicherung Ihres Portals
Die mit der Dev-, Test- und Live-Umgebung verknüpften Portalwebsites sind standardmäßig öffentlich zugänglich. Das bedeutet, dass jeder, der die URL der Website kennt, auf die Website zugreifen kann, aber möglicherweise kein Konto registrieren oder sich nicht bei der Website anmelden kann. Weitere Informationen zum Steuern der Nutzerregistrierung finden Sie unter Nutzerkonten hinzufügen und verwalten.
Sie möchten wahrscheinlich Ihre Dev- und Test-Website vor der Öffentlichkeit verbergen und Ihre Live-Website ausblenden, bis die Entwicklung abgeschlossen ist. Mit Pantheon können Sie die Steuerung von Nutzername/Passwort hinzufügen, um eine Website zu sperren, sodass nur Personen mit den entsprechenden Anmeldedaten darauf zugreifen können.
Fügen Sie einer der drei Umgebungen eine Sperre hinzu, indem Sie im linken Menü der Umgebung Sicherheit auswählen. Weitere Informationen finden Sie unter Website sperren.
Wie Sie TLS/SSL für Ihre Website aktivieren, erfahren Sie unter TLS im Portal verwenden.
Apigee-Update auf Ihr Portal anwenden
Wenn Apigee einen neuen Release des Portals veröffentlicht, wird im Pantheon-Dashboard eine Nachricht angezeigt.
Normalerweise wenden Sie das Update auf die Dev-Umgebung an und testen dann diese Änderungen auf dieselbe Weise wie Ihre eigenen Codeänderungen. Übertragen Sie beispielsweise die Dev-Umgebung auf Test, übertragen Sie die Live-Daten von Live nach Test und testen Sie dann das Update.
So wenden Sie ein Update an:
- Melden Sie sich unter https://dashboard.getpantheon.com/ in Pantheon an und wählen Sie Ihre Website aus.
- Wählen Sie die Umgebung Dev aus.
- Wählen Sie links den Menüeintrag </>Code aus. Wenn Apigee-Updates verfügbar sind, werden diese aufgeführt.
- Wenden Sie das Update an:
-
Klicken Sie das Kästchen Update.php nach dem Abrufen von Code ausführen an.
-
Klicken Sie gegebenenfalls das Kästchen Caches nach Abruf von Code löschen an.
-
Wählen Sie die Schaltfläche Deploy Code (Code bereitstellen) aus.
-
- Wählen Sie nach Abschluss der Aktualisierung links im Dashboard den Menüpunkt Status aus.
- Im Bereich Status einer Umgebung sehen Sie möglicherweise einen Fehler für eine Datenbankaktualisierung, wie unten dargestellt:
Wenn dieser Fehler in einer Umgebung auftritt, aktualisieren Sie die Datenbank manuell:
- Melden Sie sich in Ihrem Portal als Nutzer mit Administrator- oder Berechtigungen zum Erstellen von Inhalten an.
- Wählen Sie oben links im Portal das Symbol für die Startseite > Updates ausführen aus.
- Folgen Sie der Anleitung, um Ihre Datenbank zu aktualisieren.
- Übertragen Sie die Codeänderungen per Push in die Test-Umgebung und übertragen Sie sie dann wie oben beschrieben an Live.
Benutzerdefinierte Features migrieren
Wenn Sie dem Portal benutzerdefinierten Code oder Features hinzufügen, müssen Sie entscheiden, wie Sie diese verwalten und von der Dev- in die Test- in die Live-Umgebung verschieben möchten.
Für Code im Git-Repository können Sie den unter Code in den Portalumgebungen bereitstellen beschriebenen Prozess verwenden, um den Code von Dev, Test und Live zu migrieren.
Wenn Sie benutzerdefinierte Konfigurationen erstellt haben, verwenden Sie eine der folgenden Methoden, um diese zu migrieren:
| Methode | Beschreibung |
| Konfiguration in Code exportieren | Viele gängige Konfigurationen lassen sich mithilfe des Moduls „Features“ in Code exportieren. Zum Beispiel Ansichten, Felder, Bild-Cache usw. |
Funktion hook_update_N() implementieren |
Drupal verwaltet Datenbank- und Konfigurationsänderungen mit der Funktion hook_update_N().
Mit einem benutzerdefinierten Modul haben Sie folgende Möglichkeiten:
|
Unter Pantheon-Workflow verwenden erhalten Sie einen Überblick darüber, wie Sie Ihre Website entwickeln, testen und veröffentlichen. Dieser Artikel enthält auch den Abschnitt zur Konfigurationsverwaltung.
Benutzerdefinierte Domain konfigurieren
Die von Apigee für ein Portal bereitgestellten Domainnamen sind standardmäßig apigee.io, wie unter Umgebungen verwalten beschrieben. Dies sind möglicherweise nicht die Domainnamen, die Sie Ihren Kunden zur Verfügung stellen möchten.
Kostenpflichtige Portalpläne können einen benutzerdefinierten Domainnamen für das Portal konfigurieren (Entwicklerkonten oder kostenlose Konten können keine benutzerdefinierte Domain erstellen). Erstellen Sie einen CNAME in Ihrem DNS und verweisen Sie Ihre Domain auf edge.apigee.getpantheon.com, um eine benutzerdefinierte Domain zu verwenden.
So konfigurieren Sie beispielsweise die benutzerdefinierte Domain für ein Unternehmen namens Mytech:
- Konfigurieren Sie die folgende DNS-Einstellung:
developer.mytech.com. 3600 IN CNAME Edge.apigee.getpantheon.com
Es kann bis zu 48 Stunden dauern, bis diese DNS-Änderung für alle Clientgeräte wirksam wird. - Verwenden Sie den Menüeintrag Domains / SSL auf der linken Seite des Dashboards, um diese Domain nur für die Live-Umgebung zu Ihrem Pantheon-Dashboard hinzuzufügen.
In den meisten Fällen konfigurieren Sie das DNS nur für die Live-Umgebung, nicht für Dev und Test. Sie sollten die Dev- oder Test-Umgebung nicht für die Produktion verwenden.
Weitere Informationen finden Sie in der Pantheon-Dokumentation.
Portaladministratoren hinzufügen
Wenn Sie die E-Mail von Apigee erhalten, dass Ihr Portal bereit ist, hat Apigee bereits die Liste der Portaladministratoren konfiguriert. Sie können die Liste aufrufen, indem Sie oben rechts im Website-Dashboard den Link Team auswählen.
Informationen zum Hinzufügen zusätzlicher Administratoren finden Sie unter Administratoren erstellen.
Sichern Ihres Portals
Verwenden Sie zum Sichern Ihres Portals den Tab Sicherungen im Pantheon-Dashboard. Sie können eine On-Demand- oder automatische Sicherung erstellen. In Pantheon besteht eine Sicherung aus drei separaten Archiven: Datenbank, Dateien und Code.
Weitere Informationen finden Sie in der Pantheon-Dokumentation unter Tool für Sicherungen.
Statusupdates abonnieren
Sie können Apigee-Release- und -Statusupdates unter status.apigee.com abonnieren. Klicken Sie auf Subscribe to Updates, geben Sie Ihre Kontaktdaten wie z. B. Ihre E-Mail-Adresse ein, wenn Sie dazu aufgefordert werden, und klicken Sie auf Abonnieren. Prüfen Sie auf der Seite zur Verwaltung von E-Mail-Benachrichtigungen, ob Entwicklerportal ausgewählt ist. Ändern Sie nach Bedarf andere Benachrichtigungseinstellungen und klicken Sie auf Einstellungen aktualisieren.
Sie können unter http://status.getpantheon.com Pantheon-Statusupdates und Vorfallberichte abonnieren, beispielsweise wenn ein Ausfall auftritt. Klicken Sie auf Subscribe to Updates, um sich anzumelden.