aurora-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From wfar...@apache.org
Subject git commit: Make README.md more informative.
Date Fri, 17 Oct 2014 17:10:36 GMT
Repository: incubator-aurora
Updated Branches:
  refs/heads/master ffa126d68 -> 6af60de04


Make README.md more informative.

Bugs closed: AURORA-828

Reviewed at https://reviews.apache.org/r/26830/


Project: http://git-wip-us.apache.org/repos/asf/incubator-aurora/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-aurora/commit/6af60de0
Tree: http://git-wip-us.apache.org/repos/asf/incubator-aurora/tree/6af60de0
Diff: http://git-wip-us.apache.org/repos/asf/incubator-aurora/diff/6af60de0

Branch: refs/heads/master
Commit: 6af60de04f0d140202e8737834261c7fe11e145e
Parents: ffa126d
Author: Bill Farner <wfarner@apache.org>
Authored: Fri Oct 17 10:10:20 2014 -0700
Committer: Bill Farner <wfarner@apache.org>
Committed: Fri Oct 17 10:10:20 2014 -0700

----------------------------------------------------------------------
 README.md | 84 +++++++++++++++++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 77 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-aurora/blob/6af60de0/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 984f04b..26bd69b 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,83 @@
-Apache Aurora is a service scheduler that runs on top of Apache Mesos, enabling
-you to run long-running services that take advantage of Apache Mesos'
-scalability, fault-tolerance, and resource isolation. Apache Aurora is
-currently a part of the Apache Incubator.
+Apache Aurora lets you use an [Apache Mesos](http://mesos.apache.org) cluster as a private
cloud.
+It supports running long-running services, cron jobs, and ad-hoc jobs. Aurora is currently
a
+part of the Apache Incubator.
+
+Aurora aims to make it extremely quick and easy to take a built application and run it on
machines
+in a cluster, with an emphasis on reliability. It provides basic operations to manage services
+running in a cluster, such as rolling upgrades.
+
+To very concisely describe Aurora, it is a system that you can instruct to do things like
+_run 100 of these, somewhere, forever_.
+
+- [Features](#features)
+	- [User-facing](#user-facing)
+	- [Under the hood, to help you rest easy](#under-the-hood-to-help-you-rest-easy)
+	- [When to use Aurora](#when-to-use-aurora)
+	- [When to not use Aurora](#when-to-not-use-aurora)
+	- [Companies using Aurora](#companies-using-aurora)
+- [Getting Started](#getting-started)
+- [Getting Help](#getting-help)
+- [Requiremensts](#requiremensts)
+- [How to build](#how-to-build)
+	- [Testing](#testing)
+	- [Compiling the source packages](#compiling-the-source-packages)
+- [License](#license)
+
+## Features
+
+### User-facing
+- Management of long-running services
+- Cron scheduling
+- Resource quotas: provide guaranteed resources for specific applications
+- Rolling job updates, with automatic rollback
+- Multi-user support
+- Sophisticated [DSL](docs/configuration-tutorial.md): supports templating, allowing you
to
+  establish common patterns and avoid redundant configurations
+- [Dedicated machines](docs/deploying-aurora-scheduler.md#dedicated-attribute):
+  for things like stateful services that must always run on the same machines
+- Service registration: [announce](docs/configuration-reference.md#announcer-objects) services
in
+  [ZooKeeper](http://zookeeper.apache.org/) for discovery by clients like
+  [finagle](https://twitter.github.io/finagle).
+- [Scheduling constraints](docs/configuration-reference.md#specifying-scheduling-constraints)
+  to run on specific machines, or to mitigate impact of issues like machine and rack failure
+
+### Under the hood, to help you rest easy
+- Preemption: important services can 'steal' resources when they need it
+- High-availability: resists machine failures and disk failures
+- Scalable: proven to work in data center-sized clusters, with hundreds of users and thousands
of
+  jobs
+- Instrumented: a wealth of information makes it easy to [monitor](docs/monitoring.md) and
debug
+
+### When to use Aurora
+Aurora can take over for most uses of software like monit and chef.  Aurora can manage applications,
+while these tools are still useful to manage Aurora and Mesos themselves.
+
+### When to not use Aurora
+If you have very specific scheduling requirements, or are building a system that looks like
a
+scheduler itself, you may want to explore developing your own
+[framework](http://mesos.apache.org/documentation/latest/app-framework-development-guide).
+
+### Companies using Aurora
+- [Foursquare](https://foursquare.com)
+- [Magine TV](https://magine.com)
+- [Oscar Health](https://www.hioscar.com)
+- [Twitter](https://twitter.com)
+
+Are you using Aurora too?  Let us know, or submit a patch to join the list!
 
 ## Getting Started
-* [Developing Aurora](docs/developing-aurora-scheduler.md)
-* [Deploying Aurora](docs/deploying-aurora-scheduler.md)
+* [Try the tutorial](docs/tutorial.md)
 * [Running a Local Cluster with Vagrant](docs/vagrant.md)
-* More docs coming soon!
+* [Deploying Aurora](docs/deploying-aurora-scheduler.md)
+* [Developing Aurora](docs/developing-aurora-scheduler.md)
+
+## Getting Help
+If you have questions, you can reach out to our mailing list: dev@aurora.incubator.apache.org
+([archive](http://mail-archives.apache.org/mod_mbox/incubator-aurora-dev)).
+We're also often available in IRC: #aurora on
+[irc.freenode.net](http://webchat.freenode.net/?channels=#aurora).
+
+You can also file issues in our [JIRA queue](http://issues.apache.org/jira/browse/AURORA).
 
 ## Requiremensts
 * Python 2.6 or higher


Mime
View raw message