You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@aurora.apache.org by se...@apache.org on 2016/03/30 21:49:12 UTC
aurora git commit: Various minor documentation fixes. Most of them
dead links.
Repository: aurora
Updated Branches:
refs/heads/master c3a3e5ccb -> bc4649ea1
Various minor documentation fixes. Most of them dead links.
Reviewed at https://reviews.apache.org/r/45444/
Project: http://git-wip-us.apache.org/repos/asf/aurora/repo
Commit: http://git-wip-us.apache.org/repos/asf/aurora/commit/bc4649ea
Tree: http://git-wip-us.apache.org/repos/asf/aurora/tree/bc4649ea
Diff: http://git-wip-us.apache.org/repos/asf/aurora/diff/bc4649ea
Branch: refs/heads/master
Commit: bc4649ea1502b83dc4b88a43b10e33214dbaa98f
Parents: c3a3e5c
Author: Stephan Erb <se...@apache.org>
Authored: Wed Mar 30 21:48:50 2016 +0200
Committer: Stephan Erb <st...@dev.static-void.de>
Committed: Wed Mar 30 21:48:50 2016 +0200
----------------------------------------------------------------------
docs/README.md | 4 ++--
docs/development/client.md | 2 +-
docs/development/committers-guide.md | 4 ++--
docs/development/scheduler.md | 4 ++--
docs/features/constraints.md | 4 ++--
docs/features/containers.md | 2 +-
docs/features/cron-jobs.md | 2 +-
docs/getting-started/tutorial.md | 4 ++--
docs/operations/installation.md | 2 +-
docs/reference/configuration-tutorial.md | 4 ++--
docs/reference/configuration.md | 10 +++++-----
docs/reference/scheduler-configuration.md | 2 +-
12 files changed, 22 insertions(+), 22 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/aurora/blob/bc4649ea/docs/README.md
----------------------------------------------------------------------
diff --git a/docs/README.md b/docs/README.md
index 50eb7b2..aea8518 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -45,7 +45,7 @@ The complete reference of commands, configuration options, and scheduler interna
* Configuration (`.aurora` files)
- [Configuration Reference](reference/configuration.md)
- [Configuration Tutorial](reference/configuration-tutorial.md)
- - [Configuration Best Practices](reference/configuration-best-bractices.md)
+ - [Configuration Best Practices](reference/configuration-best-practices.md)
- [Configuration Templating](reference/configuration-templating.md)
* Aurora Client
- [Client Commands](reference/client-commands.md)
@@ -62,7 +62,7 @@ All the information you need to start modifying Aurora and contributing back to
* [Contributing to the project](../CONTRIBUTING.md)
* [Committer's Guide](development/committers-guide.md)
- * [Design Documents](design-documents.md)
+ * [Design Documents](development/design-documents.md)
* Developing the Aurora components:
- [Client](development/client.md)
- [Scheduler](development/scheduler.md)
http://git-wip-us.apache.org/repos/asf/aurora/blob/bc4649ea/docs/development/client.md
----------------------------------------------------------------------
diff --git a/docs/development/client.md b/docs/development/client.md
index a5fee37..7d0c230 100644
--- a/docs/development/client.md
+++ b/docs/development/client.md
@@ -12,7 +12,7 @@ Building and testing the client code are both done using Pants. The relevant tar
are:
* Build a client executable: `./pants binary src/main/python/apache/aurora/client:aurora`
- * Test client code: `./pants test src/test/python/apache/aurora/client/cli:all`
+ * Test client code: `./pants test src/test/python/apache/aurora/client/cli:cli`
If you want to build a source distribution of the client, you need to run `./build-support/release/make-python-sdists`.
http://git-wip-us.apache.org/repos/asf/aurora/blob/bc4649ea/docs/development/committers-guide.md
----------------------------------------------------------------------
diff --git a/docs/development/committers-guide.md b/docs/development/committers-guide.md
index 70f67a6..309a652 100644
--- a/docs/development/committers-guide.md
+++ b/docs/development/committers-guide.md
@@ -8,11 +8,11 @@ Setting up your email account
Once your Apache ID has been set up you can configure your account and add ssh keys and setup an
email forwarding address at
- http://id.apache.org
+ http://id.apache.org
Additional instructions for setting up your new committer email can be found at
- http://www.apache.org/dev/user-email.html
+ http://www.apache.org/dev/user-email.html
The recommended setup is to configure all services (mailing lists, JIRA, ReviewBoard) to send
emails to your @apache.org email address.
http://git-wip-us.apache.org/repos/asf/aurora/blob/bc4649ea/docs/development/scheduler.md
----------------------------------------------------------------------
diff --git a/docs/development/scheduler.md b/docs/development/scheduler.md
index 66d0857..a26dfad 100644
--- a/docs/development/scheduler.md
+++ b/docs/development/scheduler.md
@@ -104,8 +104,8 @@ Developing the Aurora Build System
Bootstrapping Gradle
--------------------
-The following files were autogenerated by `gradle wrapper` using gradle 1.8's
-[Wrapper](http://www.gradle.org/docs/1.8/dsl/org.gradle.api.tasks.wrapper.Wrapper.html) plugin and
+The following files were autogenerated by `gradle wrapper` using gradle's
+[Wrapper](http://www.gradle.org/docs/current/dsl/org.gradle.api.tasks.wrapper.Wrapper.html) plugin and
should not be modified directly:
./gradlew
http://git-wip-us.apache.org/repos/asf/aurora/blob/bc4649ea/docs/features/constraints.md
----------------------------------------------------------------------
diff --git a/docs/features/constraints.md b/docs/features/constraints.md
index ef2f664..2a6a15e 100644
--- a/docs/features/constraints.md
+++ b/docs/features/constraints.md
@@ -50,7 +50,7 @@ most one task per rack:
Use these constraints sparingly as they can dramatically reduce Tasks' schedulability.
Further details are available in the reference documentation on
-[Scheduling Constraints](#specifying-scheduling-constraints).
+[Scheduling Constraints](../reference/configuration.md#specifying-scheduling-constraints).
@@ -72,7 +72,7 @@ scheduled on nodes that claim to have an `SSD` as their disk.
Further details are available in the reference documentation on
-[Scheduling Constraints](#specifying-scheduling-constraints).
+[Scheduling Constraints](../reference/configuration.md#specifying-scheduling-constraints).
Running stateful services
http://git-wip-us.apache.org/repos/asf/aurora/blob/bc4649ea/docs/features/containers.md
----------------------------------------------------------------------
diff --git a/docs/features/containers.md b/docs/features/containers.md
index a0fd4ac..0d4791f 100644
--- a/docs/features/containers.md
+++ b/docs/features/containers.md
@@ -40,4 +40,4 @@ Example (available in the [Vagrant environment](../getting-started/vagrant.md)):
In order to correctly execute processes inside a job, the docker container must have Python 2.7
installed. Further details of how to use Docker can be found in the
-[Reference Documentation](..reference/configuration.md#docker-object).
+[Reference Documentation](../reference/configuration.md#docker-object).
http://git-wip-us.apache.org/repos/asf/aurora/blob/bc4649ea/docs/features/cron-jobs.md
----------------------------------------------------------------------
diff --git a/docs/features/cron-jobs.md b/docs/features/cron-jobs.md
index 8a864e9..3a3edea 100644
--- a/docs/features/cron-jobs.md
+++ b/docs/features/cron-jobs.md
@@ -58,7 +58,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](../reference/configuration.md#task-objects) object. To get "run-until-success" semantics,
+[Task](../reference/configuration.md#task-object) object. To get "run-until-success" semantics,
set `max_task_failures` to `-1`.
## Interacting with cron jobs via the Aurora CLI
http://git-wip-us.apache.org/repos/asf/aurora/blob/bc4649ea/docs/getting-started/tutorial.md
----------------------------------------------------------------------
diff --git a/docs/getting-started/tutorial.md b/docs/getting-started/tutorial.md
index dd3ac0a..94fdc38 100644
--- a/docs/getting-started/tutorial.md
+++ b/docs/getting-started/tutorial.md
@@ -106,8 +106,8 @@ local sandbox in which it will run. It then specifies how the code is
actually run once the second Process starts.
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](../reference/configuration-tutorial.md) and the [Configuration
+Reference](../reference/configuration.md) (preferably after finishing this
tutorial).
http://git-wip-us.apache.org/repos/asf/aurora/blob/bc4649ea/docs/operations/installation.md
----------------------------------------------------------------------
diff --git a/docs/operations/installation.md b/docs/operations/installation.md
index 739c322..f026c01 100644
--- a/docs/operations/installation.md
+++ b/docs/operations/installation.md
@@ -279,7 +279,7 @@ stumbling blocks and solutions here to help get you moving.
#### Solution
When you create a new cluster, you need to inform a quorum of schedulers that they are safe to
-consider their database to be empty by [initializing](#initializing-the-replicated-log) the
+consider their database to be empty by [initializing](#finalizing) the
replicated log. This is done to prevent the scheduler from modifying the cluster state in the event
of multiple simultaneous disk failures or, more likely, misconfiguration of the replicated log path.
http://git-wip-us.apache.org/repos/asf/aurora/blob/bc4649ea/docs/reference/configuration-tutorial.md
----------------------------------------------------------------------
diff --git a/docs/reference/configuration-tutorial.md b/docs/reference/configuration-tutorial.md
index 4390cd6..c40022b 100644
--- a/docs/reference/configuration-tutorial.md
+++ b/docs/reference/configuration-tutorial.md
@@ -52,8 +52,8 @@ configuration specification and reuse. Pystachio objects are tailored
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
+well as any objects shown in the [*Aurora Configuration
+Reference*](configuration.md), without `import` statements - the
Aurora config loader injects them automatically. Other than that, an `.aurora`
file works like any other Python script.
http://git-wip-us.apache.org/repos/asf/aurora/blob/bc4649ea/docs/reference/configuration.md
----------------------------------------------------------------------
diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md
index fa09fd4..c9459fe 100644
--- a/docs/reference/configuration.md
+++ b/docs/reference/configuration.md
@@ -337,14 +337,14 @@ 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](../features/cron-jobs.md) 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``` | ```UpdateConfig``` 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)
+ ```constraints``` | dict | Scheduling constraints for the tasks. See the section on the [constraint specification language](#specifying-scheduling-constraints)
```service``` | Boolean | If True, restart tasks regardless of success or failure. (Default: False)
```max_task_failures``` | Integer | Maximum number of failures after which the task is considered to have failed (Default: 1) Set to -1 to allow for infinite failures
```priority``` | Integer | Preemption priority to give the task (Default 0). Tasks with higher priorities may preempt tasks at lower priorities.
- ```production``` | Boolean | Whether or not this is a production task that may [preempt](resources.md#task-preemption) other tasks (Default: False). Production job role must have the appropriate [quota](resources.md#resource-quota).
+ ```production``` | Boolean | Whether or not this is a production task that may [preempt](../features/multitenancy.md#preemption) other tasks (Default: False). Production job role must have the appropriate [quota](../features/multitenancy.md#preemption).
```health_check_config``` | ```HealthCheckConfig``` object | Parameters for controlling a task's health checks. HTTP health check is only used if a health port was assigned with a command line wildcard.
```container``` | ```Container``` object | An optional container to run all processes inside of.
```lifecycle``` | ```LifecycleConfig``` object | An optional task lifecycle configuration that dictates commands to be executed on startup/teardown. HTTP lifecycle is enabled by default if the "health" port is requested. See [LifecycleConfig Objects](#lifecycleconfig-objects) for more information.
@@ -363,7 +363,7 @@ Parameters for controlling the rate and policy of rolling updates.
| ```max_total_failures``` | Integer | Maximum number of shard failures to be tolerated in total during an update. Cannot be greater than or equal to the total number of tasks in a job. (Default: 0)
| ```rollback_on_failure``` | boolean | When False, prevents auto rollback of a failed update (Default: True)
| ```wait_for_batch_completion```| boolean | When True, all threads from a given batch will be blocked from picking up new instances until the entire batch is updated. This essentially simulates the legacy sequential updater algorithm. (Default: False)
-| ```pulse_interval_secs``` | Integer | Indicates a [coordinated update](client-commands.md#user-content-coordinated-job-updates). If no pulses are received within the provided interval the update will be blocked. Beta-updater only. Will fail on submission when used with client updater. (Default: None)
+| ```pulse_interval_secs``` | Integer | Indicates a [coordinated update](../features/job-updates.md#coordinated-job-updates). If no pulses are received within the provided interval the update will be blocked. Beta-updater only. Will fail on submission when used with client updater. (Default: None)
### HealthCheckConfig Objects
@@ -524,7 +524,7 @@ constraints*.
| Limit | A string that specifies a limit for a constraint. Starts with <code>'limit:</code> followed by an Integer and closing single quote, such as ```'limit:1'```.
| Value | A string that specifies a value for a constraint. To include a list of values, separate the values using commas. To negate the values of a constraint, start with a ```!``` ```.```
-Further details can be found in the [Scheduling Constraints](../features/constraints) feature
+Further details can be found in the [Scheduling Constraints](../features/constraints.md) feature
description.
http://git-wip-us.apache.org/repos/asf/aurora/blob/bc4649ea/docs/reference/scheduler-configuration.md
----------------------------------------------------------------------
diff --git a/docs/reference/scheduler-configuration.md b/docs/reference/scheduler-configuration.md
index 0b1e3c7..9945531 100644
--- a/docs/reference/scheduler-configuration.md
+++ b/docs/reference/scheduler-configuration.md
@@ -1,4 +1,4 @@
-# Scheduler Configuration
+# Scheduler Configuration Reference
The Aurora scheduler can take a variety of configuration options through command-line arguments.
A list of the available options can be seen by running `aurora-scheduler -help`.