/
Application Lifecycle Commands

Application Lifecycle Commands

The CLI includes the following application lifecycle commands:

Command

Description

Command

Description

add time schedule <schedule-name> for workflow <app-id.program-id> [version <app-version>] [description <description>] at <cron-expression> [concurrency <concurrency>] [properties <schedule-properties>]

Adds a schedule which is associated with the program given

check service availability <app-id.service-id> [version <app-version>]

Check if a service is available to accept requests

create app <app-id> [version <app-version>] <artifact-name> <artifact-version> <scope> [<app-config-file>]

Creates an application from an artifact, optionally with a version. If the version is not given, a default version '-SNAPSHOT' will be used. A configuration is also optional. If a configuration is needed, it must be given as a file whose contents are a JSON object containing the application config. For example, the file contents could contain: '{ "config": { "stream": "purchases" } }'. In this case, the application would receive '{ "stream": "purchases" }' as its config object. Finally, an optional principal may be given.

delete app <app-id> [version <app-version>]

Deletes an application with an optional version. If version is not provided, default version '-SNAPSHOT' will be used.

delete app preferences <app-id>

Deletes the preferences of an application

delete instance preferences

Deletes the preferences of an instance

delete mapreduce preferences <app-id.mapreduce-id>

Deletes the preferences of a MapReduce program

delete namespace preferences

Deletes the preferences of a namespace

delete schedule <app-id.schedule-id>

Deletes a schedule

delete service preferences <app-id.service-id>

Deletes the preferences of a service

delete spark preferences <app-id.spark-id>

Deletes the preferences of a Spark program

delete worker preferences <app-id.worker-id>

Deletes the preferences of a worker

delete workflow local datasets <app-id.workflow-id> <runid>

DEPRECATED. Deletes the local datasets associated with the workflow for a given <runid>

delete workflow preferences <app-id.workflow-id>

Deletes the preferences of a workflow

deploy app <app-jar-file> [<app-config>]

Deploys an application, optionally with a serialized configuration string

deploy app <app-jar-file> with config <app-config-file>

Deploys an application, optionally with a configuration file

describe app <app-id> [version <app-version>]

Describes an application with an optional version. If version is not provided, default version '-SNAPSHOT' will be used.

get app <app-id> programs status [of type <program-types>]

Command to get status of one or more programs of an application. By default, gets status of all services and workers. A comma-separated list of program types can be specified, which will get status of all programs of those types. For example, specifying 'service,workflow' will get status of all services and workflows in the application.

get app preferences <app-id>

Gets the preferences of an application

get endpoints service <app-id.service-id> [version <app-version>]

Lists the endpoints that a service exposes

get instance preferences

Gets the preferences of an instance

get mapreduce logs <app-id.mapreduce-id> [<start-time>] [<end-time>]

Gets the logs of a MapReduce program