Info zum Konfigurieren einer CI/CD-Pipeline

Rufen Sie zuerst die API ab. Sie sollten mindestens ihre Endpunkte definieren und das scaffold herunterladen, das OMC für Sie generiert. Das scaffold stellt eine minimale Anwendung dar, mit der Sie sicherstellen können, dass Ihr CI/CD-Prozess ordnungsgemäß funktioniert, bevor Sie den Code für Ihre benutzerdefinierte API weiter verwenden und schreiben und testen.

Wenn Ihre API bereit ist und Sie erfolgreich Änderungen an das Git-Repository in Ihrem Developer Cloud Service-Projekt übertragen können, ist es Zeit, CI/CD für das Projekt einzurichten.

API in Oracle Mobile Hub einrichten

Erstellen Sie ein API-scaffold, indem Sie die REST-Endpunkte definieren, mit denen Ihre Apps verbunden sind. Nachdem Sie das scaffold abgeschlossen haben, können Sie seine Definition herunterladen, um es als Ausgangspunkt für Ihren API-Code zu verwenden.

Beim Definieren der HTTP-Methoden für Ihre Endpunkte können Sie Beispielantworten hinzufügen. Es sind keine Beispielantworten erforderlich, da Sie später Code schreiben, der die tatsächlichen Antworten bereitstellt. Möglicherweise möchten Sie jedoch einige Beispielantworten für das Testen der API eingeben, bevor Ihr benutzerdefinierter Code bereit ist.

  1. Melden Sie sich bei Oracle Mobile Hub an, und öffnen Sie den Navigationsbereich.
  2. Klicken Sie im Navigationsbereich im Bereich "Anwendungen " auf APIs .
  3. Klicken Sie auf Neue API, und klicken Sie im geöffneten Menü auf API.
    Das Fenster Neue API wird geöffnet.
  4. Geben Sie im Feld API-Anzeigename und im Feld API-Name einen geeigneten Namen für die API ein.
  5. Geben Sie im Feld Kurzbeschreibung eine geeignete Beschreibung ein.
  6. Wenn Sie ein RAML-Dokument für Ihre API haben, laden Sie es hier hoch.
  7. Klicken Sie auf Erstellen , und die Seite für die neue API wird geöffnet.
  8. Fügen Sie HTTP-Ressourcen hinzu. Wenn Sie ein RAML-Dokument hochgeladen haben, können Sie diesen Schritt überspringen.
    1. Klicken Sie auf Endpunkte und anschließend auf Neue Ressource , um den ersten Endpunkt zu erstellen und die zugehörigen HTTP-Methoden zu definieren.
    2. Setzen Sie die Definition der Endpunkte und HTTP-Methoden für die API fort, bis alle Endpunkte definiert sind.
  9. Klicken Sie auf Speichern .

Backend einrichten

Erstellen Sie das Backend, das Ihre API verwendet. Das Backend leitet Anforderungen von Ihren Apps an die API weiter und stellt Authentifizierungsservices bereit.

  1. Klicken Sie im Oracle Mobile Hub-Navigationsbereich auf Backends , um die Seite "Backends " zu öffnen.
  2. Klicken Sie auf Neues Backend , und geben Sie in dem daraufhin geöffneten Fenster einen entsprechenden Namen in das Feld Name ein. Klicken Sie dann auf Erstellen .
    Die Backend-Konfigurationsseite wird geöffnet. Sie verfügt über einen eigenen Navigationsbereich, der auf der Seite "Einstellungen " geöffnet wird.
  3. Klicken Sie im Navigationsbereich für die Konfigurationsseite auf APIs , und klicken Sie auf der daraufhin geöffneten Seite auf APIs auswählen. Dadurch wird der API-Katalog geöffnet.
  4. Suchen Sie im Katalog die Karte für die von Ihnen erstellte API, und klicken Sie auf die Schaltfläche + . Dadurch wird diese API mit diesem Backend verknüpft.

Informationen zu Backend- und Instanzdetails aufzeichnen

Erfassen Sie Informationen, die Sie bei der Konfiguration des Entwicklungstools benötigen.

Die Informationen werden in einer Datei namens toolsConfig.json verwendet und sind zur Authentifizierung erforderlich. Mit ihr kann ein Skript eine Verbindung zu Oracle Mobile Hub herstellen und Code-Artefakte damit bereitstellen.

  1. Klicken Sie im Oracle Mobile Hub-Navigationsbereich auf Backends , um die Seite "Backends " zu öffnen.
  2. Wählen Sie das Backend, und klicken Sie auf Öffnen .
  3. Klicken Sie im Navigationsbereich auf Einstellungen .
  4. Notieren Sie die folgenden Informationen, und kopieren Sie sie in eine Textdatei oder an eine andere Stelle, an der Sie sie später problemlos abrufen können:
    • Client-ID
    • Client Secret
    • Backend-ID
    • Backend-Name
    • Backend-Version
    • Anonymer Schlüssel
  5. Klicken Sie im Navigationsbereich auf Entwicklung , um die Hauptseite zu öffnen. Danach klicken Sie auf Instanzdetails , um den Fensterbereich "Instanzdetails " zu öffnen.
  6. Folgende Informationen aufzeichnen und die Backend-Informationen beibehalten, die Sie im vorherigen Schritt aufgezeichnet haben:
    • Client-ID des Teammitglieds
    • Client Secret von Teammitglieds-App

Projekt in Oracle Developer Cloud Service einrichten

Erstellen Sie ein Projekt, das ein Git-Repository enthält. Später konfigurieren Sie das Projekt so, dass es erstellt wird, wenn Sie einen Commit an das Repository übertragen.

Projekt erstellen

Erstellen Sie ein Projekt, das ein Git-Repository enthält.

  1. Melden Sie sich bei der Oracle Developer Cloud Service-Konsole an, und klicken Sie auf Neues Projekt .
  2. Geben Sie auf der Seite Projektdetails einen Namen für das Projekt ein, und klicken Sie auf Weiter .
  3. Wählen Sie auf der Seite Vorlage die Option Anfängliches Repository , und klicken Sie auf Weiter .
  4. Übernehmen Sie auf der Seite "Projekteigenschaften " die Standardwerte, und klicken Sie auf Fertigstellen , um den Provisioning-Prozess zu starten.

Nachdem das Projekt bereitgestellt wurde, sollte Ihr Bildschirm dem folgenden Bild ähneln:


Projektübersichtsseite

Git-Repository klonen und konfigurieren

Klonen Sie das Repository in Ihrem lokalen Entwicklungssystem.

  1. Melden Sie sich bei Oracle Developer Cloud Service an, und navigieren Sie zur Projektseite.
  2. Kopieren Sie die HTTP-Adresse aus dem Feld für das Repository für Git.
  3. Öffnen Sie ein Terminalfenster (unter Linux oder Mac) oder das Git-Bash-Terminal (unter Windows), und erstellen Sie ein neues Verzeichnis an einem geeigneten Ort auf Ihrer Festplatte. Verwenden Sie einen Namen für das Verzeichnis, das für Ihr Projekt geeignet ist.
     mkdir <your-directory-name>
  4. Wechseln Sie zum Verzeichnis, und klonen Sie das Repository, und ersetzen Sie die Repository-Adresse im Beispiel durch eine eigene.
    cd <your-directory-name>
    git clone <your-repo-url>

    Wenn Sie zur Eingabe eines Kennworts aufgefordert werden, verwenden Sie das Kennwort, das Sie zur Anmeldung bei Oracle Developer Cloud Service verwenden.

  5. Wechseln Sie zu dem Verzeichnis, das von dem Cloning-Prozess erstellt wurde.
    cd <your-directory-name>
  6. Legen Sie Ihren Namen und Ihre E-Mail-Adresse für dieses Projekt fest, und konfigurieren Sie Git zur Speicherung Ihrer Zugangsdaten.
    git config user.name "<your-name>"
    git config user.email "<your-email-address>"
    git config credential.helper store

Neuen Build-Job erstellen

Erstellen Sie einen Job, der jedes Mal ausgeführt wird, wenn Sie Code in das Git-Repository des Projekts übertragen.

  1. Melden Sie sich bei Oracle Developer Cloud Service an, und navigieren Sie zur Projektseite.
  2. Klicken Sie im Navigationsbereich auf Erstellen , und klicken Sie auf der Seite, die geöffnet wird, auf Neuer Job .
  3. Geben Sie einen Namen ein, und wählen Sie eine Softwarevorlage, und klicken Sie dann auf Job erstellen.
  4. Klicken Sie auf Versionskontrolle hinzufügen , und wählen Sie Git .
  5. Wählen Sie In der Dropdown-Liste Repository das gewünschte Git-Repository aus.
  6. Optional: Wenn Sie der einzige Entwickler sind, der Code in das Repository überträgt, wählen Sie Build bei SCM Commit automatisch ausführen aus.

    Wenn mehrere Personen am Projekt arbeiten und Code in das Repository pushen, wählen Sie diese Option nicht. Sie können stattdessen einen SCM-Polling-Trigger einrichten, den Sie nach dem Erstellen des Build-Jobs ausführen können.

  7. Klicken Sie auf Speichern .

SCM-Polling-Trigger konfigurieren

Sie können eine Abstimmung einrichten, die nach Änderungen am Git-Repository in einem von Ihnen definierten Zeitplan prüft. Wenn Änderungen ermittelt werden, wird ein Build gestartet.

Wenn Sie nur der Entwickler sind, der Code in das Repository überträgt, ist wahrscheinlich ein sofortiges Build geeignet. Wenn jedoch mehrere Personen Code anstoßen, können Sie einen Polling-Trigger einrichten, der regelmäßig auf Änderungen im Repository prüft, bevor Sie einen Build starten.

Um den SCM-Polling-Trigger einzurichten, verwenden Sie das crontab-Format, um einen Polling-Ausführungsplan festzulegen. Wenn Sie mit dem crontab-Format nicht vertraut sind, können Sie den Ausführungsplan mit der grafischen Oberfläche erstellen.

Der Standard-Ausführungsplan ist alle 30 Minuten, dargestellt durch 0/30 * * * *. Um den Ausführungsplan festzulegen, der um 30 Minuten nach der Stunde ausgeführt wird, verwenden Sie 30 * * * *.

  1. Melden Sie sich bei der Oracle Developer Cloud Service-Konsole an, und öffnen Sie Ihr Projekt.
  2. Klicken Sie im Navigationsbereich auf Erstellen , und wählen Sie den Build, für den Sie die Parameter festlegen möchten.
    Die Seite Build-Einstellungen wird geöffnet.
  3. Klicken Sie auf Konfigurieren.
    Die Seite "Jobkonfiguration " wird geöffnet.
  4. Klicken Sie auf das Zahnradsymbol Das Symbol "Einstellungen" sieht aus wie ein Zahnradpaar., und klicken Sie dann auf Trigger , um den Bereich "Erstellungstrigger konfigurieren " zu öffnen.
  5. Klicken Sie auf die Dropdown-Liste Trigger hinzufügen , und wählen Sie SCM Polling-Trigger .
  6. Legen Sie den Ausführungsplan fest, und klicken Sie auf Speichern .

Build-Parameter einrichten

Richten Sie einen Zeichenfolgenparameter und einen Kennwortparameter so ein, dass der Benutzername und das Kennwort für Ihren Oracle Mobile Hub-Account gespeichert werden.

Verfolgen Sie die Namen dieser Parameter, da Sie sie später bei der Konfiguration des Entwicklertools benötigen.

  1. Melden Sie sich bei der Oracle Developer Cloud Service-Konsole an, und öffnen Sie Ihr Projekt.
  2. Klicken Sie im Navigationsbereich auf Erstellen , und wählen Sie den Build, für den Sie die Parameter festlegen möchten.
    Die Seite Build-Einstellungen wird geöffnet.
  3. Klicken Sie auf Konfigurieren.
    Die Seite "Jobkonfiguration " wird geöffnet.
  4. Klicken Sie auf die Registerkarte Build-Parameter .
  5. Klicken Sie auf die Dropdown-Liste Build-Parameter hinzufügen , und wählen Sie Zeichenfolgenparameter aus.
  6. Geben Sie einen Namen für den Benutzernamenparameter ein. Beispiel: devUser.
  7. Geben Sie im Feld Standardwert Ihren Oracle Mobile Hub-Benutzernamen ein. Beispiel: samir.developer@example.com.
  8. Klicken Sie auf die Dropdown-Liste Build-Parameter hinzufügen , und wählen Sie Kennwortparameter aus.
  9. Geben Sie einen Namen für den Kennwortparameter ein, wie devPassword .
  10. Geben Sie im Feld Standardwert das Kennwort für den Oracle Mobile Hub-Benutzernamen ein.
  11. Klicken Sie auf Speichern .

Unix Shell Builder konfigurieren

Der Shell Builder ist ein Bash-Skript, das auf dem Erstellsystem ausgeführt wird, wenn ein Build ausgelöst wird. Sie installiert Abhängigkeiten und stellt dann Ihren Code für Oracle Mobile Hub bereit.

Das Skript wird für die Quelle aus dem Git-Repository ausgeführt, das Sie beim Erstellen des Projekts in Oracle Developer Cloud Service eingerichtet haben. Wenn das Skript zu einem beliebigen Zeitpunkt ausfällt, wird ein Fehler angezeigt, und es wird kein Code bereitgestellt.

  1. Melden Sie sich bei der Oracle Developer Cloud Service-Konsole an, und öffnen Sie Ihr Projekt.
  2. Klicken Sie im Navigationsbereich auf Erstellen , und wählen Sie den Build, für den Sie die Parameter festlegen möchten.
    Die Seite Build-Einstellungen wird geöffnet.
  3. Klicken Sie auf Konfigurieren.
    Die Seite "Jobkonfiguration " wird geöffnet.
  4. Klicken Sie auf die Registerkarte Builder .
  5. Klicken Sie auf die Dropdown-Liste Builder hinzufügen , und wählen Sie Unix Shell Builder .
  6. Geben Sie im Feld Skript das folgende Skript ein:
    export NODE_PATH=node-configurations/8.9/node_modules
    npm install
    cd omce-tools
    npm install
    cd node-configurations/8.9
    npm install
    cd ../..
    node omce-deploy ../toolsConfig.json -u $devUser -p $devPassword
  7. Klicken Sie auf Speichern .

JavaScript-Gerüst herunterladen

Nachdem Sie das API-Skeleton erstellt haben, erstellt das System ein scaffold für den API-Code, den Sie in eine ZIP-Datei herunterladen können.

Das scaffold enthält die Ausgangsstruktur und die Dateien für die Implementierung der API, die Sie als Ausgangspunkt für Ihre Anpassungen verwenden. Sie müssen die Dateien extrahieren und in Ihrem Arbeitsverzeichnis speichern.

  1. Öffnen Sie In Oracle Mobile Hub die API, für die das scaffold gelten soll.
  2. Klicken Sie im API-Navigationsbereich auf Implementierung .
  3. Klicken Sie auf JavaScript-Gerüst , um die scaffalte-Datei auf Ihren Computer herunterzuladen.
  4. Extrahieren Sie die Datei package.json, toolsConfig.json und .js für Ihre API in Ihr Arbeitsverzeichnis. Es ist dasselbe Verzeichnis, das beim Klonen des Git-Repositorys erstellt wurde und das Verzeichnis .git enthält.

Entwicklungstools installieren und konfigurieren

Oracle stellt Tools für das Hochladen von benutzerdefinierten API-Implementierungen aus der Befehlszeile in Oracle Mobile Hub bereit. Fügen Sie die Tools dem Git-Repository hinzu, damit sie Ihrem Build-Skript in Oracle Developer Cloud Service zur Verfügung stehen.

Die Tools sind Bestandteil eines Downloads, der auch eine Oracle Mobile Hub-API enthält, mit der Sie Ihre benutzerdefinierten API-Implementierungen in Ihrem Entwicklungssystem testen und debuggen können. Die API ist nicht zur Verwendung der CI/CD-Pipeline erforderlich. Anweisungen zur Verwendung der API, die als OracleMobileAPI bezeichnet wird, finden Sie in der Readme-Datei im Verzeichnis omce-tools.

Die Tools unterstützen zwei Versionen von Node.js: 6.10.0 und 8.9.x. In dieser Prozedur wird davon ausgegangen, dass Sie Version 8.9.4 oder höher verwenden.

So installieren und konfigurieren Sie das Tooling:

  1. Gehen Sie zu https://www.oracle.com/technetwork/topics/cloud/downloads/amce-downloads-4478270.html , und laden Sie die benutzerdefinierten Codetest-Tools Version 18.3.1 oder höher herunter. Beachten Sie, dass die Dateinamen auf dieser Seite weiterhin den Legacy-Produktnamen entsprechen, der enthaltene Code jedoch mit dem neuesten Release auf dem neuesten Stand ist. Gleichermaßen für die Namen der Tools innerhalb des Downloads.
  2. Öffnen Sie die Datei, die Sie heruntergeladen haben, und extrahieren Sie den Inhalt des Verzeichnisses omce-tools/omce-tools in Ihr Arbeitsverzeichnis (das Verzeichnis .git enthält). Beispiel: Wenn Ihr Arbeitsverzeichnis test-project ist, extrahieren Sie den Inhalt von omce-tools/omce-tools in test-project/omce-tools.
  3. Installieren Sie die Knotenkonfiguration: Wechseln Sie zum Verzeichnis omce-tools/node-configurations/8.9, und führen Sie npm install aus.
  4. Installieren Sie omce-Tools auf Ihrem System: Wechseln Sie zum Verzeichnis omce-tools, und führen Sie npm install-g aus.
  5. Erstellen Sie eine Umgebungsvariable namens NODE_PATH, und setzen Sie sie auf node-configurations/8.9/node_modules.
  6. Stellen Sie sicher, dass die Tools korrekt installiert sind. Führen Sie im Verzeichnis omce-tools node omce-test--version aus. Das Ergebnis muss 18.3.1.sein
  7. Aktualisieren Sie toolsConfig.json. Wenn Sie das scaffold heruntergeladen haben, enthält es die Konfigurationsdatei toolsConfig.json. Verwenden Sie die vom Backend aufgezeichneten Informationen, um den Platzhaltertext in toolsConfig.json zu ersetzen.