Operations

Check all Digibeectl available operations.

Digibeectl uses the GET and SET commands so that you can easily configure your client.

The information is automatically saved in a configuration file, which is used for the following commands.

Operations and syntax

The following table contains brief descriptions and the general syntax for all Digibeectl operations:

Operation	Syntax	Description
create	digibeectl create RESOURCE [flags]	To create 1 or more resources
delete	digibeectl delete 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 table below lists all 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
license	licenses	License resource
api-mgmt-credentials	api management credentials	API credentials management resource
api-mgmt-url	api management url	URL' s API management resource

Resource flags

The following tables categorize resources based on their corresponding operations and indicate the respective flags for each operation:

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	Get help with the config

Deployment

Operation	Resource	Flags	Common 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
		--projectName	-p	Filter deployments by project name
		--status	-s	Filter deployments by status
	deployment history			List deployments history
		--name	-n	Show deployment history by name
		--majorversion	-m	Show deployment history by major version
		--page	-p	Show the quantity of items to return. Default is 1.
		--size	-s	Show the quantity of pages to filter. Default is 20.
		--help	-h	Get help with deployment history.
create	deployment	-		Create a deployment.	DEPLOYMENT:CREATE DEPLOYMENT:CREATE:REDEPLOY CONFIGURATION:READ CONFIGURATION:UPDATE
		--pipeline-id (mandatory flag )		Pipeline ID
		--pipeline-size	-s	Pipeline size (SMALL/MEDIUM/LARGE). Default: SMALL
		--consumers	-c	Maximum of consumers on the pipeline to be deployed Default: SMALL=10 / MEDIUM=20 / LARGE=40
		--environment	-e	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		The pipeline number of replicas. Default: 1
		--wait		If active waits for the deployment to be completed. Timeout: 300 seconds.
delete	deployment	-		Remove a 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	Get help with deployment .

Pipeline

Operation	Resource	Flags	Common 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	Show pipeline FlowSpec, require the --pipeline-id
		--show-versions		Show pipelines with versions
		---help	-h	Get help with the pipeline

Realm

Operation	Resource	Flags	Common title	Description	Permissions
get	realm	-	-	List realm information	REALM:READ
		--help	-h	Get help with the realm.

License

Operation	Resource	Flags	Common title	Description	Permissions
get	license	-	-	List license information	LICENSE:READ

API Management

Operation	Resource	Flags	Common title	Description	Permissions
get	api-mgmt-credentials	-	-	Manage API credentials.	METRICS:READ
		--username	-u	Search by user name (optional)
		--help	-h	Get help with the commands.
	api-mgmt-url
		--help	-h	Get help with the commands.
create	api-mgmt-credentials	-	-
		--username	-u	Creat a username.
		--password	-p	Create a password.
delete	api-mgmt-credentials
		--username	-u	Delet a username.