In Cloud Shell öffnen

Mit der Funktion In Cloud Shell öffnen können Sie einen Link veröffentlichen, der die Cloud Console öffnet und entweder automatisch ein Git-Repository in Cloud Shell klont oder Cloud Shell mit einem benutzerdefinierten Image startet. Sie ermöglicht auch, dass Anleitungen an das Terminal ausgegeben werden, damit Nutzer mit dem Inhalt interagieren können.

Mit der Funktion In Cloud Shell öffnen können Entwickler mit Codebeispielen und APIs experimentieren, ohne sich um das Herunterladen von Cloud SDK, die Installation von erforderlichen Abhängigkeiten oder die Suche nach relevanten Quelldateien kümmern zu müssen. Auf dieser Seite wird erläutert, wie Sie diese Funktion zu Ihrem Git-Repository hinzufügen.

Derzeit sind nur GitHub- und Bitbucket-Repositorys auf der weißen Liste. Wenn Sie ein anderes Repository hinzufügen möchten, geben Sie entsprechendes Feedback und nennen Sie darin den Repository-Typ, den Sie mit der Funktion In Cloud Shell öffnen verwenden möchten.

URL-Parameter

Der Link In Cloud Shell öffnen, der optional in ein Schaltflächenbild eingebettet ist, kann der Datei README.md eines beliebigen Verzeichnisses in Ihrem Git-Repository hinzugefügt werden. Der empfohlene Speicherort für diesen Link ist das Stammverzeichnis README.md Ihres Git-Repositorys.

Um dieser Interaktion In Cloud Shell öffnen Funktionalität hinzuzufügen, müssen Sie eine Basis-URL von ssh.cloud.google.com (oder eine beliebige Seite in der Cloud Console, die mit console.cloud.google.com beginnt) mit mindestens einem dieser beiden URL-Parameter verwenden:

URL-Parameter Beschreibung Unterstützte Werte
cloudshell_git_repo

URL des zu klonenden Git-Repositorys

Das angegebene Repository wird geklont und das Stammverzeichnis des Projektordners wird geöffnet. Der Inhalt wird im linken Navigationsbereich angezeigt.

Gültige URL für ein Git-Repository.

Dieser besteht aus einer Domain auf der weißen Liste (GitHub oder Bitbucket) und einem Pfad mit diesen gültigen Zeichen: [a-zA-Z0-9_-.

cloudshell_image

Gibt ein benutzerdefiniertes Docker-Image an, in dem während der Sitzung eine benutzerdefinierte Umgebung ausgeführt wird. Auf diese Weise können Sie in Cloud Shell angepasste Tools für die Arbeit mit Ihrem Repository bereitstellen. Dadurch wird eine temporäre Umgebung mit einem neuen Basisverzeichnis erstellt, das am Ende der Sitzung gelöscht wird.

Dieses Tutorial kann durch Ausführen von "cloudshell launch-tutorial /google/devshell/tutorials/custom-image-tutorial.md" in Cloud Shell gestartet werden.

URL eines Docker-Images, das in der Google Container Registry gehostet wird. Das Docker-Image muss auf dem Cloud-Shell-Basis-Image basieren und öffentlich zugänglich sein. Beachten Sie, dass das Herunterladen eines großen Image in die Cloud Shell-VM einige Zeit dauert, wenn die URL geöffnet wird.

Außerdem können Sie einen der folgenden optionalen Parameter angeben:

URL-Parameter Beschreibung Unterstützte Werte

cloudshell_git_branch

Der spezifische Zweig vom zu klonenden Git-Repository. Gilt nur, wenn "cloudshell_git_repo" angegeben ist. Der Standardzweig ist master. Ein beliebiger gültiger Zweig im Repository. Alle Zeichen darin müssen mit dieser weißen Liste übereinstimmen: [a-zA-Z0-9~_-./:]

cloudshell_working_dir

Arbeitsverzeichnis, um den Nutzer zur Befehlszeile zu leiten. Jeder gültige Dateipfad. Alle Zeichen darin müssen mit dieser weißen Liste übereinstimmen: [a-zA-Z0-9~_-./:]

cloudshell_open_in_editor

Im integrierten Orion-Editor zu öffnende Datei(en). Kann wiederholt werden, um mehrere Dateien zum Öffnen anzugeben. Wenn mehrere angegeben sind, werden diese in der angegebenen Reihenfolge geöffnet.

Angegebene Dateien werden in den rechten Tabs des Editors geöffnet, ein Tab pro Datei im geöffneten Projekt.

Dateipfade beziehen sich auf das aktuelle Verzeichnis. Wenn der Parameter working_dir angegeben wird, wird der Pfad zu diesen Dateien so betrachtet, als würde er sich auf working_dir beziehen.

Jeder gültige Dateipfad. Alle Zeichen darin müssen mit dieser weißen Liste übereinstimmen: [a-zA-Z0-9~_-./:]

cloudshell_print

Datei im Git-Repository, die in der Regel aus Anleitungen besteht, die an das Terminal ausgegeben werden, um die nächsten Schritte eines Nutzers zu steuern. Der Dateipfad bezieht sich auf das aktuelle Verzeichnis.

Wenn der Parameter working_dir angegeben wird, wird der Pfad zu dieser Datei so betrachtet, als würde er sich auf working_dir beziehen.

Jeder gültige Dateipfad. Alle Zeichen darin müssen mit dieser weißen Liste übereinstimmen: [a-zA-Z0-9~_-./:]

cloudshell_tutorial

Anleitungs-Markup-Datei im Git-Repository mit Anweisungen, die als Anleitung gestartet werden, um Nutzer durch ein Projekt zu führen. Der Dateipfad bezieht sich auf das aktuelle Verzeichnis.

Jede korrekt formatierte Anleitungs-Markdown-Datei mit gültigem Dateinamen.

shellonly

Öffnen nur mit der Befehlszeile und nicht mit dem Editor.

"true", "false"

Beispiele

Um einen Link zum Öffnen eines Beispiel-Git-Repositorys in Cloud Shell bereitzustellen, müssen Sie Markdown sowie das folgende Snippet verwenden, um den Link in die README.md-Datei Ihres Repositorys einzubetten:

[![Open in Cloud Shell](https://gstatic.com/cloudssh/images/open-btn.svg)](https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=http://path-to-repo/sample.git)

Wenn Sie diese Funktionalität lieber in eine Website einbetten möchten, entspricht der HTML-Code dem obigen Snippet:

<a href="https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=http://path-to-repo/sample.git"><img alt="Open in Cloud Shell" src ="https://gstatic.com/cloudssh/images/open-btn.svg"></a>

Wenn Sie das Verhalten des Links "In Cloud Shell öffnen" genauer definieren möchten, können Sie mit dem nachstehenden Formular die Parameter testen und so die URL bestimmen, die zum Öffnen des Repositorys in Cloud Shell benötigt wird.