CycleCloud CLI

A CLI Azure CycleCloud permite-lhe gerir a sua instalação a partir de uma consola ou ficheiro de script.

Parâmetros globais de CLI

Estes 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 da linha de comando.

--config=CONFIG_FILE

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

--loglevel=LOG_LEVEL

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

Conta CycleCloud

Gerir contas de fornecedores cloud.

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

Lista de contas CycleCloud

Listar contas.

cyclecloud account list

Mostrar conta CycleCloud

Mostrar detalhes de uma conta.

cyclecloud account show <account_name>

Criar conta CycleCloud

Crie uma nova conta.

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

-o OUTPUT_FILE

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

--dry-run

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

-f INPUT_FILE

Lê a definição a partir de um ficheiro de configuração em vez de pedir

Conta CycleCloud Editar

Editar uma conta existente.

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

-o OUTPUT_FILE

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

--dry-run

Solicita e valida a informação, mas não faz qualquer alteração.

-f INPUT_FILE

Lê a definição a partir de um ficheiro de configuração em vez de pedir um prompt.

Eliminação de Conta CycleCloud

Apague uma conta existente.

cyclecloud account delete <account_name> [--force]

--force

Se for verdade, não solicita a eliminaçã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 usar para este nó. Se não for especificado, o padrão é usar o único modelo disponível, caso contrário, ocorre um erro.

-c COUNT, --count=COUNT

Quantos nós são necessários para começar. Se não for especificado, o padrão será 1.

-f, --fixed

Se ativado, o nó é permanentemente adicionado (até ser removido) ao template do cluster. Caso contrário, o nó é removido automaticamente ao ser terminado.

Configuração CycleCloud

É fácil alternar entre configurações de cyclecloud.

cyclecloud config <command>

Programa de configuração do CycleCloud

Mostra a configuração atual.

cyclecloud config show

Lista de configuração CycleCloud

Lista as configurações disponíveis.

cyclecloud config list

CycleCloud configurar criar

Crie uma nova configuração.

cyclecloud config create <config_name>

Renomeação de configuração do CycleCloud

Renomeie uma configuração existente.

cyclecloud config rename <old_name> <new_name>

Utilização da configuração do CycleCloud

Muda para uma configuração especificada.

cyclecloud config use <config_name>

CycleCloud config remove

Remova uma configuração nomeada.

cyclecloud config remove <config_name>

CycleCloud Connect

Liga-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 usar, caso não seja fornecido no nó ou se o 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 existam vários nós com o mesmo nome.

-u USER, --user=USER

O utilizador deve iniciar sessão no nó.

--bastion-host=BASTION-HOST

Servidor bastião SSH para encaminhar as ligações.

--bastion-port=BASTION-PORT

Porta SSH para ligação ao bastião.

--bastion-user=BASTION-USER

Nome de utilizador para ligação ao bastião.

--bastion-key=BASTION-KEY

Ficheiro de chave privada para ligação 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 ficheiro de parâmetros a usar.

CycleCloud create_cluster

Cria um cluster a partir de um template existente.

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

--force

Se especificado, o cluster é substituído se existir.

-p PARAMETERS, --parameters=PARAMETERS

O ficheiro de parâmetros a usar.

-P PARAMETER_OVERRIDE, --parameter-override=PARAMETER_OVERRIDE

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

Credencial CycleCloud

Gerir as credenciais da conta do fornecedor cloud.

cyclecloud credential <command>

Lista de credenciais CycleCloud

Lista credenciais.

cyclecloud credential list

CycleCloud criar credencial

Crie uma nova credencial.

cyclecloud credential create

Editar credenciais do CycleCloud

Editar uma credencial existente.

cyclecloud credential edit <account_name>

Eliminação de credenciais CycleCloud

Apague uma credencial existente.

cyclecloud credential delete <account_name>

CycleCloud delete_cluster

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

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

-r, --recursive

Elimine recursivamente este cluster e todos os seus subclusters.

--force

Forçar a eliminação deste cluster. Use esta opção apenas se todos os recursos do seu fornecedor de cloud já estiverem terminados.

CycleCloud delete_template

Apague um modelo de cluster.

cyclecloud delete_template <TEMPLATE>

CycleCloud export_parameters

Parâmetros de exportação para um dado cluster.

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

-o OUTPUT_FILE

Para create, escreve os parâmetros do cluster no disco.

--format=OUTPUT_FORMAT

Formato de saída.

Imagem do CycleCloud

Gerir 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 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 apenas nesta conta. Pode repetir esta opção para várias contas.

--name=NAME

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

--label=LABEL

O rótulo da embalagem a criar.

--package-version=PACKAGE_VERSION

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

--bump-version=BUMP_VERSION

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

--os=OS

Use --os linux/windows para especificar o sistema operativo 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 tempo de execução 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 qualquer informação de imagem.

CycleCloud import_cluster

Cria um cluster a partir de um ficheiro de texto. Se o CLUSTER não for fornecido e o ficheiro contiver um único cluster, o nome desse cluster é usado.

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

-c TEMPLATE

O(s) cluster(s) no ficheiro para importar. Se não for especificado, é usado o nome do novo cluster.

--force

Se especificado, o cluster é substituído se existir.

-t, --as-template

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

-f FILE, --file=FILE

O ficheiro para importar o modelo.

-p PARAMETERS, --parameters=PARAMETERS

O ficheiro de parâmetros a usar.

-P PARAMETER_OVERRIDE, --parameter-override=PARAMETER_OVERRIDE

Adicionar ou sobrepor um parâmetro específico. Tem precedência sobre valores especificados em -p.

-r, --recursive

Importa o cluster nomeado e todos os clusters no ficheiro para os quais atua como principal.

CycleCloud import_template

Importa um modelo de cluster a partir de um ficheiro de texto. Se o NAME não for fornecido e o ficheiro tiver um único cluster, o nome desse cluster é usado.

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

-c TEMPLATE

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

--force

Caso esteja especificado, o modelo é substituído se existir.

-f FILE, --file=FILE

O ficheiro para importar o modelo.

Inicializar CycleCloud

Inicializa as definiçõ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 comandos. As perguntas são assumidas como 'não'.

--force

Forçar a reinicialização mesmo que esteja disponível um ficheiro de configuração válido.

--url=URL

O URL base da instalação do CycleServer.

--username=USERNAME

O nome de utilizador da instalação do CycleServer.

--password=PASSWORD

A palavra-passe para a instalação do CycleServer.

--verify-ssl=VERIFY-SSL

Se deve verificar certificados SSL (verdadeiros) ou não (falsos) para a instalação do CycleServer.

--name=NAMED_CONFIG

Cria uma configuração nomeada que possas usar com o comando config.

CycleCloud Locker

Gerir os armazenamentos do CycleCloud.

cyclecloud locker <command>

Lista de Lockers do CycleCloud

Lista cacifos.

cyclecloud locker list

Programa CycleCloud Locker

Mostra detalhes de um cacifo.

cyclecloud locker show <locker>

Projeto CycleCloud

Gerir projetos 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

Crie um novo projeto vazio.

cyclecloud project init <name>

CycleCloud Project Fetch

Obtém um projeto do GitHub <url> para <path>.

cyclecloud project fetch <url> <path>

Informação do projeto CycleCloud

Mostra a informação do projeto.

cyclecloud project info

Projeto CycleCloud add_spec

Adiciona uma especificação ao projeto.

cyclecloud project add_spec <spec>

Projeto CycleCloud default_locker

Define o bloqueio padrão para uploads.

cyclecloud project default_locker <locker> [--global]

--global

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

Teste do projeto CycleCloud

Executa um 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

Evite desmontar o cluster criado para testes.

--output-json=JSON_FILE

Envie os resultados para o ficheiro json especificado.

--junit-xml=JUNIT_FILE

Exporte os resultados em formato junit-xml para o ficheiro JSON especificado.

-e EXTRA_VARS, --extra-var=EXTRA_VARS

Pares chave=valor arbitrários usados para parametrizar o modelo do cluster em teste.

-t TEMPLATE, --template=TEMPLATE

Caminho para ficheiro de modelo de cluster.

-n CLUSTER_NAME, --name=CLUSTER_NAME

Nome da definição de cluster a testar.

Construção do projeto CycleCloud

Construa o projeto.

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

--project-version=PROJECT_VERSION

Sobrescrever a versão do projeto presente em project.ini.

--build-dir=BUILD_DIR

O diretório de build.

Upload do projeto CycleCloud

Construir e carregar o projeto nos armários especificados (usa o padrão se nenhum for especificado).

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

--project-version=PROJECT_VERSION

Sobrescrever a versão do projeto presente em project.ini.

Download do projeto CycleCloud

Descarregue os blobs do projeto a partir dos cacifos especificados. Se não especificares os armários, o comando usa os armários padrão.

cyclecloud project download [locker]

Projeto CycleCloud generate_template

Gera um modelo de cluster para o projeto. O comando escreve o template em <file>.

cyclecloud project generate_template <file>

Comando CycleCloud reboot_node

Reinicia um nó em funcionamento.

cyclecloud reboot_node <CLUSTER> <NODE_NAME>

CycleCloud remove_node

Remova um nó do cluster. O comando encerra o nó se ele foi iniciado.

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

-f FILTER, --filter=FILTER

Remover nós que correspondam à expressão completa do class-ad.

--instance-filter=INSTANCE_FILTER

Remover nós com instâncias ativas que correspondam à expressão completa class-ad.

--creds=CREDS

Remova nodos que foram iniciados utilizando o conjunto nomeado de credenciais.

--no-prompt

Se especificado, não pede confirmação antes de terminar nós com base num filtro.

--force

Forçar a remoção deste nó, mesmo que não seja terminado. Só use esta opção se os recursos deste nó no seu fornecedor cloud já estiverem terminados.

CycleCloud Retry

As tentativas falharam nas operações de inicialização para o cluster nomeado.

cyclecloud retry <CLUSTER> [--recursive]

-r, --recursive

Repetir recursivamente as opções neste cluster e nos seus subclusters.

CycleCloud show_cluster

Mostra o(s) cluster(s) no CycleCloud.

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

-r, --recursive

Mostra este 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

Exibir 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

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

-f FILTER, --filter=FILTER

Mostrar apenas os nós que coincidem com a expressão completa do class-ad.

--instance-filter=INSTANCE_FILTER

Mostrar apenas nós com instâncias ativas que correspondam à expressão completa class-ad.

--output=OUTPUT

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

--format=FORMAT

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

--creds=CREDS

Mostrar apenas os nós iniciados com as credenciais nomeadas.

-c CLUSTER, --cluster=CLUSTER

Mostrar apenas os nós no cluster especificado.

--states=STATES

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

-l, --long

Mostrar a representação completa de class-ad do nó.

-s, --summary

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

CycleCloud start_cluster

Inicia o cluster nomeado.

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

-r, --recursive

Inicia recursivamente este cluster e todos os seus subclusters.

-t, --test

Inicia o cluster em modo de teste.

CycleCloud start_node

Inicia nós parados num cluster em execução.

cyclecloud start_node <CLUSTER> <NODE_NAME>

CycleCloud terminate_cluster

Termina o aglomerado nomeado.

cyclecloud terminate_cluster <CLUSTER> [--recursive]

-r, --recursive

Encerra recursivamente este cluster e todos os seus subclusters.

CycleCloud terminate_node

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

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

-f FILTER, --filter=FILTER

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

--instance-filter=INSTANCE_FILTER

Finalizar nós com instâncias ativas que correspondam à expressão completa de class-ad.

--creds=CREDS

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

--no-prompt

Se for especificado, não pede confirmação antes de encerrar nós com base num filtro.