In dieser Anleitung erfahren Sie, wie Sie einen benutzerdefinierten Cloud Run for Anthos-Dienst erstellen, der einen Eingabeparameter für die Diagrammbeschreibung in ein Diagramm im PNG
-Bildformat transformiert. Dabei kommt Graphviz zum Einsatz. Diese Software wird in der Containerumgebung des Dienstes als Systempaket installiert.
Graphviz wird dann über Befehlszeilendienstprogramme zum Verarbeiten von Anfragen verwendet.
Lernziele
- Einen benutzerdefinierten Container mit einem Dockerfile schreiben und erstellen
- Cloud Run for Anthos-Dienst schreiben, erstellen und bereitstellen
- Mit dem Graphviz dot-Dienstprogramm Diagramme generieren
- Dienst testen, indem Sie ein DOT-Syntaxdiagramm aus der Sammlung oder ein eigens erstelltes Diagramm veröffentlichen
Kosten
In diesem Dokument verwenden Sie die folgenden kostenpflichtigen Komponenten von Google Cloud:
Mit dem Preisrechner können Sie eine Kostenschätzung für Ihre voraussichtliche Nutzung vornehmen.
Hinweise
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
- Cloud Run for Anthos API aktivieren
- Installieren und initialisieren Sie die gcloud CLI.
- Installieren Sie die Komponente
kubectl
:gcloud components install kubectl
- Aktualisieren Sie die Komponenten:
gcloud components update
- Installieren Sie curl, um den Dienst zu testen.
- Erstellen Sie einen neuen Cluster. Folgen Sie dazu der Anleitung unter Cloud Run for Anthos einrichten.
gcloud-Standardeinstellungen einrichten
So konfigurieren Sie gcloud mit Standardeinstellungen für Ihren Cloud Run for Anthos-Dienst:
Legen Sie ein Standardprojekt fest:
gcloud config set project PROJECT_ID
Ersetzen Sie PROJECT_ID durch den Namen des Projekts, das Sie für diese Anleitung verwenden.
Konfigurieren Sie gcloud für Ihren Cluster:
gcloud config set run/platform gke gcloud config set run/cluster CLUSTER-NAME gcloud config set run/cluster_location REGION
Ersetzen Sie:
- CLUSTER-NAME durch den Namen, den Sie für den Cluster verwendet haben, und
- REGION durch den unterstützten Clusterstandort Ihrer Wahl.
Codebeispiel abrufen
So rufen Sie das gewünschte Codebeispiel ab:
Klonen Sie das Repository der Beispiel-App auf Ihren lokalen Computer:
Node.js
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git
Sie können auch das Beispiel als ZIP-Datei herunterladen und extrahieren.
Python
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
Sie können auch das Beispiel als ZIP-Datei herunterladen und extrahieren.
Go
git clone https://github.com/GoogleCloudPlatform/golang-samples.git
Sie können auch das Beispiel als ZIP-Datei herunterladen und extrahieren.
Java
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
Sie können auch das Beispiel als ZIP-Datei herunterladen und extrahieren.
Wechseln Sie in das Verzeichnis, das den Beispielcode für Cloud Run for Anthos enthält:
Node.js
cd nodejs-docs-samples/run/system-package/
Python
cd python-docs-samples/run/system-package/
Go
cd golang-samples/run/system_package/
Java
cd java-docs-samples/run/system-package/
Architektur visualisieren
Die grundlegende Architektur sieht so aus:
Der Nutzer stellt eine HTTP-Anfrage an den Cloud Run for Anthos-Dienst, der ein Graphviz-Dienstprogramm ausführt, um die Anfrage in ein Bild zu transformieren. Dieses Bild wird an den Nutzer als die HTTP-Antwort auf seine Anfrage gesendet.
Code verstehen
Umgebungskonfiguration mit dem Dockerfile
definieren
Ihr Dockerfile
ist spezifisch für die Sprache und die grundlegende Betriebsumgebung, z. B. Ubuntu, die Ihr Dienst verwenden wird.
Für diesen Dienst sind ein oder mehrere zusätzliche Systempakete erforderlich, die standardmäßig nicht verfügbar sind.
Öffnen Sie die
Dockerfile
in einem Editor.Suchen Sie nach der Anweisung
Dockerfile
RUN
. Mit dieser Anweisung können Sie beliebige Shell-Befehle ausführen, um die Umgebung zu verändern. Wenn dasDockerfile
über mehrere Phasen verfügt, also mehrereFROM
-Anweisungen aufweist, finden Sie die Anweisung in der letzten Phase.Es hängt von dem im Container angegebenen Betriebssystem ab, welche spezifischen Pakete erforderlich sind und mit welchem Mechanismus diese installiert werden.
Klicken Sie auf den entsprechenden Tab, um Anweisungen für Ihr Betriebssystem oder Basis-Image zu erhalten.
Debian/Ubuntu Alpen Alpine erfordert ein zweites Paket zur Unterstützung von Schriftarten.Wenn Sie das Betriebssystem Ihres Container-Images ermitteln möchten, sehen Sie nach, welcher Name in der
FROM
-Anweisung oder in einer README-Datei für Ihr Basis-Image verwendet wird. Wenn Sie beispielsweise vonnode
erweitern, finden Sie die Dokumentation und das übergeordnete ElementDockerfile
auf Docker Hub.Testen Sie Ihre Anpassung, indem Sie das Image erstellen. Verwenden Sie dazu lokal
docker build
oder Cloud Build.
Eingehende Anfragen verarbeiten
Der Beispieldienst verwendet Parameter aus der eingegangenen HTTP-Anfrage, um einen Systemaufruf durchzuführen, damit der entsprechende Befehl des dot
-Dienstprogramms ausgeführt wird.
Im folgenden HTTP-Handler wird aus der dot
-Abfragestringvariable ein Eingabeparameter für die Diagrammbeschreibung extrahiert.
Diagrammbeschreibungen können Zeichen enthalten, die für die Verwendung in einem Abfragestring URL-codiert sein müssen.
Node.js
Python
Go
Java
Es muss zwischen internen Serverfehlern und ungültigen Nutzereingaben unterschieden werden. Der Beispieldienst gibt für alle dot-Befehlszeilenfehler einen internen Serverfehler zurück, außer wenn die Fehlermeldung den String syntax
enthält, was auf ein Problem mit der Nutzereingabe hinweist.
Diagramm generieren
Die Kernlogik der Diagrammgenerierung verwendet das dot-Befehlszeilentool, um den Eingabeparameter für die Diagrammbeschreibung zu einem Diagramm im PNG-Bildformat zu verarbeiten.
Node.js
Python
Go
Java
Sicheren Dienst entwerfen
Alle eventuell bestehenden Sicherheitslücken im dot
-Tool sind potenzielle Sicherheitslücken im Webdienst. Sie können dies umgehen, indem Sie aktuelle Versionen des graphviz
-Pakets verwenden und das Container-Image regelmäßig neu erstellen.
Wenn Sie das aktuelle Beispiel so erweitern möchten, dass als Befehlszeilenparameter auch Nutzereingaben zulässig sind, sollten Sie gewisse Vorsichtsmaßnahmen treffen, um Angriffe durch Befehlsinjektion zu vermeiden. Auf folgende Arten können Injektionsangriffe beispielsweise verhindert werden:
- Zuordnen von Eingaben zu den Einträgen eines Wörterbuchs unterstützter Parameter
- Validierungseingaben entsprechen einer Reihe als sicher eingestufter Werte, möglicherweise unter Verwendung regulärer Ausdrücke
- Maskieren von Eingaben, damit Shell-Syntax nicht ausgewertet wird
Code versenden
Um Ihren Code zu senden, erstellen Sie ihn mit Cloud Build, laden ihn in Container Registry hoch und stellen ihn in Cloud Run for Anthos bereit:
Führen Sie den folgenden Befehl aus, um den Container zu erstellen und ihn in Container Registry zu veröffentlichen:
Node.js
gcloud builds submit --tag gcr.io/PROJECT_ID/graphviz
Dabei ist PROJECT_ID Ihre GCP-Projekt-ID und
graphviz
der Name, den Sie Ihrem Dienst geben möchten.Bei Erfolg wird eine SUCCESS-Meldung mit der ID, Erstellungszeit und dem Image-Namen angezeigt. Das Image wird in Container Registry gespeichert und kann bei Bedarf wiederverwendet werden.
Python
gcloud builds submit --tag gcr.io/PROJECT_ID/graphviz
Dabei ist PROJECT_ID Ihre GCP-Projekt-ID und
graphviz
der Name, den Sie Ihrem Dienst geben möchten.Bei Erfolg wird eine SUCCESS-Meldung mit der ID, Erstellungszeit und dem Image-Namen angezeigt. Das Image wird in Container Registry gespeichert und kann bei Bedarf wiederverwendet werden.
Go
gcloud builds submit --tag gcr.io/PROJECT_ID/graphviz
Dabei ist PROJECT_ID Ihre GCP-Projekt-ID und
graphviz
der Name, den Sie Ihrem Dienst geben möchten.Bei Erfolg wird eine SUCCESS-Meldung mit der ID, Erstellungszeit und dem Image-Namen angezeigt. Das Image wird in Container Registry gespeichert und kann bei Bedarf wiederverwendet werden.
Java
In diesem Beispiel wird Jib verwendet, um Docker-Images mit gängigen Java-Tools zu erstellen. Jib optimiert Container-Builds, ohne dass ein Dockerfile erforderlich ist oder Docker installiert sein muss. Weitere Informationen zum Erstellen von Java-Containern mit JibKonfigurieren und erstellen Sie mit dem Dockerfile ein Basis-Image mit den installierten Systempaketen, um das Standard-Basis-Image von Jib zu überschreiben:
gcloud builds submit --tag gcr.io/PROJECT_ID/graphviz-base
Dabei ist PROJECT_ID die ID des GCP-Projekts.
Erstellen Sie Ihren endgültigen Container mit Jib und veröffentlichen Sie ihn in Container Registry:
mvn compile jib:build \ -Dimage=gcr.io/PROJECT_ID/graphviz \ -Djib.from.image=gcr.io/PROJECT_ID/graphviz-base
Dabei ist PROJECT_ID die ID des GCP-Projekts.
Stellen Sie es mit dem folgenden Befehl bereit:
gcloud run deploy graphviz-web --create-if-missing --image gcr.io/PROJECT_ID/graphviz
Dabei ist PROJECT_ID Ihre GCP-Projekt-ID,
graphviz
der Name des Containers von oben undgraphviz-web
der Name des Dienstes.Warten Sie, bis die Bereitstellung abgeschlossen ist. Dies kann ungefähr eine halbe Minute dauern.
Wenn Sie eine Codeaktualisierung für den Dienst bereitstellen möchten, wiederholen Sie die vorherigen Schritte. Bei jeder Bereitstellung für einen Dienst wird eine neue Version erstellt und der Traffic wird automatisch verarbeitet, sobald der Dienst bereit ist.
Testen
Testen Sie den Dienst. Dazu senden Sie in der Anfragenutzlast HTTP-POST
-Anfragen mit DOT-Syntaxbeschreibungen.
Senden Sie eine HTTP-Anfrage an den Dienst.
Sie können das Diagramm in eine Webseite einbetten:
-
So rufen Sie die externe IP-Adresse für das Istio-Ingress-Gateway ab:
Die resultierende Ausgabe sieht in etwa so aus:kubectl get svc istio-ingress -n gke-system
Die EXTERNAL-IP für den Load-Balancer ist die zu verwendende IP-Adresse.NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) istio-ingress LoadBalancer XX.XX.XXX.XX pending 80:32380/TCP,443:32390/TCP,32400:32400/TCP
Führen Sie einen curl-Befehl aus, der die ermittelte
EXTERNAL-IP
-Adresse in der URL enthält. Lassen Sie dabei das Protokoll weg (z.B.:http://
) inSERVICE_DOMAIN
.curl -G -H "Host: SERVICE_DOMAIN" http://EXTERNAL-IP/diagram.png \ --data-urlencode "dot=digraph Run { rankdir=LR Code -> Build -> Deploy -> Run }" \ > diagram.png
-
So rufen Sie die externe IP-Adresse für das Istio-Ingress-Gateway ab:
Öffnen Sie die ausgegebene
diagram.png
-Datei in einer Anwendung, diePNG
-Dateien unterstützt, beispielsweise Chrome.Sie sollte so aussehen:
Sie können sich eine kleine Sammlung von vorgefertigten Diagrammbeschreibungen ansehen.
- Kopieren Sie den Inhalt der ausgewählten
.dot
-Datei Fügen Sie ihn in einen
curl
-Befehl ein:curl -G -H "Host: SERVICE_DOMAIN" http://EXTERNAL-IP/diagram.png \ --data-urlencode "dot=digraph Run { rankdir=LR Code -> Build -> Deploy -> Run }" \ > diagram.png
Bereinigen
Wenn Sie ein neues Projekt für diese Anleitung erstellt haben, löschen Sie das Projekt. Wenn Sie ein vorhandenes Projekt verwendet haben und es beibehalten möchten, ohne die Änderungen in dieser Anleitung hinzuzufügen, löschen Sie die für die Anleitung erstellten Ressourcen.
Projekt löschen
Am einfachsten vermeiden Sie weitere Kosten, wenn Sie das zum Ausführen der Anleitung erstellte Projekt löschen.
So löschen Sie das Projekt:
- In the Google Cloud console, go to the Manage resources page.
- In the project list, select the project that you want to delete, and then click Delete.
- In the dialog, type the project ID, and then click Shut down to delete the project.
Anleitungsressourcen löschen
Löschen Sie den Cloud Run for Anthos-Dienst, den Sie in dieser Anleitung bereitgestellt haben:
gcloud run services delete SERVICE-NAME
Dabei ist SERVICE-NAME der von Ihnen ausgewählte Dienstname.
Sie können Cloud Run for Anthos-Dienste auch über die Google Cloud Console löschen:
Entfernen Sie die gcloud-Standardkonfigurationen, die Sie während der Einrichtung der Anleitung hinzugefügt haben.
gcloud config unset run/platform gcloud config unset run/cluster gcloud config unset run/cluster_location
Entfernen Sie die Projektkonfiguration:
gcloud config unset project
Löschen Sie sonstige Google Cloud-Ressourcen, die in dieser Anleitung erstellt wurden:
- Löschen Sie das Container-Image mit dem Namen
gcr.io/<var>PROJECT_ID</var>/graphviz
aus Container Registry. - Wenn Sie einen Cluster für diese Anleitung erstellt haben, löschen Sie den Cluster.
- Löschen Sie das Container-Image mit dem Namen
Nächste Schritte
- Experimentieren Sie mit Ihrer Graphviz-App:
- Sie können Unterstützung für andere Graphviz-Dienstprogramme hinzufügen, die andere Algorithmen für die Diagrammgenerierung verwenden.
- Sie können Diagramme in Cloud Storage speichern. Sie können sowohl das Bild als auch die DOT-Syntax speichern.
- Implementieren Sie mit der Cloud Natural Language API einen Schutz, um den Missbrauch von Inhalten zu verhindern.
- Sehen Sie sich ein weiteres Beispiel für ein Systempaket unter Bildverarbeitung an.
- Referenzarchitekturen, Diagramme und Best Practices zu Google Cloud kennenlernen. Weitere Informationen zu Cloud Architecture Center