Funktion über ein Sample mit Codeeditor erstellen

Funktion mit dem Codeeditor aus einem Beispiel erstellen

So erstellen Sie mit dem Codeeditor eine neue Funktion in OCI Functions basierend auf einer Beispielfunktion:

1. Bestätigen Sie, dass Sie die Schritte in Functions QuickStart on Cloud Shell ausgeführt haben, um:
   • Richten Sie Ihren Mandanten mit Gruppen und Benutzern ein, erstellen Sie ein Compartment, in dem OCI Functions-Ressourcen erstellt werden, erstellen Sie ein VCN und Subnetze, und erstellen Sie eine IAM-Policy.
   • Richten Sie die Cloud Shell-Entwicklungsumgebung mit dem Fn-Projekt-CLI-Kontext ein, rufen Sie ein Authentifizierungstoken ab, und melden Sie sich bei der Docker-Registry an, die für den Fn-Projekt-CLI-Kontext angegeben ist.
2. Melden Sie sich als Funktionsentwickler in der Konsole an.

3. Erstellen Sie mit der Konsole eine neue Anwendung in OCI Functions:

   1. Öffnen Sie das Navigationsmenü , und wählen Sie Entwicklerservices aus. Wählen Sie unter Funktionen die Option Anwendungen aus.
   2. Wählen Sie die Region aus, die Sie für OCI Functions verwenden möchten.

      Es wird empfohlen, dass Sie dieselbe Region wie die Docker-Registry verwenden, die im Fn-Projekt-CLI-Kontext angegeben ist (siehe Fn-Projekt-CLI-Kontext für die Verbindung mit Oracle Cloud Infrastructure erstellen).

   3. Wählen Sie das Compartment aus, das im Fn-Projekt-CLI-Kontext angegeben wurde (siehe Fn-Projekt-CLI-Kontext für die Verbindung mit Oracle Cloud Infrastructure erstellen).

      Auf der Seite Anwendungen werden die bereits im Compartment definierten Anwendungen angezeigt.

   4. Wählen Sie Anwendung erstellen, und geben Sie:

      • Ein Name für die neue Anwendung. Beispiel: samples-app

      • VCN und Subnetz (bzw. Subnetze, bis zu drei sind möglich), in denen die Funktion ausgeführt werden soll. Es wird empfohlen, dass sich die Subnetze in derselben Region wie die Docker-Registry befinden sollten, die im Fn-Projekt-CLI-Kontext angegeben ist (siehe Fn-Projekt-CLI-Kontext für die Verbindung mit Oracle Cloud Infrastructure erstellen).

      Weitere Informationen zu den anderen Optionen für die Anwendungserstellung finden Sie unter Anwendung erstellen.

   5. Wählen Sie Erstellen aus, um die Anwendung zu erstellen.

4. Starten Sie den Codeeditor auf eine der folgenden Arten:

   • Auf der Listenseite Anwendungen wählen Sie die Anwendung, in der Sie die Funktion erstellen möchten. Wählen Sie auf der Seite "Anwendungsdetails" Funktionen aus. Wählen Sie auf der Registerkarte Funktionen die Option In Codeeditor erstellen aus. Mit dieser Methode wird der Code Editor in der gerade erstellten Anwendung geöffnet.
   • Wählen Sie die Option "Codeeditor" aus der Schaltfläche "Entwicklerwerkzeuge" in der Symbolleiste der Konsole aus.
5. Erstellen Sie eine neue Funktion aus einer Beispielfunktion:
   1. Navigieren Sie im Bereich "Codeeditor - Oracle Cloud Infrastructure" zu der Anwendung, die Sie gerade in dem im Fn-Projekt-CLI-Kontext angegebenen Compartment erstellt haben. Beispiel: samples-app.
   2. Wenn der Anwendungsname markiert ist, wählen Sie im Kontextmenü die Option Funktion erstellen....
   3. Wählen Sie in der Menüleiste des Codeeditors im Eingabefeld die Erstellungsmethode Aus einem Beispiel erstellen.
   4. Wählen Sie eine Funktion aus der Beispielfunktionsliste aus, und drücken Sie die Eingabetaste. Beispiel: Wählen Sie oci-list-compartments-python aus.
   5. Geben Sie in der Menüleiste des Codeeditors einen Namen für die neue Funktion in das Eingabefeld ein, und drücken Sie die Eingabetaste. Der eingegebene Name muss mit dem Namen in der Datei func.yaml der Beispielfunktion übereinstimmen. In den meisten Fällen ist dies der Name in der Liste der Beispielfunktionen im vorherigen Schritt. Beispiel: oci-list-compartments-python.

      Geben Sie in der Menüleiste des Codeeditors einen Namen für die neue Funktion in das Eingabefeld ein, und drücken Sie die Eingabetaste. Der eingegebene Name muss mit dem Namen der ausgewählten Beispielfunktion in der Liste übereinstimmen. Beispiel: oci-list-compartments-python.

   6. Wählen Sie OK, um das Dialogfeld zu bestätigen, in dem Sie darüber informiert werden, dass Änderungen festgeschrieben und an eine Remoteverzweigung übertragen werden müssen, bevor die Funktion bereitgestellt werden kann.

      Ein nach der Funktion benanntes Verzeichnis wird im Verzeichnis /home/<username>/oci-ide-plugins/faas-artifacts/<app-ocid>/ erstellt. Beispiel: In /home/jdoe/oci-ide-plugins/faas-artifacts/ocid1.fnapp.oc1.iad.aaaaaa______76nf/oci-list-compartments-python,

      Wenn Sie die neue Funktion auf der Beispielfunktion oci-list-compartments-python basieren, enthält das Verzeichnis Folgendes:

      • func.yaml
      • func.py
      • README.md
      • requirments.txt
      • ein /images-Verzeichnis
6. Speichern Sie die Funktion in einem lokalen Git-Repository:
   1. Öffnen Sie ein Terminalfenster des Codeeditors, indem Sie in der Menüleiste des Codeeditors im Fenster Terminal die Option Neues Terminal auswählen.
   2. Ändern Sie im Terminalfenster des Codeeditors das Verzeichnis in das neu erstellte Verzeichnis, das die Datei func.yaml und die Quelldateien der Funktion enthält, indem Sie Folgendes eingeben:

      cd /home/<oci-username>/oci-ide-plugins/faas-artifacts/<application-OCID>/<function-name>

      Beispiel:

      cd /home/jdoe/oci-ide-plugins/faas-artifacts/ocid1.fnapp.oc1.iad.aaaaaaaa______76nf/oci-list-compartments-python

   3. Konvertieren Sie das nicht versionierte Verzeichnis (z.B. oci-list-compartments-python) in ein lokales Git-Repository, indem Sie Folgendes eingeben:

      git init

   4. Fügen Sie die Dateien im Verzeichnis der Staging Area hinzu, indem Sie Folgendes eingeben:

      git add .

   5. Speichern Sie den Inhalt der Staging Area im lokalen Git-Repository, indem Sie Folgendes eingeben:

      git commit

   6. Wenn Sie dazu aufgefordert werden, geben Sie eine Commit-Nachricht ein:
      1. Drücken Sie die i-Taste auf der Tastatur, um Text einzufügen.
      2. Geben Sie eine Commit-Nachricht ein. Beispiel: Geben Sie Folgendes ein:

         Adds sample files.

      3. Drücken Sie die Esc-Taste, geben Sie : w q ein, und drücken Sie die Eingabetaste.
7. Erstellen Sie ein neues Remote-Git-Repository. Beispiel: In GitHub als https://github.com/jdoe/list-compartments-sample-repo.
8. Funktion an das Remote-Git-Repository übergeben:
   1. Verbinden Sie im Terminalfenster des Codeeditors im Verzeichnis mit der Datei func.yaml und den Funktionsquelldateien das lokale Git-Repository mit dem soeben erstellten Remote-Git-Repository, indem Sie Folgendes eingeben:

      git remote add origin <remote-repository-url>

      Beispiel:

      git remote add origin https://github.com/jdoe/list-compartments-sample-repo.git

   2. Erstellen Sie eine neue Verzweigung namens "main" im lokalen Git-Repository, indem Sie Folgendes eingeben:

      git branch -M main

   3. Senden Sie Dateien an die main-Verzweigung im Remote-Git-Repository, indem Sie Folgendes eingeben:

      git push -u origin main

   4. Geben Sie bei entsprechender Aufforderung den Git-Benutzernamen und das Kennwort für das Remote-Git-Repository ein.

      Beachten Sie im Fall von GitHub, dass das Kennwort das persönliche Zugriffstoken GitHub ist.

9. Funktion in OCI Functions bereitstellen:

   1. Melden Sie sich im Terminalfenster des Codeeditors im Verzeichnis mit der Datei func.yaml und den Funktionsquelldateien bei der im Fn-Projekt-CLI-Kontext angegebenen Docker-Registry an. Wenn die Docker-Registry Oracle Cloud Infrastructure Registry ist, verwenden Sie den folgenden Befehl:

      docker login -u '<tenancy-namespace>/<user-name>' <region-key>.ocir.io

      Beispiel:

      docker login -u 'ansh81vru1zp/jdoe@acme.com' phx.ocir.io

   2. Wenn Sie zur Eingabe eines Kennworts aufgefordert werden, geben Sie Ihr OCI-Authentifizierungstoken ein.
   3. Stellen Sie im Terminalfenster des Codeeditors die Funktion in OCI Functions bereit, indem Sie Folgendes ausführen:

      fn -v deploy --app <application-name>

      Beispiel:

      fn -v deploy --app samples-app

10. Einige Beispielfunktionen haben bestimmte Voraussetzungen, wie bestimmte IAM-Policys. Diese Voraussetzungen werden in der Datei README.md der Beispielfunktion beschrieben. Beispiel: Für eine Funktion, die auf der Beispielfunktion oci-list-compartments-python basiert, gibt die Datei README.md an, dass die Funktion nur ein Mitglied einer dynamischen Gruppe ist.

    Wenn die neue Funktion auf der Beispielfunktion oci-list-compartments-python basiert, befolgen Sie die folgenden Anweisungen, um die Funktion einer dynamischen Gruppe hinzuzufügen:

    1. Öffnen Sie das Navigationsmenü , und wählen Sie Identität und Sicherheit aus. Wählen Sie unter Identität die Option Domains aus. Wählen Sie unter Identitätsdomain die Option Dynamische Gruppen aus.
    2. Befolgen Sie die Anweisungen unter So erstellen Sie eine dynamische Gruppe, und geben Sie der dynamischen Gruppe einen Namen (z.B. sample-func-dyn-grp).

    3. Wenn Sie eine Regel für die dynamische Gruppe angeben, geben Sie eine Regel wie die folgende ein, um alle Funktionen in dem Compartment hinzuzufügen, in dem Sie die neue Funktion erstellt haben, zur dynamischen Gruppe:

       ALL {resource.type = 'fnfunc', resource.compartment.id = '<compartment-ocid>'}

       Dabei ist <compartment-ocid> die OCID des Compartments, in dem Sie die Anwendung erstellt haben.

       Beispiel:

       ALL {resource.type = 'fnfunc', resource.compartment.id = 'ocid1.compartment.oc1..aaaaaaaa23______smwa'}

    4. Wählen Sie Dynamische Gruppe erstellen aus.
11. Rufen Sie die soeben bereitgestellte Funktion auf:
    1. Rufen Sie im Terminalfenster des Codeeditors im Verzeichnis mit der Datei func.yaml und den Funktionsquelldateien die Funktion auf, indem Sie Folgendes ausführen:

       fn invoke <application-name> <function-name>

       Beispiel:

       fn invoke samples-app oci-list-compartments-python

       Wenn eine Meldung zurückgegeben wird, in der die Funktion nicht gefunden wird, liegt eine mögliche Ursache in einer Unstimmigkeit zwischen dem Namen der Funktion, die Sie im Codeeditor erstellt haben, und dem Namen der Funktion, die in func.yaml angegeben ist. Wiederholen Sie die vorherigen Schritte, um eine Funktion im Codeeditor zu erstellen, die denselben Namen hat wie in der Datei func.yaml im Remote-Git-Repository angegeben.

       Wenn Sie die in der Datei README.md der Funktion angegebenen Voraussetzungen erfüllt haben, gibt die Funktion eine Antwort zurück.

       Beispiel: Wenn Sie die neue Funktion auf der Beispielfunktion oci-list-compartments-python basieren und die Funktion einer dynamischen Gruppe hinzugefügt haben (wie zuvor beschrieben), gibt die Funktion wie folgt eine Liste aller Compartments im Mandanten zurück:

       {"compartments": [["<compartment-ocid>", "<compartment-name>"], ["<compartment-ocid>", "<compartment-name>"]… }

12. (Optional) Wenn Sie die neue Funktion in den vorherigen Schritten auf der Beispielfunktion oci-list-compartments-python basieren, wird in diesem optionalen Schritt beschrieben, wie Sie die Beispielfunktion anpassen, indem Sie einen Teil des Textes der Meldung ändern, der beim Aufrufen der Funktion angezeigt wird. Sie aktualisieren den Nachrichtentext im lokalen Git-Repository, übertragen das Update in das Remote-Git-Repository und stellen die Funktion dann bereit und rufen sie auf.

    1. Wählen Sie im Bereich "Codeeditor Oracle Cloud Infrastructure" unter der gerade erstellten Funktion oci-list-compartments-python die Datei func.py aus, und ändern Sie die Zeile:

       resp = {"compartments": compartments}

       zum Lesen:

       resp = {"compartments in tenancy": compartments}

    2. Wählen Sie im Codeeditor-Navigator das Quellsteuerelement aus, klicken Sie auf die Schaltfläche "Weitere Aktionen", und wählen Sie im Menü Festschreiben die Option Festschreiben.
    3. Wenn Sie zur Bereitstellung von Änderungen aufgefordert werden, wählen Sie Ja aus.
    4. Geben Sie eine Commit-Nachricht ein (z.B. Adds-in-tenancy), und drücken Sie die Eingabetaste.
    5. Wählen Sie die Schaltfläche "Weitere Aktionen", und wählen Sie im Menü Abrufen, Push die Option Push aus.
    6. Geben Sie bei entsprechender Aufforderung den Git-Benutzernamen und das Kennwort für das Remote-Git-Repository ein.

       Beachten Sie im Fall von GitHub, dass das Kennwort das persönliche Zugriffstoken GitHub ist.

    7. Wenn ein Dialogfeld mit der Meldung "Möchten Sie, dass der Codeeditor regelmäßig "Git fetch" ausführt?" angezeigt wird, wählen Sie Später fragen aus.

    8. Stellen Sie im Terminalfenster des Codeeditors im Verzeichnis mit der Datei func.yaml und den Funktionsquelldateien die Funktion in OCI Functions bereit, indem Sie Folgendes eingeben:

       fn -v deploy --app <application-name>

       Beispiel:

       fn -v deploy --app samples-app

    9. Rufen Sie im Terminalfenster des Code Editors die Funktion auf, indem Sie Folgendes eingeben:

       fn invoke <application-name> <function-name>

       Beispiel:

       fn invoke samples-app oci-list-compartments-python

       Die folgende Meldung wird angezeigt:

       {"compartments in tenancy": [["<compartment-ocid>", "<compartment-name>"], ["<compartment-ocid>", "<compartment-name>"]… }

    Die aktualisierte Nachricht bestätigt, dass Sie den Funktionsquellcode im lokalen Git-Repository erfolgreich geändert, das Update in das Remote-Git-Repository übertragen und die Funktion dann bereitgestellt und aufgerufen haben.