Este documento ha sido traducido utilizando tecnología de traducción automática. Si bien nos esforzamos por proporcionar traducciones precisas, no ofrecemos garantías sobre la integridad, precisión o confiabilidad del contenido traducido. En caso de discrepancia, la versión original en inglés prevalecerá y constituirá el texto autorizado.

CLI: sts

Descripción general

La SUSE® Observability sts CLI proporciona un acceso fácil a la funcionalidad ofrecida por las SUSE® Observability APIs. Se puede utilizar para la automatización utilizando SUSE® Observability datos, para configurar SUSE® Observability y para desarrollar StackPacks.

Requisitos previos

SUSE® Observability URL - La URL de tu instancia SUSE® Observability (la misma URL utilizada para acceder a la interfaz web).
API Token - Un token API válido para la autenticación, que se puede recuperar de la página CLI en tu instancia SUSE® Observability.

Para obtener tu token API:

Inicia sesión en tu SUSE® Observability instancia.
Navega a Menú principal > CLI.
Copia el token API que se muestra en la página.

Inicio rápido

La forma más rápida de instalar y configurar la sts CLI es utilizar los comandos predefinidos disponibles en tu instancia SUSE® Observability:

Inicia sesión en tu SUSE® Observability instancia.
Navega a Menú principal > CLI.
Copia el comando para tu sistema operativo y ejecútalo en una terminal.

Estos comandos están predefinidos con la URL correcta y el token API para tu SUSE® Observability instancia específica, haciendo que la instalación y configuración sea un solo paso.

Descargar la CLI

Windows
macOS
Linux
Docker

Abre una terminal Powershell (versión 5.1 o posterior) y ejecuta los pasos a continuación. Esto se puede hacer un paso a la vez, o unirlo todo como un solo script. Después de la instalación, el comando sts estará disponible para el usuario actual tanto en la terminal de Powershell como en el símbolo del sistema (cmd.exe).

Establece la versión de origen y la ruta de destino para la 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"

Descarga y descomprime la CLI en la ruta de destino de la CLI. Elimina los artefactos restantes:

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

Registra la ruta del CLI en el PATH del usuario actual. Esto hará que el sts comando esté disponible en todas partes:

$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"
}

Verifica que el CLI funcione:
```
sts version
```

Abre una terminal y ejecuta los pasos a continuación. Esto se puede hacer paso a paso, o todo junto como un único script. Después de la instalación, el sts comando estará disponible para el usuario actual.

Descarga la última versión del CLI para x86_64 (Intel) o 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)

Verifica que el CLI funcione:
```
sts version
```

Descarga y descomprime la última versión para 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)

Verifica que el CLI funcione:
```
sts version
```

Para ejecutar la última versión del CLI usando Docker, ejecuta:

docker run stackstate/stackstate-cli2

Alternativamente, ve a la página CLI en la interfaz de usuario SUSE® Observability y copia el comando Instalación rápida para Docker - este está pre-rellenado con el <URL> y <API-TOKEN> correctos necesarios para configurar el CLI para tu instancia de SUSE® Observability.

Ahora puedes ejecutar comandos de CLI añadiéndolos al final del docker run comando (por ejemplo, docker run stackstate/stackstate-cli2 version).

Configura el CLI

Autenticación

Token de API

Por defecto, el CLI se autentificará utilizando el token de API que proporcionaste cuando se guardó la configuración del CLI.

La forma más segura de usar tu token de API es a través de una variable de entorno. Puedes almacenar el token de API con un gestor de secretos e inyectarlo como una variable de entorno en tu shell.

Windows / macOS / Linux
Docker

En la SUSE® Observability interfaz de usuario, ve a Menú principal > CLI y copia tu token de API.
Ejecuta el comando a continuación, donde <URL> es la URL de tu instancia de SUSE® Observability y <API-TOKEN> es el token de API que copiaste de la página CLI en la interfaz de usuario de SUSE® Observability:
```
sts context save --name <NAME> --url <URL> --api-token <API-TOKEN>
```
Se probará la conexión a tu instancia de SUSE® Observability y se almacenará un archivo de configuración en ~/.config/stackstate-cli/config.yaml.

La versión de Docker del CLI no se puede configurar con un archivo de configuración. Especifica la configuración de tu instancia de SUSE® Observability utilizando variables de entorno y pásalas a Docker:

STS_CLI_URL - la URL de tu instancia de SUSE® Observability.
STS_CLI_API_TOKEN - el token de API tomado de la página CLI en la interfaz de usuario de SUSE® Observability Menú principal > CLI.
STS_CA_CERT_PATH - ruta a un archivo de certificado CA codificado en PEM para servidores que utilizan certificados autofirmados. El directorio que contiene el certificado debe estar montado en el contenedor de Docker.
STS_CA_CERT_BASE64_DATA - datos del certificado CA codificados en base64 para servidores que utilizan certificados autofirmados (se ignora si se especifica STS_CA_CERT_PATH).
STS_SKIP_SSL - desactiva la validación del certificado SSL (ignora las configuraciones de certificado, úsalo con precaución).

Por ejemplo:

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

Tokens de servicio

Puedes utilizar opcionalmente el CLI para crear uno o más tokens de servicio para autenticarte con las APIs Base y Admin de SUSE® Observability. Por ejemplo, un token de servicio puede utilizarse para autenticar en escenarios de CI (Integración Continua) donde ningún usuario real está realizando las operaciones en la instancia de SUSE® Observability.

Para crear un token de servicio, ejecuta el comando a continuación:

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

Esto creará un nuevo token de servicio y lo imprimirá. El --expiration parámetro es opcional y se puede utilizar para establecer la fecha de caducidad del token de servicio.

Una vez que tengas esto, puedes configurar el CLI para usarlo:

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

Gestionar múltiples contextos

El CLI de sts admite la configuración y gestión de diferentes contextos (de autenticación). Esto te permite cambiar fácilmente entre un usuario administrativo y uno regular, o cambiar entre diferentes instancias de SUSE® Observability. Por ejemplo, podrías usar un contexto diferente para una prueba y una instancia de producción de SUSE® Observability. Puedes listar, guardar, eliminar, establecer y validar contextos en la CLI de sts. Ejecuta sts context -h para obtener detalles sobre los comandos disponibles y su uso.

Opciones de configuración

No necesitas un archivo de configuración para ejecutar la CLI de sts. También puedes configurar la CLI a través de una combinación de variables de entorno y banderas.

Si se presentan múltiples tipos de configuración a la CLI, el orden de procesamiento será:

Indicadores
Variables de entorno
Archivo de configuración

Variable de entorno Indicadores Descripción

Variable de entorno	Indicadores	Descripción
`STS_CLI_URL`	`--url`	URL de tu instancia de SUSE® Observability.
`STS_CLI_API_TOKEN`	`--api-token`	Token de API de tu instancia de SUSE® Observability. La forma más segura de usar tu token de API es a través de una variable de entorno. Puedes almacenar el token de API con un gestor de secretos e inyectarlo como una variable de entorno en tu shell.
`STS_CLI_SERVICE_TOKEN`	`--service-token`	Un token de servicio para tu instancia de SUSE® Observability. La forma más segura de usar tu token de servicio es a través de una variable de entorno. Puedes almacenar el token de servicio con un gestor de secretos e inyectarlo como una variable de entorno en tu shell.
`STS_CA_CERT_PATH`	`--ca-cert-path`	Ruta a un archivo de certificado CA codificado en PEM para servidores que utilizan certificados autofirmados o certificados de una CA privada.
`STS_CA_CERT_BASE64_DATA`	`--ca-cert-base64-data`	Datos del certificado CA codificados en Base64 para servidores que utilizan certificados autofirmados o certificados de una CA privada. Ignorado si se especifica `STS_CA_CERT_PATH`.
`STS_SKIP_SSL`	`--skip-ssl`	Desactiva la validación del certificado SSL. Cuando se establece en `true`, la CLI no validará los certificados SSL e ignorará las configuraciones de `STS_CA_CERT_PATH` y `STS_CA_CERT_BASE64_DATA`. Usa con precaución, ya que esto reduce la seguridad.
`STS_CLI_API_PATH`	n/a	La ruta añadida al final de la URL para obtener el punto final de la API. (Por defecto: `/api`)
`STS_CLI_CONTEXT`	`--context`	El nombre del contexto a utilizar.

STS_CLI_URL

--url

URL de tu instancia de SUSE® Observability.

STS_CLI_API_TOKEN

--api-token

Token de API de tu instancia de SUSE® Observability. La forma más segura de usar tu token de API es a través de una variable de entorno. Puedes almacenar el token de API con un gestor de secretos e inyectarlo como una variable de entorno en tu shell.

STS_CLI_SERVICE_TOKEN

--service-token

Un token de servicio para tu instancia de SUSE® Observability. La forma más segura de usar tu token de servicio es a través de una variable de entorno. Puedes almacenar el token de servicio con un gestor de secretos e inyectarlo como una variable de entorno en tu shell.

STS_CA_CERT_PATH

--ca-cert-path

Ruta a un archivo de certificado CA codificado en PEM para servidores que utilizan certificados autofirmados o certificados de una CA privada.

STS_CA_CERT_BASE64_DATA

--ca-cert-base64-data

Datos del certificado CA codificados en Base64 para servidores que utilizan certificados autofirmados o certificados de una CA privada. Ignorado si se especifica STS_CA_CERT_PATH.

STS_SKIP_SSL

--skip-ssl

Desactiva la validación del certificado SSL. Cuando se establece en true, la CLI no validará los certificados SSL e ignorará las configuraciones de STS_CA_CERT_PATH y STS_CA_CERT_BASE64_DATA. Usa con precaución, ya que esto reduce la seguridad.

STS_CLI_API_PATH

n/a

La ruta añadida al final de la URL para obtener el punto final de la API. (Por defecto: /api)

STS_CLI_CONTEXT

--context

El nombre del contexto a utilizar.

Además de anular partes específicas del archivo de configuración, también es posible anular la ubicación del archivo de configuración por defecto. Esto se hace a través de la --config <PATH> bandera.

Comandos disponibles

La sts CLI proporciona los siguientes comandos de nivel superior:

Comando	Descripción
agente	Gestionar agentes de SUSE® Observability
completar	Generar scripts de autocompletado para shells
contexto	Gestionar los contextos y configuraciones de la CLI
consola	Gestionar consolas
salud	Comandos relacionados con la sincronización de salud
licencia	Gestionar la información de licencia de SUSE® Observability
monitor	Gestionar monitores y configuraciones de monitoreo
rbac	Gestionar RBAC
service-token	Gestionar tokens de servicio.
ajustes	Gestionar configuraciones y ajustes de instancia
stackpack	Gestionar y subir StackPacks
tema	Gestionar temas de Kafka
topology-sync	Gestionar la sincronización de topologías
sesión-de-usuario	Inspeccionar sesiones de usuario
versión	Mostrar información de versión

Comando

Descripción

agente

Gestionar agentes de SUSE® Observability

completar

Generar scripts de autocompletado para shells

contexto

Gestionar los contextos y configuraciones de la CLI

consola

Gestionar consolas

salud

Comandos relacionados con la sincronización de salud

licencia

Gestionar la información de licencia de SUSE® Observability

monitor

Gestionar monitores y configuraciones de monitoreo

rbac

Gestionar RBAC

service-token

Gestionar tokens de servicio.

ajustes

Gestionar configuraciones y ajustes de instancia

stackpack

Gestionar y subir StackPacks

tema

Gestionar temas de Kafka

topology-sync

Gestionar la sincronización de topologías

sesión-de-usuario

Inspeccionar sesiones de usuario

versión

Mostrar información de versión

Todos los comandos aceptan la --help bandera, que documenta el uso de cada comando.

Para información detallada sobre cualquier comando y sus subcomandos, ejecuta:

sts [command] --help

Actualización

Para actualizar a la última versión de la sts CLI, ejecuta de nuevo el comando de instalación.

Puedes comprobar la versión de la sts CLI que estás ejecutando actualmente con el comando sts version.

Desinstalación

Windows
macOS
Linux
Docker

Desinstalación rápida

Abre una Powershell terminal y ejecuta:

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

La sts CLI y toda la configuración asociada han sido eliminadas para el usuario actual.

Desinstalación manual

Abre una Powershell terminal y ejecuta cada paso uno por uno o todos a la vez. El sts CLI y toda la configuración asociada serán eliminados para el usuario actual.

Eliminar binario:

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

Eliminar configuración:

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

Eliminar el CLI de la vía del entorno:

$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)
}

Desinstalación rápida

Abre un terminal y ejecuta:

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

El sts CLI y toda la configuración asociada han sido eliminados para el usuario actual.

Desinstalación manual

Abra un terminal.
Para eliminar el sts CLI, ejecuta el comando:
```
rm -r /usr/local/bin/sts
```
Para eliminar la configuración del sts CLI, ejecuta el comando:
```
rm -r ~/.config/stackstate-cli
```

El sts CLI y toda la configuración asociada han sido eliminados para el usuario actual.

Desinstalación rápida

Abre un terminal y ejecuta:

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

El sts CLI y toda la configuración asociada han sido eliminados para el usuario actual.

Desinstalación manual

Abra un terminal.
Para eliminar el sts CLI, ejecuta el comando:
```
rm -r /usr/local/bin/sts
```
Para eliminar la configuración del sts CLI, ejecuta el comando:
```
rm -r ~/.config/stackstate-cli
```

El sts CLI y toda la configuración asociada han sido eliminados para el usuario actual.

Para eliminar la imagen del CLI y los contenedores, ejecuta:

docker rmi -f stackstate/stackstate-cli2

Código abierto

El SUSE® Observability sts CLI es de código abierto y se puede encontrar en GitHub en:

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