Compartir a través de


CycleCloud CLI

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

Parámetros de la CLI global

Están disponibles para todos los comandos.

-h, --help

muestran este mensaje de ayuda y salen

-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 va a usar para este comando.

--loglevel=LOG_LEVEL

Establece el nivel de registro predeterminado para la CLI.

cuenta cyclecloud

Administrar cuentas de proveedor de nube.

cyclecloud account <command> [-o OUTPUT_FILE]
                             [--dry-run]
                             [-f INPUT_FILE]
                             [--force]
sub-comando description
list enumerar cuentas
mostrar <account_name> mostrar detalles de una cuenta
create crear una nueva cuenta
editar <account_name> editar una cuenta existente
eliminar <account_name> eliminar una cuenta existente

lista de cuentas de cyclecloud

enumerar cuentas

cyclecloud account list

cyclecloud account show

mostrar detalles de una cuenta

cyclecloud account show <account_name>

cyclecloud account create

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

edición de la cuenta cyclecloud

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

cyclecloud account delete

eliminar una cuenta existente

cyclecloud account delete <account_name> [--force]

--force

Si es true, no 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 en caso contrario.

-c COUNT, --count=COUNT

Número de nodos que se van a iniciar. Si no se especifica, el valor predeterminado es 1.

-f, --fixed

Si se establece, el nodo se agregará permanentemente (hasta que se quite) a la plantilla de clúster. De lo contrario, el nodo se quitará automáticamente cuando finalice.

cyclecloud config

Cambiar fácilmente entre configuraciones cyclecloud

cyclecloud config <command>
sub-comando description
show mostrar la configuración actual en uso
list enumerar configuraciones disponibles
crear <config_name> crear una nueva configuración
cambiar nombre <old_name new_name><> cambiar el nombre de una configuración existente
usar <config_name> cambiar a una configuración especificada
quitar <config_name> quitar una configuración con nombre

cyclecloud config show

mostrar la configuración actual en uso

cyclecloud config show

lista de configuración de cyclecloud

enumerar configuraciones disponibles

cyclecloud config list

cyclecloud config create

crear una nueva configuración

cyclecloud config create <config_name>

cyclecloud config rename

cambiar el nombre de una configuración existente

cyclecloud config rename <old_name> <new_name>

uso de la configuración de cyclecloud

cambiar a una configuración especificada

cyclecloud config use <config_name>

cyclecloud config remove

quitar una configuración con nombre

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 teclado que se va a usar, si no se proporciona 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

Usuario con el que iniciar sesión en el nodo.

--bastion-host=BASTION-HOST

Host bastión SSH para enrutar las conexiones a través.

--bastion-port=BASTION-PORT

Puerto SSH para conectarse al bastión.

--bastion-user=BASTION-USER

Inicio de sesión 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 reemplazará 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. Toma precedentes sobre los valores especificados en -p.

credencial de cyclecloud

Administrar las credenciales de la cuenta del proveedor de nube.

cyclecloud credential <command>
sub-comando description
list enumerar credenciales
create creación de una credencial
editar <account_name> editar una credencial existente
eliminar <account_name> eliminar una credencial existente

lista de credenciales de cyclecloud

enumerar credenciales

cyclecloud credential list

cyclecloud credential create

creación de una credencial

cyclecloud credential create

edición de credenciales de cyclecloud

editar una credencial existente

cyclecloud credential edit <account_name>

cyclecloud credential delete

eliminar una credencial existente

cyclecloud credential delete <account_name>

cyclecloud delete_cluster

Elimina un clúster que no se está ejecutando.

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

-r, --recursive

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

--force

Forzar la eliminación de este clúster. Nota: use esta opción solo si ya se han terminado todos los recursos del proveedor de nube.

cyclecloud delete_template

Elimina una plantilla de clúster

cyclecloud delete_template <TEMPLATE>

cyclecloud export_parameters

Exporte 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]
sub-comando description
agregar <image_name> [...] agregar una o varias imágenes

cyclecloud image add

agregar 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

Buscar solo esta cuenta (se puede repetir para varias cuentas)

--name=NAME

Nombre del paquete que se va a crear (obligatorio)

--label=LABEL

Etiqueta del paquete que se va 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

Instalación de 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 no se da CLUSTER y el archivo tiene 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 reemplazará 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 desde el que se va a 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. Toma precedentes 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 reemplazará si existe.

-f FILE, --file=FILE

Archivo desde el que se va a importar la plantilla.

cyclecloud initialize

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 supone que las preguntas son "no".

--force

Forzar una nueva inicialización incluso si el archivo de configuración válido está disponible.

--url=URL

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

--username=USERNAME

Nombre de usuario de 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 certificados SSL (false) para la instalación de CycleServer.

--name=NAMED_CONFIG

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

cyclecloud locker

Administrar las taquillas de CycleCloud.

cyclecloud locker <command>
sub-comando description
list cuadros de seguridad de lista
show <locker> mostrar detalles de una caja de seguridad

cyclecloud locker list

cuadros de seguridad de lista

cyclecloud locker list

cyclecloud locker show

mostrar detalles de una caja de seguridad

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]
sub-comando description
nombre de inicialización <> crear un nuevo proyecto vacío
ruta de acceso de la dirección URL><de captura <> captura un proyecto de una dirección URL> de Github <a la ruta de acceso.<>
info mostrar información del proyecto
<especificación de add_spec> agrega una especificación al proyecto
<default_locker locker> establece las taquillas predeterminadas en las que se va a cargar.
test Ejecutar prueba de integración para una definición de clúster determinada
build compilar el proyecto
cargar [locker] compilar y cargar el proyecto de los locker(s) especificados (usa el valor predeterminado si no se especifica ninguno)
descargar [locker] descargar los blobs del proyecto de las taquillas especificadas (usa el valor predeterminado si no se especifica ninguno)
<generate_template archivo> generar una plantilla de clúster para el proyecto, escrita en <el archivo>

cyclecloud project init

crear un nuevo proyecto vacío

cyclecloud project init <name>

captura del proyecto cyclecloud

captura un proyecto de una dirección URL> de Github <a la ruta de acceso.<>

cyclecloud project fetch <url> <path>

información del proyecto cyclecloud

mostrar 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 las taquillas predeterminadas en las que se va a cargar.

cyclecloud project default_locker <locker> [--global]

--global

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

prueba del proyecto cyclecloud

Ejecutar prueba de integración para una definición de clúster determinada

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

--skip-teardown

Omitir la anulación del clúster creado para las pruebas

--output-json=JSON_FILE

Salida de los resultados en el archivo JSON especificado

--junit-xml=JUNIT_FILE

Salida de los resultados en el formato junit-xml al archivo json especificado

-e EXTRA_VARS, --extra-var=EXTRA_VARS

Pares clave=valor arbitrarios usados para parametrizar la plantilla de clúster en 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

compilación del proyecto cyclecloud

compilar el proyecto

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

--project-version=PROJECT_VERSION

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

--build-dir=BUILD_DIR

Directorio de compilación

carga del proyecto cyclecloud

compilar y cargar el proyecto de los locker(s) especificados (usa el valor predeterminado si no se especifica ninguno)

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

--project-version=PROJECT_VERSION

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

descarga del proyecto cyclecloud

descargar los blobs del proyecto de las taquillas especificadas (usa el valor predeterminado si no se especifica ninguno)

cyclecloud project download [locker]

generate_template del proyecto cyclecloud

generar una plantilla de clúster para el proyecto, escrita en <el archivo>

cyclecloud project generate_template <file>

cyclecloud reboot_node

Reinicie un nodo en ejecución.

cyclecloud reboot_node <CLUSTER> <NODE_NAME>

cyclecloud remove_node

Quita un nodo del clúster (y lo termina si se inicia).

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

-f FILTER, --filter=FILTER

Quite los nodos que coinciden con la expresión completa de anuncios de clase.

--instance-filter=INSTANCE_FILTER

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

--creds=CREDS

Quite los nodos que se han iniciado con el conjunto con nombre de credenciales.

--no-prompt

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

--force

Obligue a quitar este nodo, incluso si no finaliza. Nota: use esta opción solo si los recursos de este nodo del proveedor de nube ya están terminados.

reintento de cyclecloud

Reintenta las operaciones de inicialización con errores para el clúster con nombre.

cyclecloud retry <CLUSTER> [--recursive]

-r, --recursive

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

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 sub clústeres.

-l, --long

Enumera cada nodo en lugar de mostrar un resumen.

-t, --templates

Incluya plantillas de clúster en la salida.

cyclecloud show_nodes

Muestra los 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

Muestra solo los nodos que coinciden con la expresión de anuncio de clase completa.

--instance-filter=INSTANCE_FILTER

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

--output=OUTPUT

Genera los atributos de nodo coincidentes descritos por una cadena de formato de parámetro con nombre de estilo 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 | texto].

--creds=CREDS

Mostrar solo los nodos que se han iniciado con el conjunto con nombre de credenciales.

-c CLUSTER, --cluster=CLUSTER

Muestra solo los nodos del clúster especificado.

--states=STATES

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

-l, --long

Muestra la representación completa de anuncios de clase del nodo.

-s, --summary

Muestra una representación mínima del nodo.

cyclecloud start_cluster

Inicia el clúster con nombre.

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

-r, --recursive

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

-t, --test

Inicio del clúster en modo de prueba

cyclecloud start_node

(Re-) Inicia los nodos terminados en un clúster en ejecución.

cyclecloud start_node <CLUSTER> <NODE_NAME>

cyclecloud terminate_cluster

Finaliza el clúster con nombre.

cyclecloud terminate_cluster <CLUSTER> [--recursive]

-r, --recursive

Finalice de forma recursiva este clúster y todos sus sub clú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

Finalice 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 de anuncio de clase completa.

--creds=CREDS

Finalice los nodos que empezaron a usar el conjunto con nombre de credenciales.

--no-prompt

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