Documentation Portal
EN-US
Digibee.comDigibee Academy
Search
⌃K
Links

digibeectl

See the answers for questions related to digibeectl

First steps with 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.

Installing digibeectl

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.

Configuring digibeectl

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"

Updating digibeectl versions

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

Operations

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.

Resource types

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

Resource flags

The following tables separate the resources by each operation and show what their respective flags are.
  • Config
    Operation
    Resource
    Flags
    Commom title
    Description
    get
    config
    -
    configs
    Shows the current configuration
    set
    config
    -
    configs
    Sets the parameters and authentication token
    ​
    ​
    --file
    ​
    *The encrypted file with configuration
    ​
    ​
    --secret-key
    ​
    *The secret key
    ​
    ​
    --auth-key
    ​
    *The authentication key
    ​
    ​
    --help
    -h
    To have help with the config.
*Know more about the encrypted file, encrypted key, and authentication key here.
  • Deployment
    Operation
    Resource
    Flags
    Commom Title
    Description
    Permission
    get
    deployment
    -
    ​
    List deployments
    DEPLOYMENT:READ
    ​
    ​
    --deployment-id
    -d
    Filter deployment **** by ID
    ​
    ​
    ​
    --environment
    -e
    Filter deployments by environment (default "test").
    ​
    ​
    ​
    --name
    -n
    Filter deployments by name
    ​
    ​
    ​
    --help
    -h
    To have help in the deployment
    ​
    create
    deployment
    -
    ​
    Create deployment.
    DEPLOYMENT:CREATE DEPLOYMENT:CREATE:REDEPLOY CONFIGURATION:READ CONFIGURATION:UPDATE
    ​
    ​
    --pipeline-id
    (flag obrigatória)
    ​
    Pipeline id.
    ​
    ​
    ​
    --pipeline-size
    -s
    The pipeline size (SMALL/MEDIUM/LARGE) (default "SMALL")
    ​
    ​
    ​
    --consumers
    -c
    The maximum of consumers on the pipeline to be deployed (Default: SMALL=10 / MEDIUM=20 / LARGE=40)
    ​
    ​
    ​
    --environment
    -e
    The pipeline environment for deployment (default "test")
    ​
    ​
    ​
    --instance-name
    -i
    The pipeline instance name (required when the pipeline is multi-instance)
    ​
    ​
    ​
    --redeploy
    ​
    Enable redeploy to the pipeline.
    ​
    ​
    ​
    --replicas
    ​
    Define o The pipeline number of replicas (default "1")
    ​
    ​
    ​
    --wait
    ​
    If active waits for the deployment to be completed. (Timeout 300 seconds).
    ​
    delete
    deployment
    -
    ​
    Remove deployment
    DEPLOYMENT:DELETE
    ​
    ​
    --deployment-id
    -d,
    The ID of the deployment to be deleted.
    ​
    ​
    ​
    --environment
    -e,
    The environment of the deployment to be deleted.
    ​
    ​
    ​
    --help
    -h
    To 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.
​
Platform - Previous
URLs System
Next
digibeectl - FAQ
Last modified 5mo ago