CLI Docs¶

skein¶

Define and run YARN applications

usage: skein [--help] [--version] command ...

--help, -h¶: Show this help message then exit

--version¶: Show version then exit

skein application¶

Manage applications

usage: skein application [--help] command ...

--help, -h¶: Show this help message then exit

skein application kill¶

Kill a Skein application

usage: skein application kill [--user USER] [--help] APP_ID

app_id¶: The application id

--user <user>¶: The user to kill the application as. Requires the current user to have permissions to proxy as user. Default is the current user.

--help, -h¶: Show this help message then exit

skein application logs¶

Get the logs from a completed Skein application

usage: skein application logs [--user USER] [--help] APP_ID

app_id¶: The application id

--user <user>¶: The user to get the application logs as. Requires the current user to have permissions to proxy as user. Default is the current user.

--help, -h¶: Show this help message then exit

skein application ls¶

List applications

usage: skein application ls [--all] [--state STATE] [--name NAME]
                            [--queue QUEUE] [--user USER]
                            [--started-begin STARTED_BEGIN]
                            [--started-end STARTED_END]
                            [--finished-begin FINISHED_BEGIN]
                            [--finished-end FINISHED_END] [--help]

--all, -a¶: Show applications in all states (default is only active applications)

--state <state>, -s <state>¶: Select applications with this state. May be repeated to filter on multiple states.

--name <name>¶: Select applications with this name.

--queue <queue>¶: Select applications with this queue.

--user <user>¶: Select applications with this user.

--started-begin <started_begin>¶: Select applications that started after this datetime (inclusive). Accepts several date and time formats (e.g. YYYY-M-D H:M:S or H:M). See the documentation for more information.

--started-end <started_end>¶: Select applications that started before this datetime (inclusive)

--finished-begin <finished_begin>¶: Select applications that finished after this datetime (inclusive)

--finished-end <finished_end>¶: Select applications that finished before this datetime (inclusive)

--help, -h¶: Show this help message then exit

skein application mv¶

Move a Skein application to a different queue

usage: skein application mv [--help] APP_ID QUEUE

app_id¶: The application id

queue¶: The queue to move the application to.

--help, -h¶: Show this help message then exit

skein application shutdown¶

Shutdown a Skein application

usage: skein application shutdown [--status STATUS]
                                  [--diagnostics DIAGNOSTICS] [--help]
                                  APP_ID

app_id¶: The application id. To use in a container inside a skein application, pass in “current”

--status <status>¶: Final Application Status. Default is SUCCEEDED

--diagnostics <diagnostics>¶: The application diagnostic exit message. If not provided, a default will be used.

--help, -h¶: Show this help message then exit

skein application specification¶

Get specification for a running skein application

usage: skein application specification [--help] APP_ID

app_id¶: The application id. To use in a container inside a skein application, pass in “current”

--help, -h¶: Show this help message then exit

skein application status¶

Status of a Skein application

usage: skein application status [--help] APP_ID

app_id¶: The application id

--help, -h¶: Show this help message then exit

skein application submit¶

Submit a Skein Application

usage: skein application submit [--help] spec

spec¶: The specification file

--help, -h¶: Show this help message then exit

skein config¶

Manage configuration

usage: skein config [--help] command ...

--help, -h¶: Show this help message then exit

skein config gencerts¶

Generate security credentials. Creates a self-signed TLS key/certificate pair for securing Skein communication, and writes it to the skein configuration directory (“~.skein/” by default).

usage: skein config gencerts [--force] [--help]

--force, -f¶: Overwrite existing configuration

--help, -h¶: Show this help message then exit

skein container¶

Manage application containers

usage: skein container [--help] command ...

--help, -h¶: Show this help message then exit

skein container kill¶

Kill a container

usage: skein container kill --id CONTAINER_ID [--help] APP_ID

app_id¶: The application id. To use in a container inside a skein application, pass in “current”

--id <container_id>¶: The container id

--help, -h¶: Show this help message then exit

skein container ls¶

List containers

usage: skein container ls [--all] [--service SERVICE] [--state STATE] [--help]
                          APP_ID

app_id¶: The application id. To use in a container inside a skein application, pass in “current”

--all, -a¶: Show all containers (default is only active containers)

--service <service>¶: Filter by container services. May be repeated to select multiple services.

--state <state>¶: Filter by container states. May be repeated to select multiple states.

--help, -h¶: Show this help message then exit

skein container scale¶

Scale a service to a requested number of containers

usage: skein container scale --service SERVICE --number NUMBER [--help] APP_ID

app_id¶: The application id. To use in a container inside a skein application, pass in “current”

--service <service>, -s <service>¶: Service name

--number <number>, -n <number>¶: The requested number of instances

--help, -h¶: Show this help message then exit

skein driver¶

Manage the global driver

usage: skein driver [--help] command ...

--help, -h¶: Show this help message then exit

skein driver address¶

The address of the running driver

usage: skein driver address [--help]

--help, -h¶: Show this help message then exit

skein driver pid¶

The pid of the running driver

usage: skein driver pid [--help]

--help, -h¶: Show this help message then exit

skein driver restart¶

Restart the skein driver

usage: skein driver restart [--keytab PATH] [--principal PRINCIPAL]
                            [--log LOG] [--log-level LOG_LEVEL]
                            [--java-option JAVA_OPTIONS] [--help]

--keytab <path>¶: Path to a keytab file to use when starting the driver. If not provided, the driver will login using the ticket cache instead.

--principal <principal>¶: The principal to use when starting the driver with a keytab.

--log <log>¶: If provided, the driver will write logs here.

--log-level <log_level>¶: The driver log level, default is INFO

--java-option <java_options>¶: Forward a Java option to the driver, can be used multiple times.

--help, -h¶: Show this help message then exit

skein driver start¶

Start the skein driver

usage: skein driver start [--keytab PATH] [--principal PRINCIPAL] [--log LOG]
                          [--log-level LOG_LEVEL] [--java-option JAVA_OPTIONS]
                          [--help]

--keytab <path>¶: Path to a keytab file to use when starting the driver. If not provided, the driver will login using the ticket cache instead.

--principal <principal>¶: The principal to use when starting the driver with a keytab.

--log <log>¶: If provided, the driver will write logs here.

--log-level <log_level>¶: The driver log level, default is INFO

--java-option <java_options>¶: Forward a Java option to the driver, can be used multiple times.

--help, -h¶: Show this help message then exit

skein driver stop¶

Stop the skein driver

usage: skein driver stop [--force] [--help]

--force, -f¶: Stop the process associated with the driver PID, even if unable to verify it corresponds to a skein driver

--help, -h¶: Show this help message then exit

skein kv¶

Manage the key-value store

usage: skein kv [--help] command ...

--help, -h¶: Show this help message then exit

skein kv del¶

Delete a value from the key-value store

usage: skein kv del --key KEY [--help] APP_ID

app_id¶: The application id. To use in a container inside a skein application, pass in “current”

--key <key>¶: The key to delete.

--help, -h¶: Show this help message then exit

skein kv get¶

Get a value from the key-value store

usage: skein kv get --key KEY [--wait] [--help] APP_ID

app_id¶: The application id. To use in a container inside a skein application, pass in “current”

--key <key>¶: The key to get

--wait¶: If true, will block until the key is set

--help, -h¶: Show this help message then exit

skein kv ls¶

List all keys in the key-value store

usage: skein kv ls [--help] APP_ID

app_id¶: The application id. To use in a container inside a skein application, pass in “current”

--help, -h¶: Show this help message then exit

skein kv put¶

Put a value in the key-value store

usage: skein kv put --key KEY [--value VALUE] [--help] APP_ID

app_id¶: The application id. To use in a container inside a skein application, pass in “current”

--key <key>¶: The key to put

--value <value>¶: The value to put. If not provided, will be read from stdin.

--help, -h¶: Show this help message then exit