aurora-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From wfar...@apache.org
Subject aurora git commit: Slight documentation overhaul.
Date Sun, 27 Dec 2015 21:52:17 GMT
Repository: aurora
Updated Branches:
  refs/heads/master 1b43126e1 -> f56ea265c


Slight documentation overhaul.


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

Branch: refs/heads/master
Commit: f56ea265c1dcf4de5f67d31442eaee724870b0bd
Parents: 1b43126
Author: Stephan Erb <stephan@dev.static-void.de>
Authored: Sat Dec 26 22:27:33 2015 +0100
Committer: Bill Farner <wfarner@apache.org>
Committed: Sun Dec 27 13:51:29 2015 -0800

----------------------------------------------------------------------
 README.md                            | 137 ++++++++----------------------
 docs/README.md                       |  15 +++-
 docs/client-cluster-configuration.md |   5 +-
 docs/developing-aurora-client.md     |   2 +
 docs/developing-aurora-scheduler.md  |  34 +++++++-
 docs/images/aurora_logo.png          | Bin 0 -> 15106 bytes
 docs/tools.md                        |  16 ++++
 7 files changed, 101 insertions(+), 108 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/aurora/blob/f56ea265/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 143ee06..e3cd272 100644
--- a/README.md
+++ b/README.md
@@ -1,62 +1,55 @@
+![Aurora Logo](docs/images/aurora_logo.png)
+
 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 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)
+To very concisely describe Aurora, it is like a distributed monit or distributed supervisord
that
+you can instruct to do things like _run 100 of these, somewhere, forever_.
+
+https://aurora.apache.org/
+
 
 ## 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 is build for users _and_ operators.
+
+* User-facing Features:
+  - 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 and when not 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
+However, 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
+Are you using Aurora too?  Let us know, or submit a patch to join the list!
+
 - [Blue Yonder](http://www.blue-yonder.com)
 - [Boxever](http://www.boxever.com)
 - [Foursquare](https://foursquare.com)
@@ -67,69 +60,13 @@ scheduler itself, you may want to explore developing your own
 - [TellApart](https://www.tellapart.com)
 - [Twitter](https://twitter.com)
 
-Are you using Aurora too?  Let us know, or submit a patch to join the list!
-
-## Getting Started
-* [Try the tutorial](docs/tutorial.md)
-* [Running a Local Cluster with Vagrant](docs/vagrant.md)
-* [Installing Aurora](docs/installing.md)
-* [Developing Aurora](docs/developing-aurora-scheduler.md)
 
 ## Getting Help
-If you have questions, you can reach out to our mailing list: dev@aurora.apache.org
-([archive](http://mail-archives.apache.org/mod_mbox/aurora-dev)).
-We're also often available in IRC: #aurora on
+If you have questions that aren't answered in our [doucmentation](https://aurora.apache.org/documentation/latest/),
you can reach out to one of our [mailing lists](https://aurora.apache.org/community/). We're
also often available in IRC: #aurora on
 [irc.freenode.net](http://webchat.freenode.net/?channels=#aurora).
 
 You can also file bugs/issues in our [JIRA queue](http://issues.apache.org/jira/browse/AURORA).
 
-## Requirements
-* Python 2.7 or higher
-* JDK 1.8 or higher
-
-* Source distribution requirements
-       * [Gradle](http://gradle.org)
-
-## How to build
-
-Gradle and Bower are not shipped with the source distribution of Apache Aurora.
-The following instructions apply for the source release downloads only. When
-using Apache Aurora checked out from the source repository or the binary
-distribution the Gradle wrapper and JavaScript dependencies are provided.
-
-1. Install Gradle following the instructions on the [Gradle web site](http://gradle.org)
-2. From the root directory of the Apache Aurora project generate the gradle
-wrapper by running:
-```shell
-    gradle wrapper
-```
-
-### Testing
-To run the same tests that are run in the Apache Aurora continuous integration
-environment
-
-* From the root directory of the Apache Aurora project run:
-```shell
-    ./build-support/jenkins/build.sh
-```
-
-* In addition, there is an end-to-end test that runs a suite of aurora commands
-using a virtual cluster. To run the end-to-end tests:
-```shell
-    $ bash src/test/sh/org/apache/aurora/e2e/test_end_to_end.sh
-```
-
-### Compiling the source packages
-To compile the source packages into binary distributions
-
-* From the root directory of the Apache Aurora project run:
-```shell
-    ./gradlew distTar
-    ./build-support/release/make-python-sdists
-```
-
-For additional information see the [Developing Aurora](docs/developing-aurora-scheduler.md)
-guide.
 
 ## License
 Except as otherwise noted this software is licensed under the

http://git-wip-us.apache.org/repos/asf/aurora/blob/f56ea265/docs/README.md
----------------------------------------------------------------------
diff --git a/docs/README.md b/docs/README.md
index 1ace7f7..1312d70 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,6 +1,6 @@
 ## Introduction
 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. This documentation has been organized into sections with three audiences
in mind:
- 
+
  * Users: General information about the project and to learn how to run an Aurora job.
  * Operators: For those that wish to manage and fine-tune an Aurora cluster.
  * Developers: All the information you need to start modifying Aurora and contributing back
to the project.
@@ -14,24 +14,31 @@ We encourage you to ask questions on the [Aurora developer list](http://aurora.a
  * [Configuration Tutorial](configuration-tutorial.md)
  * [Aurora + Thermos Reference](configuration-reference.md)
  * [Command Line Client](client-commands.md)
+ * [Client cluster configuration](client-cluster-configuration.md)
  * [Cron Jobs](cron-jobs.md)
 
 ## Operators
- * [Install Aurora](installing.md)
+ * [Installation](installing.md)
+ * [Deployment and cluster configuraiton](deploying-aurora-scheduler.md)
+ * [Security](security.md)
  * [Monitoring](monitoring.md)
  * [Hooks for Aurora Client API](hooks.md)
  * [Scheduler Storage](storage.md)
  * [Scheduler Storage and Maintenance](storage-config.md)
+ * [Scheduler Storage Performance Tuning](scheduler-storage.md)
  * [SLA Measurement](sla.md)
  * [Resource Isolation and Sizing](resources.md)
- * [Generating test resources](test-resource-generation.md)
 
 ## Developers
  * [Contributing to the project](../CONTRIBUTING.md)
  * [Developing the Aurora Scheduler](developing-aurora-scheduler.md)
  * [Developing the Aurora Client](developing-aurora-client.md)
  * [Committers Guide](committers.md)
+ * [Deprecation Guide](thrift-deprecation.md)
  * [Build System](build-system.md)
- 
+ * [Generating test resources](test-resource-generation.md)
+
+
 ## Additional Resources
+ * [Tools integrating with Aurora](tools.md)
  * [Presentation videos and slides](presentations.md)

http://git-wip-us.apache.org/repos/asf/aurora/blob/f56ea265/docs/client-cluster-configuration.md
----------------------------------------------------------------------
diff --git a/docs/client-cluster-configuration.md b/docs/client-cluster-configuration.md
index 86bd17c..88b9d77 100644
--- a/docs/client-cluster-configuration.md
+++ b/docs/client-cluster-configuration.md
@@ -66,6 +66,5 @@ URL of your VIP in a loadbalancer or a roundrobin DNS name.
 #### auth_mechanism
 
 The identifier of an authentication mechanism that the client should use when communicating
with the
-scheduler. Support for values other than `UNAUTHENTICATED` is currently not available, however
work
-is [in progress](https://issues.apache.org/jira/browse/AURORA-720) to add federated authentication
-to Aurora which will allow for more robust configuration of client/scheduler authentication.
+scheduler. Support for values other than `UNAUTHENTICATED` requires a matching scheduler-side
+[security configuration](security.md).

http://git-wip-us.apache.org/repos/asf/aurora/blob/f56ea265/docs/developing-aurora-client.md
----------------------------------------------------------------------
diff --git a/docs/developing-aurora-client.md b/docs/developing-aurora-client.md
index 09abc00..27f1c97 100644
--- a/docs/developing-aurora-client.md
+++ b/docs/developing-aurora-client.md
@@ -22,6 +22,8 @@ are:
    * Build a client executable: `./pants binary src/main/python/apache/aurora/client:aurora`
    * Test client code: `./pants test src/test/python/apache/aurora/client/cli:all`
 
+If you want to build a source distribution of the client, you need to run `./build-support/release/make-python-sdists`.
+
 Running/Debugging the Client
 ============================
 

http://git-wip-us.apache.org/repos/asf/aurora/blob/f56ea265/docs/developing-aurora-scheduler.md
----------------------------------------------------------------------
diff --git a/docs/developing-aurora-scheduler.md b/docs/developing-aurora-scheduler.md
index f52c76e..40e123d 100644
--- a/docs/developing-aurora-scheduler.md
+++ b/docs/developing-aurora-scheduler.md
@@ -1,8 +1,25 @@
 Java code in the aurora repo is built with [Gradle](http://gradle.org).
 
+
+Prerequisite
+============
+
+When using Apache Aurora checked out from the source repository or the binary
+distribution, the Gradle wrapper and JavaScript dependencies are provided.
+However, you need to manually install them when using the source release
+downloads:
+
+1. Install Gradle following the instructions on the [Gradle web site](http://gradle.org)
+2. From the root directory of the Apache Aurora project generate the gradle
+wrapper by running:
+
+    gradle wrapper
+
+
 Getting Started
 ===============
-You will need Java 7 installed and on your `PATH` or unzipped somewhere with `JAVA_HOME`
set. Then
+
+You will need Java 8 installed and on your `PATH` or unzipped somewhere with `JAVA_HOME`
set. Then
 
     ./gradlew tasks
 
@@ -28,6 +45,21 @@ commit to origin/master.
 
     ./gradlew build -Pq
 
+Running integration tests
+-------------------------
+To run the same tests that are run in the Apache Aurora continuous integration
+environment:
+
+    ./build-support/jenkins/build.sh
+
+
+In addition, there is an end-to-end test that runs a suite of aurora commands
+using a virtual cluster:
+
+    bash src/test/sh/org/apache/aurora/e2e/test_end_to_end.sh
+
+
+
 Creating a bundle for deployment
 --------------------------------
 Gradle can create a zip file containing Aurora, all of its dependencies, and a launch script
with

http://git-wip-us.apache.org/repos/asf/aurora/blob/f56ea265/docs/images/aurora_logo.png
----------------------------------------------------------------------
diff --git a/docs/images/aurora_logo.png b/docs/images/aurora_logo.png
new file mode 100644
index 0000000..abcfbb8
Binary files /dev/null and b/docs/images/aurora_logo.png differ

http://git-wip-us.apache.org/repos/asf/aurora/blob/f56ea265/docs/tools.md
----------------------------------------------------------------------
diff --git a/docs/tools.md b/docs/tools.md
new file mode 100644
index 0000000..c14aa2e
--- /dev/null
+++ b/docs/tools.md
@@ -0,0 +1,16 @@
+# Tools
+
+Various tools integrate with Aurora. There is a tool missing? Let us know, or submit a patch
to add it!
+
+* Load-balacing technology used to direct traffic to services running on Aurora
+  - [synapse](https://github.com/airbnb/synapse) based on HAProxy
+  - [aurproxy](https://github.com/tellapart/aurproxy) based on nginx
+  - [jobhopper](https://github.com/benley/aurora-jobhopper) performing HTTP redirects for
easy developers and administor access
+
+* Monitoring
+  - [collectd-aurora](https://github.com/zircote/collectd-aurora) for cluster monitoring
using collectd
+  - [Prometheus Aurora exporter](https://github.com/tommyulfsparre/aurora_exporter) for cluster
monitoring using Prometheus
+  - [Prometheus service discovery integration](http://prometheus.io/docs/operating/configuration/#zookeeper-serverset-sd-configurations-serverset_sd_config)
for discovering and monitoring services running on Aurora
+
+* Packaging and deployment
+  - [aurora-packaging](https://github.com/apache/aurora-packaging), the source of the official
Aurora packaes


Mime
View raw message