In Cloud Shell öffnen

Mit der Funktion "In Cloud Shell öffnen" können Sie einen Link veröffentlichen, der die Google Cloud Console mit einem in Cloud Shell geklonten Git-Repository öffnet und/oder Cloud Shell mit einem benutzerdefinierten Image startet. Sie können auch eine Anleitung an das Terminal senden, damit Nutzer mit den Inhalten interagieren können.

Mithilfe der Links in Cloud Shell können Entwickler mit Ihren Codebeispielen und APIs experimentieren, ohne das Cloud SDK herunterladen, erforderliche Abhängigkeiten installieren oder nach relevanten Quelldateien suchen zu müssen. Auf dieser Seite wird erläutert, wie Sie Ihrem Git-Repository einen Link zum Öffnen in Cloud Shell hinzufügen.

URL-Parameter

Ein Link zum Öffnen in Cloud Shell, der optional in ein Schaltflächenbild eingebettet ist, kann der README.md-Datei eines beliebigen Verzeichnisses in Ihrem Git-Repository hinzugefügt werden. Der empfohlene Speicherort für diesen Link ist die README-Datei des Stammverzeichnisses Ihres Git-Repositorys.

Erforderliche Parameter

Zum Erstellen dieser Verknüpfung benötigen 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 der folgenden URL-Parameter:

URL-Parameter Beschreibung Unterstützte Werte
cloudshell_git_repo

URL des zu klonenden Git-Repositorys

Sobald das Repository geklont wurde, wird das Stammverzeichnis des Projektordners geöffnet und sein Inhalt im linken Navigationsbereich angezeigt.

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

Diese URL besteht aus einer zulässigen Domain (GitHub oder Bitbucket) und einem Pfad. Folgende Zeichen sind zulässig: Groß- und Kleinbuchstaben, Ziffern, Unterstriche (_), Bindestriche (-), Punkte (.) und Schrägstriche (/).

cloudshell_image

Benutzerdefiniertes Docker-Image, das während der Sitzung eine benutzerdefinierte Umgebung ausführt. Dadurch können Sie in Cloud Shell benutzerdefinierte Tools bereitstellen, mit denen Nutzer mit Ihrem Repository arbeiten können.

Wenn Sie in Cloud Shell ein Repository mit diesem Parameter öffnen, wird eine temporäre Umgebung mit einem Scratch-Basisverzeichnis erstellt, das am Ende der Sitzung gelöscht wird.

URL eines Docker-Images, das in Container Registry gehostet wird. Das Docker-Image muss auf dem Cloud Shell-Basis-Image basieren und öffentlich zugänglich sein.

Verwenden Sie die Anleitung zum Erstellen benutzerdefinierter Images, um mit dem folgenden Befehl in Cloud Shell ein gültiges Image zu erstellen:

cloudshell launch-tutorial /google/devshell/tutorials/custom-image-tutorial.md

Beachten Sie, dass das Herunterladen großer Images beim Öffnen der URL auf die Cloud Shell-VM einige Zeit in Anspruch nimmt.

Optionale Parameter

Sie können auch einen der folgenden optionalen Parameter angeben:

URL-Parameter Beschreibung Unterstützte Werte

cloudshell_git_branch

Verzweigen Sie aus dem Git-Repository zum Klonen. Gilt nur, wenn cloudshell_git_repo angegeben ist. Der Standardzweig ist Master. Ein beliebiger gültiger Zweig im Repository. Folgende Zeichen sind zulässig: Groß- und Kleinbuchstaben, Ziffern, Tilden (~), Unterstriche (_), Bindestriche (-), Punkte (.), Schrägstriche (/) und Doppelpunkte (:)

cloudshell_workspace

Arbeitsverzeichnis für Cloud Shell. Das Terminal wird im angegebenen Verzeichnis geöffnet. Der Cloud Shell-Editor öffnet das Verzeichnis als Arbeitsbereich. Jeder gültige Dateipfad relativ zum geklonten Repository. Sie können den Parameterwert leer lassen oder "." verwenden. um das Stammverzeichnis des geklonten Repositorys anzugeben. Wenn kein Repository angegeben ist, ist der Pfad relativ zum Cloud Shell-Basisverzeichnis. Folgende Zeichen sind zulässig: Groß- und Kleinbuchstaben, Ziffern, Tilden (~), Unterstriche (_), Bindestriche (-), Punkte (.), Schrägstriche (/) und Doppelpunkte. (:)

cloudshell_open_in_editor

Datei(en), die im Cloud Shell-Editor geöffnet werden sollen. Kann wiederholt werden, um mehrere Dateien zum Öffnen anzugeben. Wenn mehrere angegeben sind, werden sie in der angegebenen Reihenfolge geöffnet.

Die angegebenen Dateien werden im geöffneten Projekt in den Tabs des rechten Editors geöffnet(ein Tab pro Datei).

Dateipfade beziehen sich auf das aktuelle Verzeichnis. Wenn der Parameter working_dir angegeben wird, wird der Pfad zu diesen Dateien relativ zu working_dir behandelt.

Jeder gültige Dateipfad, der aus den folgenden zulässigen Zeichen besteht: Groß- und Kleinbuchstaben, Ziffern, Tilden (~), Unterstriche (_), Bindestriche (-), Punkte (.), Schrägstriche (/) und Doppelpunkte (:) gesetzt.

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 relativ zu working_dir behandelt.

Jeder gültige Dateipfad, der aus den folgenden zulässigen Zeichen besteht: Groß- und Kleinbuchstaben, Ziffern, Tilden (~), Unterstriche (_), Bindestriche (-), Punkte (.), Schrägstriche (/) und Doppelpunkte (:) gesetzt.

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

cloudshell_working_dir (verworfen)

Das Verzeichnis, das im Cloud Shell-Editor als Arbeitsbereich geöffnet werden soll Jeder gültige Dateipfad, der aus den folgenden zulässigen Zeichen besteht: Groß- und Kleinbuchstaben, Ziffern, Tilden (~), Unterstriche (_), Bindestriche (-), Punkte (.), Schrägstriche (/) und Doppelpunkte (:) gesetzt.

Beispiele

Fügen Sie zum Einbetten einer Schaltfläche zum Öffnen eines Beispiel-Git-Repositorys in Cloud Shell den folgenden Markdown-Code in die README.md-Datei Ihres Repositorys ein:

[![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)

Verwenden Sie dieses äquivalente HTML-Snippet, um die gleichen Funktionen in eine Website einzubetten:

<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 festlegen möchten, können Sie mit dem folgenden Formular Parameter testen, die zum Öffnen Ihres Repositorys in Cloud Shell erforderlich sind.