In Cloud Shell öffnen

Mit der Funktion „In Cloud Shell öffnen“ können Sie einen Link veröffentlichen, öffnet die Google Cloud Console mit einem in Cloud Shell geklonten Git-Repository und/oder startet Cloud Shell mit einem benutzerdefinierten Bild. Sie können Anweisungen auch am Terminal ausdrucken, um die Nutzer bei der Interaktion zu unterstützen mit den Inhalten.

Mithilfe von „In Cloud Shell öffnen“-Links können Entwickler mit Ihrem Code experimentieren und APIs, ohne die Google Cloud CLI herunterladen, Abhängigkeiten oder suchen Sie nach relevanten Quelldateien. Auf dieser Seite wird erläutert, wie Sie Ihrem Git-Repository den Link „In Cloud Shell öffnen“ hinzufügen.

URL-Parameter

Ein 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 die Stammverzeichnisdatei README.md Ihres Git-Repositorys.

Erforderlicher URL-Parameter

Verwenden Sie zum Erstellen dieses Links die Basis-URL shell.cloud.google.com (oder eine beliebige Seite in der Google Cloud Console, die mit console.cloud.google.com beginnt) durch folgenden erforderlichen URL-Parameter:

URL-Parameter Beschreibung Unterstützte Werte
cloudshell_git_repo

URL des zu klonenden Git-Repositorys

Nachdem das Repository geklont wurde, wird das Stammverzeichnis des Projektordners geöffnet. Der Inhalt wird 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. Die folgenden Zeichen sind zulässig: Groß- und Kleinbuchstaben, Ziffern, Unterstriche (_), Bindestriche (-), Punkte (.) und Schrägstriche (/).

Optionale URL-Parameter

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

URL-Parameter Beschreibung Unterstützte Werte
cloudshell_git_branch 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. Die folgenden Zeichen sind zulässig: Groß- und Kleinbuchstaben, Ziffern, Tilden (~), Unterstriche (_), Bindestriche (-), Punkte (.), Schrägstriche (/) und Doppelpunkte (:).
cloudshell_image

Benutzerdefiniertes Docker-Image, in dem während der Sitzung eine benutzerdefinierte Umgebung ausgeführt wird. Auf diese Weise können Sie in Cloud Shell angepasste Tools bereitstellen, die Nutzer zum Arbeiten mit Ihrem Repository verwenden können.

Repository mit diesem Parameter in Cloud Shell öffnen wird eine temporäre Umgebung mit einem neuen Basisverzeichnis erstellt. die am Ende der Sitzung gelöscht wird.

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

Verwenden Sie zum Erstellen eines gültigen Images die Anleitung zur Erstellung benutzerdefinierter Images, die Sie mit dem folgenden Befehl in Cloud Shell starten können:

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

Der Download auf eine Cloud Shell-VM dauert etwas länger.

cloudshell_open_in_editor

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

Angegebene Datei(en) 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, der aus den folgenden zulässigen Zeichen besteht: Groß- und Kleinbuchstaben, Ziffern, Tilden (~), Unterstriche (_), Bindestriche (-), Punkte (.), Schrägstriche (/) und Doppelpunkte (:).
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, der aus den folgenden zulässigen Zeichen besteht: Groß- und Kleinbuchstaben, Ziffern, Tilden (~), Unterstriche (_), Bindestriche (-), Punkte (.), Schrägstriche (/) und Doppelpunkte (:).
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.

cloudshell_working_dir (eingestellt)

Dieser Parameter wurde eingestellt. Verwenden Sie stattdessen cloudshell_workspace.

Jeder gültige Dateipfad, der aus den folgenden zulässigen Zeichen besteht: 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. 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 festzulegen. Wenn kein zusätzliches Repository angegeben ist, bezieht sich der Pfad auf das Cloud Shell-Basisverzeichnis. Die folgenden Zeichen sind zulässig: Groß- und Kleinbuchstaben, Ziffern, Tilden (~), Unterstriche (_), Bindestriche (-), Punkte (.), Schrägstriche (/), Doppelpunkte (:)
ephemeral Repository mit diesem Parameter in Cloud Shell öffnen wird eine temporäre Umgebung mit einem neuen Basisverzeichnis erstellt. die am Ende der Sitzung gelöscht wird. Weitere Informationen finden Sie unter Ephemeren Modus auswählen.

true, false

show

Sie können den Cloud Shell-Editor nur mit dem Terminal, nur mit dem Editor oder mit beiden öffnen.

ide, terminal, ide%2Cterminal

Beispiele

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

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

Verwenden Sie dieses entsprechende HTML-Snippet, um dieselbe Funktionalität in eine Website einzubetten:

  <a href="https://shell.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>

So definieren Sie das Verhalten des Links „In Cloud Shell öffnen“: können Sie das Formular unten verwenden, um mit Parametern zu experimentieren, die für die Öffnen Sie Ihr Repository in Cloud Shell.