Operações do Digibeectl

Explore as diversas operações disponíveis no Digibeectl.

Com comandos simples, você pode configurar facilmente seus clientes. As configurações são automaticamente salvas em um arquivo, acelerando os comandos subsequentes.

Siga a tabela para obter a sintaxe padrão e as descrições para executar operações em Digibeectl:

Operação	Sintaxe	Descrição
completion	digibeectl completion SUB-COMMAND [flags]	Gera o script de autocompletion para o Digibeectl para o shell especificado.
config	digibeectl config [flags]	Configura o Digibeectl.
create	digibeectl create RESOURCE [flags]	Comando para criar recursos.
delete	digibeectl delete RESOURCE [flags]	Comando para deletar recursos.
get	digibeectl get RESOURCE [flags]	Obtém todos os recursos ou um recurso específico.
help	digibeectl get SUB-COMMAND or RESOURCE [flags]	Mostra a documentação de ajuda do Digibeectl.
info	digibeectl info [flags]	Mostra todos os comandos disponíveis.
set	digibeectl create RESOURCE [flags]	Define um recurso específico.
update	digibeectl update [flags]	Atualiza o Digibeectl para a versão mais recente.
version	digibeectl version [flags]	Mostra as informações de versão do Digibeectl.

Abaixo você pode ver a documentação de ajuda do Digibeectl:

Tipos de recurso

Os tipos de recursos são os recursos específicos a serem acessados ​​e usados ​​para compor determinados comandos.

Confira os exemplos para tipos de recurso:

digibeectl [command] <resource> <resource-id> [flags]
digibeectl [command] [resource] [flags]

A tabela a seguir inclui uma lista de todos os tipos de recursos suportados:

Operações	Recurso	Descrição
create, delete, get	api-mgmt-credentials	Crie/exclua/obtenha credenciais de API.
get	api-mgmt-url	Obter URL da API.
create, delete, get	deployment	Criar/excluir implantações/Recuperar detalhes de uma implantação específica.
get	deployment-history	Obtenha todo o histórico de implantação.
get	pipeline	Este comando serve para ler o conteúdo do pipeline.
get	project	Este comando serve para ler os projetos disponíveis.
get	realm	Recursos para consultar informações sobre o seu realm.
get	metrics	Obtém as métricas de um pipeline válido.
create	pipeline	Cria um novo pipeline.
create	project	Cria um novo projeto.

Flags de recursos

As tabelas a seguir categorizam os recursos com base nas operações correspondentes e indicam as respectivas flags de cada operação:

Deployment

Operação	Recurso	Flags	Título comum	Descrição
get	deployment			Lista as implantações.
		--deployment-id	-d	Filtra as implantações por ID.
		--environment	-e	Filtra as implantações por ambiente (padrão "test").
		--name	-n	Filtra as implantações por nome.
		--projectName	-p	Filtra as implantações por nome do projeto.
		--status	-s	Filtra as implantações por status.
		--allspecs	-a	Mostra todas as especificações do pipeline (FlowSpec, TriggerSpec, InSpec, OutSpec).
		--flowspec	-f	Mostra as especificações Flow do pipeline.
		--output	-o	Exibe os recursos em formato JSON
get	deployment history			Lista o histórico das implantações.
		--name	-n	Filtra o histórico de implantações por nome do pipeline.
		--majorversion	-m	Filtra o histórico de implantações pela versão major.
		--page	-p	Mostra a quantidade de itens a serem retornados. Padrão é 1.
		--size	-s	Mostra a quantidade de páginas para filtrar. Padrão é 20.
		--help	-h	Exibe ajuda com o histórico de implantações.
create	deployment			Cria uma implantação.
		--pipeline-id	(mandatory flag)	ID do pipeline.
		--pipeline-size	-s	Tamanho do pipeline. (SMALL/MEDIUM/LARGE). Padrão: SMALL.
		--consumers	-c	Número máximo de consumidores no pipeline a ser implantado (Padrão: SMALL=10 / MEDIUM=20 / LARGE=40).
		--environment	-e	Ambiente do pipeline para implantação. Padrão: "test".
		--instance-name	-i	Nome da instância do pipeline requerido quando o pipeline possui múltiplas instâncias.
		--redeploy	-	Ativa o redeploy no pipeline.
		--replicas	-	Número de réplicas do pipeline. Padrão: 1
		--wait	-	Se ativo, aguarda a conclusão da implantação. Timeout: 300 segundos.
delete	deployment			Remove uma implantação
		--deployment-id	-d	ID da implantação a ser removida.
		--environment	-e	Ambiente da implantação a ser removido
		--help	-h	Lista os comandos de ajuda para implementação.
set	deployment	--rollback --id (flags mandatórias)		Executa rollback para restaurar a versão anterior do pipeline que foi implantada.

Metrics

Operation	Resource	Flags	Shorthand	Description	Permissions
get	metrics	--pipeline-name --pipeline-version --from --to --relative-date		Obtém as métricas de um pipeline válido. Use as flags --from e --to para filtrar métricas de uma data ou intervalo específico. A flag --from pode ser usada sem a flag --to, mas a flag --to não pode ser usada sozinha. A flag --relative-date é outra opção que permite filtrar métricas dentro de intervalos de tempo relativos. Você pode usar valores como: últimos 5 minutos, últimos 3 dias, últimos 7 dias ou especificar um intervalo de datas.

Pipeline

Operação	Recurso	Flags	Título comum	Descrição
get	pipeline			Lista os pipelines
		--allspecs		Mostra todas as especificações do pipeline (FlowSpec, TriggerSpec, InSpec, OutSpec). Requerido: --pipeline-id
		--flowspec	-o	Mostra o FlowSpec do pipeline. Requerido: --pipeline-id
		--archived	-a	Mostra apenas pipelines arquivados.
		--help	-h	Exibe ajuda para o pipeline
		--name string	-n	Filtra os pipelines por nome
		--page int		Página de resultados (padrão 1)
		--pipeline-id string		Filtra os pipelines por ID
		--pipeline-version-major string		Filtra os pipelines por versão major
		--pipeline-version-minor string		Filtra os pipelines por versão minor
		--project-id string		Filtra os pipelines por ID do projeto
		--show-versions		Mostra os pipelines que possuem versões
		--output	-o	Exibe os recursos em formato JSON
create	pipeline	--name string --description --project string (flags obrigatórias) --help	-n -d -p -h	Cria um novo pipeline.

Project

Operation	Resource	Flags	Shorthand	Description	Permissions
create	project	--name --description (flags obrigatórias) --help	-n -d -h	Cria um novo projeto.

Realm

Operação	Recurso	Flags	Título comum	Descrição	Permissões
get	realm			Lista informações do realm	REALM:READ
		--help	-h	Lista os comandos de ajuda
		--output	-o	Exibe os recursos em formato JSON

Gerenciamento de API

Operação	Recurso	Flags	Título comum	Descrição	Permissões
get	api-mgmt-credentials			Gerencia as credenciais da API	METRICS:READ
		--username	-u	Pesquisar por nome de usuário (opcional)
		--help	-h	Obter ajuda com os comandos.
get	api-mgmt-url
		--help	-h	Obtém ajuda com os comandos
create	api-mgmt-credentials
		--username	-u	Nome de usuário para credenciais de API (obrigatório)
		--password	-p	Senha para credenciais de API (obrigatório)
delete	api-mgmt-credentials	--username	-u	Excluir um nome de usuário

Para que o nome de usuário seja excluído, o nome do realm deve ser incluído antes do nome de usuário.

Gerenciamento de informações

Configurações

Operação	Subcomando	Flags	Título comum	Descrição
config	set			Definir uma nova configuração com parâmetros de autenticação.
		--file (mandatory)	-f	Gerar um arquivo de configuração.
		--secret-key (mandatory)	-s	A chave criptografada.
		--auth-key (mandatory)	-a	A chave de autenticação.
config	get			Obter os detalhes da configuração do realm. O padrão é o realm atual.
		--help	-h	Listar comandos de ajuda.
		--realm	-r	O nome do realm.
config	view			Mostrar todos os realms disponíveis e suas configurações.
config	list			Listar todos os realms disponíveis e suas configurações.
config	use			Alterar o realm atual do Digibeectl.
		--realm	-r	O nome do realm.
config	delete			Excluir uma configuração Digibeectl de um realm.
		--realm	-r	O nome do realm.
config	update			Atualizar o Digibeectl para a versão LTS (Long-term support).
config	version			Exibir a versão atual do Digibeectl.