- Startseite
- Documentation
- Laufzeitwerkzeuge
- F5 XC Kontexte
F5 XC Kontexte
xcsh verbindet sich mit F5 Distributed Cloud über Kontexte — benannte Anmeldedatensätze, die eine Tenant-URL, ein API-Token und einen Namespace binden. Wenn Sie bereits kubectl config use-context oder kubectx verwendet haben, ist der Workflow identisch: Erstellen Sie einen Kontext, wechseln Sie zwischen ihnen per Name und verwenden Sie -, um zurückzuwechseln.
Erste Schritte
Abschnitt betitelt „Erste Schritte“1. Erstellen Sie Ihren ersten Kontext
Abschnitt betitelt „1. Erstellen Sie Ihren ersten Kontext“Sie benötigen drei Dinge aus Ihrer F5 XC Konsole: die Tenant-URL, ein API-Token und optional einen Namespace.
/context create production https://acme.console.ves.volterra.io p12k3-your-api-tokenContext 'production' created. Use /context activate production to switch to it.Oder verwenden Sie den geführten Assistenten, wenn Sie schrittweise Eingabeaufforderungen bevorzugen:
/context wizard2. Aktivieren Sie ihn
Abschnitt betitelt „2. Aktivieren Sie ihn“/context production╭─ production ─────────────────────────────────────────────────╮│ XCSH_TENANT acme ││ XCSH_API_URL https://acme.console.ves.volterra.io ││ XCSH_API_TOKEN ...oken ││ Status Connected (312ms) │├─ Environment ────────────────────────────────────────────────┤│ XCSH_NAMESPACE default │╰──────────────────────────────────────────────────────────────╯Nach der Aktivierung injiziert xcsh die Tenant-Anmeldedaten in Ihre Sitzung. Der Agent kann nun F5 XC API-Aufrufe durchführen, und die Statuszeile zeigt den aktiven Kontext an.
3. Fügen Sie weitere Kontexte hinzu und wechseln Sie zwischen ihnen
Abschnitt betitelt „3. Fügen Sie weitere Kontexte hinzu und wechseln Sie zwischen ihnen“/context create staging https://staging.console.ves.volterra.io p12k3-staging-tokenWechseln Sie per Name — kein Unterbefehl-Verb erforderlich:
/context stagingWechseln Sie zurück zum vorherigen Kontext (im cd --Stil):
/context -Zweimaliges Aufrufen von /context - bringt Sie zurück zum Ausgangspunkt.
4. Sehen Sie, was Sie haben
Abschnitt betitelt „4. Sehen Sie, was Sie haben“/context production https://acme.console.ves.volterra.io* staging https://staging.console.ves.volterra.ioDas * markiert den aktiven Kontext.
Alltägliche Befehle
Abschnitt betitelt „Alltägliche Befehle“| Befehl | Was er bewirkt |
|---|---|
/context | Alle Kontexte auflisten |
/context <name> | Zu einem Kontext wechseln |
/context - | Zum vorherigen Kontext wechseln |
/context show | Details des aktiven Kontexts anzeigen (Tokens maskiert) |
/context status | Aktuellen Authentifizierungsstatus anzeigen |
Kontext-Lebenszyklus
Abschnitt betitelt „Kontext-Lebenszyklus“| Befehl | Was er bewirkt |
|---|---|
/context create <name> <url> <token> [namespace] | Einen Kontext erstellen |
/context delete <name> --confirm | Einen Kontext löschen (erfordert --confirm) |
/context rename <old> <new> | Einen Kontext umbenennen |
/context validate <name> | Anmeldedaten testen ohne zu wechseln |
/context export [name] [--include-token] | Als JSON exportieren (Tokens standardmäßig maskiert) |
/context import <path-or-json> [--overwrite] | Aus Datei oder Inline-JSON importieren |
/context wizard | Geführte interaktive Einrichtung |
Namespaces wechseln
Abschnitt betitelt „Namespaces wechseln“Jeder Kontext hat einen Standard-Namespace. Wechseln Sie ihn, ohne den Kontext zu ändern:
/context namespace systemTab-Vervollständigung bietet Namespace-Namen vom aktiven Tenant an.
Umgebungsvariablen bei Kontexten
Abschnitt betitelt „Umgebungsvariablen bei Kontexten“Kontexte können zusätzliche Umgebungsvariablen enthalten, die bei der Aktivierung in Ihre Sitzung injiziert werden. Nützlich für Tenant-spezifische Konfiguration, die nicht Teil des Anmeldedatensatzes ist.
/context set CUSTOM_HEADER=x-acme-trace/context set LOG_LEVEL=debug/context env list/context unset LOG_LEVELAliase: add = set, remove/clear = unset.
Tab-Vervollständigung
Abschnitt betitelt „Tab-Vervollständigung“Geben Sie /context ein und drücken Sie Tab. Das Dropdown zeigt:
- Kontextnamen — mit Tenant-URL-Hinweisen, damit Sie Tenants unterscheiden können
-— erscheint, wenn Sie zuvor gewechselt haben, zeigt an, zu welchem Kontext Sie wechseln würden- Unterbefehle —
list,create,delete, etc.
Kontextnamen erscheinen zuerst, da das Wechseln die häufigste Aktion ist.
Vervollständigungen auf Unterbefehl-Ebene funktionieren ebenfalls: /context activate <Tab> vervollständigt Kontextnamen, /context namespace <Tab> vervollständigt Namespaces, /context unset <Tab> vervollständigt bekannte Umgebungsvariablen-Schlüssel.
Namensregeln
Abschnitt betitelt „Namensregeln“Kontextnamen müssen 1-64 Zeichen lang sein: Buchstaben, Ziffern, Bindestriche, Unterstriche.
Namen, die mit Unterbefehlen kollidieren, werden abgelehnt:
/context create list https://example.com tokError: Context name 'list' conflicts with a /context subcommand. Choose a different name.Die vollständige reservierte Menge: list, show, status, create, delete, rename, namespace, env, set, unset, add, remove, clear, activate, validate, export, import, wizard, help. Der Vergleich ist groß-/kleinschreibungsunabhängig.
Überschreibung durch Umgebungsvariablen
Abschnitt betitelt „Überschreibung durch Umgebungsvariablen“Wenn XCSH_API_URL und XCSH_API_TOKEN in Ihrer Shell-Umgebung gesetzt sind, bevor Sie xcsh starten, haben sie Vorrang vor jedem Kontext. Dies ist nützlich für CI/CD-Pipelines oder einmalige Sitzungen, in denen Sie keinen persistenten Kontext erstellen möchten.
In diesem Modus zeigt /context die aus der Umgebung stammenden Anmeldedaten mit einem (via env vars)-Label an.
Verhalten des vorherigen Kontexts
Abschnitt betitelt „Verhalten des vorherigen Kontexts“- Sitzungsbezogen: Der vorherige Kontext wird beim Neustart von xcsh zurückgesetzt. Er wird nicht auf der Festplatte persistiert.
- Ping-Pong: Zweimaliges
/context -bringt Sie zurück zum Ausgangspunkt. - Sicher bei Mutationen: Wenn Sie den vorherigen Kontext löschen, wird der Zeiger gelöscht. Wenn Sie ihn umbenennen, folgt der Zeiger dem neuen Namen.
- Erneute Aktivierung ist ein No-Op:
/context production, wenn Sie bereits aufproductionsind, setzt den vorherigen Zeiger nicht zurück.
Design-Konventionen
Abschnitt betitelt „Design-Konventionen“Die /context-UX folgt:
- kubectx:
kubectx <name>zum Wechseln,kubectx -für den vorherigen, bloßeskubectxzum Auflisten - kubectl:
kubectl config use-contextfür die explizite Form - Shell:
cd -/OLDPWDfür die Verfolgung des vorherigen Verzeichnisses