Operações do Digibeectl
Explore as diversas operações disponíveis no Digibeectl.
Atualizado
Explore as diversas operações disponíveis no Digibeectl.
Atualizado
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:
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:
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:
A tabela a seguir inclui uma lista de todos os tipos de recursos suportados:
create, delete, get
api-mgmt-credentials
Crie/exclua/obtenha as credenciais de API para a API de Pipeline Metrics.
create, delete, get
deployment
Criar/excluir implantações/Recuperar detalhes de uma implantação específica.
get
api-mgmt-url
Obtenha o URL da API para a API de Pipeline Metrics.
get
deployment-history
Obtenha todo o histórico de implantação.
get
license
Exibe as informações de licença do realm. Usando flags, você pode visualizar os detalhes da licença filtrados por pipeline ou projeto.
get
metrics
Obtém as métricas de um pipeline válido.
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.
create
pipeline
Cria um novo pipeline.
create
project
Cria um novo projeto.
set
deployment
Gerencia operações de implantação.
As tabelas a seguir categorizam os recursos com base nas operações correspondentes e indicam as respectivas flags de cada operaçã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").
--namestring
-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.
--namestring
-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.
--output
-o
Exibe os recursos em formato JSON.
--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
Gerencia operações de implantação.
--rollback
--id
(devem ser usadas juntas)
Executa rollback para restaurar a versão anterior do pipeline que foi implantada.
--restore --history-id
Cria uma nova implantação usando o ID de uma versão implantada anteriormente.
get
license
--by-project --by-pipeline
Exiba as informações de licença do realm. Usando flags, você pode visualizar os detalhes da licença filtrados por pipeline ou projeto.
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.
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.
create
project
--name
--description
(flags obrigatórias)
--help
-n
-d
-h
Cria um novo projeto.
get
realm
Lista informações do realm
REALM:READ
--help
-h
Lista os comandos de ajuda
--output
-o
Exibe os recursos em formato JSON
get
api-mgmt-credentials
Gerencia as credenciais de API para a API de Pipeline Metrics.
METRICS:READ
--username
-u
Pesquisar por nome de usuário (opcional)
--help
-h
Obter ajuda com os comandos.
get
api-mgmt-url
Obtenha o URL da API para a API de Pipeline Metrics.
--help
-h
Obtém ajuda com os comandos
create
api-mgmt-credentials
Cria as credenciais de API para a API de Pipeline Metrics.
--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.
set
config
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.
get
config
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.
view
config
Mostrar todos os realms disponíveis e suas configurações.
list
config
Listar todos os realms disponíveis e suas configurações.
use
config
Alterar o realm atual do Digibeectl.
--realm
-r
O nome do realm.
delete
config
Excluir uma configuração Digibeectl de um realm.
--realm
-r
O nome do realm.
update
config
Atualizar o Digibeectl para a versão LTS (Long-term support).
version
config
Exibir a versão atual do Digibeectl.
