CycleCloud CLI

Article
04/11/2023

L’interface CLI Azure CycleCloud vous permet de gérer votre installation à partir d’une console ou d’un fichier de script.

Paramètres de l’interface CLI globale

Celles-ci sont disponibles pour toutes les commandes.

`-h, --help`

afficher ce message d’aide et quitter

`-v, --version`

Affiche la version de l’interface CLI.

`--config=CONFIG_FILE`

Spécifie le chemin d’accès à un fichier de configuration non par défaut à utiliser pour cette commande.

`--loglevel=LOG_LEVEL`

Définit le niveau de journal par défaut pour l’interface CLI.

compte cyclecloud

Gérer les comptes de fournisseur de cloud.

cyclecloud account <command> [-o OUTPUT_FILE]
                             [--dry-run]
                             [-f INPUT_FILE]
                             [--force]

sous-commande	description
list	répertorier les comptes
afficher <account_name>	afficher les détails d’un compte
créer	créer un compte
modifier <account_name>	modifier un compte existant
supprimer <account_name>	supprimer un compte existant

liste des comptes cyclecloud

répertorier les comptes

cyclecloud account list

cyclecloud account show

afficher les détails d’un compte

cyclecloud account show <account_name>

création d’un compte cyclecloud

créer un compte

cyclecloud account create [-o OUTPUT_FILE]
                          [--dry-run]
                          [-f INPUT_FILE]

`-o OUTPUT_FILE`

Écrit les paramètres de configuration sur le disque

`--dry-run`

Invite et valide les informations, mais n’applique aucune modification

`-f INPUT_FILE`

Lit la définition à partir d’un fichier de configuration au lieu d’inviter

modification du compte cyclecloud

modifier un compte existant

cyclecloud account edit <account_name> [-o OUTPUT_FILE]
                                       [--dry-run]
                                       [-f INPUT_FILE]

`-o OUTPUT_FILE`

Écrit les paramètres de configuration sur le disque

`--dry-run`

Invite et valide les informations, mais n’applique aucune modification

`-f INPUT_FILE`

Lit la définition à partir d’un fichier de configuration au lieu d’inviter

suppression du compte cyclecloud

supprimer un compte existant

cyclecloud account delete <account_name> [--force]

`--force`

Si la valeur est true, n’invite pas à supprimer le compte.

cyclecloud add_node

Ajoute d’autres nœuds au cluster.

cyclecloud add_node <CLUSTER> [--template=TEMPLATE]
                              [--count=COUNT]
                              [--fixed]

`-t TEMPLATE, --template=TEMPLATE`

Modèle à utiliser pour ce nœud. Si ce n’est pas spécifié, la valeur par défaut consiste à utiliser le seul modèle disponible sinon, erreur.

`-c COUNT, --count=COUNT`

Nombre de nœuds à démarrer. Si cet argument n'est pas spécifié, la valeur par défaut est 1.

`-f, --fixed`

Si elle est définie, le nœud est ajouté définitivement (jusqu’à la suppression) au modèle de cluster. Sinon, le nœud est supprimé automatiquement lors de l’arrêt.

configuration cyclecloud

Basculer facilement entre les configurations cyclecloud

cyclecloud config <command>

sous-commande	description
show	afficher la configuration actuelle en cours d’utilisation
list	répertorier les configurations disponibles
créer <config_name>	créer une configuration
renommer <old_name new_name><>	renommer une configuration existante
utiliser <config_name>	basculer vers une configuration spécifiée
supprimer <config_name>	supprimer une configuration nommée

cyclecloud config show

afficher la configuration actuelle en cours d’utilisation

cyclecloud config show

liste de configuration cyclecloud

répertorier les configurations disponibles

cyclecloud config list

création de configuration cyclecloud

créer une configuration

cyclecloud config create <config_name>

changement de nom de configuration cyclecloud

renommer une configuration existante

cyclecloud config rename <old_name> <new_name>

utilisation de la configuration cyclecloud

basculer vers une configuration spécifiée

cyclecloud config use <config_name>

configuration cyclecloud supprimer

supprimer une configuration nommée

cyclecloud config remove <config_name>

cyclecloud connect

Se connecte à une instance en cours d’exécution dans le cluster. À compter de la version 7.8, le nom peut être un nom de nœud, un nom d’hôte ou une adresse IP.

cyclecloud connect <NAME> [--keyfile=KEYFILE]
                          [--cluster=CLUSTER]
                          [--user=USER]
                          [--bastion-host=BASTION-HOST]
                          [--bastion-port=BASTION-PORT]
                          [--bastion-user=BASTION-USER]
                          [--bastion-key=BASTION-KEY]

`-k KEYFILE, --keyfile=KEYFILE`

La clé à utiliser, si elle n’est pas donnée sur le nœud ou le nœud n’existe pas.

`-c CLUSTER, --cluster=CLUSTER`

Le cluster dans lequel se trouve le nœud, si le nom est un nom de nœud. Facultatif, sauf s’il existe plusieurs nœuds portant le même nom.

`-u USER, --user=USER`

L’utilisateur avec lequel se connecter au nœud.

`--bastion-host=BASTION-HOST`

Hôte bastion SSH pour acheminer les connexions via.

`--bastion-port=BASTION-PORT`

Port SSH pour la connexion au bastion.

`--bastion-user=BASTION-USER`

Connexion utilisateur pour la connexion au bastion.

`--bastion-key=BASTION-KEY`

Fichier de clé privée pour la connexion au bastion.

cyclecloud copy_cluster

Effectue une copie d’un cluster.

cyclecloud copy_cluster <source_cluster_name> <new_cluster_name> [--parameters=PARAMETERS]

`-p PARAMETERS, --parameters=PARAMETERS`

Fichier de paramètres à utiliser

cyclecloud create_cluster

Crée un cluster à partir d’un modèle existant.

cyclecloud create_cluster <TEMPLATE> <NAME> [--force]
                                            [--parameters=PARAMETERS]
                                            [--parameter-override=PARAMETER_OVERRIDE]

`--force`

Si spécifié, le cluster est remplacé s’il existe

`-p PARAMETERS, --parameters=PARAMETERS`

Fichier de paramètres à utiliser

`-P PARAMETER_OVERRIDE, --parameter-override=PARAMETER_OVERRIDE`

Ajoutez ou remplacez un paramètre spécifique. Prend le précédent sur les valeurs spécifiées dans -p.

informations d’identification cyclecloud

Gérer les informations d’identification du compte de fournisseur cloud.

cyclecloud credential <command>

sous-commande	description
list	répertorier les informations d’identification
créer	Créer des justificatifs
modifier <account_name>	modifier des informations d’identification existantes
supprimer <account_name>	supprimer des informations d’identification existantes

liste d’informations d’identification cyclecloud

répertorier les informations d’identification

cyclecloud credential list

création d’informations d’identification cyclecloud

Créer des justificatifs

cyclecloud credential create

modification des informations d’identification cyclecloud

modifier des informations d’identification existantes

cyclecloud credential edit <account_name>

suppression des informations d’identification cyclecloud

supprimer des informations d’identification existantes

cyclecloud credential delete <account_name>

delete_cluster cyclecloud

Supprime un cluster non en cours d’exécution.

cyclecloud delete_cluster <CLUSTER> [--recursive]
                                    [--force]

`-r, --recursive`

Supprimez de manière récursive ce cluster et tous ses sous-clusters.

`--force`

Forcer la suppression de ce cluster. Remarque : utilisez cette option uniquement si toutes les ressources de votre fournisseur de cloud sont déjà terminées !

delete_template cyclecloud

Supprime un modèle de cluster

cyclecloud delete_template <TEMPLATE>

cyclecloud export_parameters

Exporter des paramètres pour un cluster donné.

cyclecloud export_parameters <cluster_name> [-o OUTPUT_FILE]
                                            [--format=OUTPUT_FORMAT]

`-o OUTPUT_FILE`

Pour créer, écrit les paramètres du cluster sur le disque

`--format=OUTPUT_FORMAT`

Format de sortie

image cyclecloud

Gérer des images personnalisées.

cyclecloud image <command> [--account=ACCOUNTS]
                           [--name=NAME]
                           [--label=LABEL]
                           [--package-version=PACKAGE_VERSION]
                           [--bump-version=BUMP_VERSION]
                           [--os=OS]
                           [--jetpack-version=JETPACK_VERSION]
                           [--install-jetpack]
                           [--jetpack-platform=JETPACK_PLATFORM]
                           [--dry-run]

sous-commande	description
ajouter <image_name> [...]	ajouter une ou plusieurs images

image cyclecloud add

ajouter une ou plusieurs images

cyclecloud image add <image_name> [...] [--account=ACCOUNTS]
                                        [--name=NAME]
                                        [--label=LABEL]
                                        [--package-version=PACKAGE_VERSION]
                                        [--bump-version=BUMP_VERSION]
                                        [--os=OS]
                                        [--jetpack-version=JETPACK_VERSION]
                                        [--install-jetpack]
                                        [--jetpack-platform=JETPACK_PLATFORM]
                                        [--dry-run]

`--account=ACCOUNTS`

Rechercher uniquement ce compte (peut être répété pour plusieurs comptes)

`--name=NAME`

Nom du package à créer (obligatoire)

`--label=LABEL`

Étiquette du package à créer

`--package-version=PACKAGE_VERSION`

Utilisez cette version pour la nouvelle image au lieu de la valeur par défaut 1.0.0

`--bump-version=BUMP_VERSION`

Utilisez « --bump-version minor » pour incrémenter la dernière version mineure de 1 (par exemple, 1.1 à 1.2), ou utilisez « ---bump-version major » ou « ---bump-version patch »

`--os=OS`

Utilisez « --os linux/windows » pour spécifier le système d’exploitation sur l’image

`--jetpack-version=JETPACK_VERSION`

Version de jetpack installée ou doit être installée sur l’image

`--install-jetpack`

Installer jetpack au moment de l’exécution sur cette image

`--jetpack-platform=JETPACK_PLATFORM`

La plateforme jetpack utilisée sur l’image (par exemple, centos-7, ubuntu-14.04, windows

`--dry-run`

Recherche des images correspondantes, mais ne stocke aucune information d’image

cyclecloud import_cluster

Crée un cluster à partir d’un fichier texte. Si CLUSTER n’est pas donné et que le fichier a un seul cluster, le nom de ce cluster est utilisé.

cyclecloud import_cluster [CLUSTER] [-c TEMPLATE]
                                    [--force]
                                    [--as-template]
                                    [--file=FILE]
                                    [--parameters=PARAMETERS]
                                    [--parameter-override=PARAMETER_OVERRIDE]
                                    [--recursive]

`-c TEMPLATE`

Cluster dans le fichier à importer. S’il n’est pas spécifié, le nom du nouveau cluster est utilisé.

`--force`

S’il est spécifié, le cluster est remplacé s’il existe.

`-t, --as-template`

S’il est spécifié, le cluster est stocké en tant que modèle qui ne peut être utilisé que pour créer d’autres clusters.

`-f FILE, --file=FILE`

Fichier à partir duquel importer le modèle.

`-p PARAMETERS, --parameters=PARAMETERS`

Fichier de paramètres à utiliser

`-P PARAMETER_OVERRIDE, --parameter-override=PARAMETER_OVERRIDE`

Ajoutez ou remplacez un paramètre spécifique. Prend un précédent sur les valeurs spécifiées dans -p.

`-r, --recursive`

Importe le cluster nommé et tous les clusters du fichier pour lequel il est le parent.

cyclecloud import_template

Importe un modèle de cluster à partir d’un fichier texte. Si NAME n’est pas donné et que le fichier a un seul cluster, le nom de ce cluster est utilisé.

cyclecloud import_template [NAME] [-c TEMPLATE]
                                  [--force]
                                  [--file=FILE]

`-c TEMPLATE`

Modèle dans le fichier à importer. S’il n’est pas spécifié, le nom du nouveau modèle est utilisé.

`--force`

S’il est spécifié, le modèle est remplacé s’il existe

`-f FILE, --file=FILE`

Fichier à partir duquel importer le modèle.

initialisation de cyclecloud

Initialise les paramètres CycleCloud.

cyclecloud initialize [--batch]
                      [--force]
                      [--url=URL]
                      [--username=USERNAME]
                      [--password=PASSWORD]
                      [--verify-ssl=VERIFY-SSL]
                      [--name=NAMED_CONFIG]

`--batch`

S’il est spécifié, les arguments doivent être fournis sur la ligne de commande. Les questions seront supposées être « non ».

`--force`

Forcez une nouvelle initialisation même si le fichier config valide est disponible.

`--url=URL`

URL de base de l’installation de CycleServer.

`--username=USERNAME`

Nom d’utilisateur de l’installation de CycleServer.

`--password=PASSWORD`

Mot de passe de l’installation de CycleServer.

`--verify-ssl=VERIFY-SSL`

Indique s’il faut vérifier (true) ou non (false) les certificats SSL pour l’installation de CycleServer.

`--name=NAMED_CONFIG`

Créer une configuration nommée qui peut être utilisée avec la commande config

casier cyclecloud

Gérer les casiers CycleCloud.

cyclecloud locker <command>

sous-commande	description
list	répertorier les casiers
show <locker>	afficher les détails d’un casier

liste de casiers cyclecloud

répertorier les casiers

cyclecloud locker list

cyclecloud locker show

afficher les détails d’un casier

cyclecloud locker show <locker>

projet cyclecloud

Gérer les projets CycleCloud.

cyclecloud project <command> [--skip-teardown]
                             [--output-json=JSON_FILE]
                             [--junit-xml=JUNIT_FILE]
                             [--extra-var=EXTRA_VARS]
                             [--template=TEMPLATE]
                             [--name=CLUSTER_NAME]
                             [--global]
                             [--project-version=PROJECT_VERSION]
                             [--build-dir=BUILD_DIR]

sous-commande	description
init <name>	créer un projet vide
chemin d’accès d’extraction d’URL <><>	extrait un projet à partir d’une URL> Github <vers le chemin d’accès <>
info	afficher les informations de projet
<spécification add_spec>	ajoute une spécification au projet
<casier default_locker>	définit le ou les casiers par défaut à charger sur
test	exécuter un test d’intégration pour une définition de cluster donnée
build	générer le projet
upload [locker]	générer et charger le projet le ou les casiers spécifiés (utilise la valeur par défaut si aucun n’est spécifié)
télécharger [locker]	télécharger les objets blob de projet à partir du ou des casiers spécifiés (utilise la valeur par défaut si aucun spécifié)
<fichier generate_template>	générer un modèle de cluster pour le projet, écrit dans <un fichier>

cyclecloud project init

créer un projet vide

cyclecloud project init <name>

extraction de projet cyclecloud

extrait un projet à partir d’une URL> Github <vers le chemin d’accès <>

cyclecloud project fetch <url> <path>

informations sur le projet cyclecloud

afficher les informations de projet

cyclecloud project info

add_spec de projet cyclecloud

ajoute une spécification au projet

cyclecloud project add_spec <spec>

default_locker de projet cyclecloud

définit le ou les casiers par défaut à charger sur

cyclecloud project default_locker <locker> [--global]

`--global`

Définissez la valeur par défaut globale au lieu d’une valeur spécifique au projet.

test de projet cyclecloud

exécuter un test d’intégration pour une définition de cluster donnée

cyclecloud project test [--skip-teardown]
                        [--output-json=JSON_FILE]
                        [--junit-xml=JUNIT_FILE]
                        [--extra-var=EXTRA_VARS]
                        [--template=TEMPLATE]
                        [--name=CLUSTER_NAME]

`--skip-teardown`

Ignorer la suppression du cluster créé pour le test

`--output-json=JSON_FILE`

Sortie des résultats dans le fichier json spécifié

`--junit-xml=JUNIT_FILE`

Générer les résultats au format junit-xml dans le fichier json spécifié

`-e EXTRA_VARS, --extra-var=EXTRA_VARS`

Paires clé=valeur arbitraires utilisées pour paramétrer le modèle de cluster testé

`-t TEMPLATE, --template=TEMPLATE`

Chemin d’accès au fichier de modèle de cluster

`-n CLUSTER_NAME, --name=CLUSTER_NAME`

Nom de la définition de cluster à tester

build du projet cyclecloud

générer le projet

cyclecloud project build [--project-version=PROJECT_VERSION]
                         [--build-dir=BUILD_DIR]

`--project-version=PROJECT_VERSION`

Remplacer la version du projet présente dans project.ini

`--build-dir=BUILD_DIR`

Répertoire de build

chargement du projet cyclecloud

générer et charger le projet le ou les casiers spécifiés (utilise la valeur par défaut si aucun n’est spécifié)

cyclecloud project upload [locker] [--project-version=PROJECT_VERSION]

`--project-version=PROJECT_VERSION`

Remplacer la version du projet présente dans project.ini

téléchargement du projet cyclecloud

télécharger les objets blob de projet à partir du ou des casiers spécifiés (utilise la valeur par défaut si aucun spécifié)

cyclecloud project download [locker]

generate_template de projet cyclecloud

générer un modèle de cluster pour le projet, écrit dans <un fichier>

cyclecloud project generate_template <file>

reboot_node cyclecloud

Redémarrez un nœud en cours d’exécution.

cyclecloud reboot_node <CLUSTER> <NODE_NAME>

cyclecloud remove_node

Supprime un nœud du cluster (et l’arrête en cas de démarrage).

cyclecloud remove_node <CLUSTER> <NODE_NAME> [--filter=FILTER]
                                             [--instance-filter=INSTANCE_FILTER]
                                             [--creds=CREDS]
                                             [--no-prompt]
                                             [--force]

`-f FILTER, --filter=FILTER`

Supprimez les nœuds correspondant à l’expression class-ad complète.

`--instance-filter=INSTANCE_FILTER`

Supprimez des nœuds avec des instances actives correspondant à l’expression class-ad complète.

`--creds=CREDS`

Supprimez les nœuds démarrés à l’aide de l’ensemble nommé d’informations d’identification.

`--no-prompt`

S’il est spécifié, ne demande pas de confirmation avant de mettre fin aux nœuds en fonction d’un filtre.

`--force`

Forcer la suppression de ce nœud, même si elle n’est pas terminée. Remarque : utilisez cette option uniquement si les ressources de ce nœud dans votre fournisseur de cloud sont déjà terminées !

nouvelle tentative cyclecloud

Nouvelles tentatives d’initialisation ayant échoué pour le cluster nommé.

cyclecloud retry <CLUSTER> [--recursive]

`-r, --recursive`

Nouvelles tentatives récursives dans ce cluster et tous ses sous-clusters.

show_cluster cyclecloud

Affiche le cluster ou les clusters dans CycleCloud.

cyclecloud show_cluster <CLUSTER> [--recursive]
                                  [--long]
                                  [--templates]

`-r, --recursive`

Afficher ce cluster et tous ses sous-clusters.

`-l, --long`

Répertorie chaque nœud plutôt que d’afficher un résumé.

`-t, --templates`

Incluez des modèles de cluster dans la sortie.

show_nodes cyclecloud

Afficher les détails des nœuds/instances sélectionnés.

cyclecloud show_nodes [NAME] [--attrs=ATTRS]
                             [--filter=FILTER]
                             [--instance-filter=INSTANCE_FILTER]
                             [--output=OUTPUT]
                             [--format=FORMAT]
                             [--creds=CREDS]
                             [--cluster=CLUSTER]
                             [--states=STATES]
                             [--long]
                             [--summary]

`-a ATTRS, --attrs=ATTRS`

Afficher l’ensemble spécifié d’attributs (liste séparée par des virgules).

`-f FILTER, --filter=FILTER`

Afficher uniquement les nœuds correspondant à l’expression class-ad complète.

`--instance-filter=INSTANCE_FILTER`

Afficher uniquement les nœuds avec des instances actives correspondant à l’expression class-ad complète.

`--output=OUTPUT`

Sortie des attributs de nœud correspondants décrits par une chaîne de format de paramètre nommé de style Python. Ex. --output="Name: %(Name)s\t(ID: %(InstanceId)s)\n Cluster: %(ClusterName)s\n »

`--format=FORMAT`

Modifiez le format d’affichage de sortie [xml | json | texte].

`--creds=CREDS`

Afficher uniquement les nœuds démarrés à l’aide de l’ensemble nommé d’informations d’identification.

`-c CLUSTER, --cluster=CLUSTER`

Afficher uniquement les nœuds dans le cluster spécifié.

`--states=STATES`

Afficher uniquement les nœuds dans les états spécifiés (liste séparée par des virgules).

`-l, --long`

Affichez la représentation complète de la classe publicitaire du nœud.

`-s, --summary`

Afficher une représentation minimale du nœud.

start_cluster cyclecloud

Démarre le cluster nommé.

cyclecloud start_cluster <CLUSTER> [--recursive]
                                   [--test]

`-r, --recursive`

Démarrez ce cluster de manière récursive et tous ses sous-clusters.

`-t, --test`

Démarrer le cluster en mode test

start_node cyclecloud

(Re-) Démarre les nœuds arrêtés dans un cluster en cours d’exécution.

cyclecloud start_node <CLUSTER> <NODE_NAME>

terminate_cluster cyclecloud

Met fin au cluster nommé.

cyclecloud terminate_cluster <CLUSTER> [--recursive]

`-r, --recursive`

Mettre fin de manière récursive à ce cluster et à tous ses sous-clusters.

cyclecloud terminate_node

Met fin à un nœud en cours d’exécution (mais le laisse dans le cluster).

cyclecloud terminate_node <CLUSTER> <NODE_NAME> [--filter=FILTER]
                                                [--instance-filter=INSTANCE_FILTER]
                                                [--creds=CREDS]
                                                [--no-prompt]

`-f FILTER, --filter=FILTER`

Terminez les nœuds correspondant à l’expression class-ad complète.

`--instance-filter=INSTANCE_FILTER`

Terminez les nœuds avec des instances actives correspondant à l’expression class-ad complète.

`--creds=CREDS`

Mettre fin aux nœuds démarrés à l’aide de l’ensemble nommé d’informations d’identification.

`--no-prompt`

S’il est spécifié, ne demande pas de confirmation avant de mettre fin aux nœuds en fonction d’un filtre.