Base de conhecimento  /  Gerenciador de aplicativos em nuvem  /  Tutoriais
Base de conhecimento  /  Gerenciador de aplicativos em nuvem  /  Tutoriais

Como usar ebcli

Atualizado por Diego Sanjuan em 20 de maio de 2019
Código do artigo: kb/1216

Neste artigo:

Visão geral

Este tutorial destina-se a ajudar os usuários do Cloud Application Manager a aprender a usar a ebcli, nossa ferramenta da linha de comando, para controlarem suas contas Cloud Application Manager da seguinte forma:

  • Para caixas - como implementar, exportar e importar como versão ou como rascunho etc., usando ebcli.
  • Para instâncias - como reconfigurar, reinstalar, desligar, ligar, exportar etc., usando ebcli.
  • Para imagens ECS - como gerenciá-las usando a ebcli.
  • Para espaços de trabalho - como listá-los usando a ebcli.

A ebcli faz com que as API de back-end do Cloud Application Manager listem, provisionem e gerenciem o ciclo de vida de suas cargas de trabalho com base na configuração da caixa.

Público

Todos os usuários do Cloud Application Manager que desejam controlar suas contas do Cloud Application Manager usando a ferramenta de linha de comando ebcli.

Pré-requisitos

  • Acesso ao site do Cloud Application Manager ou a um Cloud Application Manager Dedicated Edition (edição dedicada) (aplicativo CAM) no local.
  • O usuário deve ter uma conta já existente na qual fazer login usando nome de usuário e senha ou seu mecanismo de autenticação preferido.

Instalação da ferramenta da linha de comando ebcli

Antes de começar a usar a ebcli, você precisa instalá-la usando o pip, que é um gerenciador de pacotes para pacotes Python, ou módulos, se preferir

Se você não tiver o pip instalado. Siga este guia para instalá-lo em seu computador: https://pip.pypa.io/en/stable/installing/

Comando de terminal

Abra um terminal no seu computador e execute o comando de instalação:

pip install ebcli

Quando o processo de instalação terminar, o pip deverá ter instalado a ebcli e todas as suas dependências necessárias.

Login na sua conta do Cloud Application Manager com a ebcli

Antes que você possa controlar sua conta do Cloud Application Manager com a ebcli, você precisa conectar sua conta do Cloud Application Manager com a ebcli.

A ebcli precisa de um token para fazer login na sua conta do Cloud Application Manager.

Etapas para criar um token

  • Abra https://cam.ctl.io se estiver usando o SaaS ou https://YOUR_APPLIANCE_FQDN se estiver usando a edição local do Cloud Application Manager
  • Faça login com seu nome de usuário e senha ou com seu mecanismo de autenticação preferido
  • Clique no menu do seu nome de usuário (no canto superior direito da interface do usuário CAM)
  • Clique em "Tokens de autenticação"
  • Escreva um nome descritivo para o seu token, por exemplo, ebcli
  • Clique em "Criar Token"
  • Clique no botão da área de transferência à direita do seu token para copiá-lo

Comando de terminal

Abra um terminal no seu computador e execute o comando de login:

ebcli login

Você será solicitado a introduzir seu "Token de autenticação:"; apenas cole seu token e pressione Enter.

Agora seu computador pedirá a senha do seu token de autenticação para armazenar seu token do Cloud Application Manager com segurança no seu token de autenticação.

Mostrar comandos ebcli disponíveis

Comando de terminal

Abra um terminal no seu computador e execute o comando de login:

ebcli

a ebcli mostrará uma ajuda de uso como esta:

usage: ebcli [-h] [--url URL] [--token TOKEN] [--debug] [--verbose] [-j]
             {boxes,build,delete,deploy,get,export,export-instance,import,instances,login,logout,set,poweron,reconfigure,reinstall,shutdown,terminate,workspaces}
             ...
ebcli: error: too few arguments

Parâmetros gerais

Opção pegar caixas Descrição
--url Por padrão é https://cam.ctl.io, mas você pode usar isso para especificar o FQDN DO APLICATIVO.
–-token Você pode usá-lo para especificar seu token em todos os comandos se não quiser armazená-lo no seu token de autenticação.
–-debug Mostrar informações de depuração para fornecer rastreamento detalhado para suporte em caso de problemas.
–-verbose Mostrar informações detalhadas das operações e chamadas de api solicitadas ao Cloud Operation Manager.

Comandos de caixa usando ebcli

Obter caixas

Use a ebcli para listar suas caixas.

Comando de terminal

ebcli boxes [-f [-f [<FIELD> [<FIELD> ...]]] [-r [<REQUIREMENT> [<REQUIREMENT> ...]]] [-w “<WORKSPACE ID>”]

Parâmetros

Opção pegar caixas Descrição
-f Campo ou campos que você quer que sejam listados.
–r Tags de requisitos que você deseja usar para filtrar suas caixas, por exemplo, ubuntu.
–w Área de trabalho que contém as caixas que você deseja listar.

Exportar uma caixa

Use a ebcli para exportar uma caixa do Cloud Application Manager para o JSON e arquivos de texto para poder importá-la depois.

Comando de terminal

ebcli export [--boxes-path <BOXES_PATH>] [-r] ”<box ID>”

Parâmetros

Opção Descrição
–-boxes-path Caminho onde as caixas serão exportadas.
-r Exportar recursivamente caixa e caixas internas.

Importar uma caixa

Use o ebcli para importar uma caixa de seus arquivos JSON e de texto para o Cloud Application Manager ou ao seu aplicativo.

Comando de terminal

ebcli import [--boxes-path <BOXES_PATH>] [-w <WORKSPACE_ID>] [-m <COMMENT>] [--image <IMAGE>] [--as-draft] box-name

Parâmetros

Opção Descrição
–-boxes-path Caminho onde o caixas estão localizadas.
-w ID da área de trabalho para onde a caixa será importada.
–m Será criada uma descrição da versão, por exemplo, "Requisitos de atualização".
–-image Nome da imagem de base a ser usada, por exemplo, Ubuntu: 0.1 ou Centos.
–-as-draft Em vez de criar uma versão, a caixa será importada como rascunho da caixa.

Implementar uma application box

Use a ebcli para implementar uma application box em seu Cloud Application Manager ou em sua conta de aplicativo.

Comando de terminal

ebcli deploy [-w <WORKSPACE_ID>] [-t [<TAG> [<TAG> ...]]] [-c [<CLAIM> [<CLAIM> ...]]] input

Parâmetros

Opção Descrição
-w ID do espaço de trabalho para onde a caixa será importada
–t Tag ou tags que marcarão e isolarão as instâncias e associações (bindings) do aplicativo, por exemplo, "production us-east-0"
–c Declarações para selecionar as políticas de implementação corretas a serem usadas por instâncias, por exemplo, "ubuntu us-east-0"
–input Documento JSON do aplicativo para implementar

Ciclo de vida da instância usando ebcli

Obter instâncias

Use a ebcli para listar suas instâncias.

Comando de terminal

ebcli instances [-f [<FIELD> [<FIELD> ...]]] [-t [<TAG> [<TAG> ...]]] [-w “<WORKSPACE ID>”]

Parâmetros

Opção pegar caixas Descrição
-f Campo ou campos que você quer que sejam listados.
–t Tag ou tags usadas para filtrar suas instâncias, por exemplo, "production us-east-0"
–w Área de trabalho que contém as instâncias que você deseja listar.

Reconfigurar uma instância

Use a ebcli para executar a operação de reconfiguração em uma instância que está ligada.

Comando de terminal

ebcli reconfigure ”<instance-id>”

Parâmetros

Opção Descrição
instance-id ID da instância cujas caixas você deseja reconfigurar.

Reinstalar uma instância

Use a ebcli para executar a operação de reinstalação em uma instância que está ligada.

Comando de terminal

ebcli reinstall ”<instance-id>”

Parâmetros

Opção Descrição
instance-id ID da instância que você deseja ativar.

Encerrar uma instância

Use ebcli para executar a operação de encerramento em uma instância que está provisionada.

ATENÇÃO – esta é uma operação destrutiva 

Você não pode se conectar, reiniciar ou recuperar uma instância depois que você terminou.

Antes de encerrar a instância confirme se você não perderá nenhum dado; verifique se os seus volumes não serão excluídos no encerramento e se você copiou os dados de que você precisa dos seus volumes de instância para um serviço de armazenamento persistente.

Quando uma instância é encerrada, os dados de qualquer armazenamento de instância e volumes associados a esta instância são excluídos.

Quando você terminar uma instância, toda a história da instância é mantida em Cloud Application Manager e você pode usá-la como referência para outras instâncias, copiar as variáveis ou clonar instância. A instância em seu provedor de nuvem é encerrada ou desprovisionada.

Depois de encerrar uma instância, ela permanece visível no console do provedor de nuvem por um curto período de tempo e, em seguida, a entrada é excluída automaticamente. Depois de uma instância encerrada, recursos como tags e volumes são gradualmente desassociados da instância.

Comando de terminal

ebcli terminate ”<instance-id>”

Parâmetros

Opção Descrição
instance-id ID da instância que você deseja encerrar.

Ligar uma instância

Use a ebcli para executar a operação de reinstalação em uma instância que está desligada.

Comando de terminal

ebcli reinstall ”<instance-id>”

Parâmetros

Opção Descrição
instance-id ID da Instância que você deseja reinstalar.

Desligar uma instância

Use a ebcli para executar a operação de desligamento em uma instância que está ligada.

Comando de terminal

ebcli shutdown ”<instance-id>”

Parâmetros

Opção Descrição
instance-id ID da instância cujas caixas você deseja desligar.

Exportar caixas de instâncias

Use a ebcli para exportar uma caixa do Cloud Application Manager para o JSON e arquivos de texto para poder importá-la depois.

Comando de terminal

ebcli export-instance [--boxes-path <BOXES_PATH>] [-r] ”<instance-id>”

Parâmetros

Opção Descrição
–-boxes-path Caminho onde as caixas serão exportadas.
-r Exportar recursivamente caixas externas e caixas internas.
instance-id ID da instância cujas caixas você deseja exportar.

Ciclo de vida de imagem ECS usando ebcli

Construa a imagem

Use o ebcli para construir a imagem.

Comando de terminal

ebcli build ”<box ID>” [-t “<image name>”] [--image <image name>] [--boxes-path <boxes path>]

Parâmetros

Opção de Implementação Descrição
-t Nome da imagem a ser criada.
–-image Nome da imagem base a ser usada. Por exemplo. Ubuntu: 0. 1 ou Centos.
–-boxes-path Caminho onde o caixas estão localizadas.

Empurre a imagem

Use o cliente docker para enviar a imagem para seu registro de janela de encaixe favorito. Se você tiver dúvidas sobre essa etapa, confira a documentação oficial do Docker sobre imagens.

Comando de terminal

docker push “<image name>”

Postar a imagem

Use o ebcli para postar a imagem na sua caixa

Comando de terminal

ebcli post “<docker image>”

Lista de áreas de trabalho usando ebcli

Obter espaços de trabalho

Use o ebcli para listar seus espaços de trabalho.

Comando de terminal

ebcli workspaces [-f [<FIELD> [<FIELD> ...]]]

Parâmetros

Opção pegar caixas Descrição
-f Campo ou campos que você quer que sejam listados.

Excluir recursos usando ebcli

Excluir instâncias, caixas ou espaços de trabalho

Use a ebcli para excluir seus recursos.

Comando de terminal

ebcli delete (-b BOX_ID | -i INSTANCE_ID | -w WORKSPACE_ID)

Parâmetros

Opção pegar caixas Descrição
id de caixa ID da caixa que você deseja excluir.
instance-id ID da instância que você deseja excluir.
ID do espaço de trabalho ID do espaço de trabalho que você deseja excluir.

Logout da sua conta Cloud Application Manager com a ebcli

Remover o token do token de autenticação do seu computador

Use a ebcli para fazer logout

Comando de terminal

ebcli logout

Como contatar o suporte do Cloud Application Manager

Lamentamos que você tenha encontrado um problema com o Cloud Application Manager. Consulte as dicas de troubleshooting ou entre em contato com o suporte do Cloud Application Manager e apresente detalhes e capturas de tela, conforme possível.

Para problemas relacionados a chamadas de API, envie o corpo da solicitação junto com os detalhes referentes ao problema.

Em caso de erro de caixa, compartilhe a caixa no espaço de trabalho que sua organização e o Cloud Application Manager podem acessar e anexe os registros.

  • Linux: SSH e localize o registro em /var/log/elasticbox/elasticbox-agent.log
  • Windows: RDP na instância para localizar o registro em C:\ProgramData\ElasticBox\Logs\elasticbox-agent.log
Powered by Translations.com GlobalLink OneLink SoftwarePowered By OneLink