Diese Seite enthält eine Übersicht über das Befehlszeilentool gcloud und seine allgemeinen Befehlsmuster und -funktionen.
Was ist das gcloud-Befehlszeilentool?
Die gcloud-Befehlszeilenschnittstelle ist das primäre CLI-Tool zum Erstellen und Verwalten von Google Cloud-Ressourcen. Mit diesem Tool lassen sich viele gängige Plattformaufgaben entweder über die Befehlszeile oder in Skripts und anderen Automatisierungen ausführen.
Beispielsweise können Sie mit der gcloud-Befehlszeile Folgendes erstellen und verwalten:
- VM-Instanzen und andere Ressourcen von Google Compute Engine
- Google Cloud SQL-Instanzen
- Google Kubernetes Engine-Cluster
- Google Cloud Dataproc-Cluster und -Jobs
- Verwaltete Zonen und Datensätze von Google Cloud DNS
- Bereitstellungen von Google Cloud Deployment Manager
Sie können die gcloud-CLI auch verwenden, um App Engine-Anwendungen bereitzustellen, die Authentifizierung zu verwalten, die lokale Konfiguration anzupassen und andere Aufgaben auszuführen. In der Referenz zu gcloud finden Sie weitere Informationen zu den Funktionen dieses Tools.
Der Spickzettel für das gcloud-Befehlszeilentool
Eine kurze Einführung in das gcloud-Befehlszeilentool, eine Liste häufig verwendeter Befehle und die Struktur dieser Befehle finden Sie im Spickzettel für das gcloud-Befehlszeilentool.
Die gcloud-Befehlszeile und das Cloud SDK
Die gcloud-Befehlszeile ist Teil des Google Cloud SDK. Sie müssen das SDK herunterladen, auf Ihrem System installieren und initialisieren, bevor Sie das gcloud-Befehlszeilentool verwenden können.
Standardmäßig installiert das SDK nur die gcloud-Befehle auf der Stufe "Allgemeine Verfügbarkeit" und "Vorschau". Die SDK-Komponenten alpha und beta bieten zusätzliche Funktionalität. Mit ihnen können Sie die gcloud-Befehlszeile verwenden, um mit Google Cloud Bigtable, Google Cloud Dataflow und anderen Teilen der Cloud Platform zu arbeiten, die noch nicht auf der Stufe "Allgemeine Verfügbarkeit" sind.
Releases der gcloud-Befehlszeile haben dieselbe Versionsnummer wie das SDK. Die aktuelle SDK-Version ist 317.0.0. Vorgängerversionen des SDK können aus dem Downloadarchiv heruntergeladen und installiert werden.
gcloud-Befehlszeilentool herunterladen
Sie können die neueste Version des Cloud SDK, die das gcloud-Befehlszeilentool enthält, von der Downloadseite herunterladen.
Releasestufen
Die gcloud-Befehlszeilenbefehle haben die folgenden Releasestufen:
| Releasestufe | Label | Beschreibung |
|---|---|---|
| Allgemeine Verfügbarkeit | – | Die Befehle gelten als völlig stabil und stehen für den Einsatz in der Produktion zur Verfügung. Für Befehle, die die aktuelle Funktionalität ändern, werden Vorwarnungen ausgegeben und in den Versionshinweisen dokumentiert. |
| Beta | beta |
Die Befehle sind funktional vollständig, können aber noch einige ungelöste Probleme aufweisen. Nicht abwärtskompatible Änderungen an diesen Befehlen können ohne vorherige Ankündigung vorgenommen werden. |
| Alpha | alpha |
Die Befehle befinden sich in der frühen Releasephase und können ohne Vorankündigung geändert werden. |
Die Komponenten alpha und beta werden bei der Installation des SDK nicht standardmäßig installiert. Mit dem Befehl gcloud components install müssen Sie diese Komponenten separat installieren. Wenn Sie versuchen, einen Alpha- oder Betabefehl auszuführen und die entsprechende Komponente nicht installiert ist, werden Sie vom gcloud-Befehlszeilentool zur Installation aufgefordert.
Befehlsgruppen
Innerhalb jeder Releasestufe sind gcloud-Befehlszeilenbefehle in einer verschachtelten Hierarchie von Befehlsgruppen organisiert, von denen jede ein Produkt oder eine Funktion der Cloud Platform oder ihrer funktionalen Untergruppen darstellt.
Beispiel:
| Befehlsgruppe | Beschreibung |
|---|---|
gcloud compute |
Befehle für Compute Engine, die auf der Stufe "Allgemeine Verfügbarkeit" freigegeben sind |
gcloud compute instances |
Befehle für Compute Engine-Instanzen, die auf der Stufe "Allgemeine Verfügbarkeit" freigegeben sind |
gcloud beta compute |
Befehle für Compute Engine in der Betaphase |
gcloud alpha app |
Befehle für die Verwaltung von App Engine-Bereitstellungen in der Alphaphase |
gcloud-Befehlszeilenbefehle ausführen
Sie können gcloud-Befehlszeilenbefehle auf dieselbe Weise über die Befehlszeile ausführen wie mit anderen Befehlszeilentools. Sie können gcloud-Befehlszeilenbefehle auch mit Skripts und anderen Automatisierungsmethoden ausführen, wenn Sie beispielsweise Jenkins zur Automatisierung von Aufgaben in der Cloud Platform verwenden.
Attribute
Attribute der gcloud-Befehlszeile sind Einstellungen, die die Funktionsweise der gcloud-Befehlszeile und anderer Cloud SDK-Tools steuern. Manche dieser Attribute können global oder mit Befehls-Flags festgelegt werden. In diesem Fall hat der durch das Flag festgelegte Wert Vorrang.
Bedienungshilfen aktivieren
Wenn Sie einen optimierten Screenreader benötigen, können Sie das Attribut accessibility/screen_reader im gcloud-Befehlszeilentool verwenden.
Führen Sie folgenden Befehl aus, um dieses Attribut zu aktivieren:
gcloud config set accessibility/screen_reader true
Weitere Informationen zu den Bedienungshilfen des gcloud-Befehlszeilentools finden Sie im Handbuch zum Aktivieren von Bedienungshilfen.
Konfigurationen
Eine Konfiguration ist ein benannter Satz von Attributen der gcloud-Befehlszeile. Sie funktioniert praktisch wie ein Profil.
Sie beginnen mit dem Cloud SDK und verwenden eine einzige Konfiguration mit dem Namen default. Sie können Attribute festlegen, indem Sie entweder gcloud init oder gcloud config set ausführen. Diese eine Standardkonfiguration ist für die meisten Anwendungsfälle geeignet.
Wenn Sie mit mehreren Projekten oder Autorisierungskonten arbeiten möchten, können Sie verschiedene Konfigurationen mit gcloud config configurations create festlegen und zwischen ihnen wechseln. Innerhalb dieser Konfigurationen können Sie Attribute anpassen. Um Ihr Projekt beispielsweise in einer aktiven Konfiguration festzulegen, verwenden Sie das project-Attribut: gcloud config set project <project-id>.
Ausführliche Beschreibungen zu diesen Konzepten finden Sie im Konfigurationsleitfaden.
Globale Flags
Die gcloud-Befehlszeile bietet eine Reihe von für die gesamte gcloud-Befehlszeile gültigen Flags, die die Funktionsweise von Befehlen auf Aufrufebene steuern. Flags überschreiben alle Werte, die in SDK-Attributen festgelegt sind.
Positionsargumente und Flags
Sowohl Positionsargumente als auch Flags wirken sich auf die Ausgabe eines gcloud-Befehlszeilenbefehls aus. Es gibt aber einen feinen Unterschied in ihren Anwendungsfällen. Mit einem Positionsargument wird die Entität definiert, auf die ein Befehl angewendet wird, während ein Flag erforderlich ist, um eine andere Funktionsweise des Befehls festzulegen.
stdout und stderr verwenden
Die erfolgreiche Ausgabe von gcloud-Befehlszeilenbefehlen wird in stdout geschrieben. Alle anderen Antworten – Aufforderungen, Warnungen und Fehler – werden in stderr geschrieben. Was in stderr geschrieben wird, ist nicht stabil und sollte nicht für Skripts verwendet werden.
Eine aktuelle Liste von Richtlinien zum Umgang mit Ausgaben finden Sie im Skript-Leitfaden.
Aufforderungen
Zum Schutz vor unbeabsichtigten, folgenschweren Aktionen fordert die gcloud-Befehlszeile Sie zur Bestätigung Ihrer Absichten auf, bevor Befehle wie gcloud projects delete ausgeführt werden.
Aufforderungen sind auch zu erwarten, wenn Sie mit gcloud compute instances create test-instance eine VM-Instanz für Google Compute Engine erstellen, in diesem Beispiel "test-instance". Sie werden aufgefordert, eine Zone auszuwählen, in der die Instanz erstellt werden soll.
Verwenden Sie das Flag --quiet, um Aufforderungen zu deaktivieren.
Da sich die Formulierung von Eingabeaufforderungen ändern kann, sollten diese nicht in Skripts verwendet werden.
Aufforderungen verhindern, in das Terminal schreiben und Logging
Das Flag --quiet (auch -q) deaktiviert für die gcloud-Befehlszeile alle interaktiven Eingabeaufforderungen beim Ausführen von gcloud-Befehlen, was sie für Skripts nützlich macht. Falls Eingaben erforderlich sind, werden die zugehörigen Standardeinstellungen verwendet. Wenn keine vorhanden sind, wird ein Fehler ausgegeben.
Mithilfe des Flags --no-user-output-enabled kann im Terminal die Anzeige der Befehlsausgabe in der Standardausgabe und Standardfehlerausgabe unterdrückt werden.
Um die Ausführlichkeit von Logs stattdessen anzupassen, verwenden Sie das Flag --verbosity mit einer geeigneten Ebene (Debug, Info, Warnung, Fehler, kritisch oder keine).
Ausgabestruktur bestimmen
Wenn ein gcloud-Befehlszeilenbefehl eine Liste von Ressourcen zurückgibt, werden diese standardmäßig an die Standardausgabe gesendet. Zum Optimieren der Ausgabe können Sie die Flags "format", "filter" und "projection" verwenden.
Wenn Sie nur das Format Ihrer Ausgabe definieren möchten, erstellen Sie mit dem Flag --format eine tabellarische bzw. vereinfachte Version für eine interaktive Anzeige oder eine maschinenlesbare Version der Ausgabe als json, csv, yaml, value.
Mithilfe von projections können Sie eine Liste der Schlüssel zum Auswählen von Ressourcendatenwerten formatieren. Verwenden Sie filter, um die Ausgabe weiter an die von Ihnen definierten Kriterien anzupassen.
Über den nachfolgenden Link gelangen Sie zu einer kurzen interaktiven Anleitung, in der Sie sich mit den Filter- und Formatfunktionen vertraut machen können.
Weitere Informationen
- Mehr über die Befehle des gcloud-Befehlszeilentools finden Sie in der Referenz zur gcloud-Befehlszeile.