Repository: aurora Updated Branches: refs/heads/master b2df0eb56 -> ddbb9657e
Small Documentation fixes and nitpicks. Reviewed at https://reviews.apache.org/r/45779/ Project: http://git-wip-us.apache.org/repos/asf/aurora/repo Commit: http://git-wip-us.apache.org/repos/asf/aurora/commit/ddbb9657 Tree: http://git-wip-us.apache.org/repos/asf/aurora/tree/ddbb9657 Diff: http://git-wip-us.apache.org/repos/asf/aurora/diff/ddbb9657 Branch: refs/heads/master Commit: ddbb9657e95f199ad6d5d653169ac96031edca78 Parents: b2df0eb Author: Tony Dong <[email protected]> Authored: Wed Apr 6 10:37:59 2016 -0700 Committer: Bill Farner <[email protected]> Committed: Wed Apr 6 10:37:59 2016 -0700 ---------------------------------------------------------------------- docs/additional-resources/tools.md | 4 ++-- docs/development/client.md | 2 +- docs/development/committers-guide.md | 2 +- docs/development/scheduler.md | 4 ++-- docs/features/services.md | 2 +- docs/getting-started/overview.md | 16 +++++++++------- 6 files changed, 16 insertions(+), 14 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/aurora/blob/ddbb9657/docs/additional-resources/tools.md ---------------------------------------------------------------------- diff --git a/docs/additional-resources/tools.md b/docs/additional-resources/tools.md index 354ccf0..64a4f74 100644 --- a/docs/additional-resources/tools.md +++ b/docs/additional-resources/tools.md @@ -5,7 +5,7 @@ Various tools integrate with Aurora. Is there a tool missing? Let us know, or su * Load-balancing 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 + - [jobhopper](https://github.com/benley/aurora-jobhopper) performs HTTP redirects for easy developer and administrator access * RPC libraries that integrate with the Aurora's [service discovery mechanism](../features/service-discovery.md): - [linkerd](https://linkerd.io/) RPC proxy @@ -18,4 +18,4 @@ Various tools integrate with Aurora. Is there a tool missing? Let us know, or su - [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 + - [aurora-packaging](https://github.com/apache/aurora-packaging), the source of the official Aurora packages http://git-wip-us.apache.org/repos/asf/aurora/blob/ddbb9657/docs/development/client.md ---------------------------------------------------------------------- diff --git a/docs/development/client.md b/docs/development/client.md index 7d0c230..41d44be 100644 --- a/docs/development/client.md +++ b/docs/development/client.md @@ -23,7 +23,7 @@ Running/Debugging For manually testing client changes against a cluster, we use [Vagrant](https://www.vagrantup.com/). To start a virtual cluster, you need to install Vagrant, and then run `vagrant up` for the root of the aurora workspace. This will create a vagrant host named "devcluster", with a mesos master, a set -of mesos slaves, and an aurora scheduler. +of mesos agents, and an aurora scheduler. If you have a change you would like to test in your local cluster, you'll rebuild the client: http://git-wip-us.apache.org/repos/asf/aurora/blob/ddbb9657/docs/development/committers-guide.md ---------------------------------------------------------------------- diff --git a/docs/development/committers-guide.md b/docs/development/committers-guide.md index 309a652..e76e487 100644 --- a/docs/development/committers-guide.md +++ b/docs/development/committers-guide.md @@ -55,7 +55,7 @@ official Apache Aurora release. Before starting your gpg key should be in the KE must have access to commit to the dist.a.o repositories. 1. Ensure that all issues resolved for this release candidate are tagged with the correct Fix -Version in Jira, the changelog script will use this to generate the CHANGELOG in step #2. +Version in JIRA, the changelog script will use this to generate the CHANGELOG in step #2. 2. Create a release candidate. This will automatically update the CHANGELOG and commit it, create a branch and update the current version within the trunk. To create a minor version update and publish http://git-wip-us.apache.org/repos/asf/aurora/blob/ddbb9657/docs/development/scheduler.md ---------------------------------------------------------------------- diff --git a/docs/development/scheduler.md b/docs/development/scheduler.md index a26dfad..fc0836a 100644 --- a/docs/development/scheduler.md +++ b/docs/development/scheduler.md @@ -13,7 +13,7 @@ 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 +2. From the root directory of the Apache Aurora project generate the Gradle wrapper by running: gradle wrapper @@ -93,7 +93,7 @@ For example, to add a dependency on `com.example`'s `example-lib` 1.0 add this b compile 'com.example:example-lib:1.0' -NOTE: Anyone thinking about adding a new dependency should first familiarize themself with the +NOTE: Anyone thinking about adding a new dependency should first familiarize themselves with the Apache Foundation's third-party licensing [policy](http://www.apache.org/legal/resolved.html#category-x). http://git-wip-us.apache.org/repos/asf/aurora/blob/ddbb9657/docs/features/services.md ---------------------------------------------------------------------- diff --git a/docs/features/services.md b/docs/features/services.md index 691fa28..b6bfc9d 100644 --- a/docs/features/services.md +++ b/docs/features/services.md @@ -50,7 +50,7 @@ Ports ----- In order to be useful, most services have to bind to one or more ports. Aurora enables this -usecase via the [`thermos.ports` namespace](..reference/configuration.md#thermos-namespace) that +usecase via the [`thermos.ports` namespace](../reference/configuration.md#thermos-namespace) that allows to request arbitrarily named ports: http://git-wip-us.apache.org/repos/asf/aurora/blob/ddbb9657/docs/getting-started/overview.md ---------------------------------------------------------------------- diff --git a/docs/getting-started/overview.md b/docs/getting-started/overview.md index 854f8d7..f49c911 100644 --- a/docs/getting-started/overview.md +++ b/docs/getting-started/overview.md @@ -40,7 +40,8 @@ a functioning Aurora cluster. * **ZooKeeper** [ZooKeeper](http://zookeeper.apache.org) is a distributed consensus system. In an Aurora cluster - it is used for reliable election of the leading Aurora scheduler and Mesos master. + it is used for reliable election of the leading Aurora scheduler and Mesos master. It is also + used as a vehicle for service discovery, see [Service Discovery](../features/service-discovery.md) * **Mesos master** The master is responsible for tracking worker machines and performing accounting of their @@ -65,7 +66,7 @@ things like "instance id" or specific port numbers which may differ from machine to machine). How many tasks make up a Job is complicated. On a basic level, a Job consists of -one task template and instructions for creating near-idential replicas of that task +one task template and instructions for creating near-identical replicas of that task (otherwise referred to as "instances" or "shards"). A task can merely be a single *process* corresponding to a single @@ -73,17 +74,18 @@ command line, such as `python2.7 my_script.py`. However, a task can also consist of many separate processes, which all run within a single sandbox. For example, running multiple cooperating agents together, such as `logrotate`, `installer`, master, or slave processes. This is -where Thermos comes in. While Aurora provides a `Job` abstraction on +where Thermos comes in. While Aurora provides a `Job` abstraction on top of Mesos `Tasks`, Thermos provides a `Process` abstraction underneath Mesos `Task`s and serves as part of the Aurora framework's executor. You define `Job`s,` Task`s, and `Process`es in a configuration file. -Configuration files are written in Python, and make use of the Pystachio -templating language, along with specific Aurora, Mesos, and Thermos -commands and methods. They end in a `.aurora` extension. +Configuration files are written in Python, and make use of the +[Pystachio](https://github.com/wickman/pystachio) templating language, +along with specific Aurora, Mesos, and Thermos commands and methods. +The configuration files typically end with a `.aurora` extension. -This can be summarized as: +Summary: * Aurora manages jobs made of tasks. * Mesos manages tasks made of processes.
