caade

CAADE commands helps developers to compose applications based on archetypes and work with them - provision, view environments, check logs.

caade activity

caade activity abandon

Abandon an operation

Usage:

caade activity abandon --operation <operation> [--force {[true]|false}]

Parameter Name Description Default Value Mandatory
operation Operation ID   Yes
force Option to force abandon false No

caade activity cancel

Cancel an operation

Usage:

caade activity cancel --operation <operation>

Parameter Name Description Default Value Mandatory
operation Operation ID   Yes

caade activity info

Show details of operations.

Usage:

caade activity info --operation <operation> [--step <step>]

Parameter Name Description Default Value Mandatory
operation Operation ID   Yes
step Step ID   No

caade activity ls

Show activities.

Usage:

caade activity ls [--env <env>] [--page-size <page-size>] [--page <page>] [--archive <archive>]

[--area {design|development|application}]

Parameter Name Description Default Value Mandatory
env Name of environment and related activities   No
page-size Max number of activities that should be displayed 25 No
page Page number 1 No
archive If this parameter is entered then archived activities should be displayed, otherwise active ones   No
area Area of activities. Possible values are: ‘design’, ‘development’ or ‘application’   No

caade activity restart

Restart an operation

Usage:

caade activity restart --operation <operation>

Parameter Name Description Default Value Mandatory
operation Operation ID   Yes

caade app-stack

caade app-stack export

Exports Application Stack to Unity Catalog.

Usage:

caade app-stack export --key <key> [--timeout <timeout>]

Parameter Name Description Default Value Mandatory
key Application Stack to export   Yes
timeout Export Operation timeout in minutes (0 for infinite timeout) 0 No

caade app-stack import

Imports Application Stack from Unity Catalog.

Usage:

caade app-stack import --name <name> [--import-project-archive {[true]|false}] [--import-no-project-archive {[true]|false}] [--timeout <timeout>]

Parameter Name Description Default Value Mandatory
name Application Stack name to import in the following format: ‘vendor/type:version’   Yes
import-project-archive Import Project Archive from Unity Catalog Repository false No
import-no-project-archive Do not import Project Archive from Unity Catalog Repository false No
timeout Import Operation timeout in minutes (0 for infinite timeout) 0 No

caade app-stack ls

Shows all application stacks

Usage:

caade app-stack ls

caade app

caade app build

Builds customization project locally

Usage:

caade app build

caade app create

Creates local application project from specified application stack

Usage:

caade app create --name <name> --app-stack <app-stack> [--stack-template <stack-template>]

Parameter Name Description Default Value Mandatory
name Project name (the folder with this name will be created)   Yes
app-stack Key of the application stack that need to be used   Yes
stack-template Stack template key   No

caade app ls

Shows all applications

Usage:

caade app ls

caade app publish

Publish application.

Usage:

caade app publish

caade app push

Push application to server

Usage:

caade app push

caade app reject

Reject application.

Usage:

caade app reject

caade destroy

Destroys environment. You can destroy environment with status ‘ACTIVE’, ‘READY_FOR_PROVISIONING’. Environment with ‘PROCESSING’ state has unfinished operation with state ‘FAILED’, ‘ABANDONED_FAILED’. In case when you cannot delete environment with status ‘ABANDON_FAILED’ use –force-delete option. NOTE: –force-delete may not normally clean all resources.

Usage:

caade destroy [--env <env>] [--force-delete {true|false}] [--timeout <timeout>]

Parameter Name Description Default Value Mandatory
env Environment name   No
force-delete Performs force deletion false No
timeout Timeout in minutes (0 for infinite timeout) 0 No

caade disuse

Reset current environment.

Usage:

caade disuse

caade env

caade env ls

Show environment runtime info.

Usage:

caade env ls [--area {design|development|application}]

Parameter Name Description Default Value Mandatory
area Environment’s operation area: ‘design’, ‘development’ or ‘application’   No

caade info

Show environment runtime info.

Usage:

caade info [--env <env>] [--service <service>] [--v] [--vv]

Parameter Name Description Default Value Mandatory
env Environment name   No
service Service name   No
v 1st level of verbosity   No
vv 2nd level of verbosity   No

caade logs

Get logs from specific environment/service/node

Usage:

caade logs [--log <log>] [--env <env>] [--service <service>] [--node <node>] [--target <target>]

Parameter Name Description Default Value Mandatory
log Path to logs on remote machine   No
env Environment name   No
service Service name   No
node Nodes names, separated by commas   No
target Destination folder where logs stored   No

caade ps

Show service statuses in environment.

Usage:

caade ps [--env <env>]

Parameter Name Description Default Value Mandatory
env Environment name   No

caade run

Run command in specific environment/service/node

Usage:

caade run ['<shell-cmd>'] [--env <env>] [--service <service>] [--node <node>]

Parameter Name Description Default Value Mandatory
<shell-cmd> Command to execute   No
env Environment name   No
service Service name   No
node Nodes names, separated by commas   No

caade service-template

caade service-template export

Exports Service Template to Unity Catalog.

Usage:

caade service-template export --key <key> [--dependencies {[true]|false}] [--export-all-media {[true]|false}]

[--export-no-media {[true]|false}] [--force {[true]|false}] [--stereotype {service-template|stack-template}]

[--timeout <timeout>]

Parameter Name Description Default Value Mandatory
key Service Template to export   Yes
dependencies Export all Service Template dependencies to Unity Catalog   No
export-all-media Export all Media Files to Unity Catalog Repository   No
export-no-media Do not export Media Files to Unity Catalog Repository   No
force Forces Export of non published Service Templates   No
stereotype Export Service Template as Service or Stack Template. Allowed values are “service-template” and “stack-template”   No
timeout Export Operation timeout in minutes (0 for infinite timeout) 0 No

caade service-template import

Imports Service Template from Unity Catalog.

Usage:

caade service-template import --name <name> [--dependencies {[true]|false}] [--import-all-media {[true]|false}]

[--import-no-media {[true]|false}] [--timeout <timeout>]

Parameter Name Description Default Value Mandatory
name Service Template to import in the following format: ‘vendor/type:version’   Yes
dependencies Import all Service Template dependencies from Unity Catalog   No
import-all-media Import all Media Files from Unity Catalog Repository   No
import-no-media Do not import Media Files from Unity Catalog Repository   No
timeout Import Operation timeout in minutes (0 for infinite timeout) 0 No

caade service-template ls

Shows all service templates

Usage:

caade service-template ls

caade stack-template

caade stack-template ls

Shows all stack templates

Usage:

caade stack-template ls

caade start

Start service.

Usage:

caade start [--env <env>] --service <service> [--timeout <timeout>]

Parameter Name Description Default Value Mandatory
env Environment name   No
service Service name   Yes
timeout Timeout in minutes (0 for infinite timeout) 0 No

caade stop

Stop service.

Usage:

caade stop [--env <env>] --service <service> [--timeout <timeout>]

Parameter Name Description Default Value Mandatory
env Environment name   No
service Service name   Yes
timeout Timeout in minutes (0 for infinite timeout) 0 No

caade up

Provision environment with specified profile. By default use ‘dev’ profile.

Usage:

caade up [--profile <profile>] [--space <space>] [--area {design|development|application}]

[--security-profile <security-profile>] [--timeout <timeout>]

Parameter Name | Description Default Value Mandatory
profile | Environment profile, e.g. ‘development’, ‘production’, ‘testing’ development No
space Space name or key   No
area Area where to provision environment: ‘design’, ‘development’ or ‘application’ design No
security-profile Security profile of the space   No
timeout Provisioning timeout in minutes (0 for infinite timeout) 0 No

caade update

Update application in the environment.

Usage:

caade update [--env <env>] [--timeout <timeout>] [--skip-save {[true]|false}]

Parameter Name Description Default Value Mandatory
env Environment name   No
timeout Provisioning timeout in minutes (0 for infinite timeout) 0 No
skip-save Flag, if need to skip saving maintenance plan   No

caade use

Switch current environment.

Usage:

caade use [<environment>]

Parameter Name Description Default Value Mandatory
<environment> Environment name   No