Adding README to aurora client project
Project: http://git-wip-us.apache.org/repos/asf/airavata/repo Commit: http://git-wip-us.apache.org/repos/asf/airavata/commit/cdbe5c59 Tree: http://git-wip-us.apache.org/repos/asf/airavata/tree/cdbe5c59 Diff: http://git-wip-us.apache.org/repos/asf/airavata/diff/cdbe5c59 Branch: refs/heads/develop Commit: cdbe5c592a2372a9b8eafbf202fb22f6ee1e7871 Parents: 0f781b2 Author: Gourav Shenoy <[email protected]> Authored: Sun Oct 23 13:37:28 2016 -0400 Committer: Shameera Rathnayaka <[email protected]> Committed: Thu Oct 27 17:30:41 2016 -0400 ---------------------------------------------------------------------- modules/cloud/aurora-client/README.md | 49 ++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/airavata/blob/cdbe5c59/modules/cloud/aurora-client/README.md ---------------------------------------------------------------------- diff --git a/modules/cloud/aurora-client/README.md b/modules/cloud/aurora-client/README.md new file mode 100644 index 0000000..70acab9 --- /dev/null +++ b/modules/cloud/aurora-client/README.md @@ -0,0 +1,49 @@ +# Aurora Thrift Client +This project implements a Thrift based Java client for Apache Aurora scheduler, running on a Mesos cluster. This client has been developed with a focus of being integrated with Apache Airavata for job submission & monitoring + +## Requirements + +In order to use this client, you must have the following: + +* A Mesos cluster - running on any public cloud (eg: AWS) + We have written ansible scripts to deploy a Mesos-Marathon cluster on any given cloud infrastructure. + The scripts can be found in the ```modules/cloud/ansible-playbooks``` directory, with necessary steps. + +* Aurora scheduler installed on this Mesos cluster. Follow instructions at: ```http://aurora.apache.org/documentation/latest/operations/installation/``` to install Aurora components in the cluster - including the scheduler, and worker components. + +## Configuration + +Please update the __aurora-scheduler.properties__ file in __src/main/resources__ directory with the following properties: + + ``` + # aurora scheduler host-name + aurora.scheduler.host=mesos-master-1 + + # aurora scheduler port (http) + aurora.scheduler.port=8081 + + # aurora executor name + aurora.executor.name=AuroraExecutor + + # mesos cluster name + mesos.cluster.name=example + ``` + +Default values for some of the parameters are added to the properties file. + +## Operations supported + +Currently the following operations are supported, but more will be added progressively. + +* Submit a job to the Aurora scheduler + Job can be AdHoc(one time) or a Service (long running) + +* Get job details + +* Get pending jobs & reason for why it is pending + +* Kill tasks in a Job, or kill all tasks in a Job + +## Sample Code + +The __AuroraClientSample.java__ contains sample code on how to use the Client. \ No newline at end of file
