cluster

Type Members

1. case class AppDescription(name: String, appMaster: String, userConfig: UserConfig, clusterConfig: Config = ConfigFactory.empty()) extends Product with Serializable

   

   This contains all information to run an application

   This contains all information to run an application

   name

   The name of this application

   appMaster

   The class name of AppMaster Actor

   userConfig

   user configuration.

   clusterConfig

   User provided cluster config, it overrides gear.conf when starting new applications. In most cases, you should not need to change it. If you do really need to change it, please use ClusterConfigSource(filePath) to construct the object, while filePath points to the .conf file.

2. case class AppJar(name: String, filePath: FilePath) extends Product with Serializable

   

   Jar file container in the cluster

   Jar file container in the cluster

   name

   A meaningful name to represent this jar

   filePath

   Where the jar file is stored.

3. case class AppMasterContext(appId: Int, username: String, resource: Resource, workerInfo: WorkerInfo, appJar: Option[AppJar], masterProxy: ActorRef) extends Product with Serializable

   

   This contains context information when starting an AppMaster

   This contains context information when starting an AppMaster

   appId

   application instance id assigned, it is unique in the cluster

   username

   The username who submitted this application

   resource

   Resouce allocated to start this AppMaster daemon. AppMaster are allowed to request more resource from Master.

   appJar

   application Jar. If the jar is already in classpath, then it can be None.

   masterProxy

   The proxy to master actor, it bridges the messages between appmaster and master

4. trait Application extends AnyRef

   

   Each job, streaming or not streaming, need to provide an Application class.

   Each job, streaming or not streaming, need to provide an Application class. The master uses this class to start AppMaster.

5. abstract class ApplicationMaster extends Actor

   

   Used for verification.

   Used for verification. All AppMaster must extend this interface

6. sealed abstract class ApplicationStatus extends Serializable

   

7. sealed abstract class ApplicationTerminalStatus extends ApplicationStatus

   

8. sealed trait ClusterConfigSource extends Serializable

   

   Data Source of ClusterConfig

   Data Source of ClusterConfig

   Please use ClusterConfigSource.apply(filePath) to construct this object

9. case class ExecutorContext(executorId: Int, worker: WorkerInfo, appId: Int, appName: String, appMaster: ActorRef, resource: Resource) extends Product with Serializable

   

   Serves as the context to start an Executor JVM.

10. case class ExecutorJVMConfig(classPath: Array[String], jvmArguments: Array[String], mainClass: String, arguments: Array[String], jar: Option[AppJar], username: String, executorAkkaConfig: Config = ConfigFactory.empty()) extends Product with Serializable

    

    JVM configurations to start an Executor JVM.

    JVM configurations to start an Executor JVM.

    classPath

    When executor is created by a worker JVM, executor automatically inherits parent worker's classpath. Sometimes, you still want to add some extra classpath, you can do this by specify classPath option.

    jvmArguments

    java arguments like -Dxx=yy

    mainClass

    Executor main class name like org.apache.gearpump.xx.AppMaster

    arguments

    Executor command line arguments

    jar

    application jar

    executorAkkaConfig

    Akka config used to initialize the actor system of this executor. It uses org.apache.gearpump.util.Constants.GEARPUMP_CUSTOM_CONFIG_FILE to pass the config to executor process

11. final class UserConfig extends Serializable

    

    Immutable configuration