Modified: aurora/site/source/documentation/0.10.0/resources.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.10.0/resources.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.10.0/resources.md (original) +++ aurora/site/source/documentation/0.10.0/resources.md Sun Dec 13 00:49:43 2015 @@ -147,18 +147,18 @@ the same host may cause contention. ## Resource Quota Aurora requires resource quotas for -[production non-dedicated jobs](/documentation/0.10.0//). Quota is enforced at +[production non-dedicated jobs](/documentation/0.10.0/configuration-reference/#job-objects). Quota is enforced at the job role level and when set, defines a non-preemptible pool of compute resources within that role. To grant quota to a particular role in production use `aurora_admin set_quota` command. NOTE: all job types (service, adhoc or cron) require role resource quota unless a job has -[dedicated constraint set](/documentation/0.10.0//). +[dedicated constraint set](/documentation/0.10.0/deploying-aurora-scheduler/#dedicated-attribute). ## Task preemption Under a particular resource shortage pressure, tasks from -[production](/documentation/0.10.0//) jobs may preempt tasks from any non-production +[production](/documentation/0.10.0/configuration-reference/#job-objects) jobs may preempt tasks from any non-production job. A production task may only be preempted by tasks from production jobs in the same role with -higher [priority](/documentation/0.10.0//). \ No newline at end of file +higher [priority](/documentation/0.10.0/configuration-reference/#job-objects). \ No newline at end of file
Modified: aurora/site/source/documentation/0.10.0/storage-config.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.10.0/storage-config.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.10.0/storage-config.md (original) +++ aurora/site/source/documentation/0.10.0/storage-config.md Sun Dec 13 00:49:43 2015 @@ -22,7 +22,7 @@ This document summarizes Aurora storage configuration and maintenance details and is intended for use by anyone deploying and/or maintaining Aurora. -For a high level overview of the Aurora storage architecture refer to [this document](/documentation/0.10.0//). +For a high level overview of the Aurora storage architecture refer to [this document](/documentation/0.10.0/storage/). ## Scheduler storage configuration flags @@ -33,7 +33,7 @@ or require attention before deploying in #### -native_log_quorum_size Defines the Mesos replicated log quorum size. See -[the replicated log configuration document](/documentation/0.10.0//) +[the replicated log configuration document](/documentation/0.10.0/deploying-aurora-scheduler/#replicated-log-configuration) on how to choose the right value. #### -native_log_file_path Modified: aurora/site/source/documentation/0.10.0/storage.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.10.0/storage.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.10.0/storage.md (original) +++ aurora/site/source/documentation/0.10.0/storage.md Sun Dec 13 00:49:43 2015 @@ -33,7 +33,7 @@ is [thrift](https://github.com/apache/th This helps establishing periodic recovery checkpoints and speeds up volatile storage recovery on restart. * Backup manager: as a precaution, snapshots are periodically written out into backup files. -This solves a [disaster recovery problem](/documentation/0.10.0//) +This solves a [disaster recovery problem](/documentation/0.10.0/storage-config/#recovering-from-a-scheduler-backup) in case of a complete loss or corruption of Mesos log files.  Modified: aurora/site/source/documentation/0.10.0/test-resource-generation.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.10.0/test-resource-generation.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.10.0/test-resource-generation.md (original) +++ aurora/site/source/documentation/0.10.0/test-resource-generation.md Sun Dec 13 00:49:43 2015 @@ -19,6 +19,6 @@ that would undermine the goal of ensurin The most common reason to add a new checkpoint file would be to provide coverage for new thermos features that alter the data format. This is accomplished by writing and running a -[job configuration](/documentation/0.10.0//) that exercises the feature, and +[job configuration](/documentation/0.10.0/configuration-reference/) that exercises the feature, and copying the checkpoint file from the sandbox directory, by default this is `/var/run/thermos/checkpoints/<aurora task id>`. Modified: aurora/site/source/documentation/0.10.0/thrift-deprecation.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.10.0/thrift-deprecation.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.10.0/thrift-deprecation.md (original) +++ aurora/site/source/documentation/0.10.0/thrift-deprecation.md Sun Dec 13 00:49:43 2015 @@ -45,6 +45,6 @@ Finalize the change by removing the depr ## Testing It's always advisable to test your changes in the local vagrant environment to build more confidence that you change is backwards compatible. It's easy to simulate different -client/scheduler versions by playing with `aurorabuild` command. See [this document](/documentation/0.10.0//) +client/scheduler versions by playing with `aurorabuild` command. See [this document](/documentation/0.10.0/vagrant/) for more. Modified: aurora/site/source/documentation/0.10.0/tutorial.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.10.0/tutorial.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.10.0/tutorial.md (original) +++ aurora/site/source/documentation/0.10.0/tutorial.md Sun Dec 13 00:49:43 2015 @@ -30,7 +30,7 @@ To get help, email questions to the Auro ## Setup: Install Aurora You use the Aurora client and web UI to interact with Aurora jobs. To -install it locally, see [vagrant.md](/documentation/0.10.0//). The remainder of this +install it locally, see [vagrant.md](/documentation/0.10.0/vagrant/). The remainder of this Tutorial assumes you are running Aurora using Vagrant. Unless otherwise stated, all commands are to be run from the root of the aurora repository clone. @@ -105,8 +105,8 @@ jobs = [ ``` For more about Aurora configuration files, see the [Configuration -Tutorial](/documentation/0.10.0//) and the [Aurora + Thermos -Reference](/documentation/0.10.0//) (preferably after finishing this +Tutorial](/documentation/0.10.0/configuration-tutorial/) and the [Aurora + Thermos +Reference](/documentation/0.10.0/configuration-reference/) (preferably after finishing this tutorial). ## What's Going On In That Configuration File? @@ -256,10 +256,10 @@ The job page now shows the `hello_world` Now that you've finished this Tutorial, you should read or do the following: -- [The Aurora Configuration Tutorial](/documentation/0.10.0//), which provides more examples +- [The Aurora Configuration Tutorial](/documentation/0.10.0/configuration-tutorial/), which provides more examples and best practices for writing Aurora configurations. You should also look at - the [Aurora + Thermos Configuration Reference](/documentation/0.10.0//). -- The [Aurora User Guide](/documentation/0.10.0//) provides an overview of how Aurora, Mesos, and + the [Aurora + Thermos Configuration Reference](/documentation/0.10.0/configuration-reference/). +- The [Aurora User Guide](/documentation/0.10.0/user-guide/) provides an overview of how Aurora, Mesos, and Thermos work "under the hood". - Explore the Aurora Client - use `aurora -h`, and read the - [Aurora Client Commands](/documentation/0.10.0//) document. + [Aurora Client Commands](/documentation/0.10.0/client-commands/) document. Modified: aurora/site/source/documentation/0.10.0/user-guide.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.10.0/user-guide.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.10.0/user-guide.md (original) +++ aurora/site/source/documentation/0.10.0/user-guide.md Sun Dec 13 00:49:43 2015 @@ -21,7 +21,7 @@ Overview This document gives an overview of how Aurora works under the hood. It assumes you've already worked through the "hello world" example -job in the [Aurora Tutorial](/documentation/0.10.0//). Specifics of how to use Aurora are **not** +job in the [Aurora Tutorial](/documentation/0.10.0/tutorial/). Specifics of how to use Aurora are **not** given here, but pointers to documentation about how to use Aurora are provided. @@ -212,7 +212,7 @@ requests: | `POST /abortabortabort` | Final warning task is being killed. | Please see the -[configuration reference](/documentation/0.10.0//) for +[configuration reference](/documentation/0.10.0/configuration-reference/#healthcheckconfig-objects) for configuration options for this feature. #### Snoozing Health Checks @@ -292,8 +292,8 @@ Aurora configuration files. Their filena suffix, and you write them in Python making use of the Pystachio templating language, along with specific Aurora, Mesos, and Thermos commands and methods. See the -[Configuration Guide and Reference](/documentation/0.10.0//) and -[Configuration Tutorial](/documentation/0.10.0//). +[Configuration Guide and Reference](/documentation/0.10.0/configuration-reference/) and +[Configuration Tutorial](/documentation/0.10.0/configuration-tutorial/). Service Discovery ----------------- @@ -308,14 +308,14 @@ of which there are several reference imp These can also be used natively in Finagle using the [ZookeeperServerSetCluster](https://github.com/twitter/finagle/blob/master/finagle-serversets/src/main/scala/com/twitter/finagle/zookeeper/ZookeeperServerSetCluster.scala). -For more information about how to configure announcing, see the [Configuration Reference](/documentation/0.10.0//). +For more information about how to configure announcing, see the [Configuration Reference](/documentation/0.10.0/configuration-reference/). Creating Jobs ------------- You create and manipulate Aurora Jobs with the Aurora client, which starts all its command line commands with -`aurora`. See [Aurora Client Commands](/documentation/0.10.0//) for details +`aurora`. See [Aurora Client Commands](/documentation/0.10.0/client-commands/) for details about the Aurora Client. Interacting With Jobs @@ -352,4 +352,4 @@ You interact with Aurora jobs either via - The Aurora client - See [client commands](/documentation/0.10.0//). + See [client commands](/documentation/0.10.0/client-commands/). Modified: aurora/site/source/documentation/0.10.0/vagrant.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.10.0/vagrant.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.10.0/vagrant.md (original) +++ aurora/site/source/documentation/0.10.0/vagrant.md Sun Dec 13 00:49:43 2015 @@ -100,7 +100,7 @@ Run your first job ------------------ Now that your cluster is up and running, you are ready to define and run your first job in Aurora. -For more information, see the [Aurora Tutorial](/documentation/0.10.0//). +For more information, see the [Aurora Tutorial](/documentation/0.10.0/tutorial/). Rebuild components Modified: aurora/site/source/documentation/0.5.0-incubating/client-commands.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.5.0-incubating/client-commands.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.5.0-incubating/client-commands.md (original) +++ aurora/site/source/documentation/0.5.0-incubating/client-commands.md Sun Dec 13 00:49:43 2015 @@ -131,7 +131,7 @@ Hooks can be associated with these Auror - `update` The process for writing and activating them is complex enough -that we explain it in a devoted document, [Hooks for Aurora Client API](/documentation/0.5.0-incubating//). +that we explain it in a devoted document, [Hooks for Aurora Client API](/documentation/0.5.0-incubating/hooks/). Regular Jobs ------------ Modified: aurora/site/source/documentation/0.5.0-incubating/configuration-reference.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.5.0-incubating/configuration-reference.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.5.0-incubating/configuration-reference.md (original) +++ aurora/site/source/documentation/0.5.0-incubating/configuration-reference.md Sun Dec 13 00:49:43 2015 @@ -45,8 +45,8 @@ powerful, and configurations can become cases. For examples of simple configurations to get something up and running -quickly, check out the [Tutorial](/documentation/0.5.0-incubating//). When you feel comfortable with the basics, move -on to the [Configuration Tutorial](/documentation/0.5.0-incubating//) for more in-depth coverage of +quickly, check out the [Tutorial](/documentation/0.5.0-incubating/tutorial/). When you feel comfortable with the basics, move +on to the [Configuration Tutorial](/documentation/0.5.0-incubating/configuration-tutorial/) for more in-depth coverage of configuration design. For additional basic configuration examples, see [the end of this document](#BasicExamples). @@ -289,7 +289,7 @@ ordering constraints. ### Resource Object Specifies the amount of CPU, Ram, and disk resources the task needs. See the -[Resource Isolation document](/documentation/0.5.0-incubating//) for suggested values and to understand how +[Resource Isolation document](/documentation/0.5.0-incubating/resource-isolation/) for suggested values and to understand how resources are allocated. param | type | description Modified: aurora/site/source/documentation/0.5.0-incubating/configuration-tutorial.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.5.0-incubating/configuration-tutorial.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.5.0-incubating/configuration-tutorial.md (original) +++ aurora/site/source/documentation/0.5.0-incubating/configuration-tutorial.md Sun Dec 13 00:49:43 2015 @@ -7,7 +7,7 @@ and best practices. When writing a confi arguments as `aurora create` or `aurora update`. It first ensures the configuration parses, then outputs it in human-readable form. -You should read this after going through the general [Aurora Tutorial](/documentation/0.5.0-incubating//). +You should read this after going through the general [Aurora Tutorial](/documentation/0.5.0-incubating/tutorial/). [The Basics](#Basics) [Use Bottom-To-Top Object Ordering](#Bottom) @@ -66,11 +66,11 @@ via {{}} surrounded templates. When writing your `.aurora` file, you may use any Pystachio datatypes, as well as any objects shown in the [*Aurora+Thermos Configuration -Reference*](/documentation/0.5.0-incubating//), without `import` statements - the +Reference*](/documentation/0.5.0-incubating/configuration-reference/), without `import` statements - the Aurora config loader injects them automatically. Other than that, an `.aurora` file works like any other Python script. -[*Aurora+Thermos Configuration Reference*](/documentation/0.5.0-incubating//) +[*Aurora+Thermos Configuration Reference*](/documentation/0.5.0-incubating/configuration-reference/) has a full reference of all Aurora/Thermos defined Pystachio objects. ### Use Bottom-To-Top Object Ordering @@ -620,7 +620,7 @@ The final three Job attributes each take scheduler automatically inserts reasonable defaults. Please do not set this field unless you are sure of what you are doing. See the section in the Aurora + Thermos Reference manual on [Specifying - Scheduling Constraints](/documentation/0.5.0-incubating//) for more information. + Scheduling Constraints](/documentation/0.5.0-incubating/configuration-reference/) for more information. ## The jobs List @@ -637,7 +637,7 @@ The `.aurora` file format is just Python `Process`, and other classes are defined by a templating library called *Pystachio*, a powerful tool for configuration specification and reuse. -[Aurora+Thermos Configuration Reference](/documentation/0.5.0-incubating//) +[Aurora+Thermos Configuration Reference](/documentation/0.5.0-incubating/configuration-reference/) has a full reference of all Aurora/Thermos defined Pystachio objects. When writing your `.aurora` file, you may use any Pystachio datatypes, as Modified: aurora/site/source/documentation/0.5.0-incubating/index.html.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.5.0-incubating/index.html.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.5.0-incubating/index.html.md (original) +++ aurora/site/source/documentation/0.5.0-incubating/index.html.md Sun Dec 13 00:49:43 2015 @@ -10,11 +10,11 @@ Typically a Task is a single *Process* c To use and get up to speed on Aurora, you should look the docs in this directory in this order: -1. How to [deploy Aurora](/documentation/0.5.0-incubating//) or, how to [install Aurora on virtual machines on your private machine](/documentation/0.5.0-incubating//) (the Tutorial uses the virtual machine approach). -2. As a user, get started quickly with a [Tutorial](/documentation/0.5.0-incubating//). -3. For an overview of Aurora's process flow under the hood, see the [User Guide](/documentation/0.5.0-incubating//). -4. To learn how to write a configuration file, look at our [Configuration Tutorial](/documentation/0.5.0-incubating//). From there, look at the [Aurora + Thermos Reference](/documentation/0.5.0-incubating//). -5. Then read up on the [Aurora Command Line Client](/documentation/0.5.0-incubating//). -6. Find out general information and useful tips about how Aurora does [Resource Isolation](/documentation/0.5.0-incubating//). +1. How to [deploy Aurora](/documentation/0.5.0-incubating/deploying-aurora-scheduler/) or, how to [install Aurora on virtual machines on your private machine](/documentation/0.5.0-incubating/vagrant/) (the Tutorial uses the virtual machine approach). +2. As a user, get started quickly with a [Tutorial](/documentation/0.5.0-incubating/tutorial/). +3. For an overview of Aurora's process flow under the hood, see the [User Guide](/documentation/0.5.0-incubating/user-guide/). +4. To learn how to write a configuration file, look at our [Configuration Tutorial](/documentation/0.5.0-incubating/configuration-tutorial/). From there, look at the [Aurora + Thermos Reference](/documentation/0.5.0-incubating/configuration-reference/). +5. Then read up on the [Aurora Command Line Client](/documentation/0.5.0-incubating/client-commands/). +6. Find out general information and useful tips about how Aurora does [Resource Isolation](/documentation/0.5.0-incubating/resource-isolation/). To contact the Aurora Developer List, email [[email protected]](mailto:[email protected]). You may want to read the list [archives](http://mail-archives.apache.org/mod_mbox/incubator-aurora-dev/). You can also use the IRC channel `#aurora` on `irc.freenode.net` Modified: aurora/site/source/documentation/0.5.0-incubating/tutorial.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.5.0-incubating/tutorial.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.5.0-incubating/tutorial.md (original) +++ aurora/site/source/documentation/0.5.0-incubating/tutorial.md Sun Dec 13 00:49:43 2015 @@ -30,7 +30,7 @@ To get help, email questions to the Auro ## Setup: Install Aurora You use the Aurora client and web UI to interact with Aurora jobs. To -install it locally, see [vagrant.md](/documentation/0.5.0-incubating//). The remainder of this +install it locally, see [vagrant.md](/documentation/0.5.0-incubating/vagrant/). The remainder of this Tutorial assumes you are running Aurora using Vagrant. Unless otherwise stated, all commands are to be run from the root of the aurora repository clone. @@ -105,8 +105,8 @@ jobs = [ ``` For more about Aurora configuration files, see the [Configuration -Tutorial](/documentation/0.5.0-incubating//) and the [Aurora + Thermos -Reference](/documentation/0.5.0-incubating//) (preferably after finishing this +Tutorial](/documentation/0.5.0-incubating/configuration-tutorial/) and the [Aurora + Thermos +Reference](/documentation/0.5.0-incubating/configuration-reference/) (preferably after finishing this tutorial). ## What's Going On In That Configuration File? @@ -256,10 +256,10 @@ The job page now shows the `hello_world` Now that you've finished this Tutorial, you should read or do the following: -- [The Aurora Configuration Tutorial](/documentation/0.5.0-incubating//), which provides more examples +- [The Aurora Configuration Tutorial](/documentation/0.5.0-incubating/configuration-tutorial/), which provides more examples and best practices for writing Aurora configurations. You should also look at - the [Aurora + Thermos Configuration Reference](/documentation/0.5.0-incubating//). -- The [Aurora User Guide](/documentation/0.5.0-incubating//) provides an overview of how Aurora, Mesos, and + the [Aurora + Thermos Configuration Reference](/documentation/0.5.0-incubating/configuration-reference/). +- The [Aurora User Guide](/documentation/0.5.0-incubating/user-guide/) provides an overview of how Aurora, Mesos, and Thermos work "under the hood". - Explore the Aurora Client - use the `aurora help` subcommand, and read the - [Aurora Client Commands](/documentation/0.5.0-incubating//) document. + [Aurora Client Commands](/documentation/0.5.0-incubating/client-commands/) document. Modified: aurora/site/source/documentation/0.5.0-incubating/user-guide.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.5.0-incubating/user-guide.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.5.0-incubating/user-guide.md (original) +++ aurora/site/source/documentation/0.5.0-incubating/user-guide.md Sun Dec 13 00:49:43 2015 @@ -20,7 +20,7 @@ Overview This document gives an overview of how Aurora works under the hood. It assumes you've already worked through the "hello world" example -job in the [Aurora Tutorial](/documentation/0.5.0-incubating//). Specifics of how to use Aurora are **not** +job in the [Aurora Tutorial](/documentation/0.5.0-incubating/tutorial/). Specifics of how to use Aurora are **not** given here, but pointers to documentation about how to use Aurora are provided. @@ -211,7 +211,7 @@ requests: | `POST /abortabortabort` | Final warning task is being killed. | Please see the -[configuration reference](/documentation/0.5.0-incubating//) for +[configuration reference](/documentation/0.5.0-incubating/configuration-reference/#healthcheckconfig-objects) for configuration options for this feature. #### Tearing a task down @@ -279,15 +279,15 @@ Aurora configuration files. Their filena suffix, and you write them in Python making use of the Pystashio templating language, along with specific Aurora, Mesos, and Thermos commands and methods. See the -[Configuration Guide and Reference](/documentation/0.5.0-incubating//) and -[Configuration Tutorial](/documentation/0.5.0-incubating//). +[Configuration Guide and Reference](/documentation/0.5.0-incubating/configuration-reference/) and +[Configuration Tutorial](/documentation/0.5.0-incubating/configuration-tutorial/). Creating Jobs ------------- You create and manipulate Aurora Jobs with the Aurora client, which starts all its command line commands with -`aurora`. See [Aurora Client Commands](/documentation/0.5.0-incubating//) for details +`aurora`. See [Aurora Client Commands](/documentation/0.5.0-incubating/client-commands/) for details about the Aurora Client. Interacting With Jobs @@ -332,4 +332,4 @@ You interact with Aurora jobs either via command help, `aurora help [command]`. **Note**: `aurora help open` returns `"subcommand open not found"` due to our reflection tricks not working on words that are also builtin Python function names. Or see the - [Aurora Client Commands](/documentation/0.5.0-incubating//) document. + [Aurora Client Commands](/documentation/0.5.0-incubating/client-commands/) document. Modified: aurora/site/source/documentation/0.6.0-incubating/client-commands.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.6.0-incubating/client-commands.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.6.0-incubating/client-commands.md (original) +++ aurora/site/source/documentation/0.6.0-incubating/client-commands.md Sun Dec 13 00:49:43 2015 @@ -16,7 +16,7 @@ reflection. - [Running a Command On a Running Job](#running-a-command-on-a-running-job) - [Killing a Job](#killing-a-job) - [Updating a Job](#updating-a-job) - - [Asynchronous job updates (beta)](#user-content-asynchronous-job-updates-beta) + - [Asynchronous job updates (beta)](#asynchronous-job-updates-beta) - [Renaming a Job](#renaming-a-job) - [Restarting Jobs](#restarting-jobs) - [Cron Jobs](#cron-jobs) @@ -89,7 +89,7 @@ A configuration for a leader-elected sch ``` For more details on cluster configuration see the -[Client Cluster Configuration](client-cluster-configuration.md) documentation. +[Client Cluster Configuration](/documentation/0.6.0-incubating/client-cluster-configuration/) documentation. Job Keys -------- @@ -135,7 +135,7 @@ Hooks can be associated with these Auror - `update` The process for writing and activating them is complex enough -that we explain it in a devoted document, [Hooks for Aurora Client API](hooks.md). +that we explain it in a devoted document, [Hooks for Aurora Client API](/documentation/0.6.0-incubating/hooks/). Regular Jobs ------------ Modified: aurora/site/source/documentation/0.6.0-incubating/configuration-reference.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.6.0-incubating/configuration-reference.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.6.0-incubating/configuration-reference.md (original) +++ aurora/site/source/documentation/0.6.0-incubating/configuration-reference.md Sun Dec 13 00:49:43 2015 @@ -46,8 +46,8 @@ powerful, and configurations can become cases. For examples of simple configurations to get something up and running -quickly, check out the [Tutorial](tutorial.md). When you feel comfortable with the basics, move -on to the [Configuration Tutorial](configuration-tutorial.md) for more in-depth coverage of +quickly, check out the [Tutorial](/documentation/0.6.0-incubating/tutorial/). When you feel comfortable with the basics, move +on to the [Configuration Tutorial](/documentation/0.6.0-incubating/configuration-tutorial/) for more in-depth coverage of configuration design. For additional basic configuration examples, see [the end of this document](#BasicExamples). @@ -290,7 +290,7 @@ ordering constraints. ### Resource Object Specifies the amount of CPU, Ram, and disk resources the task needs. See the -[Resource Isolation document](resource-isolation.md) for suggested values and to understand how +[Resource Isolation document](/documentation/0.6.0-incubating/resource-isolation/) for suggested values and to understand how resources are allocated. param | type | description @@ -313,7 +313,7 @@ Job Schema ```environment``` | String | Job environment, default ```devel```. Must be one of ```prod```, ```devel```, ```test``` or ```staging<number>```. ```contact``` | String | Best email address to reach the owner of the job. For production jobs, this is usually a team mailing list. ```instances```| Integer | Number of instances (sometimes referred to as replicas or shards) of the task to create. (Default: 1) - ```cron_schedule``` | String | Cron schedule in cron format. May only be used with non-service jobs. See [Cron Jobs](cron-jobs.md) for more information. Default: None (not a cron job.) + ```cron_schedule``` | String | Cron schedule in cron format. May only be used with non-service jobs. See [Cron Jobs](/documentation/0.6.0-incubating/cron-jobs/) for more information. Default: None (not a cron job.) ```cron_collision_policy``` | String | Policy to use when a cron job is triggered while a previous run is still active. KILL_EXISTING Kill the previous run, and schedule the new run CANCEL_NEW Let the previous run continue, and cancel the new run. (Default: KILL_EXISTING) ```update_config``` | ```update_config``` object | Parameters for controlling the rate and policy of rolling updates. ```constraints``` | dict | Scheduling constraints for the tasks. See the section on the [constraint specification language](#Specifying-Scheduling-Constraints) @@ -361,7 +361,7 @@ Parameters for controlling a task's heal If the `announce` field in the Job configuration is set, each task will be registered in the ServerSet `/aurora/role/environment/jobname` in the zookeeper ensemble configured by the executor. If no Announcer object is specified, -no announcement will take place. For more information about ServerSets, see the [User Guide](user-guide.md). +no announcement will take place. For more information about ServerSets, see the [User Guide](/documentation/0.6.0-incubating/user-guide/). | object | type | description | ------- | :-------: | -------- Modified: aurora/site/source/documentation/0.6.0-incubating/configuration-tutorial.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.6.0-incubating/configuration-tutorial.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.6.0-incubating/configuration-tutorial.md (original) +++ aurora/site/source/documentation/0.6.0-incubating/configuration-tutorial.md Sun Dec 13 00:49:43 2015 @@ -7,42 +7,42 @@ and best practices. When writing a confi arguments as `aurora create` or `aurora update`. It first ensures the configuration parses, then outputs it in human-readable form. -You should read this after going through the general [Aurora Tutorial](tutorial.md). +You should read this after going through the general [Aurora Tutorial](/documentation/0.6.0-incubating/tutorial/). -- [Aurora Configuration Tutorial](#user-content-aurora-configuration-tutorial) - - [The Basics](#user-content-the-basics) - - [Use Bottom-To-Top Object Ordering](#user-content-use-bottom-to-top-object-ordering) - - [An Example Configuration File](#user-content-an-example-configuration-file) - - [Defining Process Objects](#user-content-defining-process-objects) - - [Getting Your Code Into The Sandbox](#user-content-getting-your-code-into-the-sandbox) - - [Defining Task Objects](#user-content-defining-task-objects) - - [SequentialTask: Running Processes in Parallel or Sequentially](#user-content-sequentialtask-running-processes-in-parallel-or-sequentially) - - [SimpleTask](#user-content-simpletask) - - [Combining tasks](#user-content-combining-tasks) - - [Defining Job Objects](#user-content-defining-job-objects) - - [The jobs List](#user-content-the-jobs-list) - - [Templating](#user-content-templating) - - [Templating 1: Binding in Pystachio](#user-content-templating-1-binding-in-pystachio) - - [Structurals in Pystachio / Aurora](#user-content-structurals-in-pystachio--aurora) - - [Mustaches Within Structurals](#user-content-mustaches-within-structurals) - - [Templating 2: Structurals Are Factories](#user-content-templating-2-structurals-are-factories) - - [A Second Way of Templating](#user-content-a-second-way-of-templating) - - [Advanced Binding](#user-content-advanced-binding) - - [Bind Syntax](#user-content-bind-syntax) - - [Binding Complex Objects](#user-content-binding-complex-objects) - - [Lists](#user-content-lists) - - [Maps](#user-content-maps) - - [Structurals](#user-content-structurals) - - [Structural Binding](#user-content-structural-binding) - - [Configuration File Writing Tips And Best Practices](#user-content-configuration-file-writing-tips-and-best-practices) - - [Use As Few .aurora Files As Possible](#user-content-use-as-few-aurora-files-as-possible) - - [Avoid Boilerplate](#user-content-avoid-boilerplate) - - [Thermos Uses bash, But Thermos Is Not bash](#user-content-thermos-uses-bash-but-thermos-is-not-bash) - - [Bad](#user-content-bad) - - [Good](#user-content-good) - - [Rarely Use Functions In Your Configurations](#user-content-rarely-use-functions-in-your-configurations) - - [Bad](#user-content-bad-1) - - [Good](#user-content-good-1) +- [Aurora Configuration Tutorial](#aurora-configuration-tutorial) + - [The Basics](#the-basics) + - [Use Bottom-To-Top Object Ordering](#use-bottom-to-top-object-ordering) + - [An Example Configuration File](#an-example-configuration-file) + - [Defining Process Objects](#defining-process-objects) + - [Getting Your Code Into The Sandbox](#getting-your-code-into-the-sandbox) + - [Defining Task Objects](#defining-task-objects) + - [SequentialTask: Running Processes in Parallel or Sequentially](#sequentialtask-running-processes-in-parallel-or-sequentially) + - [SimpleTask](#simpletask) + - [Combining tasks](#combining-tasks) + - [Defining Job Objects](#defining-job-objects) + - [The jobs List](#the-jobs-list) + - [Templating](#templating) + - [Templating 1: Binding in Pystachio](#templating-1-binding-in-pystachio) + - [Structurals in Pystachio / Aurora](#structurals-in-pystachio--aurora) + - [Mustaches Within Structurals](#mustaches-within-structurals) + - [Templating 2: Structurals Are Factories](#templating-2-structurals-are-factories) + - [A Second Way of Templating](#a-second-way-of-templating) + - [Advanced Binding](#advanced-binding) + - [Bind Syntax](#bind-syntax) + - [Binding Complex Objects](#binding-complex-objects) + - [Lists](#lists) + - [Maps](#maps) + - [Structurals](#structurals) + - [Structural Binding](#structural-binding) + - [Configuration File Writing Tips And Best Practices](#configuration-file-writing-tips-and-best-practices) + - [Use As Few .aurora Files As Possible](#use-as-few-aurora-files-as-possible) + - [Avoid Boilerplate](#avoid-boilerplate) + - [Thermos Uses bash, But Thermos Is Not bash](#thermos-uses-bash-but-thermos-is-not-bash) + - [Bad](#bad) + - [Good](#good) + - [Rarely Use Functions In Your Configurations](#rarely-use-functions-in-your-configurations) + - [Bad](#bad-1) + - [Good](#good-1) The Basics ---------- @@ -74,11 +74,11 @@ via {{}} surrounded templates. When writing your `.aurora` file, you may use any Pystachio datatypes, as well as any objects shown in the [*Aurora+Thermos Configuration -Reference*](configuration-reference.md), without `import` statements - the +Reference*](/documentation/0.6.0-incubating/configuration-reference/), without `import` statements - the Aurora config loader injects them automatically. Other than that, an `.aurora` file works like any other Python script. -[*Aurora+Thermos Configuration Reference*](configuration-reference.md) +[*Aurora+Thermos Configuration Reference*](/documentation/0.6.0-incubating/configuration-reference/) has a full reference of all Aurora/Thermos defined Pystachio objects. ### Use Bottom-To-Top Object Ordering @@ -628,7 +628,7 @@ The final three Job attributes each take scheduler automatically inserts reasonable defaults. Please do not set this field unless you are sure of what you are doing. See the section in the Aurora + Thermos Reference manual on [Specifying - Scheduling Constraints](configuration-reference.md) for more information. + Scheduling Constraints](/documentation/0.6.0-incubating/configuration-reference/) for more information. ## The jobs List @@ -645,7 +645,7 @@ The `.aurora` file format is just Python `Process`, and other classes are defined by a templating library called *Pystachio*, a powerful tool for configuration specification and reuse. -[Aurora+Thermos Configuration Reference](configuration-reference.md) +[Aurora+Thermos Configuration Reference](/documentation/0.6.0-incubating/configuration-reference/) has a full reference of all Aurora/Thermos defined Pystachio objects. When writing your `.aurora` file, you may use any Pystachio datatypes, as Modified: aurora/site/source/documentation/0.6.0-incubating/cron-jobs.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.6.0-incubating/cron-jobs.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.6.0-incubating/cron-jobs.md (original) +++ aurora/site/source/documentation/0.6.0-incubating/cron-jobs.md Sun Dec 13 00:49:43 2015 @@ -22,11 +22,11 @@ Aurora supports execution of scheduled j A job is identified as a cron job by the presence of a `cron_schedule` attribute containing a cron-style schedule in the -[`Job`](configuration-reference.md#job-objects) object. Examples of cron schedules +[`Job`](/documentation/0.6.0-incubating/configuration-reference/#job-objects) object. Examples of cron schedules include "every 5 minutes" (`*/5 * * * *`), "Fridays at 17:00" (`* 17 * * FRI`), and "the 1st and 15th day of the month at 03:00" (`0 3 1,15 *`). -Example (available in the [Vagrant environment](vagrant.md)): +Example (available in the [Vagrant environment](/documentation/0.6.0-incubating/vagrant/)): $ cat /vagrant/examples/job/cron_hello_world.aurora # cron_hello_world.aurora @@ -67,7 +67,7 @@ grow faster than they can process it. Unlike with services, which aurora will always re-execute regardless of exit status, instances of cron jobs retry according to the `max_task_failures` attribute of the -[Task](configuration-reference.md#task-objects) object. To get "run-until-failure" semantics, +[Task](/documentation/0.6.0-incubating/configuration-reference/#task-objects) object. To get "run-until-failure" semantics, set `max_task_failures` to `-1`. ## Interacting with cron jobs via the Aurora CLI Modified: aurora/site/source/documentation/0.6.0-incubating/deploying-aurora-scheduler.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.6.0-incubating/deploying-aurora-scheduler.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.6.0-incubating/deploying-aurora-scheduler.md (original) +++ aurora/site/source/documentation/0.6.0-incubating/deploying-aurora-scheduler.md Sun Dec 13 00:49:43 2015 @@ -112,7 +112,7 @@ should be set to `2`, and in a cluster o *Incorrectly setting this flag will cause data corruption to occur!* -See [this document](storage-config.md#scheduler-storage-configuration-flags) for more replicated +See [this document](/documentation/0.6.0-incubating/storage-config/#scheduler-storage-configuration-flags) for more replicated log and storage configuration options. ## Initializing the Replicated Log @@ -126,7 +126,7 @@ Failing to do this will result the follo ### Storage Performance Considerations -See [this document](scheduler-storage.md) for scheduler storage performance considerations. +See [this document](/documentation/0.6.0-incubating/scheduler-storage/) for scheduler storage performance considerations. ### Network considerations The Aurora scheduler listens on 2 ports - an HTTP port used for client RPCs and a web UI, @@ -161,7 +161,7 @@ assuming you set `-http_port=8081`. ### Maintaining an Aurora Installation ### Monitoring -Please see our dedicated [monitoring guide](monitoring.md) for in-depth discussion on monitoring. +Please see our dedicated [monitoring guide](/documentation/0.6.0-incubating/monitoring/) for in-depth discussion on monitoring. ### Running stateful services Aurora is best suited to run stateless applications, but it also accommodates for stateful services @@ -172,7 +172,7 @@ The Mesos slave has the `--attributes` c static attributes (not to be confused with `--resources`, which are dynamic and accounted). Aurora makes these attributes available for matching with scheduling -[constraints](configuration-reference.md#specifying-scheduling-constraints). Most of these +[constraints](/documentation/0.6.0-incubating/configuration-reference/#specifying-scheduling-constraints). Most of these constraints are arbitrary and available for custom use. There is one exception, though: the `dedicated` attribute. Aurora treats this specially, and only allows matching jobs to run on these machines, and will only schedule matching jobs on these machines. Modified: aurora/site/source/documentation/0.6.0-incubating/developing-aurora-client.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.6.0-incubating/developing-aurora-client.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.6.0-incubating/developing-aurora-client.md (original) +++ aurora/site/source/documentation/0.6.0-incubating/developing-aurora-client.md Sun Dec 13 00:49:43 2015 @@ -27,9 +27,9 @@ Client Configuration The client uses a configuration file that specifies available clusters. More information about the contents of this file can be found in the -[Client Cluster Configuration](client-cluster-configuration.md) documentation. Information about +[Client Cluster Configuration](/documentation/0.6.0-incubating/client-cluster-configuration/) documentation. Information about how the client locates this file can be found in the -[Client Commands](client-commands.md#cluster-configuration) documentation. +[Client Commands](/documentation/0.6.0-incubating/client-commands/#cluster-configuration) documentation. Client Versions =============== Added: aurora/site/source/documentation/0.6.0-incubating/index.html.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.6.0-incubating/index.html.md?rev=1719756&view=auto ============================================================================== --- aurora/site/source/documentation/0.6.0-incubating/index.html.md (added) +++ aurora/site/source/documentation/0.6.0-incubating/index.html.md Sun Dec 13 00:49:43 2015 @@ -0,0 +1,20 @@ +# Overview + +*Aurora* is a service scheduler that schedules jobs onto *Mesos*, which runs tasks at a specified cluster. Typical services consist of up to hundreds of task replicas. + +Aurora provides a *Job* abstraction consisting of a *Task* template and instructions for creating near-identical replicas of that Task (modulo things like "instance id" or specific port numbers which may differ from machine to machine). + +*Terminology Note*: *Replicas* are also referred to as *shards* and *instances*. While there is a general desire to move to using "instances", "shard" is still found in commands and help strings. + +Typically a Task is a single *Process* corresponding to a single command line, such as `python2.6 my_script.py`. However, sometimes you must colocate separate Processes together within a single Task, which runs within a single container and `chroot`, often referred to as a "sandbox". For example, if you run multiple cooperating agents together such as `logrotate`, `installer`, and master or slave processes. *Thermos* provides a Process abstraction under the Mesos Tasks. + +To use and get up to speed on Aurora, you should look the docs in this directory in this order: + +1. How to [deploy Aurora](/documentation/0.6.0-incubating/deploying-aurora-scheduler/) or, how to [install Aurora on virtual machines on your private machine](/documentation/0.6.0-incubating/vagrant/) (the Tutorial uses the virtual machine approach). +2. As a user, get started quickly with a [Tutorial](/documentation/0.6.0-incubating/tutorial/). +3. For an overview of Aurora's process flow under the hood, see the [User Guide](/documentation/0.6.0-incubating/user-guide/). +4. To learn how to write a configuration file, look at our [Configuration Tutorial](/documentation/0.6.0-incubating/configuration-tutorial/). From there, look at the [Aurora + Thermos Reference](/documentation/0.6.0-incubating/configuration-reference/). +5. Then read up on the [Aurora Command Line Client](/documentation/0.6.0-incubating/client-commands/). +6. Find out general information and useful tips about how Aurora does [Resource Isolation](/documentation/0.6.0-incubating/resource-isolation/). + +To contact the Aurora Developer List, email [[email protected]](mailto:[email protected]). You may want to read the list [archives](http://mail-archives.apache.org/mod_mbox/incubator-aurora-dev/). You can also use the IRC channel `#aurora` on `irc.freenode.net` Modified: aurora/site/source/documentation/0.6.0-incubating/sla.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.6.0-incubating/sla.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.6.0-incubating/sla.md (original) +++ aurora/site/source/documentation/0.6.0-incubating/sla.md Sun Dec 13 00:49:43 2015 @@ -60,7 +60,7 @@ relevant to uptime calculations. By appl transition records, we can build a deterministic downtime trace for every given service instance. A task going through a state transition carries one of three possible SLA meanings -(see [SlaAlgorithm.java](../src/main/java/org/apache/aurora/scheduler/sla/SlaAlgorithm.java) for +(see [SlaAlgorithm.java](https://github.com/apache/aurora/blob/#{git_tag}/src/main/java/org/apache/aurora/scheduler/sla/SlaAlgorithm.java)) for sla-to-task-state mapping): * Task is UP: starts a period where the task is considered to be up and running from the Aurora @@ -107,7 +107,7 @@ metric that helps track the dependency o * Per job - `sla_<job_key>_mtta_ms` * Per cluster - `sla_cluster_mtta_ms` * Per instance size (small, medium, large, x-large, xx-large). Size are defined in: -[ResourceAggregates.java](../src/main/java/org/apache/aurora/scheduler/base/ResourceAggregates.java) +[ResourceAggregates.java](https://github.com/apache/aurora/blob/#{git_tag}/src/main/java/org/apache/aurora/scheduler/base/ResourceAggregates.java)) * By CPU: * `sla_cpu_small_mtta_ms` * `sla_cpu_medium_mtta_ms` @@ -143,7 +143,7 @@ reflecting on the overall time it takes * Per job - `sla_<job_key>_mttr_ms` * Per cluster - `sla_cluster_mttr_ms` * Per instance size (small, medium, large, x-large, xx-large). Size are defined in: -[ResourceAggregates.java](../src/main/java/org/apache/aurora/scheduler/base/ResourceAggregates.java) +[ResourceAggregates.java](https://github.com/apache/aurora/blob/#{git_tag}/src/main/java/org/apache/aurora/scheduler/base/ResourceAggregates.java)) * By CPU: * `sla_cpu_small_mttr_ms` * `sla_cpu_medium_mttr_ms` Modified: aurora/site/source/documentation/0.6.0-incubating/storage-config.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.6.0-incubating/storage-config.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.6.0-incubating/storage-config.md (original) +++ aurora/site/source/documentation/0.6.0-incubating/storage-config.md Sun Dec 13 00:49:43 2015 @@ -22,7 +22,7 @@ This document summarizes Aurora storage configuration and maintenance details and is intended for use by anyone deploying and/or maintaining Aurora. -For a high level overview of the Aurora storage architecture refer to [this document](storage.md). +For a high level overview of the Aurora storage architecture refer to [this document](/documentation/0.6.0-incubating/storage/). ## Scheduler storage configuration flags @@ -33,7 +33,7 @@ or require attention before deploying in #### -native_log_quorum_size Defines the Mesos replicated log quorum size. See -[the replicated log configuration document](deploying-aurora-scheduler.md#replicated-log-configuration) +[the replicated log configuration document](/documentation/0.6.0-incubating/deploying-aurora-scheduler/#replicated-log-configuration) on how to choose the right value. #### -native_log_file_path @@ -43,7 +43,7 @@ for Mesos replicated log files to ensure #### -native_log_zk_group_path ZooKeeper path used for Mesos replicated log quorum discovery. -See [code](../src/main/java/org/apache/aurora/scheduler/log/mesos/MesosLogStreamModule.java) for +See [code](https://github.com/apache/aurora/blob/#{git_tag}/src/main/java/org/apache/aurora/scheduler/log/mesos/MesosLogStreamModule.java)) for other available Mesos replicated log configuration options and default values. ### Backup configuration flags Modified: aurora/site/source/documentation/0.6.0-incubating/storage.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.6.0-incubating/storage.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.6.0-incubating/storage.md (original) +++ aurora/site/source/documentation/0.6.0-incubating/storage.md Sun Dec 13 00:49:43 2015 @@ -33,7 +33,7 @@ is [thrift](https://github.com/apache/th This helps establishing periodic recovery checkpoints and speeds up volatile storage recovery on restart. * Backup manager: as a precaution, snapshots are periodically written out into backup files. -This solves a [disaster recovery problem](storage-config.md#recovering-from-a-scheduler-backup) +This solves a [disaster recovery problem](/documentation/0.6.0-incubating/storage-config/#recovering-from-a-scheduler-backup) in case of a complete loss or corruption of Mesos log files.  Modified: aurora/site/source/documentation/0.6.0-incubating/test-resource-generation.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.6.0-incubating/test-resource-generation.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.6.0-incubating/test-resource-generation.md (original) +++ aurora/site/source/documentation/0.6.0-incubating/test-resource-generation.md Sun Dec 13 00:49:43 2015 @@ -2,7 +2,7 @@ ## Background The Aurora source repository and distributions contain several -[binary files](../src/test/resources/org/apache/thermos/root/checkpoints) to +[binary files](https://github.com/apache/aurora/blob/#{git_tag}/src/test/resources/org/apache/thermos/root/checkpoints)) to qualify the backwards-compatibility of thermos with checkpoint data. Since thermos persists state to disk, to be read by other components (the GC executor and the thermos observer), it is important that we have tests that prevent @@ -20,6 +20,6 @@ that would undermine the goal of ensurin The most common reason to add a new checkpoint file would be to provide coverage for new thermos features that alter the data format. This is accomplished by writing and running a -[job configuration](configuration-reference.md) that exercises the feature, and +[job configuration](/documentation/0.6.0-incubating/configuration-reference/) that exercises the feature, and copying the checkpoint file from the sandbox directory, by default this is `/var/run/thermos/checkpoints/<aurora task id>`. Modified: aurora/site/source/documentation/0.6.0-incubating/tutorial.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.6.0-incubating/tutorial.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.6.0-incubating/tutorial.md (original) +++ aurora/site/source/documentation/0.6.0-incubating/tutorial.md Sun Dec 13 00:49:43 2015 @@ -30,7 +30,7 @@ To get help, email questions to the Auro ## Setup: Install Aurora You use the Aurora client and web UI to interact with Aurora jobs. To -install it locally, see [vagrant.md](vagrant.md). The remainder of this +install it locally, see [vagrant.md](/documentation/0.6.0-incubating/vagrant/). The remainder of this Tutorial assumes you are running Aurora using Vagrant. Unless otherwise stated, all commands are to be run from the root of the aurora repository clone. @@ -105,8 +105,8 @@ jobs = [ ``` For more about Aurora configuration files, see the [Configuration -Tutorial](configuration-tutorial.md) and the [Aurora + Thermos -Reference](configuration-reference.md) (preferably after finishing this +Tutorial](/documentation/0.6.0-incubating/configuration-tutorial/) and the [Aurora + Thermos +Reference](/documentation/0.6.0-incubating/configuration-reference/) (preferably after finishing this tutorial). ## What's Going On In That Configuration File? @@ -256,10 +256,10 @@ The job page now shows the `hello_world` Now that you've finished this Tutorial, you should read or do the following: -- [The Aurora Configuration Tutorial](configuration-tutorial.md), which provides more examples +- [The Aurora Configuration Tutorial](/documentation/0.6.0-incubating/configuration-tutorial/), which provides more examples and best practices for writing Aurora configurations. You should also look at - the [Aurora + Thermos Configuration Reference](configuration-reference.md). -- The [Aurora User Guide](user-guide.md) provides an overview of how Aurora, Mesos, and + the [Aurora + Thermos Configuration Reference](/documentation/0.6.0-incubating/configuration-reference/). +- The [Aurora User Guide](/documentation/0.6.0-incubating/user-guide/) provides an overview of how Aurora, Mesos, and Thermos work "under the hood". - Explore the Aurora Client - use the `aurora help` subcommand, and read the - [Aurora Client Commands](client-commands.md) document. + [Aurora Client Commands](/documentation/0.6.0-incubating/client-commands/) document. Modified: aurora/site/source/documentation/0.6.0-incubating/user-guide.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.6.0-incubating/user-guide.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.6.0-incubating/user-guide.md (original) +++ aurora/site/source/documentation/0.6.0-incubating/user-guide.md Sun Dec 13 00:49:43 2015 @@ -1,27 +1,27 @@ Aurora User Guide ----------------- -- [Overview](#user-content-overview) -- [Job Lifecycle](#user-content-job-lifecycle) - - [Life Of A Task](#user-content-life-of-a-task) - - [PENDING to RUNNING states](#user-content-pending-to-running-states) - - [Task Updates](#user-content-task-updates) - - [HTTP Health Checking and Graceful Shutdown](#user-content-http-health-checking-and-graceful-shutdown) - - [Tearing a task down](#user-content-tearing-a-task-down) - - [Giving Priority to Production Tasks: PREEMPTING](#user-content-giving-priority-to-production-tasks-preempting) - - [Natural Termination: FINISHED, FAILED](#user-content-natural-termination-finished-failed) - - [Forceful Termination: KILLING, RESTARTING](#user-content-forceful-termination-killing-restarting) -- [Service Discovery](#user-content-service-discovery) -- [Configuration](#user-content-configuration) -- [Creating Jobs](#user-content-creating-jobs) -- [Interacting With Jobs](#user-content-interacting-with-jobs) +- [Overview](#overview) +- [Job Lifecycle](#job-lifecycle) + - [Life Of A Task](#life-of-a-task) + - [PENDING to RUNNING states](#pending-to-running-states) + - [Task Updates](#task-updates) + - [HTTP Health Checking and Graceful Shutdown](#http-health-checking-and-graceful-shutdown) + - [Tearing a task down](#tearing-a-task-down) + - [Giving Priority to Production Tasks: PREEMPTING](#giving-priority-to-production-tasks-preempting) + - [Natural Termination: FINISHED, FAILED](#natural-termination-finished-failed) + - [Forceful Termination: KILLING, RESTARTING](#forceful-termination-killing-restarting) +- [Service Discovery](#service-discovery) +- [Configuration](#configuration) +- [Creating Jobs](#creating-jobs) +- [Interacting With Jobs](#interacting-with-jobs) Overview -------- This document gives an overview of how Aurora works under the hood. It assumes you've already worked through the "hello world" example -job in the [Aurora Tutorial](tutorial.md). Specifics of how to use Aurora are **not** +job in the [Aurora Tutorial](/documentation/0.6.0-incubating/tutorial/). Specifics of how to use Aurora are **not** given here, but pointers to documentation about how to use Aurora are provided. @@ -212,7 +212,7 @@ requests: | `POST /abortabortabort` | Final warning task is being killed. | Please see the -[configuration reference](configuration-reference.md#user-content-healthcheckconfig-objects) for +[configuration reference](/documentation/0.6.0-incubating/configuration-reference/#healthcheckconfig-objects) for configuration options for this feature. #### Snoozing Health Checks @@ -292,8 +292,8 @@ Aurora configuration files. Their filena suffix, and you write them in Python making use of the Pystachio templating language, along with specific Aurora, Mesos, and Thermos commands and methods. See the -[Configuration Guide and Reference](configuration-reference.md) and -[Configuration Tutorial](configuration-tutorial.md). +[Configuration Guide and Reference](/documentation/0.6.0-incubating/configuration-reference/) and +[Configuration Tutorial](/documentation/0.6.0-incubating/configuration-tutorial/). Service Discovery ----------------- @@ -308,14 +308,14 @@ of which there are several reference imp These can also be used natively in Finagle using the [ZookeeperServerSetCluster](https://github.com/twitter/finagle/blob/master/finagle-serversets/src/main/scala/com/twitter/finagle/zookeeper/ZookeeperServerSetCluster.scala). -For more information about how to configure announcing, see the [Configuration Reference](configuration-reference.md). +For more information about how to configure announcing, see the [Configuration Reference](/documentation/0.6.0-incubating/configuration-reference/). Creating Jobs ------------- You create and manipulate Aurora Jobs with the Aurora client, which starts all its command line commands with -`aurora`. See [Aurora Client Commands](client-commands.md) for details +`aurora`. See [Aurora Client Commands](/documentation/0.6.0-incubating/client-commands/) for details about the Aurora Client. Interacting With Jobs @@ -360,4 +360,4 @@ You interact with Aurora jobs either via command help, `aurora help [command]`. **Note**: `aurora help open` returns `"subcommand open not found"` due to our reflection tricks not working on words that are also builtin Python function names. Or see the - [Aurora Client Commands](client-commands.md) document. + [Aurora Client Commands](/documentation/0.6.0-incubating/client-commands/) document. Modified: aurora/site/source/documentation/0.7.0-incubating/client-commands.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.7.0-incubating/client-commands.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.7.0-incubating/client-commands.md (original) +++ aurora/site/source/documentation/0.7.0-incubating/client-commands.md Sun Dec 13 00:49:43 2015 @@ -83,7 +83,7 @@ A configuration for a leader-elected sch ``` For more details on cluster configuration see the -[Client Cluster Configuration](/documentation/0.7.0-incubating//) documentation. +[Client Cluster Configuration](/documentation/0.7.0-incubating/client-cluster-configuration/) documentation. Job Keys -------- @@ -129,7 +129,7 @@ Hooks can be associated with these Auror - `job update` The process for writing and activating them is complex enough -that we explain it in a devoted document, [Hooks for Aurora Client API](/documentation/0.7.0-incubating//). +that we explain it in a devoted document, [Hooks for Aurora Client API](/documentation/0.7.0-incubating/hooks/). Regular Jobs ------------ @@ -274,7 +274,7 @@ Cron Jobs --------- You can manage cron jobs using the `aurora cron` command. Please see -[cron-jobs.md](/documentation/0.7.0-incubating//) for more details. +[cron-jobs.md](/documentation/0.7.0-incubating/cron-jobs/) for more details. You will see various commands and options relating to cron jobs in `aurora -h` and similar. Ignore them, as they're not yet implemented. Modified: aurora/site/source/documentation/0.7.0-incubating/configuration-reference.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.7.0-incubating/configuration-reference.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.7.0-incubating/configuration-reference.md (original) +++ aurora/site/source/documentation/0.7.0-incubating/configuration-reference.md Sun Dec 13 00:49:43 2015 @@ -47,8 +47,8 @@ powerful, and configurations can become cases. For examples of simple configurations to get something up and running -quickly, check out the [Tutorial](/documentation/0.7.0-incubating//). When you feel comfortable with the basics, move -on to the [Configuration Tutorial](/documentation/0.7.0-incubating//) for more in-depth coverage of +quickly, check out the [Tutorial](/documentation/0.7.0-incubating/tutorial/). When you feel comfortable with the basics, move +on to the [Configuration Tutorial](/documentation/0.7.0-incubating/configuration-tutorial/) for more in-depth coverage of configuration design. For additional basic configuration examples, see [the end of this document](#BasicExamples). @@ -291,7 +291,7 @@ ordering constraints. ### Resource Object Specifies the amount of CPU, Ram, and disk resources the task needs. See the -[Resource Isolation document](/documentation/0.7.0-incubating//) for suggested values and to understand how +[Resource Isolation document](/documentation/0.7.0-incubating/resource-isolation/) for suggested values and to understand how resources are allocated. param | type | description @@ -315,7 +315,7 @@ Job Schema ```environment``` | String | Job environment, default ```devel```. Must be one of ```prod```, ```devel```, ```test``` or ```staging<number>```. ```contact``` | String | Best email address to reach the owner of the job. For production jobs, this is usually a team mailing list. ```instances```| Integer | Number of instances (sometimes referred to as replicas or shards) of the task to create. (Default: 1) - ```cron_schedule``` | String | Cron schedule in cron format. May only be used with non-service jobs. See [Cron Jobs](/documentation/0.7.0-incubating//) for more information. Default: None (not a cron job.) + ```cron_schedule``` | String | Cron schedule in cron format. May only be used with non-service jobs. See [Cron Jobs](/documentation/0.7.0-incubating/cron-jobs/) for more information. Default: None (not a cron job.) ```cron_collision_policy``` | String | Policy to use when a cron job is triggered while a previous run is still active. KILL_EXISTING Kill the previous run, and schedule the new run CANCEL_NEW Let the previous run continue, and cancel the new run. (Default: KILL_EXISTING) ```update_config``` | ```update_config``` object | Parameters for controlling the rate and policy of rolling updates. ```constraints``` | dict | Scheduling constraints for the tasks. See the section on the [constraint specification language](#Specifying-Scheduling-Constraints) @@ -364,7 +364,7 @@ Parameters for controlling a task's heal If the `announce` field in the Job configuration is set, each task will be registered in the ServerSet `/aurora/role/environment/jobname` in the zookeeper ensemble configured by the executor. If no Announcer object is specified, -no announcement will take place. For more information about ServerSets, see the [User Guide](/documentation/0.7.0-incubating//). +no announcement will take place. For more information about ServerSets, see the [User Guide](/documentation/0.7.0-incubating/user-guide/). | object | type | description | ------- | :-------: | -------- Modified: aurora/site/source/documentation/0.7.0-incubating/configuration-tutorial.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.7.0-incubating/configuration-tutorial.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.7.0-incubating/configuration-tutorial.md (original) +++ aurora/site/source/documentation/0.7.0-incubating/configuration-tutorial.md Sun Dec 13 00:49:43 2015 @@ -7,7 +7,7 @@ and best practices. When writing a confi arguments as `aurora create` or `aurora update`. It first ensures the configuration parses, then outputs it in human-readable form. -You should read this after going through the general [Aurora Tutorial](/documentation/0.7.0-incubating//). +You should read this after going through the general [Aurora Tutorial](/documentation/0.7.0-incubating/tutorial/). - [Aurora Configuration Tutorial](#aurora-configuration-tutorial) - [The Basics](#the-basics) @@ -74,11 +74,11 @@ via {{}} surrounded templates. When writing your `.aurora` file, you may use any Pystachio datatypes, as well as any objects shown in the [*Aurora+Thermos Configuration -Reference*](/documentation/0.7.0-incubating//), without `import` statements - the +Reference*](/documentation/0.7.0-incubating/configuration-reference/), without `import` statements - the Aurora config loader injects them automatically. Other than that, an `.aurora` file works like any other Python script. -[*Aurora+Thermos Configuration Reference*](/documentation/0.7.0-incubating//) +[*Aurora+Thermos Configuration Reference*](/documentation/0.7.0-incubating/configuration-reference/) has a full reference of all Aurora/Thermos defined Pystachio objects. ### Use Bottom-To-Top Object Ordering @@ -628,7 +628,7 @@ The final three Job attributes each take scheduler automatically inserts reasonable defaults. Please do not set this field unless you are sure of what you are doing. See the section in the Aurora + Thermos Reference manual on [Specifying - Scheduling Constraints](/documentation/0.7.0-incubating//) for more information. + Scheduling Constraints](/documentation/0.7.0-incubating/configuration-reference/) for more information. ## The jobs List @@ -645,7 +645,7 @@ The `.aurora` file format is just Python `Process`, and other classes are defined by a templating library called *Pystachio*, a powerful tool for configuration specification and reuse. -[Aurora+Thermos Configuration Reference](/documentation/0.7.0-incubating//) +[Aurora+Thermos Configuration Reference](/documentation/0.7.0-incubating/configuration-reference/) has a full reference of all Aurora/Thermos defined Pystachio objects. When writing your `.aurora` file, you may use any Pystachio datatypes, as Modified: aurora/site/source/documentation/0.7.0-incubating/cron-jobs.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.7.0-incubating/cron-jobs.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.7.0-incubating/cron-jobs.md (original) +++ aurora/site/source/documentation/0.7.0-incubating/cron-jobs.md Sun Dec 13 00:49:43 2015 @@ -22,11 +22,11 @@ Aurora supports execution of scheduled j A job is identified as a cron job by the presence of a `cron_schedule` attribute containing a cron-style schedule in the -[`Job`](/documentation/0.7.0-incubating//) object. Examples of cron schedules +[`Job`](/documentation/0.7.0-incubating/configuration-reference/#job-objects) object. Examples of cron schedules include "every 5 minutes" (`*/5 * * * *`), "Fridays at 17:00" (`* 17 * * FRI`), and "the 1st and 15th day of the month at 03:00" (`0 3 1,15 *`). -Example (available in the [Vagrant environment](/documentation/0.7.0-incubating//)): +Example (available in the [Vagrant environment](/documentation/0.7.0-incubating/vagrant/)): $ cat /vagrant/examples/job/cron_hello_world.aurora # cron_hello_world.aurora @@ -67,7 +67,7 @@ grow faster than they can process it. Unlike with services, which aurora will always re-execute regardless of exit status, instances of cron jobs retry according to the `max_task_failures` attribute of the -[Task](/documentation/0.7.0-incubating//) object. To get "run-until-failure" semantics, +[Task](/documentation/0.7.0-incubating/configuration-reference/#task-objects) object. To get "run-until-failure" semantics, set `max_task_failures` to `-1`. ## Interacting with cron jobs via the Aurora CLI Modified: aurora/site/source/documentation/0.7.0-incubating/deploying-aurora-scheduler.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.7.0-incubating/deploying-aurora-scheduler.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.7.0-incubating/deploying-aurora-scheduler.md (original) +++ aurora/site/source/documentation/0.7.0-incubating/deploying-aurora-scheduler.md Sun Dec 13 00:49:43 2015 @@ -113,7 +113,7 @@ should be set to `2`, and in a cluster o *Incorrectly setting this flag will cause data corruption to occur!* -See [this document](/documentation/0.7.0-incubating//) for more replicated +See [this document](/documentation/0.7.0-incubating/storage-config/#scheduler-storage-configuration-flags) for more replicated log and storage configuration options. ## Initializing the Replicated Log @@ -127,7 +127,7 @@ Failing to do this will result the follo ### Storage Performance Considerations -See [this document](/documentation/0.7.0-incubating//) for scheduler storage performance considerations. +See [this document](/documentation/0.7.0-incubating/scheduler-storage/) for scheduler storage performance considerations. ### Network considerations The Aurora scheduler listens on 2 ports - an HTTP port used for client RPCs and a web UI, @@ -179,7 +179,7 @@ assuming you set `-http_port=8081`. ### Maintaining an Aurora Installation ### Monitoring -Please see our dedicated [monitoring guide](/documentation/0.7.0-incubating//) for in-depth discussion on monitoring. +Please see our dedicated [monitoring guide](/documentation/0.7.0-incubating/monitoring/) for in-depth discussion on monitoring. ### Running stateful services Aurora is best suited to run stateless applications, but it also accommodates for stateful services @@ -190,7 +190,7 @@ The Mesos slave has the `--attributes` c static attributes (not to be confused with `--resources`, which are dynamic and accounted). Aurora makes these attributes available for matching with scheduling -[constraints](/documentation/0.7.0-incubating//). Most of these +[constraints](/documentation/0.7.0-incubating/configuration-reference/#specifying-scheduling-constraints). Most of these constraints are arbitrary and available for custom use. There is one exception, though: the `dedicated` attribute. Aurora treats this specially, and only allows matching jobs to run on these machines, and will only schedule matching jobs on these machines. Modified: aurora/site/source/documentation/0.7.0-incubating/developing-aurora-client.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.7.0-incubating/developing-aurora-client.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.7.0-incubating/developing-aurora-client.md (original) +++ aurora/site/source/documentation/0.7.0-incubating/developing-aurora-client.md Sun Dec 13 00:49:43 2015 @@ -9,9 +9,9 @@ Client Configuration The client uses a configuration file that specifies available clusters. More information about the contents of this file can be found in the -[Client Cluster Configuration](/documentation/0.7.0-incubating//) documentation. Information about +[Client Cluster Configuration](/documentation/0.7.0-incubating/client-cluster-configuration/) documentation. Information about how the client locates this file can be found in the -[Client Commands](/documentation/0.7.0-incubating//) documentation. +[Client Commands](/documentation/0.7.0-incubating/client-commands/#cluster-configuration) documentation. Building and Testing the Client =============================== Modified: aurora/site/source/documentation/0.7.0-incubating/index.html.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.7.0-incubating/index.html.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.7.0-incubating/index.html.md (original) +++ aurora/site/source/documentation/0.7.0-incubating/index.html.md Sun Dec 13 00:49:43 2015 @@ -8,26 +8,26 @@ Apache Aurora is a service scheduler tha This documentation is a work in progress, and we encourage you to ask questions on the [Aurora developer list](http://aurora.incubator.apache.org/community/) or the `#aurora` IRC channel on `irc.freenode.net`. ## Users - * [Install Aurora on virtual machines on your private machine](/documentation/0.7.0-incubating//) - * [Hello World Tutorial](/documentation/0.7.0-incubating//) - * [User Guide](/documentation/0.7.0-incubating//) - * [Configuration Tutorial](/documentation/0.7.0-incubating//) - * [Aurora + Thermos Reference](/documentation/0.7.0-incubating//) - * [Command Line Client](/documentation/0.7.0-incubating//) - * [Cron Jobs](/documentation/0.7.0-incubating//) + * [Install Aurora on virtual machines on your private machine](/documentation/0.7.0-incubating/vagrant/) + * [Hello World Tutorial](/documentation/0.7.0-incubating/tutorial/) + * [User Guide](/documentation/0.7.0-incubating/user-guide/) + * [Configuration Tutorial](/documentation/0.7.0-incubating/configuration-tutorial/) + * [Aurora + Thermos Reference](/documentation/0.7.0-incubating/configuration-reference/) + * [Command Line Client](/documentation/0.7.0-incubating/client-commands/) + * [Cron Jobs](/documentation/0.7.0-incubating/cron-jobs/) ## Operators - * [Deploy Aurora](/documentation/0.7.0-incubating//) - * [Monitoring](/documentation/0.7.0-incubating//) - * [Hooks for Aurora Client API](/documentation/0.7.0-incubating//) - * [Scheduler Storage](/documentation/0.7.0-incubating//) - * [Scheduler Storage and Maintenance](/documentation/0.7.0-incubating//) - * [SLA Measurement](/documentation/0.7.0-incubating//) - * [Resource Isolation and Sizing](/documentation/0.7.0-incubating//) - * [Generating test resources](/documentation/0.7.0-incubating//) + * [Deploy Aurora](/documentation/0.7.0-incubating/deploying-aurora-scheduler/) + * [Monitoring](/documentation/0.7.0-incubating/monitoring/) + * [Hooks for Aurora Client API](/documentation/0.7.0-incubating/hooks/) + * [Scheduler Storage](/documentation/0.7.0-incubating/storage/) + * [Scheduler Storage and Maintenance](/documentation/0.7.0-incubating/storage-config/) + * [SLA Measurement](/documentation/0.7.0-incubating/sla/) + * [Resource Isolation and Sizing](/documentation/0.7.0-incubating/resource-isolation/) + * [Generating test resources](/documentation/0.7.0-incubating/test-resource-generation/) ## Developers - * [Contributing to the project](/documentation/0.7.0-incubating//) - * [Developing the Aurora Scheduler](/documentation/0.7.0-incubating//) - * [Developing the Aurora Client](/documentation/0.7.0-incubating//) - * [Committers Guide](/documentation/0.7.0-incubating//) + * [Contributing to the project](/documentation/0.7.0-incubating/CONTRIBUTING/) + * [Developing the Aurora Scheduler](/documentation/0.7.0-incubating/developing-aurora-scheduler/) + * [Developing the Aurora Client](/documentation/0.7.0-incubating/developing-aurora-client/) + * [Committers Guide](/documentation/0.7.0-incubating/committers/) Modified: aurora/site/source/documentation/0.7.0-incubating/storage-config.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.7.0-incubating/storage-config.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.7.0-incubating/storage-config.md (original) +++ aurora/site/source/documentation/0.7.0-incubating/storage-config.md Sun Dec 13 00:49:43 2015 @@ -22,7 +22,7 @@ This document summarizes Aurora storage configuration and maintenance details and is intended for use by anyone deploying and/or maintaining Aurora. -For a high level overview of the Aurora storage architecture refer to [this document](/documentation/0.7.0-incubating//). +For a high level overview of the Aurora storage architecture refer to [this document](/documentation/0.7.0-incubating/storage/). ## Scheduler storage configuration flags @@ -33,7 +33,7 @@ or require attention before deploying in #### -native_log_quorum_size Defines the Mesos replicated log quorum size. See -[the replicated log configuration document](/documentation/0.7.0-incubating//) +[the replicated log configuration document](/documentation/0.7.0-incubating/deploying-aurora-scheduler/#replicated-log-configuration) on how to choose the right value. #### -native_log_file_path Modified: aurora/site/source/documentation/0.7.0-incubating/storage.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.7.0-incubating/storage.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.7.0-incubating/storage.md (original) +++ aurora/site/source/documentation/0.7.0-incubating/storage.md Sun Dec 13 00:49:43 2015 @@ -33,7 +33,7 @@ is [thrift](https://github.com/apache/th This helps establishing periodic recovery checkpoints and speeds up volatile storage recovery on restart. * Backup manager: as a precaution, snapshots are periodically written out into backup files. -This solves a [disaster recovery problem](/documentation/0.7.0-incubating//) +This solves a [disaster recovery problem](/documentation/0.7.0-incubating/storage-config/#recovering-from-a-scheduler-backup) in case of a complete loss or corruption of Mesos log files.  Modified: aurora/site/source/documentation/0.7.0-incubating/test-resource-generation.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.7.0-incubating/test-resource-generation.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.7.0-incubating/test-resource-generation.md (original) +++ aurora/site/source/documentation/0.7.0-incubating/test-resource-generation.md Sun Dec 13 00:49:43 2015 @@ -20,6 +20,6 @@ that would undermine the goal of ensurin The most common reason to add a new checkpoint file would be to provide coverage for new thermos features that alter the data format. This is accomplished by writing and running a -[job configuration](/documentation/0.7.0-incubating//) that exercises the feature, and +[job configuration](/documentation/0.7.0-incubating/configuration-reference/) that exercises the feature, and copying the checkpoint file from the sandbox directory, by default this is `/var/run/thermos/checkpoints/<aurora task id>`. Modified: aurora/site/source/documentation/0.7.0-incubating/tutorial.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.7.0-incubating/tutorial.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.7.0-incubating/tutorial.md (original) +++ aurora/site/source/documentation/0.7.0-incubating/tutorial.md Sun Dec 13 00:49:43 2015 @@ -30,7 +30,7 @@ To get help, email questions to the Auro ## Setup: Install Aurora You use the Aurora client and web UI to interact with Aurora jobs. To -install it locally, see [vagrant.md](/documentation/0.7.0-incubating//). The remainder of this +install it locally, see [vagrant.md](/documentation/0.7.0-incubating/vagrant/). The remainder of this Tutorial assumes you are running Aurora using Vagrant. Unless otherwise stated, all commands are to be run from the root of the aurora repository clone. @@ -105,8 +105,8 @@ jobs = [ ``` For more about Aurora configuration files, see the [Configuration -Tutorial](/documentation/0.7.0-incubating//) and the [Aurora + Thermos -Reference](/documentation/0.7.0-incubating//) (preferably after finishing this +Tutorial](/documentation/0.7.0-incubating/configuration-tutorial/) and the [Aurora + Thermos +Reference](/documentation/0.7.0-incubating/configuration-reference/) (preferably after finishing this tutorial). ## What's Going On In That Configuration File? @@ -256,10 +256,10 @@ The job page now shows the `hello_world` Now that you've finished this Tutorial, you should read or do the following: -- [The Aurora Configuration Tutorial](/documentation/0.7.0-incubating//), which provides more examples +- [The Aurora Configuration Tutorial](/documentation/0.7.0-incubating/configuration-tutorial/), which provides more examples and best practices for writing Aurora configurations. You should also look at - the [Aurora + Thermos Configuration Reference](/documentation/0.7.0-incubating//). -- The [Aurora User Guide](/documentation/0.7.0-incubating//) provides an overview of how Aurora, Mesos, and + the [Aurora + Thermos Configuration Reference](/documentation/0.7.0-incubating/configuration-reference/). +- The [Aurora User Guide](/documentation/0.7.0-incubating/user-guide/) provides an overview of how Aurora, Mesos, and Thermos work "under the hood". - Explore the Aurora Client - use `aurora -h`, and read the - [Aurora Client Commands](/documentation/0.7.0-incubating//) document. + [Aurora Client Commands](/documentation/0.7.0-incubating/client-commands/) document. Modified: aurora/site/source/documentation/0.7.0-incubating/user-guide.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.7.0-incubating/user-guide.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.7.0-incubating/user-guide.md (original) +++ aurora/site/source/documentation/0.7.0-incubating/user-guide.md Sun Dec 13 00:49:43 2015 @@ -21,7 +21,7 @@ Overview This document gives an overview of how Aurora works under the hood. It assumes you've already worked through the "hello world" example -job in the [Aurora Tutorial](/documentation/0.7.0-incubating//). Specifics of how to use Aurora are **not** +job in the [Aurora Tutorial](/documentation/0.7.0-incubating/tutorial/). Specifics of how to use Aurora are **not** given here, but pointers to documentation about how to use Aurora are provided. @@ -212,7 +212,7 @@ requests: | `POST /abortabortabort` | Final warning task is being killed. | Please see the -[configuration reference](/documentation/0.7.0-incubating//) for +[configuration reference](/documentation/0.7.0-incubating/configuration-reference/#healthcheckconfig-objects) for configuration options for this feature. #### Snoozing Health Checks @@ -292,8 +292,8 @@ Aurora configuration files. Their filena suffix, and you write them in Python making use of the Pystachio templating language, along with specific Aurora, Mesos, and Thermos commands and methods. See the -[Configuration Guide and Reference](/documentation/0.7.0-incubating//) and -[Configuration Tutorial](/documentation/0.7.0-incubating//). +[Configuration Guide and Reference](/documentation/0.7.0-incubating/configuration-reference/) and +[Configuration Tutorial](/documentation/0.7.0-incubating/configuration-tutorial/). Service Discovery ----------------- @@ -308,14 +308,14 @@ of which there are several reference imp These can also be used natively in Finagle using the [ZookeeperServerSetCluster](https://github.com/twitter/finagle/blob/master/finagle-serversets/src/main/scala/com/twitter/finagle/zookeeper/ZookeeperServerSetCluster.scala). -For more information about how to configure announcing, see the [Configuration Reference](/documentation/0.7.0-incubating//). +For more information about how to configure announcing, see the [Configuration Reference](/documentation/0.7.0-incubating/configuration-reference/). Creating Jobs ------------- You create and manipulate Aurora Jobs with the Aurora client, which starts all its command line commands with -`aurora`. See [Aurora Client Commands](/documentation/0.7.0-incubating//) for details +`aurora`. See [Aurora Client Commands](/documentation/0.7.0-incubating/client-commands/) for details about the Aurora Client. Interacting With Jobs @@ -352,4 +352,4 @@ You interact with Aurora jobs either via - The Aurora client - See [client commands](/documentation/0.7.0-incubating//). + See [client commands](/documentation/0.7.0-incubating/client-commands/). Modified: aurora/site/source/documentation/0.8.0/client-commands.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.8.0/client-commands.md?rev=1719756&r1=1719755&r2=1719756&view=diff ============================================================================== --- aurora/site/source/documentation/0.8.0/client-commands.md (original) +++ aurora/site/source/documentation/0.8.0/client-commands.md Sun Dec 13 00:49:43 2015 @@ -84,7 +84,7 @@ A configuration for a leader-elected sch ``` For more details on cluster configuration see the -[Client Cluster Configuration](/documentation/0.8.0//) documentation. +[Client Cluster Configuration](/documentation/0.8.0/client-cluster-configuration/) documentation. Job Keys -------- @@ -130,7 +130,7 @@ Hooks can be associated with these Auror - `job update` The process for writing and activating them is complex enough -that we explain it in a devoted document, [Hooks for Aurora Client API](/documentation/0.8.0//). +that we explain it in a devoted document, [Hooks for Aurora Client API](/documentation/0.8.0/hooks/). Regular Jobs ------------ @@ -203,7 +203,7 @@ pulsing an active coordinated job update [pulseJobUpdate RPC](https://github.com/apache/aurora/blob/#{git_tag}/api/src/main/thrift/org/apache/aurora/gen/api.thrift)). A coordinated update is defined by setting a positive -[pulse_interval_secs](/documentation/0.8.0//) value in job configuration +[pulse_interval_secs](/documentation/0.8.0/configuration-reference/#updateconfig-objects) value in job configuration file. If no pulses are received within specified interval the update will be blocked. A blocked update is unable to continue rolling forward (or rolling back) but retains its active status. It may only be unblocked by a fresh `pulseJobUpdate` call. @@ -294,7 +294,7 @@ Cron Jobs --------- You can manage cron jobs using the `aurora cron` command. Please see -[cron-jobs.md](/documentation/0.8.0//) for more details. +[cron-jobs.md](/documentation/0.8.0/cron-jobs/) for more details. You will see various commands and options relating to cron jobs in `aurora -h` and similar. Ignore them, as they're not yet implemented.
