org.apache.slider.providers

Interface ProviderService

All Superinterfaces:

AutoCloseable, Closeable, ExitCodeProvider, ProviderCore, RMOperationHandlerActions, org.apache.hadoop.service.Service

All Known Implementing Classes:

AbstractProviderService, AgentProviderService, SliderAMProviderService

public interface ProviderService
extends ProviderCore, org.apache.hadoop.service.Service, RMOperationHandlerActions, ExitCodeProvider

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
void	applyInitialRegistryDefinitions(URL amWebURI, URL agentOpsURI, URL agentStatusURI, org.apache.hadoop.registry.client.types.ServiceRecord serviceRecord) Prior to going live -register the initial service registry data
void	bind(StateAccessForProviders stateAccessor, QueueAccess queueAccess, List<org.apache.hadoop.yarn.api.records.Container> liveContainers)
void	bindToYarnRegistry(YarnRegistryViewForProviders yarnRegistry) Bind to the YARN registry
void	buildContainerLaunchContext(ContainerLauncher containerLauncher, AggregateConf instanceDefinition, org.apache.hadoop.yarn.api.records.Container container, String role, SliderFileSystem sliderFileSystem, org.apache.hadoop.fs.Path generatedConfPath, MapOperations resourceComponent, MapOperations appComponent, org.apache.hadoop.fs.Path containerTmpDirPath) Set up the entire container launch context
void	buildEndpointDetails(Map<String,String> details) Build up the endpoint details for this service
Map<String,String>	buildMonitorDetails(ClusterDescription clusterSpec) Build a map of data intended for the AM webapp that is specific about this provider.
Map<String,String>	buildProviderStatus()
ContainerReleaseSelector	createContainerReleaseSelector() Create the container release selector for this provider...any policy can be implemented
boolean	exec(AggregateConf instanceDefinition, File confDir, Map<String,String> env, ProviderCompleted execInProgress) Execute a process in the AM
AgentRestOperations	getAgentRestOperations() Returns the agent rest operations interface.
String	getHumanName() Get a human friendly name for web UIs and messages
void	initializeApplicationConfiguration(AggregateConf instanceDefinition, SliderFileSystem fileSystem) The application configuration should be initialized here
boolean	isSupportedRole(String role) Scan through the roles and see if it is supported.
org.apache.hadoop.conf.Configuration	loadProviderConfigurationInformation(File confDir) Load a specific XML configuration file for the provider config
void	notifyContainerCompleted(org.apache.hadoop.yarn.api.records.ContainerId containerId) Notify the providers of container completion
void	rebuildContainerDetails(List<org.apache.hadoop.yarn.api.records.Container> liveContainers, String applicationId, Map<Integer,ProviderRole> providerRoles) On AM restart (for whatever reason) this API is required to rebuild the AM internal state with the containers which were already assigned and running
void	validateApplicationConfiguration(AggregateConf instanceDefinition, File confDir, boolean secure) This is a validation of the application configuration on the AM.

Methods inherited from interface org.apache.slider.providers.ProviderCore

getConf, getName, getRoles, validateInstanceDefinition

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

Methods inherited from interface org.apache.slider.server.appmaster.operations.RMOperationHandlerActions

addContainerRequest, cancelContainerRequests, cancelSingleRequest, execute, releaseAssignedContainer

Methods inherited from interface org.apache.slider.core.main.ExitCodeProvider

getExitCode

Method Detail

buildContainerLaunchContext

void buildContainerLaunchContext(ContainerLauncher containerLauncher,
                               AggregateConf instanceDefinition,
                               org.apache.hadoop.yarn.api.records.Container container,
                               String role,
                               SliderFileSystem sliderFileSystem,
                               org.apache.hadoop.fs.Path generatedConfPath,
                               MapOperations resourceComponent,
                               MapOperations appComponent,
                               org.apache.hadoop.fs.Path containerTmpDirPath)
                                 throws IOException,
                                        SliderException

Set up the entire container launch context

Parameters:

containerLauncher -

instanceDefinition -

container -

role -

sliderFileSystem -

generatedConfPath -

appComponent -

containerTmpDirPath -

Throws:

IOException

SliderException

notifyContainerCompleted

void notifyContainerCompleted(org.apache.hadoop.yarn.api.records.ContainerId containerId)

Notify the providers of container completion

Parameters:

containerId - container that has completed

exec

boolean exec(AggregateConf instanceDefinition,
           File confDir,
           Map<String,String> env,
           ProviderCompleted execInProgress)
             throws IOException,
                    SliderException

Execute a process in the AM

Parameters:

instanceDefinition - cluster description

confDir - configuration directory

env - environment

execInProgress - the callback for the exec events

Returns:

true if a process was actually started

Throws:

IOException

SliderException

isSupportedRole

boolean isSupportedRole(String role)

Scan through the roles and see if it is supported.

Parameters:

role - role to look for

Returns:

true if the role is known about -and therefore that a launcher thread can be deployed to launch it

loadProviderConfigurationInformation

org.apache.hadoop.conf.Configuration loadProviderConfigurationInformation(File confDir)
                                                                          throws BadCommandArgumentsException,
                                                                                 IOException

Load a specific XML configuration file for the provider config

Parameters:

confDir - configuration directory

Returns:

a configuration to be included in status

Throws:

BadCommandArgumentsException

IOException

initializeApplicationConfiguration

void initializeApplicationConfiguration(AggregateConf instanceDefinition,
                                      SliderFileSystem fileSystem)
                                        throws IOException,
                                               SliderException

The application configuration should be initialized here

Parameters:

instanceDefinition -

fileSystem -

Throws:

IOException

SliderException

validateApplicationConfiguration

void validateApplicationConfiguration(AggregateConf instanceDefinition,
                                    File confDir,
                                    boolean secure)
                                      throws IOException,
                                             SliderException

This is a validation of the application configuration on the AM. Here is where things like the existence of keytabs and other not-seen-client-side properties can be tested, before the actual process is spawned.

Parameters:

instanceDefinition - clusterSpecification

confDir - configuration directory

secure - flag to indicate that secure mode checks must exist

Throws:

IOException - IO problemsn

SliderException - any failure

buildProviderStatus

Map<String,String> buildProviderStatus()

buildMonitorDetails

Map<String,String> buildMonitorDetails(ClusterDescription clusterSpec)

Build a map of data intended for the AM webapp that is specific about this provider. The key is some text to be displayed, and the value can be a URL that will create an anchor over the key text. If no anchor is needed/desired, insert the key with a null value.

Returns:

the details

getHumanName

String getHumanName()

Get a human friendly name for web UIs and messages

Returns:

a name string. Default is simply the service instance name.

bind

void bind(StateAccessForProviders stateAccessor,
        QueueAccess queueAccess,
        List<org.apache.hadoop.yarn.api.records.Container> liveContainers)

bindToYarnRegistry

void bindToYarnRegistry(YarnRegistryViewForProviders yarnRegistry)

Bind to the YARN registry

Parameters:

yarnRegistry - YARN registry

getAgentRestOperations

AgentRestOperations getAgentRestOperations()

Returns the agent rest operations interface.

Returns:

the interface if available, null otherwise.

buildEndpointDetails

void buildEndpointDetails(Map<String,String> details)

Build up the endpoint details for this service

Parameters:

details -

applyInitialRegistryDefinitions

void applyInitialRegistryDefinitions(URL amWebURI,
                                   URL agentOpsURI,
                                   URL agentStatusURI,
                                   org.apache.hadoop.registry.client.types.ServiceRecord serviceRecord)
                                     throws IOException

Prior to going live -register the initial service registry data

Parameters:

amWebURI - URL to the AM. This may be proxied, so use relative paths

agentOpsURI - URI for agent operations. This will not be proxied

agentStatusURI - URI For agent status. Again: no proxy

serviceRecord - service record to build up

Throws:

IOException

createContainerReleaseSelector

ContainerReleaseSelector createContainerReleaseSelector()

Create the container release selector for this provider...any policy can be implemented

Returns:

the selector to use for choosing containers.

rebuildContainerDetails

void rebuildContainerDetails(List<org.apache.hadoop.yarn.api.records.Container> liveContainers,
                           String applicationId,
                           Map<Integer,ProviderRole> providerRoles)

On AM restart (for whatever reason) this API is required to rebuild the AM internal state with the containers which were already assigned and running

Parameters:

liveContainers -

applicationId -

providerRoles -