Package org.apache.hadoop.yarn.service.client

Class ServiceClient

java.lang.Object

org.apache.hadoop.service.AbstractService

org.apache.hadoop.service.CompositeService

org.apache.hadoop.yarn.client.api.AppAdminClient

org.apache.hadoop.yarn.service.client.ServiceClient

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.hadoop.service.Service, SliderExitCodes, YarnServiceConstants, LauncherExitCodes

@Public
@Unstable
public class ServiceClient
extends org.apache.hadoop.yarn.client.api.AppAdminClient
implements SliderExitCodes, YarnServiceConstants

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.service.CompositeService

org.apache.hadoop.service.CompositeService.CompositeServiceShutdownHook

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

org.apache.hadoop.service.Service.STATE

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.hadoop.yarn.client.api.YarnClient	yarnClient

Fields inherited from class org.apache.hadoop.yarn.client.api.AppAdminClient

DEFAULT_CLASS_NAME, DEFAULT_TYPE, UNIT_TEST_CLASS_NAME, UNIT_TEST_TYPE, YARN_APP_ADMIN_CLIENT_PREFIX

Fields inherited from class org.apache.hadoop.service.CompositeService

STOP_ONLY_STARTED_SERVICES

Fields inherited from interface org.apache.hadoop.yarn.service.exceptions.LauncherExitCodes

EXIT_CLIENT_INITIATED_SHUTDOWN, EXIT_COMMAND_ARGUMENT_ERROR, EXIT_CONFLICT, EXIT_CONNECTIVITY_PROBLEM, EXIT_EXCEPTION_THROWN, EXIT_FALSE, EXIT_FORBIDDEN, EXIT_FOUND, EXIT_INTERNAL_ERROR, EXIT_INTERRUPTED, EXIT_MOVED, EXIT_NOT_ACCEPTABLE, EXIT_NOT_FOUND, EXIT_NOT_MODIFIED, EXIT_OPERATION_NOT_ALLOWED, EXIT_OTHER_FAILURE, EXIT_SERVICE_UNAVAILABLE, EXIT_SUCCESS, EXIT_TASK_LAUNCH_FAILURE, EXIT_UNAUTHORIZED, EXIT_UNIMPLEMENTED, EXIT_UNSUPPORTED_VERSION, EXIT_USAGE

Fields inherited from interface org.apache.hadoop.yarn.service.conf.SliderExitCodes

_EXIT_CODE_BASE, EXIT_APPLICATION_IN_USE, EXIT_BAD_CONFIGURATION, EXIT_BAD_STATE, EXIT_DEPLOYMENT_FAILED, EXIT_INSTANCE_EXISTS, EXIT_PROCESS_FAILED, EXIT_TIMED_OUT, EXIT_UNKNOWN_INSTANCE, EXIT_YARN_SERVICE_FAILED, EXIT_YARN_SERVICE_FINISHED_WITH_ERROR, EXIT_YARN_SERVICE_KILLED

Fields inherited from interface org.apache.hadoop.yarn.service.conf.YarnServiceConstants

APP_CONF_DIR, APP_LIB_DIR, APP_RESOURCES_DIR, APP_TYPE, CONTAINER_STATE_REPORT_AS_SERVICE_STATE, CONTENT, DEPENDENCY_DIR, DEPENDENCY_DIR_PERMISSIONS, DEPENDENCY_LOCALIZED_DIR_LINK, DEPENDENCY_TAR_GZ_FILE_EXT, DEPENDENCY_TAR_GZ_FILE_NAME, ERR_FILE, HADOOP_USER_NAME, KEYTAB_DIR, KEYTAB_LOCATION, OUT_FILE, PRINCIPAL, PROPERTY_LIB_DIR, RESOURCE_DIR, SERVICE_BASE_DIRECTORY, SERVICE_CORE_JAR, SERVICES_DIRECTORY, SERVICES_PUBLIC_DIRECTORY, STDERR_AM, STDOUT_AM, SUBMITTED_CONF_DIR, SYSPROP_LOG_DIR, SYSPROP_LOG4J_CONFIGURATION, TMP_DIR_PREFIX, UPGRADE_DIR, YARN_SERVICE_LOG4J_FILENAME

Constructor Summary

Constructors

Constructor	Description
ServiceClient()

Method Summary

Modifier and Type	Method	Description
int	actionBuild(Service service)
int	actionCancelUpgrade(String appName)
int	actionCleanUp(String appName, String userName)
org.apache.hadoop.yarn.api.records.ApplicationId	actionCreate(Service service)
int	actionDecommissionInstances(String appName, List<String> componentInstances)
int	actionDependency(String destinationFolder, boolean overwrite)
int	actionDestroy(String serviceName)
int	actionFlex(String serviceName, Map<String,String> componentCountStrings)
int	actionLaunch(String fileName, String serviceName, Long lifetime, String queue)
int	actionSave(String fileName, String serviceName, Long lifetime, String queue)
int	actionStart(String serviceName)
org.apache.hadoop.yarn.api.records.ApplicationId	actionStartAndGetId(String serviceName)
int	actionStop(String serviceName)
int	actionStop(String serviceName, boolean waitForAppStopped)
int	actionUpgrade(Service service, List<Container> compInstances)
int	actionUpgradeComponents(String appName, List<String> components)
int	actionUpgradeExpress(String appName, File path)
int	actionUpgradeExpress(Service service)
int	actionUpgradeInstances(String appName, List<String> componentInstances)
protected Map<String,String>	addAMEnv()
protected org.apache.hadoop.fs.Path	addJarResource(String serviceName, Map<String,org.apache.hadoop.yarn.api.records.LocalResource> localResources)
static File	compressFiles(Collection<File> files, File output, String bundleRoot)	Compress (tar) the input files to the output file.
ServiceState	convertState(org.apache.hadoop.yarn.api.records.YarnApplicationState state)
protected org.apache.hadoop.yarn.service.ClientAMProtocol	createAMProxy(String serviceName, org.apache.hadoop.yarn.api.records.ApplicationReport appReport)
int	enableFastLaunch(String destinationFolder)
Map<String,Long>	flexByRestService(String serviceName, Map<String,Long> componentCounts)
org.apache.hadoop.yarn.api.records.ApplicationId	getAppId(String serviceName)
ComponentContainers[]	getContainers(String appName, List<String> components, String version, List<ContainerState> containerStates)
String	getInstances(String appName, List<String> components, String version, List<String> containerStates)
Service	getStatus(String serviceName)
String	getStatusString(String appIdOrName)
org.apache.hadoop.yarn.client.api.YarnClient	getYarnClient()
int	initiateUpgrade(String appName, String fileName, boolean autoFinalize)
int	initiateUpgrade(Service service)
Service	loadAppJsonFromLocalFS(String fileName, String serviceName, Long lifetime, String queue)
protected void	serviceInit(org.apache.hadoop.conf.Configuration configuration)
protected void	serviceStop()
String	updateLifetime(String serviceName, long lifetime)

Methods inherited from class org.apache.hadoop.yarn.client.api.AppAdminClient

createAppAdminClient

Methods inherited from class org.apache.hadoop.service.CompositeService

addIfService, addService, getServices, removeService, serviceStart

Methods inherited from class org.apache.hadoop.service.AbstractService

close, getBlockers, getConfig, getFailureCause, getFailureState, getLifecycleHistory, getName, getServiceState, getStartTime, init, isInState, noteFailure, putBlocker, registerGlobalListener, registerServiceListener, removeBlocker, setConfig, start, stop, toString, unregisterGlobalListener, unregisterServiceListener, waitForServiceToStop

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

yarnClient

protected org.apache.hadoop.yarn.client.api.YarnClient yarnClient

Constructor Details

ServiceClient

public ServiceClient()

Method Details

serviceInit

protected void serviceInit(org.apache.hadoop.conf.Configuration configuration)
                    throws Exception

Overrides:

serviceInit in class org.apache.hadoop.service.CompositeService

Throws:

Exception

serviceStop

protected void serviceStop()
                    throws Exception

Overrides:

serviceStop in class org.apache.hadoop.service.CompositeService

Throws:

Exception

loadAppJsonFromLocalFS

public Service loadAppJsonFromLocalFS(String fileName,
 String serviceName,
 Long lifetime,
 String queue)
                               throws IOException,
org.apache.hadoop.yarn.exceptions.YarnException

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

actionSave

public int actionSave(String fileName,
 String serviceName,
 Long lifetime,
 String queue)
               throws IOException,
org.apache.hadoop.yarn.exceptions.YarnException

Specified by:

actionSave in class org.apache.hadoop.yarn.client.api.AppAdminClient

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

actionBuild

public int actionBuild(Service service)
                throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

actionUpgradeExpress

public int actionUpgradeExpress(String appName,
 File path)
                         throws IOException,
org.apache.hadoop.yarn.exceptions.YarnException

Specified by:

actionUpgradeExpress in class org.apache.hadoop.yarn.client.api.AppAdminClient

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

actionUpgradeExpress

public int actionUpgradeExpress(Service service)
                         throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

initiateUpgrade

public int initiateUpgrade(String appName,
 String fileName,
 boolean autoFinalize)
                    throws IOException,
org.apache.hadoop.yarn.exceptions.YarnException

Specified by:

initiateUpgrade in class org.apache.hadoop.yarn.client.api.AppAdminClient

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

initiateUpgrade

public int initiateUpgrade(Service service)
                    throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

actionUpgradeInstances

public int actionUpgradeInstances(String appName,
 List<String> componentInstances)
                           throws IOException,
org.apache.hadoop.yarn.exceptions.YarnException

Specified by:

actionUpgradeInstances in class org.apache.hadoop.yarn.client.api.AppAdminClient

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

actionUpgradeComponents

public int actionUpgradeComponents(String appName,
 List<String> components)
                            throws IOException,
org.apache.hadoop.yarn.exceptions.YarnException

Specified by:

actionUpgradeComponents in class org.apache.hadoop.yarn.client.api.AppAdminClient

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

actionCancelUpgrade

public int actionCancelUpgrade(String appName)
                        throws IOException,
org.apache.hadoop.yarn.exceptions.YarnException

Specified by:

actionCancelUpgrade in class org.apache.hadoop.yarn.client.api.AppAdminClient

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

actionDecommissionInstances

public int actionDecommissionInstances(String appName,
 List<String> componentInstances)
                                throws IOException,
org.apache.hadoop.yarn.exceptions.YarnException

Specified by:

actionDecommissionInstances in class org.apache.hadoop.yarn.client.api.AppAdminClient

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

actionCleanUp

public int actionCleanUp(String appName,
 String userName)
                  throws IOException,
org.apache.hadoop.yarn.exceptions.YarnException

Specified by:

actionCleanUp in class org.apache.hadoop.yarn.client.api.AppAdminClient

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

getInstances

public String getInstances(String appName,
 List<String> components,
 String version,
 List<String> containerStates)
                    throws IOException,
org.apache.hadoop.yarn.exceptions.YarnException

Specified by:

getInstances in class org.apache.hadoop.yarn.client.api.AppAdminClient

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

getContainers

public ComponentContainers[] getContainers(String appName,
 List<String> components,
 String version,
 List<ContainerState> containerStates)
                                    throws IOException,
org.apache.hadoop.yarn.exceptions.YarnException

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

actionUpgrade

public int actionUpgrade(Service service,
 List<Container> compInstances)
                  throws IOException,
org.apache.hadoop.yarn.exceptions.YarnException

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

actionLaunch

public int actionLaunch(String fileName,
 String serviceName,
 Long lifetime,
 String queue)
                 throws IOException,
org.apache.hadoop.yarn.exceptions.YarnException

Specified by:

actionLaunch in class org.apache.hadoop.yarn.client.api.AppAdminClient

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

actionCreate

public org.apache.hadoop.yarn.api.records.ApplicationId actionCreate(Service service)
                                                              throws IOException,
org.apache.hadoop.yarn.exceptions.YarnException

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

actionFlex

public int actionFlex(String serviceName,
 Map<String,String> componentCountStrings)
               throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

Specified by:

actionFlex in class org.apache.hadoop.yarn.client.api.AppAdminClient

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

flexByRestService

public Map<String,Long> flexByRestService(String serviceName,
 Map<String,Long> componentCounts)
                                   throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

actionStop

public int actionStop(String serviceName)
               throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

Specified by:

actionStop in class org.apache.hadoop.yarn.client.api.AppAdminClient

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

actionStop

public int actionStop(String serviceName,
 boolean waitForAppStopped)
               throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

actionDestroy

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

Specified by:

actionDestroy in class org.apache.hadoop.yarn.client.api.AppAdminClient

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

compressFiles

public static File compressFiles(Collection<File> files,
 File output,
 String bundleRoot)
                          throws IOException

Compress (tar) the input files to the output file.

Parameters:

files - The files to compress

output - The resulting output file (should end in .tar.gz)

bundleRoot -

Throws:

IOException

addAMEnv

@VisibleForTesting
protected Map<String,String> addAMEnv()
                               throws IOException

Throws:

IOException

addJarResource

protected org.apache.hadoop.fs.Path addJarResource(String serviceName,
 Map<String,org.apache.hadoop.yarn.api.records.LocalResource> localResources)
                                            throws IOException,
org.apache.hadoop.yarn.exceptions.YarnException

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

actionStart

public int actionStart(String serviceName)
                throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

Specified by:

actionStart in class org.apache.hadoop.yarn.client.api.AppAdminClient

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

actionStartAndGetId

public org.apache.hadoop.yarn.api.records.ApplicationId actionStartAndGetId(String serviceName)
                                                                     throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

updateLifetime

public String updateLifetime(String serviceName,
 long lifetime)
                      throws org.apache.hadoop.yarn.exceptions.YarnException,
IOException

Throws:

org.apache.hadoop.yarn.exceptions.YarnException

IOException

convertState

public ServiceState convertState(org.apache.hadoop.yarn.api.records.YarnApplicationState state)

getStatusString

public String getStatusString(String appIdOrName)
                       throws IOException,
org.apache.hadoop.yarn.exceptions.YarnException

Specified by:

getStatusString in class org.apache.hadoop.yarn.client.api.AppAdminClient

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

getStatus

public Service getStatus(String serviceName)
                  throws IOException,
org.apache.hadoop.yarn.exceptions.YarnException

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

getYarnClient

public org.apache.hadoop.yarn.client.api.YarnClient getYarnClient()

enableFastLaunch

public int enableFastLaunch(String destinationFolder)
                     throws IOException,
org.apache.hadoop.yarn.exceptions.YarnException

Specified by:

enableFastLaunch in class org.apache.hadoop.yarn.client.api.AppAdminClient

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

actionDependency

public int actionDependency(String destinationFolder,
 boolean overwrite)

createAMProxy

protected org.apache.hadoop.yarn.service.ClientAMProtocol createAMProxy(String serviceName,
 org.apache.hadoop.yarn.api.records.ApplicationReport appReport)
                                                                 throws IOException,
org.apache.hadoop.yarn.exceptions.YarnException

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException

getAppId

public org.apache.hadoop.yarn.api.records.ApplicationId getAppId(String serviceName)
                                                          throws IOException,
org.apache.hadoop.yarn.exceptions.YarnException

Throws:

IOException

org.apache.hadoop.yarn.exceptions.YarnException