CycleCloud CLI

A CLI do Azure CycleCloud permite que você gerencie sua instalação de um console ou arquivo de script.

Parâmetros da CLI global

Esses parâmetros estão disponíveis para todos os comandos.

-h, --help

Mostra a mensagem de ajuda e sai.

-v, --version

Mostra a versão do CLI.

--config=CONFIG_FILE

Especifica o caminho para um arquivo de configuração não padrão a ser usado para esse comando.

--loglevel=LOG_LEVEL

Define o nível de log padrão para a CLI.

conta do cyclecloud

Gerenciar contas de provedor de nuvem.

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

lista de contas do cyclecloud

Listar contas.

cyclecloud account list

mostrar conta do cyclecloud

Mostrar detalhes de uma conta.

cyclecloud account show <account_name>

criar conta do cyclecloud

Crie uma conta nova.

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

-o OUTPUT_FILE

Grava os parâmetros de configuração no disco

--dry-run

Solicita e valida informações, mas não gera alterações

-f INPUT_FILE

Lê a definição de um arquivo de configuração em vez de solicitar

edição da conta do cyclecloud

Edite uma conta existente.

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

-o OUTPUT_FILE

Grava os parâmetros de configuração no disco.

--dry-run

Solicita e valida informações, mas não gera alterações.

-f INPUT_FILE

Lê a definição de um arquivo de configuração em vez de solicitar.

exclusão da conta do cyclecloud

Exclua uma conta existente.

cyclecloud account delete <account_name> [--force]

--force

Se for true, não pedirá a exclusão da conta.

cyclecloud add_node

Adiciona mais nós ao cluster.

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

-t TEMPLATE, --template=TEMPLATE

O modelo a ser usado para este nó. Se não for especificado, o padrão é usar o único modelo disponível caso contrário, erro.

-c COUNT, --count=COUNT

Quantos nós serão iniciados. Se não for especificado, o padrão será 1.

-f, --fixed

Se definido, o nó será adicionado permanentemente (até ser removido) ao modelo de cluster. Caso contrário, o nó será removido automaticamente quando encerrado.

configuração do cyclecloud

Alternar facilmente entre configurações do CycleCloud.

cyclecloud config <command>

mostrar configuração do cyclecloud

Mostrar a configuração atual.

cyclecloud config show

lista de configurações do cyclecloud

Listar configurações disponíveis.

cyclecloud config list

criar configuração do cyclecloud

Crie uma nova configuração.

cyclecloud config create <config_name>

renomear a configuração do cyclecloud

Renomeie uma configuração existente.

cyclecloud config rename <old_name> <new_name>

cyclecloud config use

Alterne para uma configuração especificada.

cyclecloud config use <config_name>

remoção da configuração do cyclecloud

Remova uma configuração nomeada.

cyclecloud config remove <config_name>

cyclecloud connect

Conecta-se a uma instância em execução no cluster. A partir da versão 7.8, o Nome pode ser um nome de nó, um nome de host ou um endereço 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

O par de chaves a ser usado, caso não seja fornecido no nó ou o nó não exista.

-c CLUSTER, --cluster=CLUSTER

O cluster em que o nó está, se o nome for um nome de nó. Opcional, a menos que haja vários nós com o mesmo nome.

-u USER, --user=USER

O usuário deve entrar no nó.

--bastion-host=BASTION-HOST

Host de bastion SSH para rotear conexões.

--bastion-port=BASTION-PORT

Porta SSH para se conectar ao bastião.

--bastion-user=BASTION-USER

Nome de usuário para se conectar ao bastião.

--bastion-key=BASTION-KEY

Arquivo de chave privada para se conectar ao bastião.

cyclecloud copy_cluster

Faz uma cópia de um cluster.

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

-p PARAMETERS, --parameters=PARAMETERS

O arquivo de parâmetros a ser usado.

cyclecloud create_cluster

Cria um cluster com base em um modelo existente.

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

--force

Caso seja especificado, o cluster é substituído se existir.

-p PARAMETERS, --parameters=PARAMETERS

O arquivo de parâmetros a ser usado.

-P PARAMETER_OVERRIDE, --parameter-override=PARAMETER_OVERRIDE

Adicione ou substitua um parâmetro específico. Essa opção tem precedência sobre os valores especificados em -p.

credencial do CycleCloud

Gerenciar credenciais de conta do provedor de nuvem.

cyclecloud credential <command>

lista de credenciais do cyclecloud

Listar credenciais.

cyclecloud credential list

criação de credencial do cyclecloud

Crie uma nova credencial.

cyclecloud credential create

edição de credencial do cyclecloud

Edite uma credencial existente.

cyclecloud credential edit <account_name>

exclusão de credenciais do cyclecloud

Exclua uma credencial existente.

cyclecloud credential delete <account_name>

cyclecloud delete_cluster

Excluir um cluster que não está em execução.

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

-r, --recursive

Exclua recursivamente esse cluster e todos os seus subclusters.

--force

Force a exclusão deste cluster. Use essa opção somente se todos os recursos em seu provedor de nuvem já estiverem encerrados.

cyclecloud delete_template

Exclua um modelo de cluster.

cyclecloud delete_template <TEMPLATE>

export_parameters do cyclecloud

Exportar parâmetros para um determinado cluster.

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

-o OUTPUT_FILE

Para criar, grava os parâmetros de cluster no disco.

--format=OUTPUT_FORMAT

Formato de saída.

imagem do cyclecloud

Gerenciar imagens 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]

adicionar imagem do cyclecloud

Adicione uma ou mais imagens.

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

Pesquise somente essa conta. Você pode repetir essa opção para várias contas.

--name=NAME

O nome do pacote a ser criado. Este parâmetro é obrigatório.

--label=LABEL

O rótulo do pacote a ser criado.

--package-version=PACKAGE_VERSION

Use esta versão para a nova imagem em vez do padrão de 1.0.0.

--bump-version=BUMP_VERSION

Use --bump-version minor para incrementar a versão secundária mais recente por 1 (por exemplo, 1.1 a 1.2) ou use --bump-version major ou --bump-version patch.

--os=OS

Use --os linux/windows para especificar o sistema operacional na imagem.

--jetpack-version=JETPACK_VERSION

A versão do Jetpack que está instalada ou deve ser instalada na imagem.

--install-jetpack

Instale o Jetpack em runtime nesta imagem.

--jetpack-platform=JETPACK_PLATFORM

A plataforma Jetpack usada na imagem (por exemplo, centos-7, ubuntu-14.04, windows).

--dry-run

Procura imagens correspondentes, mas não armazena nenhuma informação de imagem.

cyclecloud import_cluster

Cria um cluster com base em um arquivo de texto. Se o CLUSTER não for fornecido e o arquivo contiver um único cluster, o nome desse cluster será usado.

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

-c TEMPLATE

O cluster no arquivo a ser importado. Se não for especificado, o nome do novo cluster será usado.

--force

Caso seja especificado, o cluster é substituído se existir.

-t, --as-template

Se especificado, o cluster será armazenado como um modelo que só pode ser usado para criar outros clusters.

-f FILE, --file=FILE

O arquivo para importar o modelo.

-p PARAMETERS, --parameters=PARAMETERS

O arquivo de parâmetros a ser usado.

-P PARAMETER_OVERRIDE, --parameter-override=PARAMETER_OVERRIDE

Adicione ou substitua um parâmetro específico. Tem precedência sobre os valores especificados em -p.

-r, --recursive

Importa o cluster nomeado e todos os clusters no arquivo dos quais ele é o pai.

cyclecloud import_template

Importa um modelo de cluster de um arquivo de texto. Se NAME não for fornecido e o arquivo tiver um único cluster, o nome desse cluster será usado.

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

-c TEMPLATE

O modelo no arquivo a ser importado. Se não for especificado, o nome do novo modelo será usado.

--force

Caso especificado, o modelo será substituído se existir.

-f FILE, --file=FILE

O arquivo para importar o modelo.

inicializar o cyclecloud

Inicializa as configurações do CycleCloud.

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

--batch

Se especificado, os argumentos devem ser fornecidos na linha de comando. Supõe-se que as perguntas sejam "não".

--force

Force a reinicialização mesmo se um arquivo de configuração válido estiver disponível.

--url=URL

A URL base para a instalação do CycleServer.

--username=USERNAME

O nome de usuário para a instalação do CycleServer.

--password=PASSWORD

A senha da instalação do CycleServer.

--verify-ssl=VERIFY-SSL

Se os certificados SSL devem ser verificados (verdadeiro) ou não (falso) para a instalação do CycleServer.

--name=NAMED_CONFIG

Crie uma configuração nomeada que você pode usar com o comando de configuração.

repositório CycleCloud

Gerencie os armários do CycleCloud.

cyclecloud locker <command>

cyclecloud locker list

Listar armários.

cyclecloud locker list

cyclecloud locker show

Mostre detalhes de um cofre.

cyclecloud locker show <locker>

projeto cyclecloud

Gerenciar projetos do 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]

Comando "cyclecloud project init"

Crie um novo projeto vazio.

cyclecloud project init <name>

cyclecloud project fetch

Busca um projeto de um <url> para <path> do GitHub.

cyclecloud project fetch <url> <path>

informações do projeto cyclecloud

Exibe as informações do projeto.

cyclecloud project info

projeto cyclecloud add_spec

Adiciona uma especificação ao projeto.

cyclecloud project add_spec <spec>

cyclecloud project default_locker

Configura o repositório padrão para uploads.

cyclecloud project default_locker <locker> [--global]

--global

Defina o padrão global em vez do valor específico do projeto.

teste de projeto do cyclecloud

Executa o teste de integração para uma definição 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

Ignore a desmontagem do cluster criado para teste.

--output-json=JSON_FILE

Gere os resultados para o arquivo json especificado.

--junit-xml=JUNIT_FILE

Gere os resultados no formato junit-xml para o arquivo json especificado.

-e EXTRA_VARS, --extra-var=EXTRA_VARS

Chave arbitrária=pares de valores usados para parametrizar o modelo de cluster em teste.

-t TEMPLATE, --template=TEMPLATE

Caminho para o arquivo de modelo de cluster.

-n CLUSTER_NAME, --name=CLUSTER_NAME

Nome da definição de cluster a ser testada.

build do projeto CycleCloud

Compile o projeto.

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

--project-version=PROJECT_VERSION

Substitua a versão do projeto presente no project.ini.

--build-dir=BUILD_DIR

O diretório de build.

upload do projeto cyclecloud

Compile e carregue o projeto dos cofres especificados (usa o padrão se nenhum for especificado).

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

--project-version=PROJECT_VERSION

Sobrescreva a versão do projeto presente no project.ini.

download do projeto cyclecloud

Baixe os blobs do projeto a partir dos repositórios especificados. Se você não especificar armários, o comando usará os armários padrão.

cyclecloud project download [locker]

cyclecloud project generate_template

Gere um modelo de cluster para o projeto. O comando grava o modelo em <file>.

cyclecloud project generate_template <file>

cyclecloud reboot_node

Reinicialize um nó em execução.

cyclecloud reboot_node <CLUSTER> <NODE_NAME>

cyclecloud remove_node

Remova um nó do cluster. O comando encerrará o nó se ele já tiver sido iniciado.

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

-f FILTER, --filter=FILTER

Remova os nós que correspondem à expressão completa de class-ad.

--instance-filter=INSTANCE_FILTER

Remova os nós com instâncias ativas que correspondem a uma expressão completa de class-ad.

--creds=CREDS

Remova os nós que você iniciou usando o conjunto de credenciais nomeado.

--no-prompt

Se especificado, não solicitará confirmação antes de encerrar nós com base em um filtro.

--force

Forçar a remoção deste nó, mesmo que não tenha sido terminado. ** Use essa opção somente se os recursos deste nó do seu provedor de nuvem já estiverem encerrados.

CycleCloud tentar novamente

Reexecuta operações de inicialização que falharam para o cluster nomeado.

cyclecloud retry <CLUSTER> [--recursive]

-r, --recursive

Recursivamente, tente novamente as opções neste cluster e em todos os seus subclusters.

cyclecloud show_cluster

Mostra o cluster ou clusters no CycleCloud.

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

-r, --recursive

Mostrar esse cluster e todos os seus subclusters.

-l, --long

Lista cada nó em vez de mostrar um resumo.

-t, --templates

Inclua modelos de cluster na saída.

cyclecloud show_nodes

Mostrar detalhes dos nós ou instâncias selecionados.

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

Exiba o conjunto de atributos especificado (lista separada por vírgulas).

-f FILTER, --filter=FILTER

Mostrar somente os nós que correspondem à expressão completa de class-ad.

--instance-filter=INSTANCE_FILTER

Mostrar somente nós com instâncias ativas que correspondem à expressão completa de class-ad.

--output=OUTPUT

Produza os atributos de nó correspondentes descritos por uma cadeia de caracteres de formato de parâmetro nomeado no estilo Python. Por exemplo, --output="Name: %(Name)s\t(ID: %(InstanceId)s)\n Cluster: %(ClusterName)s\n".

--format=FORMAT

Altere o formato de exibição de saída [xml | json | texto].

--creds=CREDS

Mostrar somente os nós que foram iniciados usando o conjunto de credenciais nomeado.

-c CLUSTER, --cluster=CLUSTER

Mostrar apenas nós no cluster especificado.

--states=STATES

Mostrar apenas nós em determinados estados especificados (lista separada por vírgulas).

-l, --long

Exiba a representação de anúncio de classe completa do nó.

-s, --summary

Exiba uma representação mínima do nó.

cyclecloud start_cluster

Inicia o cluster nomeado.

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

-r, --recursive

Inicie recursivamente esse cluster e todos os seus subclusters.

-t, --test

Inicie o cluster no modo de teste.

cyclecloud start_node

Inicia nodos terminados em um cluster que está sendo executado.

cyclecloud start_node <CLUSTER> <NODE_NAME>

cyclecloud terminate_cluster

Encerra o cluster nomeado.

cyclecloud terminate_cluster <CLUSTER> [--recursive]

-r, --recursive

Encerre recursivamente esse cluster e todos os seus subclusters.

cyclecloud terminate_node

Termina um nó em execução (mas o deixa no cluster).

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

-f FILTER, --filter=FILTER

Encerre os nós que correspondem à expressão completa de class-ad.

--instance-filter=INSTANCE_FILTER

Encerra os nós com instâncias ativas que correspondem à expressão completa de class-ad.

--creds=CREDS

Encerra os nós iniciados usando o conjunto nomeado de credenciais.

--no-prompt

Se especificado, não solicitará confirmação antes de encerrar nós com base em um filtro.