Utilisation des commandes stanctl

Utilisez l'interface de ligne de commande (CLI) stanctl pour installer et configurer Instana.

Remarque : utilisez stanctl --help pour afficher toutes les commandes disponibles.

Attention :

Standard Edition en auto-hébergement 1.10.3 and earlier versions :

Pour les installations en ligne (sans isolation physique), la plupart des commandes stanctl de gestion du cycle de vie, telles que [...] stanctl up , ne s'exécuteront pas.
Pour les installations en mode air-gap, les stanctl commandes continuent de fonctionner.

Action requise : effectuez une mise à niveau stanctl vers la version 1.10.4 ou une version ultérieure avant d'effectuer une opération liée au cycle de vie.

Exemple : dans les déploiements en ligne exécutant stanctl1.10.3 ou une version antérieure, tout workflow qui arrête des services, par exemple une stanctl down commande, avant une sauvegarde, ne peut pas aboutir car la commande stanctl up suivante échoue. Mettez à jour stanctl votre système vers la version 1.10.4 ou une version ultérieure avant de suivre ces étapes.

Commandes fréquemment utilisées

Modifier en ligne

Les commandes stanctl suivantes sont fréquemment utilisées.

agent stanctl
Système de back-end stanctl
stanctl vers le haut

Pour plus d'informations sur une commande, utilisez l'indicateur --help .

stanctl [command] --help

Indicateurs pour les valeurs de configuration personnalisées

Modifier en ligne

La commande stanctl utilise des valeurs par défaut pour certaines configurations.

Pour utiliser des valeurs personnalisées à la place des valeurs par défaut, vous pouvez utiliser des indicateurs pour transmettre des valeurs de configuration aux commandes stanctl . Utilisez stanctl [command] --help pour afficher la liste des options de configuration disponibles.

Par exemple, stanctl utilise le point de montage /mnt/instana/stanctl/analytics par défaut pour Analytics. Si vous souhaitez utiliser un point de montage personnalisé, vous pouvez utiliser l'indicateur --volume-analytics . Voir l'exemple suivant :

stanctl up --volume-analytics <custom-path>

Configuration de la stratégie de mise à jour pour les mises à niveau

Modifier en ligne

Vous pouvez configurer la stratégie de mise à jour du déploiement d' Standard Edition pour les composants backend lors des mises à niveau en utilisant l'option --core-update-strategy dans la stanct commande.

Gestion des stratégies

Modifier en ligne

La stanctl commande prend en charge les stratégies de mise à jour suivantes :

RollingUpdate (par défaut pour l'environnement de production)
- Garantit une disponibilité totale pendant les mises à jour.
- Cela nécessite davantage de puissance de calcul (CPU) et de mémoire pour faire fonctionner simultanément les anciens et les nouveaux pods.
- Recommandé pour les systèmes de production disposant de ressources suffisantes.
Recréer (paramètre par défaut pour la démo)
- Provoque une brève interruption de service (de quelques minutes) pendant les mises à jour.
- Ne nécessite pas de capacité supplémentaire.
- Recommandé pour les systèmes aux ressources limitées, les déploiements à nœud unique ou les installations d' Standard Edition s utilisant des distributions d' Kubernetes légères telles que K3s.

Remarque : les installations de démonstration utilisent par défaut la stratégie « Recreate ». Les installations de production utilisent par défaut la stratégie « RollingUpdate ». Vous pouvez remplacer ces valeurs par défaut en utilisant l'option --core-update-strategy .

Pour plus d'informations sur les cas dans lesquels il convient d'utiliser cette stratégie, consultez la section « Échec de la mise à niveau avec les erreurs « CPU insuffisant » ou « Mémoire insuffisante » ».

Exemples d'utilisation

Modifier en ligne

Utilisez la stratégie « Recreate » dans les environnements aux ressources limitées :

stanctl up --core-update-strategy=Recreate

Spécifiez explicitement la stratégie d' RollingUpdate :

stanctl up --core-update-strategy=RollingUpdate

Variables d'environnement

Modifier en ligne

Vous pouvez stocker des valeurs de configuration personnalisées en tant que variables d'environnement en les exportant ou en les stockant dans un fichier d'environnement (.env).

Le nom de la variable d'environnement d'un indicateur de configuration doit commencer par STANCTL_. Utilisez --help pour afficher le nom de la variable d'environnement d'un indicateur.

Par exemple, si vous exécutez stanctl up --help, vous voyez que le nom de la variable d'environnement pour l'indicateur --volume-analytics est STANCTL_VOLUME_ANALYTICS.

Lorsque vous définissez des variables d'environnement pour les indicateurs, la commande stanctl utilise automatiquement les valeurs de variable d'environnement pour la configuration.

Examinez l'exemple --volume-analytics utilisé dans la section précédente. Si vous avez défini une variable d'environnement pour l'indicateur, vous pouvez exécuter la commande stanctl up sans spécifier l'indicateur --volume-analytics . La commande utilise la valeur de la variable d'environnement.

Toutefois, si vous définissez la variable d'environnement et que vous spécifiez également l'indicateur à l'aide de la commande, stanctl utilise la valeur de l'indicateur et non de la variable d'environnement.

Exporter les variables d'environnement

Modifier en ligne

Vous pouvez définir des variables d'environnement à l'aide de la commande export . Toutefois, ce paramètre n'est pas persistant.

Voir cet exemple :

export STANCTL_VOLUME_ANALYTICS=/data/analytics
export STANCTL_CORE_BASE_DOMAIN=instana.example.com
export STANCTL_INSTALL_TYPE=production

Utiliser le fichier d'environnement

Modifier en ligne

Ajoutez les variables d'environnement dans un fichier .env .

STANCTL_VOLUME_ANALYTICS=/data/analytics
STANCTL_CORE_BASE_DOMAIN=instana.example.com
STANCTL_INSTALL_TYPE=production

Vous pouvez exécuter les commandes stanctl à partir du répertoire du fichier .env .

stanctl up

Vous pouvez également utiliser l'indicateur --env-file pour spécifier le chemin d'accès au fichier d'environnement.

stanctl up --env-file <path-to-the-.env-file>

Instana versions du backend et des images

Modifier en ligne

Avant d'installer ou de mettre à jour Standard Edition, vous pouvez consulter la liste des versions et des images du backend d' Instana disponibles à l'installation.

Pour afficher la liste des versions du backend d' Instana, exécutez la commande suivante. Cette commande exclut de la liste votre version actuelle et les versions antérieures du backend.
```
stanctl versions identify
 
```
Voir l'exemple suivant :
```
$ stanctl versions identify
⠏ Identifying supported Instana versions  [0s] ✓
Identified the following Instana versions:
- 3.283.450-0
- 3.281.446-0
- 3.279.395-0
 
```

Pour afficher les images disponibles avec une version du backend Instana, exécutez les commandes suivantes :

Pour sélectionner une version du backend d' Instana, puis afficher les images disponibles pour cette version, exécutez la commande suivante :

stanctl versions list-images

Voir l'exemple suivant :

$ stanctl versions list-images
? Select Instana version:

[Use arrows to move, type to filter]
 > 3.283.450-0
   3.281.446-0
   3.279.395-0
   Cancel

stanctl versions list-images
? Select Instana version:

3.283.450-0
artifact-public.instana.io/backend/acceptor:3.283.450-0
artifact-public.instana.io/backend/accountant:3.283.450-0
artifact-public.instana.io/backend/action-orchestration:3.283.450-0
artifact-public.instana.io/backend/action-reader:3.283.450-0
.
.
.

Pour afficher les images disponibles dans une version spécifique du backend d' Instana, exécutez la commande suivante. La demande de sélection d'une version du backend ne s'affiche pas.

stanctl versions list-images --instana-version <backend-version>

Voir l'exemple suivant :

$ stanctl versions list-images --instana-version 3.283.450-0

artifact-public.instana.io/backend/acceptor:3.283.450-0
artifact-public.instana.io/backend/accountant:3.283.450-0
artifact-public.instana.io/backend/action-orchestration:3.283.450-0
artifact-public.instana.io/backend/action-reader:3.283.450-0
.
.
.