Operações
Confira as operações disponíveis no Digibeectl.
O Digibeectl utiliza os comandos GET e SET para você configurar o seu cliente sem dificuldades.
As informações são salvas automaticamente em um arquivo de configuração usado para comandos subsequentes.
Operações e sintaxe
Acompanhe na tabela as descrições curtas e a sintaxe geral para todas as operações do 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 abaixo lista todos os tipos de recursos suportados e os seus títulos mais comuns:
Recurso | Titulo 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. |
license | licenses | Recurso para consultar informações sobre sua licença. |
api-mgmt-credentials | api management credentials | Recurso para gerenciamento de API. |
api-mgmt-url | api management url | Recurso para gerenciamento de URL da API de métricas. |
Flags de recursos
As tabelas a seguir separam os recursos por cada operação e suas respectivas flags:
Config
Operação | Recurso | Flags | Titulo comum | Descrição |
---|---|---|---|---|
get | config | - | config | Lista as configurações atuais. |
set | config | - | config | 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. |
Deployment
Operação | Recurso | Flags | Titulo 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 padrão é "test". | |||
--name | -n | Filtra implantações por nome. | |||
--projectName | -p | Filtra por nome de projeto. | |||
--status | -s | Filtra por status. | |||
deployment history | Mostra o histórico de implantações. | ||||
--name | -n | Mostra o histórico por nome. | |||
--majorversion | -m | Exibe o histórico por versão major. | |||
--page | -p | Mostra a quantidade de itens para retornar. O padrão é 1. | |||
--size | -s | Exibe a quantidade de páginas para filtrar. O padrão é 20. | |||
--help | -h | 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 padrão é SMALL. | |||
--consumers | -c | Número máximo de Consumers do pipeline a ser implantado. O valor máximo e/ou padrão de cada tamanho é: SMALL=10/ MEDIUM=2 / LARGE=40 | |||
--environment | -e | Define o ambiente da implantação. O ambiente padrão é "test". | |||
--instance-name | -i | Define a instância de um pipeline multi-instância para implantação. | |||
--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 implantação. |
Pipeline
Operação | Recurso | Flags | Titulo 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 | |||
--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 | Titulo comum | Descrição | Permissões |
---|---|---|---|---|---|
get | realm | - | - | Consulta informações sobre o seu ambiente. | REALM:READ |
--help | -h | Lista os comandos de ajuda. |
Gerenciamento de API
Operação | Recurso | Flags | Titulo comum | Descrição | Permissões |
---|---|---|---|---|---|
get | api-mgmt-credentials | - | - | Gerencia informações da API. | METRICS:READ |
--username | -u | Pesquisa por nome de usuário (opcional). | |||
--help | -h | Lista os comandos de ajuda. | |||
api-mgmt-url | |||||
--help | -h | Lista os comandos de ajuda. | |||
create | api-mgmt-credentials | - | - | METRICS:READ | |
--username | -u | Cria o nome de usuário. | |||
--password | -p | Cria a senha. | |||
delete | api-mgmt-credentials | ||||
--username | -u | Exclui o nome de usuário informado. |
Last updated