IMPORTANTE: esta documentação foi descontinuada. Leia a documentação Guia de Uso do digibeeclt atualizada no nosso novo portal de documentação.

Primeiros passos com o digibeectl

O digibeectl é uma aplicação que não somente expõe comandos para o gerenciamento dos seus pipelines, mas também viabiliza interações com as suas respectivas implantações em cada estágio na Plataforma Digibee. Aqui você saberá quais são os primeiros passos para manusear o digibeectl, incluindo o processo de instalação e a autenticação de usuários.

Instalando o digibeectl

A maneira mais fácil de instalar o digibeectl é com ferramentas de linha de comando, pois assim o processo se resume a apenas 1 linha de comando.

As opções de instalação para o digibeectl variam de acordo com o seu sistema operacional:

Linux / MacOs

O digibeectl é fornecido como um arquivo ‘tar.gz’ para MacOS. O comando abaixo ajuda na instalação do digibeectl com apenas uma execução. Para isso, abra uma janela do terminal e execute:

curl -s https://storage.googleapis.com/digibee-release-test/releases/install.sh | bash

Windows

Não suportado. Está em desenvolvimento.

Configurando o digibeectl

Para utilizar o digibeectl é necessário obter o arquivo de configurações através da Plataforma Digibee seguindo o passo a passo descrito aqui.

O digibeectl utiliza os comandos GET e SET para que você possa configurar o seu cliente sem dificuldades. As informações são salvas automaticamente em um arquivo de configuração, o qual é usado para comandos subsequentes.

O exemplo a seguir mostra a configuração usando um set que persiste os dados localmente:

digibeectl set config --file "path/file.json" --secret-key "chave-de-criptografia" --auth-key "senha-de-criptografia"

Atualização do digibeectl

Para atualizar o digibeectl nos sistemas Linux e Mac basta executar a linha de instalação novamente. Para isso, abra uma janela do terminal e execute:

curl -s https://storage.googleapis.com/digibee-release-test/releases/install.sh | bash

Operações

A tabela a seguir inclui descrições curtas e a sintaxe geral para todas as operações da digibeectl:

Operação	Sintaxe	Descrição
create	digibeectl create RESOURCE [flags]	Para a criação de 1 ou mais recursos.
delete	digibeectl delete RESOURCE [flags]	Para remover recursos de forma permanente.
get	digibeectl get RESOURCE [flags] [–watch]	Para listar 1 ou mais recursos.
set	digibeectl set RESOURCE [flags]	Para alterar os recursos.
help	digibeectl [-h]	Para obter mais detalhes sobre cada flag ou comando.

Tipos de recurso

A tabela a seguir lista todos os tipos de recursos suportados e os seus títulos mais comuns.

Recurso	Título comum	Descrição
config	-	Recurso para operar configurações.
deployment	deployments	Recurso para operar implantações.
pipeline	pipelines	Recurso para operar pipelines.
realm	realms	Recurso para consultar informações sobre o seu realm.

Flags de recursos

As tabelas abaixo separam os recursos por cada operação e suas respectivas flags.

Config

Operação	Recurso	Flags	Título comum	Descrição
get	config	-	configs	Lista as configurações atuais.
set	config	-	configs	Configura os parâmetros e o token de autenticação.
		--file		*Arquivo de configurações gerado através da Plataforma.
		--secret-key		*Chave de criptografia.
		--auth-key		*Chave de autorização.
		--help	-h	Lista os comandos de ajuda.

* Para saber mais sobre sobre como gerar chaves de autenticação e obter o arquivo de configurações clique aqui.

Deployment

Operação	Recurso	Flags	Título comum	Descrição	Permissões
get	deployment	-		Consulta implantações.	DEPLOYMENT:READ
		--deployment-id	-d	ID da implantação.
		--environment	-e	Filtra implantações por ambiente. O ambiente default é "test".
		--name	-n	Filtra implantações por nome.
		--help	-h	Para obter ajuda na implantação.
create	deployment	-		Cria implantações.	DEPLOYMENT:CREATE DEPLOYMENT:CREATE:REDEPLOY CONFIGURATION:READ CONFIGURATION:UPDATE
		--pipeline-id (flag obrigatória)		ID do pipeline.
		--pipeline-size	-s	Tamanho do pipeline (SMALL/MEDIUM/LARGE). O tamanho default é SMALL.
		--consumers	-c	Número máximo de execuções simultâneas do pipeline a ser implantado.O valor máximo e/ou default de cada tamanho é: SMALL=10 / MEDIUM=20 / LARGE=40.
		--environment	-e	Define o ambiente no qual a implantação será feita. O ambiente default é "test".
		--instance-name	-i	Quando o pipeline têm multi-instâncias, define qual instância deste pipeline deve ser implantada.
		--redeploy		Permite a reimplantação de um pipeline.
		--replicas		Define o número de réplicas do pipeline. O valor padrão é "1".
		--wait		Se ativado, aguarda a implantação ser concluída. O timeout é de 300 segundos.
delete	deployment	-		Remove implantações.	DEPLOYMENT:DELETE
		--deployment-id	-d,	Id da implantação a ser removida.
		--environment	-e,	Ambiente da implantação a ser removida.
		--help	-h	Lista os comandos de ajuda para deploymeny.

Pipeline

Operação	Recurso	Flags	Título comum	Descrição	Permissões
get	pipeline	-		Consulta informações de pipelines.	PIPELINE:READ
		--name	-n	Filtra pipelines por nome.
		--pipeline-id		Filtra pipelines por ID.
		--pipeline-version-major		Filtra pipelines por versão major.
		--pipeline-version-minor		Filtra pipelines por versão minor.
		--archived	-a	Lista apenas pipelines arquivados.
		--flowspec	-o	Exibe o FlowSpec do pipeline e exige o `--pipeline-id.`
		--show-versions		Exibe todas as versões minor de um pipeline.
		--help	-h	Lista os comandos de ajuda para pipeline.

Realm

Operação	Recurso	Flags	Título comum	Descrição	Permissões
get	realm	-	Consulta informações sobre o seu realm.		REALM:READ
		--help	-h	Lista os comandos de ajuda.