org.apache.slider.client

Interface SliderClientAPI

All Superinterfaces:

AutoCloseable, Closeable, org.apache.hadoop.service.Service

All Known Implementing Classes:

Slider, SliderClient

public interface SliderClientAPI
extends org.apache.hadoop.service.Service

Interface of those method calls in the slider API that are intended for direct public invocation.

Stability: evolving

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.service.Service

org.apache.hadoop.service.Service.STATE

Method Summary

Methods

Modifier and Type	Method and Description
int	actionAmSuicide(String clustername, ActionAMSuicideArgs args) AM to commit an asynchronous suicide
int	actionBuild(String clustername, AbstractClusterBuildingActionArgs buildInfo) Build up the cluster specification/directory
int	actionClient(ActionClientArgs clientInfo) Perform client operations such as install or configure
int	actionDependency(ActionDependencyArgs dependencyArgs) Upload all Slider AM and agent dependency libraries to HDFS, so that they do not need to be uploaded with every create call.
int	actionDestroy(String clustername)
int	actionDestroy(String clustername, ActionDestroyArgs destroyArgs) Destroy a cluster.
int	actionDiagnostic(ActionDiagnosticArgs diagnosticArgs) diagnostic operation
String	actionEcho(String name, ActionEchoArgs args) Echo operation (not currently wired up to command line)
int	actionExists(String name, boolean checkLive) Test for a cluster existing probe for a cluster of the given name existing in the filesystem.
int	actionFlex(String name, ActionFlexArgs args) Implement the islive action: probe for a cluster of the given name existing
int	actionFreeze(String clustername, ActionFreezeArgs freezeArgs) Stop the cluster
int	actionInstallKeytab(ActionInstallKeytabArgs installKeytabInfo) Deprecated. use #actionKeytab
int	actionInstallPkg(ActionInstallPackageArgs installPkgInfo) Upload application package to user home directory
int	actionKeytab(ActionKeytabArgs keytabInfo) Deprecated. use #actionKeytab
int	actionKillContainer(String name, ActionKillContainerArgs args) Kill a specific container of the cluster
int	actionList(String clustername, ActionListArgs args) Implement the list action: list all nodes
int	actionPackage(ActionPackageArgs pkgInfo) Managing slider application package
int	actionRegistry(ActionRegistryArgs registryArgs) Registry operation
int	actionResolve(ActionResolveArgs args) Registry operation
int	actionStatus(String clustername, ActionStatusArgs statusArgs) Status operation
int	actionThaw(String clustername, ActionThawArgs thaw) Restore a cluster
int	actionUpdate(String clustername, AbstractClusterBuildingActionArgs buildInfo) Update the cluster specification
int	actionUpgrade(String clustername, ActionUpgradeArgs buildInfo) Upgrade the cluster with a newer version of the application
int	actionVersion() Version Details
AbstractClientProvider	createClientProvider(String provider) Get the provider for this cluster
Map<String,SliderInstanceDescription>	enumSliderInstances(boolean listOnlyInState, org.apache.hadoop.yarn.api.records.YarnApplicationState minAppState, org.apache.hadoop.yarn.api.records.YarnApplicationState maxAppState) Enumerate slider instances for the current user, and the most recent app report, where available.
boolean	forceKillApplication(String reason) Kill the submitted application via YARN
org.apache.hadoop.yarn.api.records.ApplicationReport	getApplicationReport() Get the report of a this application
org.apache.hadoop.registry.client.api.RegistryOperations	getRegistryOperations() Get the registry binding.
NodeInformationList	listYarnClusterNodes(ActionNodesArgs args) List the nodes

Methods inherited from interface org.apache.hadoop.service.Service

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, registerServiceListener, start, stop, unregisterServiceListener, waitForServiceToStop

Method Detail

actionDestroy

int actionDestroy(String clustername,
                ActionDestroyArgs destroyArgs)
                  throws org.apache.hadoop.yarn.exceptions.YarnException,
                         IOException

Destroy a cluster. There's two race conditions here #1 the cluster is started between verifying that there are no live clusters of that name.

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

actionDestroy

int actionDestroy(String clustername)
                  throws org.apache.hadoop.yarn.exceptions.YarnException,
                         IOException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

actionAmSuicide

int actionAmSuicide(String clustername,
                  ActionAMSuicideArgs args)
                    throws org.apache.hadoop.yarn.exceptions.YarnException,
                           IOException

AM to commit an asynchronous suicide

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

createClientProvider

AbstractClientProvider createClientProvider(String provider)
                                            throws SliderException

Get the provider for this cluster

Parameters:

provider - the name of the provider

Returns:

the provider instance

Throws:

SliderException - problems building the provider

actionBuild

int actionBuild(String clustername,
              AbstractClusterBuildingActionArgs buildInfo)
                throws org.apache.hadoop.yarn.exceptions.YarnException,
                       IOException

Build up the cluster specification/directory

Parameters:

clustername - cluster name

buildInfo - the arguments needed to build the cluster

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - Yarn problems

IOException - other problems

BadCommandArgumentsException - bad arguments.

actionInstallKeytab

int actionInstallKeytab(ActionInstallKeytabArgs installKeytabInfo)
                        throws org.apache.hadoop.yarn.exceptions.YarnException,
                               IOException

Deprecated. use #actionKeytab

Upload keytab to a designated sub-directory of the user home directory

Parameters:

installKeytabInfo - the arguments needed to upload the keytab

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - Yarn problems

IOException - other problems

BadCommandArgumentsException - bad arguments.

actionKeytab

int actionKeytab(ActionKeytabArgs keytabInfo)
                 throws org.apache.hadoop.yarn.exceptions.YarnException,
                        IOException

Deprecated. use #actionKeytab

Manage keytabs leveraged by slider

Parameters:

keytabInfo - the arguments needed to manage the keytab

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - Yarn problems

IOException - other problems

BadCommandArgumentsException - bad arguments.

actionInstallPkg

int actionInstallPkg(ActionInstallPackageArgs installPkgInfo)
                     throws org.apache.hadoop.yarn.exceptions.YarnException,
                            IOException

Upload application package to user home directory

Parameters:

installPkgInfo - the arguments needed to upload the package

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - Yarn problems

IOException - other problems

BadCommandArgumentsException - bad arguments.

actionClient

int actionClient(ActionClientArgs clientInfo)
                 throws IOException,
                        org.apache.hadoop.yarn.exceptions.YarnException

Perform client operations such as install or configure

Parameters:

clientInfo - the arguments needed for client operations

Throws:

SliderException - bad arguments.

IOException - problems related to package and destination folders

org.apache.hadoop.yarn.exceptions.YarnException

actionPackage

int actionPackage(ActionPackageArgs pkgInfo)
                  throws org.apache.hadoop.yarn.exceptions.YarnException,
                         IOException

Managing slider application package

Parameters:

pkgInfo - the arguments needed to upload, delete or list the package

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - Yarn problems

IOException - other problems

BadCommandArgumentsException - bad arguments.

actionUpdate

int actionUpdate(String clustername,
               AbstractClusterBuildingActionArgs buildInfo)
                 throws org.apache.hadoop.yarn.exceptions.YarnException,
                        IOException

Update the cluster specification

Parameters:

clustername - cluster name

buildInfo - the arguments needed to update the cluster

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - Yarn problems

IOException - other problems

actionUpgrade

int actionUpgrade(String clustername,
                ActionUpgradeArgs buildInfo)
                  throws org.apache.hadoop.yarn.exceptions.YarnException,
                         IOException

Upgrade the cluster with a newer version of the application

Parameters:

clustername - cluster name

buildInfo - the arguments needed to upgrade the cluster

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - Yarn problems

IOException - other problems

getApplicationReport

org.apache.hadoop.yarn.api.records.ApplicationReport getApplicationReport()
                                                                          throws IOException,
                                                                                 org.apache.hadoop.yarn.exceptions.YarnException

Get the report of a this application

Returns:

the app report or null if it could not be found.

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

forceKillApplication

boolean forceKillApplication(String reason)
                             throws org.apache.hadoop.yarn.exceptions.YarnException,
                                    IOException

Kill the submitted application via YARN

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

actionList

int actionList(String clustername,
             ActionListArgs args)
               throws IOException,
                      org.apache.hadoop.yarn.exceptions.YarnException

Implement the list action: list all nodes

Returns:

exit code of 0 if a list was created

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

enumSliderInstances

Map<String,SliderInstanceDescription> enumSliderInstances(boolean listOnlyInState,
                                                        org.apache.hadoop.yarn.api.records.YarnApplicationState minAppState,
                                                        org.apache.hadoop.yarn.api.records.YarnApplicationState maxAppState)
                                                          throws IOException,
                                                                 org.apache.hadoop.yarn.exceptions.YarnException

Enumerate slider instances for the current user, and the most recent app report, where available.

Parameters:

listOnlyInState - boolean to indicate that the instances should only include those in a YARN state minAppState <= currentState <= maxAppState

minAppState - minimum application state to include in enumeration.

maxAppState - maximum application state to include

Returns:

a map of application instance name to description

Throws:

IOException - Any IO problem

org.apache.hadoop.yarn.exceptions.YarnException - YARN problems

actionFlex

int actionFlex(String name,
             ActionFlexArgs args)
               throws org.apache.hadoop.yarn.exceptions.YarnException,
                      IOException

Implement the islive action: probe for a cluster of the given name existing

Returns:

exit code

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

actionExists

int actionExists(String name,
               boolean checkLive)
                 throws org.apache.hadoop.yarn.exceptions.YarnException,
                        IOException

Test for a cluster existing probe for a cluster of the given name existing in the filesystem. If the live param is set, it must be a live cluster

Returns:

exit code

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

actionKillContainer

int actionKillContainer(String name,
                      ActionKillContainerArgs args)
                        throws org.apache.hadoop.yarn.exceptions.YarnException,
                               IOException

Kill a specific container of the cluster

Parameters:

name - cluster name

args - arguments

Returns:

exit code

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

actionEcho

String actionEcho(String name,
                ActionEchoArgs args)
                  throws org.apache.hadoop.yarn.exceptions.YarnException,
                         IOException

Echo operation (not currently wired up to command line)

Parameters:

name - cluster name

args - arguments

Returns:

the echoed text

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

actionStatus

int actionStatus(String clustername,
               ActionStatusArgs statusArgs)
                 throws org.apache.hadoop.yarn.exceptions.YarnException,
                        IOException

Status operation

Parameters:

clustername - cluster name

statusArgs - status arguments

Returns:

0 -for success, else an exception is thrown

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

actionVersion

int actionVersion()

Version Details

Returns:

exit code

actionFreeze

int actionFreeze(String clustername,
               ActionFreezeArgs freezeArgs)
                 throws org.apache.hadoop.yarn.exceptions.YarnException,
                        IOException

Stop the cluster

Parameters:

clustername - cluster name

freezeArgs - arguments to the stop

Returns:

EXIT_SUCCESS if the cluster was not running by the end of the operation

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

actionThaw

int actionThaw(String clustername,
             ActionThawArgs thaw)
               throws org.apache.hadoop.yarn.exceptions.YarnException,
                      IOException

Restore a cluster

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

actionResolve

int actionResolve(ActionResolveArgs args)
                  throws org.apache.hadoop.yarn.exceptions.YarnException,
                         IOException

Registry operation

Parameters:

args - registry Arguments

Returns:

0 for success, -1 for some issues that aren't errors, just failures to retrieve information (e.g. no configurations for that entry)

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - YARN problems

IOException - Network or other problems

actionRegistry

int actionRegistry(ActionRegistryArgs registryArgs)
                   throws org.apache.hadoop.yarn.exceptions.YarnException,
                          IOException

Registry operation

Parameters:

registryArgs - registry Arguments

Returns:

0 for success, -1 for some issues that aren't errors, just failures to retrieve information (e.g. no configurations for that entry)

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - YARN problems

IOException - Network or other problems

actionDiagnostic

int actionDiagnostic(ActionDiagnosticArgs diagnosticArgs)

diagnostic operation

Parameters:

diagnosticArgs - diagnostic Arguments

Returns:

0 for success, -1 for some issues that aren't errors, just failures to retrieve information (e.g. no application name specified)

Throws:

org.apache.hadoop.yarn.exceptions.YarnException - YARN problems

IOException - Network or other problems

getRegistryOperations

org.apache.hadoop.registry.client.api.RegistryOperations getRegistryOperations()
                                                                               throws SliderException,
                                                                                      IOException

Get the registry binding. As this may start the registry, it can take time and fail

Returns:

the registry

Throws:

SliderException

IOException

actionDependency

int actionDependency(ActionDependencyArgs dependencyArgs)
                     throws IOException,
                            org.apache.hadoop.yarn.exceptions.YarnException

Upload all Slider AM and agent dependency libraries to HDFS, so that they do not need to be uploaded with every create call. This operation is Slider version specific. So it needs to be invoked for every single version of slider/slider-client.

Throws:

SliderException

IOException

org.apache.hadoop.yarn.exceptions.YarnException

listYarnClusterNodes

NodeInformationList listYarnClusterNodes(ActionNodesArgs args)
                                         throws org.apache.hadoop.yarn.exceptions.YarnException,
                                                IOException

List the nodes

Parameters:

args -

Returns:

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException