public interface ClusterManager extends JobHistoryService
ClusterManager
to get information about the
cluster, such as the names and management objects of nodes.
End users should not be directly accessing ClusterManager
objects; it is public for implementation purposes only.
Modifier and Type | Method and Description |
---|---|
void |
addContainersToAppMaster(JobInformation jobInfo,
List<ContainerDescriptor> containers)
Add descriptors of containers that are allocated to the application master.
|
String |
allocateMaster(GUID jobGUID)
Allocates the master node for the given job
|
NodeAllocationPlan |
allocateWorkers(GUID jobGUID)
Allocates the worker nodes for the given job
|
void |
clearClasspathCache()
Clears the shared classpath cache
|
void |
deregisterAppMaster(JobInformation jobInfo)
Deregister an external application master.
|
void |
ensureRegistered(NodeDescriptor node)
Adds a node to the cluster registry.
|
void |
failJob(GUID jobGUID)
Manually force job fail
|
List<MasterDescriptor> |
getActiveAppMasters()
Get a list of active (external) application masters.
|
List<JobInformation> |
getAllocatedJobs() |
ClusterPreferences |
getConfiguration()
Get the global cluster configuration (not for a specific node).
|
ClusterPreferences |
getConfiguration(String node)
Requests the configuration for the given node.
|
List<ContainerDescriptor> |
getContainers(MasterDescriptor masterDescriptor)
Get the list of containers allocated to an application master.
|
ExecutorOptions |
getDefaultOptions()
Gets the default options configured for remote fragment
execution.
|
Integer |
getJobStatus(GUID jobGUID)
Get the general run status of the job
-1 - job in progress
0 - job completed normally
1+ - job has errors
|
NodeDescriptor |
getNodeDescriptor(String name)
Gets the node descriptor for the specified node
|
NodeMapping |
getNodes(boolean refresh)
Gets node info for all nodes in the cluster
|
List<MasterDescriptor> |
getPendingAppMasters()
Get a list of pending (external) application masters.
|
List<NodeAllocationRequest> |
getPendingJobs() |
String |
getStatus()
Gets a description of the current status of the node
|
String |
getVersion()
Returns the version number of this ClusterManager instance
|
String |
initializeNodeAllocation(SerializationBridge<NodeAllocationRequest> request) |
void |
killJob(GUID jobGUID)
Administrative job kill
|
InputStream |
openClusterLogFile(LogFileOptions options)
Opens the log file for cluster manager for reading
|
void |
registerAppMaster(MasterDescriptor masterDescriptor)
Register an application master started outside of the context of the cluster manager.
|
void |
rotateClusterLog()
Rotates the cluster manager log
|
void |
rotateNodeLogs()
Rotates all of the node manager logs
|
void |
shutdown()
Requests a shutdown of the cluster.
|
void |
shutdownNode(String node)
Shuts down the given node.
|
jobFinished
String getStatus() throws RMIException
RMIException
ExecutorOptions getDefaultOptions() throws RMIException
RMIException
NodeMapping getNodes(boolean refresh) throws RMIException
refresh
- if true, pings each node to ensure that it only returns live nodesRMIException
NodeDescriptor getNodeDescriptor(String name) throws RMIException
name
- the name of the node requestedRMIException
void ensureRegistered(NodeDescriptor node) throws RMIException
node
- the node informationnodeMgr
- the management object for the nodescratchDir
- the scratch directory associated with this nodeRMIException
void shutdownNode(String node) throws RMIException
node
- the entry to removeDRException
- if the given node is not registeredRMIException
void shutdown() throws RMIException
RMIException
ClusterPreferences getConfiguration(String node) throws RMIException
node
- the node requesting the configurationRMIException
InputStream openClusterLogFile(LogFileOptions options) throws RMIException, IOException
options
- IOException
RMIException
void killJob(GUID jobGUID) throws RMIException
jobGUID
- RMIException
void failJob(GUID jobGUID) throws RMIException
jobGUID
- RMIException
Integer getJobStatus(GUID jobGUID) throws RMIException
jobGUID
- RMIException
void clearClasspathCache() throws RMIException, IOException
IOException
- if unable to delete (would typically happen if job is running). Generally we don't care so much about
cleanup failures, but here we need to let the user know because otherwise case may still be dirty.RMIException
void rotateClusterLog() throws RMIException
RMIException
void rotateNodeLogs() throws RMIException, IOException
RMIException
IOException
- if unable to rotateString getVersion()
String initializeNodeAllocation(SerializationBridge<NodeAllocationRequest> request)
String allocateMaster(GUID jobGUID)
jobInformation
- NodeAllocationPlan allocateWorkers(GUID jobGUID)
jobGUID
- resources
- List<JobInformation> getAllocatedJobs()
List<NodeAllocationRequest> getPendingJobs()
ClusterPreferences getConfiguration() throws RMIException
RMIException
- thrown for communication errorsvoid registerAppMaster(MasterDescriptor masterDescriptor) throws RMIException
masterDescriptor
- descriptor of the application masterRMIException
- thrown for communication errorsvoid addContainersToAppMaster(JobInformation jobInfo, List<ContainerDescriptor> containers) throws RMIException
masterDescriptor
- application mastercontainers
- containers allocated to the application masterRMIException
- thrown for communication errorsvoid deregisterAppMaster(JobInformation jobInfo) throws RMIException
masterDescriptor
- application master to de-listRMIException
- thrown for communication errorsList<MasterDescriptor> getPendingAppMasters() throws RMIException
RMIException
- throw for communication errorsList<MasterDescriptor> getActiveAppMasters() throws RMIException
RMIException
- throw for communication errorsList<ContainerDescriptor> getContainers(MasterDescriptor masterDescriptor) throws RMIException
masterDescriptor
- application masterRMIException
- throws for communication errorsCopyright © 2015 Actian Corporation. All Rights Reserved.