CycleCloud CLI

La CLI de Azure CycleCloud le permite administrar la instalación desde una consola o un archivo de script.

Parámetros globales de CLI

Estos parámetros están disponibles para todos los comandos.

-h, --help

Muestra el mensaje de ayuda y se cierra.

-v, --version

Muestra la versión de la CLI.

--config=CONFIG_FILE

Especifica la ruta de acceso a un archivo de configuración no predeterminado que se usará para este comando.

--loglevel=LOG_LEVEL

Establece el nivel de registro predeterminado para la CLI.

cyclecloud cuenta

Administrar cuentas de proveedor de nube.

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

lista de cuentas cyclecloud

Enumerar cuentas.

cyclecloud account list

mostrar cuenta de cyclecloud

Mostrar detalles de una cuenta.

cyclecloud account show <account_name>

cyclecloud crear cuenta

Crea una nueva cuenta.

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

-o OUTPUT_FILE

Escribe los parámetros de configuración en el disco.

--dry-run

Solicita y valida la información, pero no aplica ningún cambio.

-f INPUT_FILE

Lee la definición de un archivo de configuración en lugar de preguntar.

editar cuenta de CycleCloud

Edite una cuenta existente.

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

-o OUTPUT_FILE

Escribe los parámetros de configuración en el disco.

--dry-run

Solicita y valida la información, pero no aplica ningún cambio.

-f INPUT_FILE

Lee la definición de un archivo de configuración en lugar de preguntar.

eliminar cuenta de cyclecloud

Elimine una cuenta existente.

cyclecloud account delete <account_name> [--force]

--force

Si es true, no se le pide que elimine la cuenta.

cyclecloud add_node

Agrega más nodos al clúster.

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

-t TEMPLATE, --template=TEMPLATE

Plantilla que se va a usar para este nodo. Si no se especifica, el valor predeterminado es usar la única plantilla disponible; de lo contrario, se producirá un error.

-c COUNT, --count=COUNT

¿Cuántos nodos para comenzar? Si no se especifica, el valor predeterminado es 1.

-f, --fixed

Si se establece, el nodo se agrega permanentemente (hasta que se quita) a la plantilla de clúster. De lo contrario, el nodo se quita automáticamente cuando finaliza.

cyclecloud config

Cambia fácilmente entre configuraciones de CycleCloud.

cyclecloud config <command>

cyclecloud config show

Muestra la configuración actual.

cyclecloud config show

lista de configuración de cyclecloud

Enumera las configuraciones disponibles.

cyclecloud config list

cyclecloud config create

Cree una nueva configuración.

cyclecloud config create <config_name>

cyclecloud config rename

Cambie el nombre de una configuración existente.

cyclecloud config rename <old_name> <new_name>

cyclecloud config use

Cambie a una configuración especificada.

cyclecloud config use <config_name>

cyclecloud config remove

Quite una configuración con un nombre específico.

cyclecloud config remove <config_name>

cyclecloud connect

Se conecta a una instancia en ejecución en el clúster. A partir de la versión 7.8, el nombre puede ser un nombre de nodo, un nombre de host o una dirección 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

El par de claves a utilizar, si no se especifica en el nodo o el nodo no existe.

-c CLUSTER, --cluster=CLUSTER

El clúster en el que se encuentra el nodo, si el nombre es un nombre de nodo. Opcional a menos que haya varios nodos con el mismo nombre.

-u USER, --user=USER

El usuario que va a iniciar sesión en el nodo.

--bastion-host=BASTION-HOST

Servidor bastión SSH para enrutar las conexiones.

--bastion-port=BASTION-PORT

Puerto SSH para conectarse al bastión.

--bastion-user=BASTION-USER

Nombre de usuario para conectarse al bastión.

--bastion-key=BASTION-KEY

Archivo de clave privada para conectarse al bastión.

cyclecloud copy_cluster

Realiza una copia de un clúster.

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

-p PARAMETERS, --parameters=PARAMETERS

Archivo de parámetros que se va a usar.

cyclecloud create_cluster

Crea un clúster a partir de una plantilla existente.

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

--force

Si se especifica, el clúster se reemplaza si existe.

-p PARAMETERS, --parameters=PARAMETERS

Archivo de parámetros que se va a usar.

-P PARAMETER_OVERRIDE, --parameter-override=PARAMETER_OVERRIDE

Agregue o invalide un parámetro específico. Esta opción tiene prioridad sobre los valores especificados en -p.

credencial de cyclecloud

Administrar las credenciales de la cuenta del proveedor de nube.

cyclecloud credential <command>

lista de credenciales de cyclecloud

Enumerar las credenciales.

cyclecloud credential list

cyclecloud credential create

Cree una nueva credencial.

cyclecloud credential create

cyclecloud credential edit

Edite una credencial existente.

cyclecloud credential edit <account_name>

eliminar credencial en cyclecloud

Elimine una credencial existente.

cyclecloud credential delete <account_name>

cyclecloud eliminar_clúster

Elimine un clúster inactivo.

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

-r, --recursive

Elimine de forma recursiva este clúster y todos sus subclusters.

--force

Forzar la eliminación de este clúster. Use esta opción solo si todos los recursos del proveedor de nube ya están terminados.

cyclecloud delete_template

Elimine una plantilla de clúster.

cyclecloud delete_template <TEMPLATE>

cyclecloud export_parameters

Exportar parámetros para un clúster determinado.

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

-o OUTPUT_FILE

Para crear, escribe los parámetros del clúster en el disco.

--format=OUTPUT_FORMAT

Formato de salida.

imagen cyclecloud

Administrar imágenes personalizadas.

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 image add

Agregue una o varias imágenes.

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

Busque solo esta cuenta. Puede repetir esta opción para varias cuentas.

--name=NAME

Nombre del paquete que se va a crear. Este parámetro es obligatorio.

--label=LABEL

Etiqueta del paquete a crear.

--package-version=PACKAGE_VERSION

Use esta versión para la nueva imagen en lugar del valor predeterminado de 1.0.0.

--bump-version=BUMP_VERSION

Use --bump-version minor para incrementar la versión secundaria más reciente en 1 (por ejemplo, 1.1 a 1.2) o use --bump-version major o --bump-version patch.

--os=OS

Use --os linux/windows para especificar el sistema operativo en la imagen.

--jetpack-version=JETPACK_VERSION

La versión de Jetpack que está instalada o debe instalarse en la imagen.

--install-jetpack

Instale Jetpack en tiempo de ejecución en esta imagen.

--jetpack-platform=JETPACK_PLATFORM

La plataforma Jetpack usada en la imagen (por ejemplo, centos-7, ubuntu-14.04, windows).

--dry-run

Busca imágenes coincidentes, pero no almacena ninguna información de imagen.

cyclecloud import_cluster

Crea un clúster a partir de un archivo de texto. Si CLUSTER no se proporciona y el archivo contiene un único clúster, se usa el nombre de ese clúster.

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

-c TEMPLATE

Clúster del archivo que se va a importar. Si no se especifica, se usa el nombre del nuevo clúster.

--force

Si se especifica, el clúster se reemplaza si existe.

-t, --as-template

Si se especifica, el clúster se almacena como una plantilla que solo se puede usar para crear otros clústeres.

-f FILE, --file=FILE

Archivo para importar la plantilla.

-p PARAMETERS, --parameters=PARAMETERS

Archivo de parámetros que se va a usar.

-P PARAMETER_OVERRIDE, --parameter-override=PARAMETER_OVERRIDE

Agregue o invalide un parámetro específico. Tiene prioridad sobre los valores especificados en -p.

-r, --recursive

Importa el clúster con nombre y todos los clústeres del archivo para el que es el elemento primario.

cyclecloud import_template

Importa una plantilla de clúster desde un archivo de texto. Si no se da NAME y el archivo tiene un único clúster, se usa el nombre de ese clúster.

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

-c TEMPLATE

Plantilla del archivo que se va a importar. Si no se especifica, se usa el nombre de la nueva plantilla.

--force

Si se especifica, la plantilla se reemplaza si existe.

-f FILE, --file=FILE

Archivo para importar la plantilla.

cyclecloud inicializar

Inicializa la configuración de CycleCloud.

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

--batch

Si se especifica, los argumentos se deben proporcionar en la línea de comandos. Se considera que las respuestas a las preguntas son "no".

--force

Forzar la reinicialización incluso si hay disponible un archivo de configuración válido.

--url=URL

Dirección URL base para la instalación de CycleServer.

--username=USERNAME

Nombre de usuario para la instalación de CycleServer.

--password=PASSWORD

Contraseña de la instalación de CycleServer.

--verify-ssl=VERIFY-SSL

Si se deben comprobar (true) o no comprobar (false) los certificados SSL para la instalación de CycleServer.

--name=NAMED_CONFIG

Cree una configuración con nombre que pueda usar con el comando config.

cyclecloud locker

Administrar los almacenes de CycleCloud.

cyclecloud locker <command>

lista de almacenamientos de cyclecloud

Enumerar almacenes.

cyclecloud locker list

cyclecloud locker show

Mostrar detalle de un almacén.

cyclecloud locker show <locker>

proyecto cyclecloud

Administrar proyectos de 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

Cree un nuevo proyecto vacío.

cyclecloud project init <name>

cyclecloud project fetch

Captura un proyecto de un GitHub <url> en <path>.

cyclecloud project fetch <url> <path>

información del proyecto cyclecloud

Muestra la información del proyecto.

cyclecloud project info

add_spec del proyecto cyclecloud

Agrega una especificación al proyecto.

cyclecloud project add_spec <spec>

default_locker del proyecto cyclecloud

Establece el almacén predeterminado para las cargas.

cyclecloud project default_locker <locker> [--global]

--global

Establezca el valor predeterminado global en lugar del valor específico del proyecto.

prueba del proyecto cyclecloud

Ejecuta la prueba de integración para una definición de clúster.

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

--skip-teardown

Omita el desmantelamiento del clúster creado de prueba.

--output-json=JSON_FILE

Genera los resultados en el archivo JSON especificado.

--junit-xml=JUNIT_FILE

Genera los resultados en formato junit-xml en el archivo json especificado.

-e EXTRA_VARS, --extra-var=EXTRA_VARS

Pares clave=valor arbitrarios usados para parametrizar la plantilla de clúster sometida a prueba.

-t TEMPLATE, --template=TEMPLATE

Ruta de acceso al archivo de plantilla de clúster.

-n CLUSTER_NAME, --name=CLUSTER_NAME

Nombre de la definición del clúster que se va a probar.

construcción del proyecto cyclecloud

Compile el proyecto.

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

--project-version=PROJECT_VERSION

Invalide la versión del proyecto presente en project.ini.

--build-dir=BUILD_DIR

Directorio de compilación.

subida del proyecto CycleCloud

Construya y suba el proyecto de los casilleros especificados (utiliza el valor predeterminado si no se especifica ninguno).

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

--project-version=PROJECT_VERSION

Invalide la versión del proyecto presente en project.ini.

descarga del proyecto cyclecloud

Descargue los blobs del proyecto desde los casilleros especificados. Si no especifica casilleros, el comando utilizará los casilleros por defecto.

cyclecloud project download [locker]

generate_template del proyecto cyclecloud

Genere una plantilla de clúster para el proyecto. El comando escribe la plantilla en <file>.

cyclecloud project generate_template <file>

cyclecloud reboot_node

Reinicie un nodo en ejecución.

cyclecloud reboot_node <CLUSTER> <NODE_NAME>

cyclecloud remove_node

Quite un nodo del clúster. El comando termina el nodo si este ha sido iniciado.

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

-f FILTER, --filter=FILTER

Elimine los nodos que coincidan con la expresión class-ad completa.

--instance-filter=INSTANCE_FILTER

Elimine los nodos con instancias activas que coincidan con la expresión completa de class-ad.

--creds=CREDS

Quite los nodos que inició usando el conjunto de credenciales nombrado.

--no-prompt

Si se especifica, no solicita confirmación antes de finalizar los nodos según un filtro.

--force

Obligar a eliminar este nodo, incluso si no ha sido terminado. Use esta opción solo si los recursos de este nodo del proveedor de nube ya están terminados.

cyclecloud retry

Reintenta las operaciones de inicialización fallidas para el clúster especificado.

cyclecloud retry <CLUSTER> [--recursive]

-r, --recursive

Vuelva a intentar de forma recursiva las opciones de este clúster y todos sus subclusters.

cyclecloud show_cluster

Muestra el clúster o los clústeres en CycleCloud.

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

-r, --recursive

Muestre este clúster y todos sus subclusters.

-l, --long

Enumera cada nodo en lugar de mostrar un resumen.

-t, --templates

Incluya plantillas de clúster en la salida.

cyclecloud show_nodes

Mostrar detalles de los nodos o instancias seleccionados.

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

Muestra el conjunto de atributos especificado (lista separada por comas).

-f FILTER, --filter=FILTER

Mostrar solo los nodos que coinciden con la expresión completa de class-ad.

--instance-filter=INSTANCE_FILTER

Vea solo los nodos con instancias activas que coincidan con la expresión de anuncio de clase completa.

--output=OUTPUT

Muestra los atributos de nodo coincidentes descritos por una cadena de formato de parámetros nombrados al estilo de Python. Por ejemplo: --output="Name: %(Name)s\t(ID: %(InstanceId)s)\n Cluster: %(ClusterName)s\n".

--format=FORMAT

Cambie el formato de presentación de salida [xml | json | text].

--creds=CREDS

Mostrar solo los nodos iniciados con el conjunto de credenciales nombrado.

-c CLUSTER, --cluster=CLUSTER

Mostrar solo nodos en el clúster especificado.

--states=STATES

Mostrar solo nodos en los estados especificados (lista separada por comas).

-l, --long

Vea la representación completa del anuncio de clase del nodo.

-s, --summary

Muestra una representación mínima del nodo.

cyclecloud start_cluster

Inicia el clúster especificado.

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

-r, --recursive

Inicie de forma recursiva este clúster y todos sus subclusters.

-t, --test

Inicie el clúster en modo de prueba.

cyclecloud start_node

Inicia los nodos terminados en un clúster en ejecución.

cyclecloud start_node <CLUSTER> <NODE_NAME>

cyclecloud terminate_cluster

Finaliza el clúster denominado.

cyclecloud terminate_cluster <CLUSTER> [--recursive]

-r, --recursive

Termina de forma recursiva este clúster y todos sus subclústeres.

cyclecloud terminate_node

Finaliza un nodo en ejecución (pero lo deja en el clúster).

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

-f FILTER, --filter=FILTER

Termine los nodos que coincidan con la expresión de anuncio de clase completa.

--instance-filter=INSTANCE_FILTER

Finalice los nodos con instancias activas que coincidan con la expresión completa de clase-ad.

--creds=CREDS

Termine los nodos iniciados utilizando el conjunto de credenciales nombrado.

--no-prompt

Si se especifica, no se solicitará confirmación antes de finalizar los nodos basándose en un filtro.