Compartilhar via


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

Eles estão disponíveis para todos os comandos.

-h, --help

mostrar esta mensagem de ajuda e sair

-v, --version

Mostra a versão da CLI.

--config=CONFIG_FILE

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

--loglevel=LOG_LEVEL

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

conta cyclecloud

Gerenciar contas de provedor de nuvem.

cyclecloud account <command> [-o OUTPUT_FILE]
                             [--dry-run]
                             [-f INPUT_FILE]
                             [--force]
sub-comando descrição
list listar contas
mostrar <account_name> mostrar detalhes de uma conta
create criar uma nova conta
editar <account_name> editar uma conta existente
excluir <account_name> excluir uma conta existente

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

criar uma nova conta

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 promulga nenhuma alteração

-f INPUT_FILE

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

edição da conta do cyclecloud

editar 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 promulga nenhuma alteração

-f INPUT_FILE

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

exclusão da conta do cyclecloud

excluir uma conta existente

cyclecloud account delete <account_name> [--force]

--force

Se for verdadeiro, não solicitará 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é que seja removido) ao modelo de cluster. Caso contrário, o nó será removido automaticamente quando encerrado.

configuração do cyclecloud

Alternar facilmente entre configurações de cyclecloud

cyclecloud config <command>
sub-comando descrição
show mostrar a configuração atual em uso
list listar configurações disponíveis
criar <config_name> criar uma nova configuração
renomear <old_name><new_name> renomear uma configuração existente
usar <config_name> mudar para uma configuração especificada
remover <config_name> remover uma configuração nomeada

cyclecloud config show

mostrar a configuração atual em uso

cyclecloud config show

lista de configurações do cyclecloud

listar configurações disponíveis

cyclecloud config list

configuração do cyclecloud create

criar uma nova configuração

cyclecloud config create <config_name>

cyclecloud config rename

renomear uma configuração existente

cyclecloud config rename <old_name> <new_name>

uso da configuração do cyclecloud

mudar para uma configuração especificada

cyclecloud config use <config_name>

configuração do cyclecloud remove

remover uma configuração nomeada

cyclecloud config remove <config_name>

cyclecloud connect

Conecta-se a uma instância em execução no cluster. A partir de 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 keypair a ser usado, se não for dado no nó ou no nó, não existirá.

-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 com o qual fazer logon no nó.

--bastion-host=BASTION-HOST

Host de bastião SSH para rotear conexões.

--bastion-port=BASTION-PORT

Porta SSH para se conectar ao bastião.

--bastion-user=BASTION-USER

Logon do 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 de um modelo existente.

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

--force

Se especificado, o cluster será 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. Tem precedente sobre valores especificados em -p.

credencial cyclecloud

Gerenciar credenciais de conta do provedor de nuvem.

cyclecloud credential <command>
sub-comando descrição
list listar credenciais
create criar uma credencial
editar <account_name> editar uma credencial existente
excluir <account_name> excluir uma credencial existente

lista de credenciais do cyclecloud

listar credenciais

cyclecloud credential list

criação de credencial cyclecloud

criar uma credencial

cyclecloud credential create

edição de credencial do cyclecloud

editar uma credencial existente

cyclecloud credential edit <account_name>

exclusão de credencial cyclecloud

excluir uma credencial existente

cyclecloud credential delete <account_name>

cyclecloud delete_cluster

Exclui um cluster não em execução.

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

-r, --recursive

Exclua recursivamente esse cluster e todos os seus sub clusters.

--force

Force esse cluster a ser excluído. Observação: use essa opção somente se todos os recursos em seu provedor de nuvem já estiverem encerrados!

cyclecloud delete_template

Exclui um modelo de cluster

cyclecloud delete_template <TEMPLATE>

cyclecloud export_parameters

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 da saída

imagem 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]
sub-comando descrição
adicionar <image_name> [...] adicionar uma ou mais imagens

adicionar imagem cyclecloud

adicionar 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 (pode ser repetida para várias contas)

--name=NAME

O nome do pacote a ser criado (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 1.0.0

--bump-version=BUMP_VERSION

Use '--bump-version minor' para incrementar a versão secundária mais recente em 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

Instalar 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 de um arquivo de texto. Se CLUSTER não for fornecido e o arquivo tiver 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

Se especificado, o cluster será 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 do qual 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 precedente sobre valores especificados em -p.

-r, --recursive

Importa o cluster nomeado e todos os clusters no arquivo para o qual 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

Se especificado, o modelo será substituído se existir

-f FILE, --file=FILE

O arquivo do qual importar o modelo.

inicializar 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. Serão consideradas perguntas como "não".

--force

Force uma inicialização novamente mesmo se o 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 da instalação do CycleServer.

--password=PASSWORD

A senha da instalação do CycleServer.

--verify-ssl=VERIFY-SSL

Se é necessário verificar (true) ou não (false) certificados SSL para a instalação do CycleServer.

--name=NAMED_CONFIG

Criar uma configuração nomeada que possa ser usada com o comando de configuração

cyclecloud locker

Gerencie os armários do CycleCloud.

cyclecloud locker <command>
sub-comando descrição
list list lockers
show <locker> mostrar detalhes para um armário

lista de armários cyclecloud

list lockers

cyclecloud locker list

cyclecloud locker show

mostrar detalhes para um armário

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]
sub-comando descrição
nome do init <> criar um novo projeto vazio
buscar <caminho de url><> busca um projeto de uma URL> do Github <para caminho <>
informações exibir informações do projeto
<add_spec especificação> adiciona uma especificação ao projeto
<default_locker armário> define os armários padrão a serem carregados para
test executar o teste de integração para uma determinada definição de cluster
compilar compilar o projeto
upload [locker] compilar e carregar projeto os armários especificados (usa o padrão se nenhum especificado)
baixar [locker] baixe os blobs de projeto dos armários especificados (usa o padrão se nenhum especificado)
<arquivo generate_template> gerar um modelo de cluster para o projeto, gravado no <arquivo>

init do projeto cyclecloud

criar um novo projeto vazio

cyclecloud project init <name>

busca de projeto do cyclecloud

busca um projeto de uma URL do Github <para o <caminho>>

cyclecloud project fetch <url> <path>

informações do projeto do cyclecloud

exibir informações do projeto

cyclecloud project info

add_spec do projeto cyclecloud

adiciona uma especificação ao projeto

cyclecloud project add_spec <spec>

default_locker do projeto cyclecloud

define os armários padrão a serem carregados para

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

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

Ignorar a demolição do cluster criado para teste

--output-json=JSON_FILE

Gerar os resultados para o arquivo json especificado

--junit-xml=JUNIT_FILE

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

-e EXTRA_VARS, --extra-var=EXTRA_VARS

Pares de chave=valor arbitrários 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

compilação de projeto do cyclecloud

compilar 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

compilar e carregar projeto os armários especificados (usa o padrão se nenhum especificado)

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

--project-version=PROJECT_VERSION

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

Download do projeto do cyclecloud

baixe os blobs de projeto dos armários especificados (usa o padrão se nenhum especificado)

cyclecloud project download [locker]

generate_template do projeto cyclecloud

gerar um modelo de cluster para o projeto, gravado no <arquivo>

cyclecloud project generate_template <file>

reboot_node do cyclecloud

Reinicialize um nó em execução.

cyclecloud reboot_node <CLUSTER> <NODE_NAME>

remove_node do cyclecloud

Remove um nó do cluster (e termina-o se 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 de anúncio de classe completa.

--instance-filter=INSTANCE_FILTER

Remova nós com instâncias ativas que correspondam à expressão de anúncio de classe completa.

--creds=CREDS

Remova os nós iniciados 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

Force esse nó a ser removido, mesmo que não seja encerrado. Observação: use essa opção somente se os recursos para esse nó em seu provedor de nuvem já estiverem encerrados!

repetição de nuvem de ciclo

Repeti operações de inicialização com falha para o cluster nomeado.

cyclecloud retry <CLUSTER> [--recursive]

-r, --recursive

Recursivamente, repita as opções neste cluster e em todos os seus sub clusters.

show_cluster do cyclecloud

Mostra o cluster ou clusters no CycleCloud.

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

-r, --recursive

Mostre esse cluster e todos os seus sub clusters.

-l, --long

Lista cada nó em vez de mostrar um resumo.

-t, --templates

Inclua modelos de cluster na saída.

show_nodes do cyclecloud

Mostrar detalhes dos nós/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 apenas nós que correspondem à expressão de anúncio de classe completa.

--instance-filter=INSTANCE_FILTER

Mostrar apenas nós com instâncias ativas que correspondem à expressão de anúncio de classe completa.

--output=OUTPUT

Produza os atributos de nó correspondentes descritos por uma cadeia de caracteres de formato de parâmetro nomeado no estilo Python. Ex.: --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 nós iniciados usando o conjunto nomeado de credenciais.

-c CLUSTER, --cluster=CLUSTER

Mostrar apenas nós no cluster especificado.

--states=STATES

Mostrar apenas nós nos estados especificados (lista separada por vírgula).

-l, --long

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

-s, --summary

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

start_cluster do cyclecloud

Inicia o cluster nomeado.

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

-r, --recursive

Inicie recursivamente esse cluster e todos os seus sub clusters.

-t, --test

Iniciar cluster no modo de teste

start_node do cyclecloud

(Re-) Inicia nós encerrados em um cluster em execução.

cyclecloud start_node <CLUSTER> <NODE_NAME>

terminate_cluster do cyclecloud

Encerra o cluster nomeado.

cyclecloud terminate_cluster <CLUSTER> [--recursive]

-r, --recursive

Encerre recursivamente esse cluster e todos os seus sub clusters.

terminate_node do cyclecloud

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 de anúncio de classe completa.

--instance-filter=INSTANCE_FILTER

Encerre os nós com instâncias ativas que correspondem à expressão de anúncio de classe completa.

--creds=CREDS

Termina os nós iniciados 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.