CycleCloud CLI

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

Paramètres de l’interface CLI globale

Ces paramètres sont disponibles pour toutes les commandes.

-h, --help

Affiche le message d’aide et les sorties.

-v, --version

Affiche la version de l’interface CLI.

--config=CONFIG_FILE

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

--loglevel=LOG_LEVEL

Définit le niveau de journal par défaut de 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]

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éez un nouveau 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 de demander à l'utilisateur.

modification du compte cyclecloud

Modifiez 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 depuis un fichier de configuration plutôt que de demander.

suppression du compte cyclecloud

Supprimez 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. S'il n'est pas spécifié, la valeur par défaut est d'utiliser le seul modèle disponible, sinon une erreur se produit.

-c COUNT, --count=COUNT

Nombre de nœuds à démarrer. S’il n’est pas spécifié, la valeur par défaut est 1.

-f, --fixed

S’il est défini, le nœud est ajouté définitivement (jusqu’à ce qu’il soit supprimé) au modèle de cluster. Sinon, le nœud est automatiquement supprimé lorsqu’il est arrêté.

configuration cyclecloud

Basculez facilement entre les configurations cyclecloud.

cyclecloud config <command>

cyclecloud config show

Affichez la configuration actuelle.

cyclecloud config show

liste de configuration cyclecloud

Répertorier les configurations disponibles.

cyclecloud config list

cyclecloud config créer

Créez une nouvelle configuration.

cyclecloud config create <config_name>

changement de nom de configuration cyclecloud

Renommez une configuration existante.

cyclecloud config rename <old_name> <new_name>

cyclecloud config use

Basculez vers une configuration spécifiée.

cyclecloud config use <config_name>

cyclecloud config remove

Supprimez 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

Le couple de clés à utiliser, s'il n'est pas fourni sur le nœud ou si 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 pour se connecter au nœud.

--bastion-host=BASTION-HOST

Hôte bastion SSH pour faire transiter les connexions.

--bastion-port=BASTION-PORT

Port SSH pour la connexion au bastion.

--bastion-user=BASTION-USER

Nom d’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. Cette option est prioritaire sur les valeurs spécifiées dans -p.

informations d’identification cyclecloud

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

cyclecloud credential <command>

liste des identifiants CycleCloud

Répertorier les informations d’identification.

cyclecloud credential list

création d'identifiants CycleCloud

Créez un nouvel identifiant.

cyclecloud credential create

modification des informations d’identification cyclecloud

Modifiez des informations d’identification existantes.

cyclecloud credential edit <account_name>

suppression des informations d’identification cyclecloud

Supprimez des informations d’identification existantes.

cyclecloud credential delete <account_name>

cyclecloud delete_cluster

Supprimez un cluster inactif.

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. Utilisez cette option uniquement si toutes les ressources de votre fournisseur de cloud sont déjà arrêtées.

cyclecloud delete_template

Supprimez 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]

cyclecloud ajouter image

Ajoutez 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

Recherchez uniquement ce compte. Vous pouvez répéter cette option pour plusieurs comptes.

--name=NAME

Nom du package à créer. Ce paramètre est 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

Permet --bump-version minor d’incrémenter la dernière version mineure de 1 (par exemple, 1.1 à 1.2) ou d’utiliser --bump-version major ou --bump-version patch.

--os=OS

Permet --os linux/windows de spécifier le système d’exploitation sur l’image.

--jetpack-version=JETPACK_VERSION

La version de Jetpack qui est installée ou qui doit être installée sur l'image.

--install-jetpack

Installez Jetpack au moment de l’exécution sur cette image.

--jetpack-platform=JETPACK_PLATFORM

Plateforme Jetpack utilisée sur l’image (par exemple, centos-7, ubuntu-14.04, windows).

--dry-run

Recherche des images correspondantes, mais ne stocke pas d’informations sur l’image.

cyclecloud import_cluster

Crée un cluster à partir d’un fichier texte. Si CLUSTER n’est pas fourni et que le fichier contient 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

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

--force

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

-t, --as-template

Si 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 pour l’importation du 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. Prévaut sur les valeurs spécifiées dans -p.

-r, --recursive

Importe le cluster nommé et tous les clusters du fichier pour lesquels il s’agit du 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 possède 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

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

-f FILE, --file=FILE

Fichier pour l’importation du modèle.

cyclecloud initialize

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 sont supposées être « non ».

--force

Forcez la réinitialisation même si un 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

La vérification (true) ou non (false) des certificats SSL pour l’installation de CycleServer.

--name=NAMED_CONFIG

Créez une configuration nommée que vous pouvez utiliser avec la commande config.

cyclecloud locker

Gérer les coffres CycleCloud.

cyclecloud locker <command>

liste des coffres cyclecloud

List lockers.

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]

cyclecloud project init

Créez un projet vide.

cyclecloud project init <name>

cyclecloud project fetch

Récupère un projet à partir d’un GitHub <url> vers <path>.

cyclecloud project fetch <url> <path>

informations sur le projet cyclecloud

Affiche les informations du projet.

cyclecloud project info

projet cyclecloud ajouter_spécification

Ajoute une spécification au projet.

cyclecloud project add_spec <spec>

projet cyclecloud default_locker

Définit le casier par défaut pour les chargements.

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écute un test d’intégration pour une définition de cluster.

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

--skip-teardown

Ne pas effectuer la suppression du cluster créé pour les tests.

--output-json=JSON_FILE

Affichez les résultats dans le fichier json spécifié.

--junit-xml=JUNIT_FILE

Affichez 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 en cours de 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

Construisez le projet.

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

--project-version=PROJECT_VERSION

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

--build-dir=BUILD_DIR

Le répertoire de build.

chargement de projet cyclecloud

Générez et chargez le projet les coffres spécifiés (utilise la valeur par défaut si aucun coffre n’est spécifié).

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

--project-version=PROJECT_VERSION

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

téléchargement du projet cyclecloud

Téléchargez les blobs du projet à partir des espaces de stockage spécifiés. Si vous ne spécifiez pas de casiers, la commande utilise les casiers par défaut.

cyclecloud project download [locker]

projet cyclecloud générer_modèle

Générez un modèle de cluster pour le projet. La commande écrit le modèle dans <file>.

cyclecloud project generate_template <file>

cyclecloud reboot_node

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

cyclecloud reboot_node <CLUSTER> <NODE_NAME>

cyclecloud remove_node

Supprimez un nœud du cluster. La commande met fin au nœud s’il a démarré.

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 qui correspondent à l’expression class-ad complète.

--instance-filter=INSTANCE_FILTER

Supprimez les nœuds avec des instances actives qui correspondent à l'expression class-ad complète.

--creds=CREDS

Supprimez les nœuds que vous avez lancés avec l'ensemble nommé d'informations d'identification.

--no-prompt

Si cela est spécifié, aucune confirmation n'est demandée avant de terminer les nœuds sur la base d'un filtre.

--force

Forcer la suppression de ce nœud, même s’il n’est pas terminé. Utilisez cette option uniquement si les ressources de ce nœud dans votre fournisseur de cloud sont déjà arrêtées.

nouvelle tentative de cyclecloud

Tentatives de réinitialisation ont échoué pour le cluster nommé.

cyclecloud retry <CLUSTER> [--recursive]

-r, --recursive

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

cyclecloud show_cluster

Affiche le cluster ou les clusters dans CycleCloud.

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

-r, --recursive

Affichez 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.

cyclecloud show_nodes

Afficher les détails des nœuds ou 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

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

-f FILTER, --filter=FILTER

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

--instance-filter=INSTANCE_FILTER

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

--output=OUTPUT

Affichez les attributs du nœud correspondant décrits par une chaîne de format à paramètres nommés de style Python. Par exemple : --output="Name: %(Name)s\t(ID: %(InstanceId)s)\n Cluster: %(ClusterName)s\n".

--format=FORMAT

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

--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 class-ad complète du nœud.

-s, --summary

Affichez une représentation minimale du nœud.

cyclecloud start_cluster

Démarre le cluster nommé.

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

-r, --recursive

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

-t, --test

Démarrez le cluster en mode test.

cyclecloud start_node

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

cyclecloud start_node <CLUSTER> <NODE_NAME>

cyclecloud terminate_cluster

Termine le cluster nommé.

cyclecloud terminate_cluster <CLUSTER> [--recursive]

-r, --recursive

Terminez de façon récursive ce cluster et tous ses sous-clusters.

cyclecloud terminate_node

Arrête 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 qui correspondent à l'expression complète de class-ad.

--instance-filter=INSTANCE_FILTER

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

--creds=CREDS

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

--no-prompt

Si spécifié, ne demandez pas de confirmation avant d'arrêter les nœuds d'après un filtre.