Ce document a été traduit à l'aide d'une technologie de traduction automatique. Bien que nous nous efforcions de fournir des traductions exactes, nous ne fournissons aucune garantie quant à l'exhaustivité, l'exactitude ou la fiabilité du contenu traduit. En cas de divergence, la version originale anglaise prévaut et fait foi.

CLI : sts

Présentation

Le CLI SUSE® Observability sts offre un accès facile aux fonctionnalités fournies par les API SUSE® Observability. Il peut être utilisé pour l’automatisation à l’aide des données SUSE® Observability, pour configurer SUSE® Observability et pour développer des StackPacks.

Conditions préalables

SUSE® Observability URL - L’URL de votre instance SUSE® Observability (la même URL utilisée pour accéder à l’interface web).
API Token - Un jeton API valide pour l’authentification, qui peut être récupéré depuis la page CLI dans votre instance SUSE® Observability.

Pour obtenir votre jeton API :

Connectez-vous à votre SUSE® Observability instance.
Naviguez vers Main menu > CLI.
Copiez le jeton API affiché sur la page.

Actions de

Le moyen le plus rapide d’installer et de configurer le sts CLI est d’utiliser les commandes préremplies disponibles dans votre instance SUSE® Observability :

Connectez-vous à votre SUSE® Observability instance.
Naviguez vers Main menu > CLI.
Copiez la commande pour votre système d’exploitation et exécutez-la dans un terminal.

Ces commandes sont pré-remplies avec l’URL correcte et le jeton API pour votre SUSE® Observability instance spécifique, rendant l’installation et la configuration en une seule étape.

Téléchargez le CLI

Windows
macOS
Linux
Docker

Ouvrez un terminal Powershell (version 5.1 ou ultérieure) et exécutez les étapes ci-dessous. Cela peut être fait étape par étape, ou combiné en un seul script. Après l’installation, la commande sts sera disponible pour l’utilisateur actuel à la fois dans le terminal Powershell et l’invite de commande (cmd.exe).

Définissez la version source et le chemin cible pour le CLI :

$CLI_PATH = $env:USERPROFILE +"\stackstate-cli"
If (!(test-path $CLI_PATH)) { md $CLI_PATH }
Invoke-WebRequest https://dl.stackstate.com/stackstate-cli/LATEST_VERSION -OutFile $CLI_PATH\VERSION
$VERSION=type $CLI_PATH\VERSION
$VERSION=$VERSION -replace "[v]"
$CLI_DL = "https://dl.stackstate.com/stackstate-cli/v$VERSION/stackstate-cli-$VERSION.windows-x86_64.zip"
echo "Installing {stackstate-product-name} CLI v$VERSION to: $CLI_PATH"

Téléchargez et décompressez le CLI dans le chemin cible du CLI. Supprimez les artefacts restants :

Invoke-WebRequest $CLI_DL -OutFile $CLI_PATH\stackstate-cli.zip
Expand-Archive -Path "$CLI_PATH\stackstate-cli.zip" -DestinationPath $CLI_PATH -Force
rm $CLI_PATH\stackstate-cli.zip, $CLI_PATH\VERSION

Enregistrez le chemin CLI dans le PATH de l’utilisateur actuel. Cela rendra la commande sts disponible partout :

$PATH = (Get-ItemProperty -Path "Registry::HKEY_CURRENT_USER\Environment" -Name PATH).Path
if ( $PATH -notlike "*$CLI_PATH*" ) {
  $PATH = "$PATH;$CLI_PATH"
  (Set-ItemProperty -Path "Registry::HKEY_CURRENT_USER\Environment" -Name PATH –Value $PATH)
  $MACHINE_PATH = (Get-ItemProperty -Path "Registry::HKEY_LOCAL_MACHINE\System\CurrentControlSet\Control\Session Manager\Environment" -Name PATH).path
  $env:Path = "$PATH;$MACHINE_PATH"
}

Vérifiez que le CLI fonctionne :
```
sts version
```

Ouvrez un terminal et exécutez les étapes ci-dessous. Cela peut être fait étape par étape, ou tout ensemble comme un seul script. Après l’installation, la commande sts sera disponible pour l’utilisateur actuel.

Téléchargez la dernière version du CLI pour x86_64 (Intel) ou arm64 (M1).

(VERSION=`curl https://dl.stackstate.com/stackstate-cli/LATEST_VERSION` &&
  VERSION=${VERSION#v} &&
  ARCH=`uname -m` &&
  curl https://dl.stackstate.com/stackstate-cli/v$VERSION/stackstate-cli-$VERSION.darwin-$ARCH.tar.gz | tar xz --directory /usr/local/bin)

Vérifiez que le CLI fonctionne :
```
sts version
```

Téléchargez et décompressez la dernière version pour x86_64 :

(VERSION=`curl https://dl.stackstate.com/stackstate-cli/LATEST_VERSION` && VERSION=${VERSION#v} &&
curl https://dl.stackstate.com/stackstate-cli/v$VERSION/stackstate-cli-$VERSION.linux-x86_64.tar.gz | tar xz --directory /usr/local/bin)

Vérifiez que le CLI fonctionne :
```
sts version
```

Pour exécuter la dernière version du CLI en utilisant Docker, exécutez :

docker run stackstate/stackstate-cli2

Alternativement, allez à la page CLI dans l’interface SUSE® Observability et copiez la commande Installation rapide pour Docker - cela est pré-rempli avec les <URL> et <API-TOKEN> corrects nécessaires pour configurer le CLI pour votre SUSE® Observability instance.

Vous pouvez maintenant exécuter des commandes CLI en les ajoutant à la fin de la commande docker run (par exemple, docker run stackstate/stackstate-cli2 version).

Configurez le CLI

Authentification

Jeton API

Par défaut, le CLI s’authentifiera en utilisant le jeton API que vous avez fourni lorsque la configuration du CLI a été enregistrée.

La manière la plus sécurisée d’utiliser votre jeton API est via une variable d’environnement. Vous pouvez stocker le jeton API avec un gestionnaire de secrets et l’injecter en tant que variable d’environnement dans votre shell.

Windows / macOS / Linux
Docker

Dans l’interface SUSE® Observability, allez à Menu principal > CLI et copiez votre jeton API.
Exécutez la commande ci-dessous, où <URL> est l’URL de votre instance SUSE® Observability et <API-TOKEN> est le jeton API que vous avez copié depuis la page CLI dans l’interface SUSE® Observability :
```
sts context save --name <NAME> --url <URL> --api-token <API-TOKEN>
```
La connexion à votre SUSE® Observability instance sera testée et un fichier de configuration sera enregistré à ~/.config/stackstate-cli/config.yaml.

La version Docker du CLI ne peut pas être configurée avec un fichier de configuration. Spécifiez la configuration de votre SUSE® Observability instance en utilisant des variables d’environnement et passez-les à Docker :

STS_CLI_URL - l’URL de votre SUSE® Observability instance.
STS_CLI_API_TOKEN - le jeton API pris depuis l’interface utilisateur SUSE® Observability Menu principal > CLI page.
STS_CA_CERT_PATH - chemin vers un fichier de certificat CA encodé en PEM pour les serveurs utilisant des certificats auto-signés. Le répertoire contenant le certificat doit être monté dans le conteneur Docker.
STS_CA_CERT_BASE64_DATA - données de certificat CA encodées en base64 pour les serveurs utilisant des certificats auto-signés (ignoré si STS_CA_CERT_PATH est spécifié).
STS_SKIP_SSL - désactive la validation du certificat SSL (ignore les configurations de certificat, à utiliser avec précaution).

Par exemple :

docker run \
   -v /path/to/certs:/certs \
   -e STS_CLI_URL \
   -e STS_CLI_API_TOKEN \
   -e STS_CA_CERT_PATH=/certs/ca.crt \
   stackstate/stackstate-cli2 settings list --type Layer

Jetons de service

Vous pouvez optionnellement utiliser le CLI pour créer un ou plusieurs jetons de service pour s’authentifier auprès des API Base et Admin de SUSE® Observability. Par exemple, un jeton de service peut être utilisé pour s’authentifier dans des scénarios CI (Intégration Continue) où aucun utilisateur réel n’effectue les opérations sur l’instance SUSE® Observability.

Pour créer un jeton de service, exécutez la commande ci-dessous :

sts service-token create --name <NAME> --roles <ROLE(s)> [--expiration <yyyy-MM-dd>]

Cela créera un nouveau jeton de service et l’affichera. Le paramètre --expiration est optionnel et peut être utilisé pour définir la date d’expiration du jeton de service.

Une fois que vous avez cela, vous pouvez configurer le CLI pour l’utiliser :

sts context save --name <NAME> --service-token <TOKEN> --url <URL>

Gérer plusieurs contextes

Le sts CLI prend en charge la configuration et la gestion de différents contextes (d’authentification). Cela vous permet de passer facilement d’un utilisateur administratif à un utilisateur régulier, ou de passer entre différentes SUSE® Observability instances. Par exemple, vous pourriez utiliser un contexte différent pour une instance de test et de production de SUSE® Observability. Vous pouvez lister, enregistrer, supprimer, définir et valider des contextes dans le sts CLI. Exécutez sts context -h pour des détails sur les commandes disponibles et leur utilisation.

Options de configuration

Vous n’avez pas besoin d’un fichier de configuration pour exécuter le sts CLI. Vous pouvez également configurer le CLI par une combinaison de variables d’environnement et de drapeaux :

Si plusieurs types de configuration sont présentés au CLI, l’ordre de traitement sera :

Drapeaux
Variables d’environnement
Fichier de configuration

Variable d’environnement Indicateur Description

Variable d’environnement	Indicateur	Description
`STS_CLI_URL`	`--url`	URL de votre SUSE® Observability instance.
`STS_CLI_API_TOKEN`	`--api-token`	Jeton API de votre SUSE® Observability instance. La manière la plus sécurisée d’utiliser votre jeton API est via une variable d’environnement. Vous pouvez stocker le jeton API avec un gestionnaire de secrets et l’injecter en tant que variable d’environnement dans votre shell.
`STS_CLI_SERVICE_TOKEN`	`--service-token`	Un jeton de service pour votre SUSE® Observability instance. La manière la plus sécurisée d’utiliser votre jeton de service est via une variable d’environnement. Vous pouvez stocker le jeton de service avec un gestionnaire de secrets et l’injecter en tant que variable d’environnement dans votre shell.
`STS_CA_CERT_PATH`	`--ca-cert-path`	Chemin vers un fichier de certificat CA encodé en PEM pour les serveurs utilisant des certificats auto-signés ou des certificats d’une CA privée.
`STS_CA_CERT_BASE64_DATA`	`--ca-cert-base64-data`	Données de certificat CA encodées en Base64 pour les serveurs utilisant des certificats auto-signés ou des certificats d’une CA privée. Ignoré si `STS_CA_CERT_PATH` est spécifié.
`STS_SKIP_SSL`	`--skip-ssl`	Désactive la validation des certificats SSL. Lorsque défini sur `true`, le CLI ne validera pas les certificats SSL et ignorera les paramètres `STS_CA_CERT_PATH` et `STS_CA_CERT_BASE64_DATA`. À utiliser avec précaution car cela réduit la sécurité.
`STS_CLI_API_PATH`	s. o.	Le chemin ajouté à la fin de l’URL pour obtenir le point de terminaison de l’API. (Par défaut, `/api`)
`STS_CLI_CONTEXT`	`--context`	Le nom du contexte à utiliser.

STS_CLI_URL

--url

URL de votre SUSE® Observability instance.

STS_CLI_API_TOKEN

--api-token

Jeton API de votre SUSE® Observability instance. La manière la plus sécurisée d’utiliser votre jeton API est via une variable d’environnement. Vous pouvez stocker le jeton API avec un gestionnaire de secrets et l’injecter en tant que variable d’environnement dans votre shell.

STS_CLI_SERVICE_TOKEN

--service-token

Un jeton de service pour votre SUSE® Observability instance. La manière la plus sécurisée d’utiliser votre jeton de service est via une variable d’environnement. Vous pouvez stocker le jeton de service avec un gestionnaire de secrets et l’injecter en tant que variable d’environnement dans votre shell.

STS_CA_CERT_PATH

--ca-cert-path

Chemin vers un fichier de certificat CA encodé en PEM pour les serveurs utilisant des certificats auto-signés ou des certificats d’une CA privée.

STS_CA_CERT_BASE64_DATA

--ca-cert-base64-data

Données de certificat CA encodées en Base64 pour les serveurs utilisant des certificats auto-signés ou des certificats d’une CA privée. Ignoré si STS_CA_CERT_PATH est spécifié.

STS_SKIP_SSL

--skip-ssl

Désactive la validation des certificats SSL. Lorsque défini sur true, le CLI ne validera pas les certificats SSL et ignorera les paramètres STS_CA_CERT_PATH et STS_CA_CERT_BASE64_DATA. À utiliser avec précaution car cela réduit la sécurité.

STS_CLI_API_PATH

s. o.

Le chemin ajouté à la fin de l’URL pour obtenir le point de terminaison de l’API. (Par défaut, /api)

STS_CLI_CONTEXT

--context

Le nom du contexte à utiliser.

En plus de remplacer des parties spécifiques du fichier de configuration, il est également possible de remplacer l’emplacement par défaut du fichier de configuration. Cela se fait via l’option --config <PATH>.

Commandes disponibles

Le sts CLI fournit les commandes de niveau supérieur suivantes :

Commande	Description
agent	Gérer les SUSE® Observability agents
complétion	Générer des scripts d’autocomplétion pour les shells
contexte	Gérer les contextes et configurations du CLI
tableau de bord	Gérer les tableaux de bord
état de santé	Commandes liées à la synchronisation de la santé
licence	Gérer les SUSE® Observability informations de licence
monitor	Gérer les moniteurs et les configurations de surveillance
rbac	Gérer le RBAC
service-token	Gérer les jetons de service.
paramètres	Gérer les paramètres et configurations d’instance
stackpack	Gérer et télécharger des StackPacks
topic	Gérer les rubriques Kafka
synchronisation-topologie	Gérer la synchronisation de la topologie
session-utilisateur	Inspecter les sessions utilisateur
version	Afficher les informations sur la version

Commande

Description

agent

Gérer les SUSE® Observability agents

complétion

Générer des scripts d’autocomplétion pour les shells

contexte

Gérer les contextes et configurations du CLI

tableau de bord

Gérer les tableaux de bord

état de santé

Commandes liées à la synchronisation de la santé

licence

Gérer les SUSE® Observability informations de licence

monitor

Gérer les moniteurs et les configurations de surveillance

rbac

Gérer le RBAC

service-token

Gérer les jetons de service.

paramètres

Gérer les paramètres et configurations d’instance

stackpack

Gérer et télécharger des StackPacks

topic

Gérer les rubriques Kafka

synchronisation-topologie

Gérer la synchronisation de la topologie

session-utilisateur

Inspecter les sessions utilisateur

version

Afficher les informations sur la version

Toutes les commandes acceptent le drapeau --help, qui documente l’utilisation de chaque commande.

Pour des informations détaillées sur n’importe quelle commande et ses sous-commandes, exécutez :

sts [command] --help

Mise à niveau

Pour mettre à niveau vers la dernière version du sts CLI, exécutez à nouveau la commande d’installation.

Vous pouvez vérifier la version du sts CLI que vous exécutez actuellement avec la commande sts version.

Uninstall

Windows
macOS
Linux
Docker

Désinstallation rapide

Ouvrez un terminal Powershell et exécutez :

. { iwr -useb https://dl.stackstate.com/stackstate-cli/install.ps1 } | iex; uninstall

Le sts CLI et toute la configuration associée sont maintenant supprimés pour l’utilisateur actuel.

Désinstallation manuelle

Ouvrez un terminal Powershell et exécutez chaque étape une par une ou toutes en même temps. Le sts CLI et toute la configuration associée seront supprimés pour l’utilisateur actuel.

Supprimer le binaire :

$CLI_PATH = $env:USERPROFILE+"\stackstate-cli"
rm -R $CLI_PATH 2>1  > $null

Supprimer la configuration :

rm -R $env:USERPROFILE+"\.config\stackstate-cli" 2>1  > $null

Supprimer le CLI du chemin d’environnement :

$PATH = (Get-ItemProperty -Path 'Registry::HKEY_CURRENT_USER\Environment' -Name PATH).Path
$i = $PATH.IndexOf(";$CLI_PATH")
if ($i -ne -1) {
  $PATH = $PATH.Remove($i, $CLI_PATH.Length+1)
  (Set-ItemProperty -Path 'Registry::HKEY_CURRENT_USER\Environment' -Name PATH –Value $PATH)
}

Désinstallation rapide

Ouvrez un terminal et exécutez :

curl -o- https://dl.stackstate.com/stackstate-cli/uninstall.sh | bash

Le sts CLI et toute la configuration associée sont maintenant supprimés pour l’utilisateur actuel.

Désinstallation manuelle

Ouvrez un terminal.
Pour supprimer le sts CLI, exécutez la commande :
```
rm -r /usr/local/bin/sts
```
Pour supprimer la configuration du sts CLI, exécutez la commande :
```
rm -r ~/.config/stackstate-cli
```

Le sts CLI et toute la configuration associée sont maintenant supprimés pour l’utilisateur actuel.

Désinstallation rapide

Ouvrez un terminal et exécutez :

curl -o- https://dl.stackstate.com/stackstate-cli/uninstall.sh | bash

Le sts CLI et toute la configuration associée sont maintenant supprimés pour l’utilisateur actuel.

Désinstallation manuelle

Ouvrez un terminal.
Pour supprimer le sts CLI, exécutez la commande :
```
rm -r /usr/local/bin/sts
```
Pour supprimer la configuration du sts CLI, exécutez la commande :
```
rm -r ~/.config/stackstate-cli
```

Le sts CLI et toute la configuration associée sont maintenant supprimés pour l’utilisateur actuel.

Pour supprimer l’image et les conteneurs du CLI, exécutez :

docker rmi -f stackstate/stackstate-cli2

Open Source

Le SUSE® Observability sts CLI est Open Source et peut être trouvé sur GitHub à l’adresse :

https://github.com/stackvista/stackstate-cli