Eerste CLI-sessie

Wat u opbouwt

U installeert de opdrachtregelclient kyvernon op een eigen machine, meldt zich aan bij de controller, toont objecten uit de inventaris en start een taak waarop u wacht.

Voordat u begint

• Een draaiende controller waarvan u het adres kent, bijvoorbeeld https://controller.example.com:8443. Installeren vanuit een offline depot zet er een op.
• Een gebruikersnaam en wachtwoord. Na Eerste aanmelding heeft de gebruiker admin ook zijn zescijferige code nodig.
• Een Debian- of Ubuntu-machine, de depotmap en de publieke releasesleutel, zoals in de installatieles.

1. De client installeren

Op de machine die de client moet draaien:

sudo ./kyvernon-install --role cli --pubkey /path/to/release-signing.minisign.pub

Het installatieprogramma controleert het depot zoals in de installatieles en installeert daarna alleen het pakket kyvernon-cli.

2. De client vertellen waar de controller staat

De client leest het adres van de controller uit --server of uit de variabele KYVERNON_SERVER:

export KYVERNON_SERVER=https://controller.example.com:8443

Een controller die nog zijn bootstrapcertificaat heeft, wordt door de machine niet vertrouwd. Voeg --insecure toe aan elke opdracht tot de controller een certificaat heeft dat de machine vertrouwt, en alleen op een netwerk dat u beheert. De voorbeelden hieronder laten het weg.

3. Aanmelden

De client leest het wachtwoord uit de variabele KYVERNON_PASSWORD of van standaardinvoer, nooit van de opdrachtregel:

read -rs KYVERNON_PASSWORD
export KYVERNON_PASSWORD
kyvernon login admin --save --code <code>

Vervang <code> door de huidige zescijferige code van uw authenticator-app, of laat --code weg voor een gebruiker zonder tweestapsverificatie. De opdracht toont het token. --save schrijft het ook naar het referentiebestand, zodat latere opdrachten geen --token nodig hebben. Het bestand is $XDG_CONFIG_HOME/kyvernon/credentials.json, geschreven met modus 0600 in een map met modus 0700. Het opgeslagen token hoort bij de controller waarbij u zich aanmeldde: met een andere --server weigert de client het te versturen en eindigt met code 3.

4. De verbinding controleren

kyvernon whoami
kyvernon about

whoami toont de identiteit van de huidige sessie. about toont de serviceinformatie van de controller.

5. De inventaris tonen

kyvernon inventory roots
kyvernon inventory vms
kyvernon inventory hosts
kyvernon inventory datastores
kyvernon inventory search <name>

Lijsten verschijnen als tabel. Voeg --json toe voor het ruwe antwoord, dat scripts kunnen lezen:

kyvernon inventory vms --json

Elk object heeft een id zoals vm-42. De opdrachten die op een object werken, nemen het als argument.

6. Een taak starten en erop wachten

Kies een uitgeschakelde virtuele machine, bijvoorbeeld die uit Eerste virtuele machine, en schakel haar in:

kyvernon vm power-on <id>

De opdracht keert meteen terug met de taak die Kyvernon heeft gemaakt. Wacht tot de taak eindigt met het id dat is getoond:

kyvernon tasks wait <task-id>

De wachtopdracht stopt standaard na 60 seconden; --timeout wijzigt dat. De meeste opdrachten die een taak starten, accepteren --wait, dat beide stappen doet:

kyvernon vm shutdown <id> --wait

De afsluitcode vertelt een script wat er gebeurde: 0 voor succes, 1 voor mislukking, 2 voor een gebruiks- of verbindingsfout, 3 wanneer de sessie niet is geauthenticeerd of niet is toegestaan, en 4 wanneer het object niet is gevonden.

7. Een token voor scripts bewaren

Een script hoort uw wachtwoord niet te bewaren. Maak een API-token en geef het als bestand aan het script:

kyvernon auth api-tokens create ci-build --ttl <seconds>
kyvernon --token-file /etc/ci/kyvernon.token inventory vms

Het geheim wordt één keer getoond; bewaar het op de eerste regel van het bestand. De client leest ook --token en de variabelen KYVERNON_TOKEN en KYVERNON_TOKEN_FILE.

8. De sessie beëindigen

kyvernon logout

Dit trekt de sessie op de controller in. Voor aanvullen met de tabtoets in uw shell toont kyvernon completion bash een script voor Bash. Zsh, Fish, PowerShell en Elvish zijn beschikbaar onder dezelfde opdracht, bijvoorbeeld source <(kyvernon completion bash).

Resultaat

U hebt een client die zich aanmeldt bij de controller, de inventaris toont, een taak uitvoert en erop wacht. De volledige lijst met opdrachten staat in de CLI-referentie.

Volgende stappen

• Overzicht legt de objecten uit die de opdrachten noemen.
• In- en uitschakelen somt de opdrachten voor het in- en uitschakelen van een virtuele machine op.
• vSphere-tools koppelen richt tools die voor de vSphere-API zijn geschreven op de controller.