Befehlszeilenschnittstelle verwenden

Voraussetzungen

Weitere Informationen finden Sie unter Installieren der CLI.

Zusammenfassung

Die Befehlszeilenschnittstelle führt Aktionen für Ressourcen mit der folgenden Befehlssyntax aus:

palmctl <action> <resource> [<arguments>] [<flags>]

Die kontextbezogene Hilfe der Befehlszeilenschnittstelle zeigt eine Liste der verfügbaren Befehle und Aktionen sowie eine Zusammenfassung der Befehlssyntax an. Verwenden Sie das Flag --help oder -h , um die palmctl -Hilfe anzuzeigen:

palmctl --help

Um Hilfe für einen bestimmten Befehl abzurufen, hängen Sie das Flag -–help an den Befehl an. Zum Beispiel:

palmctl config --help

Das Ausgabeformat von palmctl ist standardmäßig YAML. Der yq YAML- und JSON-Prozessor ist ein nützliches Open-Source-Paket zum Parsen der palmctl -Ausgabe. Wenn Sie das JSON-Format bevorzugen, verwenden Sie das Flag -F json , um das JSON-Ausgabeformat palmctl zu verwenden. In diesem Fall ist der jq JSON-Prozessor ein nützliches Open-Source-Paket zum Parsen der palmctl JSON-Ausgabe.

Mit dem Flag -v oder --verbose können Sie eine detailliertere Ausgabe anzeigen, um den Detaillierungsgrad anzugeben:

• 0: Fehler-Es werden nur Fehler angezeigt. Dies ist die Standardeinstellung.
• 1: Warnung-zeigt auch Warnungen an.
• 2: Info-zeigt auch Informationsnachrichten an
• 3: Debug-zeigt auch Debugnachrichten an.
• 4: Trace - zeigt auch die Verfolgung von HTTP auf niedriger Ebene an.

Zum Beispiel:

palmctl <action> <resource> --verbose 4

palmctl Aktionen

create

Erstellt die angegebene Ressource und konfiguriert sie gemäß einer YAML-Eingabedatei.

install

Installiert Software in der Zielumgebung. Sie können zum Beispiel Mesh Agenten in einem entfernten Kubernetes Namespace installieren oder einen Single-Node-Cluster und die entsprechenden Mesh Agenten auf Ihrem lokalen Rechner installieren.

get

Rufen Sie die Details einer oder mehrerer Ressourcen ab.

update

Ändert die Konfiguration der angegebenen Ressource gemäß einer YAML-Eingabedatei. Dies ist eine vollständige Ersetzung der Ressource, d. h., Felder, die nicht in der Eingabedatei angegeben sind, werden auf leer gesetzt.

patch

Aktualisiert die angegebenen Felder in der angegebenen Ressource. Felder, die nicht aktualisiert werden, behalten ihren aktuellen Wert bei.

delete

Löscht die angegebene Ressource. Dieser Befehl zeigt keine Ausgabe an, wenn die Ausführlichkeit nicht mit dem Flag -v <verbosity> erhöht wird.

bind

Ordnet zugehörige Ressourcen zu Verwenden Sie bind , um Berechtigungen Rollen und Rollen Identitäten zuzuordnen.

unbind

Entkoppelt zuvor einander zugeordnete Ressourcen mit dem Befehl bind .

redeploy

Stellt eine Ressource erneut bereit.

palmctl Ressourcen.

Verwenden Sie palmctl <action> -h , um die Ressourcen anzuzeigen, die mit dieser Aktion verwendet werden können.

palmctl Verwendungsbeispiele

Die folgenden Befehle sind Beispiele für häufig verwendete palmctl.

In den Beispielen, die eine Dateieingabe erfordern, wird dieses allgemeine Muster verwendet:

cat << EOM | palmctl <action> <resource> <arguments> <flags> -f -
name: some-name
description: some description
EOM

In diesem Muster werden die Zeilen nach dem Anfangsbefehl (ohne die letzte EOM) als Eingabedatei an palmctl gesendet. Es folgen die Details:

• Der Befehl cat wird angewiesen, Eingaben aus den folgenden Zeilen zu lesen, bis er EOMerreicht. Es ist das Argument << EOM , das es anweist, dies zu tun.
• Der Befehl cat meldet die von ihm gelesene Eingabe an seine Ausgabe zurück.
• Der Pipe-Befehl | sendet die Ausgabe des Befehls cat an die Eingabe des Befehls palmctl .
• Das Flag -f - weist palmctl an, die Eingabe so zu lesen, als wäre es eine Datei.

Anwendungsressource erstellen

Registrieren Sie Ihre Anwendung bei Mesh:

cat << EOM | palmctl create application -f -
name: myapp
app_identity: app.my.domain.example
labels:                  # optional
  - app:my-app-label
EOM

Anwendungsressource aktualisieren

Anwendungsressource vollständig durch neue Feldwerte ersetzen:

cat << EOM | palmctl create application -f -
name: myapp
app_identity: app.my.domain.example
labels:                  # optional
  - app:my-app-label
EOM

Ein Feld in einer Anwendungsressource aktualisieren

cat << EOM | palmctl patch application --name myapp -f -
app_identity: app.my.domain.example
EOM

Anwendungsressource nach Namen abrufen

palmctl get application --name myapp

Alle Anwendungsressourcen abrufen

palmctl get applications

Anwendungsressource nach Namen löschen

palmctl delete application --name myapp

Installieren eines Open Horizon-Agenten

palmctl install openhorizon --name <agent_name> --namespace <agent_namespace> \
  --storage-class <storage_class> -d <install_package_location>

Rolle einer Identität (Benutzer) zuordnen (binden)

Erteilen Sie einem Benutzer alle Berechtigungen, die in einer Rolle enthalten sind:

palmctl bind identity --name <user-email> --role-name ReadAll

Rolle aus einer Identität (Benutzer) entfernen (Bindung aufheben)

Entfernen Sie die Berechtigungen einer Rolle für einen Benutzer:

palmctl unbind identity --name <user-email> --role-name ReadAll