digibeectl
See the answers for questions related to digibeectl
digibeectl is an application that not only exposes commands for your pipelines management, but also enables interactions with its respective deployments at each stage in the Digibee Integration Platform. Here you’ll know the first steps to deal with digibeectl, including the installation process and user authentication.
The easiest way to install digibeectl is with command line tools. so that the process leads to a 1 simple command line.
The installation options for digibeectl vary according to your operational system:
- Linux / MacOs
digibeectl is provided as a ‘tar.gz’ file for MacOS and linux. The command below helps in the digibeectl installation with one execution only. For that, open a terminal window and execute:
curl -s https://storage.googleapis.com/digibee-release-test/releases/install.sh | bash
- Windows
Windows is not supported.
digibeectl requires a configuration file that is encrypted and generates an authentication token. You can follow these steps to download your own file.
digibeectl uses GET and SET commands for you to configure your client with no issues. The information is automatically saved in a configuration file, which is used for subsequent commands.
The following example shows the configuration using a set that locally persists the data:
digibeectl set config --file "path/file.json" --secret-key "encryption-key" --auth-key "encryption-passphrase"
The command below helps in the digibeectl update with one execution only. For that, open a terminal window and execute:
curl -s https://storage.googleapis.com/digibee-release-test/releases/install.sh | bash
The following table includes brief descriptions and the general syntax for all the digibeectl operations:
Operation | Syntax | Description |
---|---|---|
create | digibeectl create RESOURCE [flags] | To create 1 or more resources. |
delete | digibeectl create RESOURCE [flags] | To delete resources permanently. |
get | digibeectl get RESOURCE [flags] [–watch] | To list 1 or more resources |
set | digibeectl set RESOURCE [flags] | To change the resources |
help | digibeectl [-h] | To have more details about each flag or command. |
The following table lists all the supported resource types and their most common titles.
Resource | Commom title | Description |
---|---|---|
config | - | Configurations resource |
deployment | deployments | Deployments resource |
pipeline | pipelines | Pipelines resource |
realm | realms | Realm resource |
The following tables separate the resources by each operation and show what their respective flags are.
- ConfigOperationResourceFlagsCommom titleDescriptiongetconfig-configsShows the current configurationsetconfig-configsSets the parameters and authentication token--file*The encrypted file with configuration--secret-key*The secret key--auth-key*The authentication key--help-hTo have help with the config.
- DeploymentOperationResourceFlagsCommom TitleDescriptionPermissiongetdeployment-List deploymentsDEPLOYMENT:READ--deployment-id-dFilter deployment **** by ID--environment-eFilter deployments by environment (default "test").--name-nFilter deployments by name--help-hTo have help in the deploymentcreatedeployment-Create deployment.DEPLOYMENT:CREATE DEPLOYMENT:CREATE:REDEPLOY CONFIGURATION:READ CONFIGURATION:UPDATE--pipeline-id(flag obrigatória)Pipeline id.--pipeline-size-sThe pipeline size (SMALL/MEDIUM/LARGE) (default "SMALL")--consumers-cThe maximum of consumers on the pipeline to be deployed (Default: SMALL=10 / MEDIUM=20 / LARGE=40)--environment-eThe pipeline environment for deployment (default "test")--instance-name-iThe pipeline instance name (required when the pipeline is multi-instance)--redeployEnable redeploy to the pipeline.--replicasDefine o The pipeline number of replicas (default "1")--waitIf active waits for the deployment to be completed. (Timeout 300 seconds).deletedeployment-Remove deploymentDEPLOYMENT:DELETE--deployment-id-d,The ID of the deployment to be deleted.--environment-e,The environment of the deployment to be deleted.--help-hTo have help in the deployment
- Pipeline
Operation | Resource | Flags | Commom title | Description | Permissions |
---|---|---|---|---|---|
get | pipeline | - | | List pipelines. | PIPELINE:READ |
| | --name | -n | Filter pipelines by name | |
| | --pipeline-id | | Filter pipelines by ID | |
| | --pipeline-version-major | | Filter pipelines by version major | |
| | --pipeline-version-minor | | Filter pipelines by version minor | |
| | --archived | -a | Show only archived pipelines. | |
| | --flowspec | -o | Exibe o Show pipeline FlowSpec, require the -- pipeline-id | |
| | --show-versions | | Show pipelines with versions | |
| | ---help | -h | To have help with the pipeline. | |
- Realm
Operation | Resource | Flags | Common title | Description | Permissions |
---|---|---|---|---|---|
get | realm | - | - | List realm info | REALM:READ |
| | --help | -h | To have help with the realm. | |
Last modified 5mo ago