Added: aurora/site/publish/documentation/latest/reference/scheduler-configuration/index.html URL: http://svn.apache.org/viewvc/aurora/site/publish/documentation/latest/reference/scheduler-configuration/index.html?rev=1739120&view=auto ============================================================================== --- aurora/site/publish/documentation/latest/reference/scheduler-configuration/index.html (added) +++ aurora/site/publish/documentation/latest/reference/scheduler-configuration/index.html Thu Apr 14 14:20:54 2016 @@ -0,0 +1,332 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <title>Apache Aurora</title> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css";> + <link href="/assets/css/main.css" rel="stylesheet"> + <!-- Analytics --> + <script type="text/javascript"> + var _gaq = _gaq || []; + _gaq.push(['_setAccount', 'UA-45879646-1']); + _gaq.push(['_setDomainName', 'apache.org']); + _gaq.push(['_trackPageview']); + + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); + })(); + </script> + </head> + <body> + <div class="container-fluid section-header"> + <div class="container"> + <div class="nav nav-bar"> + <a href="/"><img src="/assets/img/aurora_logo_dkbkg.svg" width="300" alt="Transparent Apache Aurora logo with dark background"/></a> + <ul class="nav navbar-nav navbar-right"> + <li><a href="/documentation/latest/">Documentation</a></li> + <li><a href="/community/">Community</a></li> + <li><a href="/downloads/">Downloads</a></li> + <li><a href="/blog/">Blog</a></li> + </ul> + </div> + </div> +</div> + + <div class="container-fluid"> + <div class="container content"> + <div class="col-md-12 documentation"> +<h5 class="page-header text-uppercase">Documentation +<select onChange="window.location.href='/documentation/' + this.value + '/reference/scheduler-configuration/'" + value="latest"> + <option value="0.12.0" + > + 0.12.0 + (latest) + </option> + <option value="0.11.0" + > + 0.11.0 + </option> + <option value="0.10.0" + > + 0.10.0 + </option> + <option value="0.9.0" + > + 0.9.0 + </option> + <option value="0.8.0" + > + 0.8.0 + </option> + <option value="0.7.0-incubating" + > + 0.7.0-incubating + </option> + <option value="0.6.0-incubating" + > + 0.6.0-incubating + </option> + <option value="0.5.0-incubating" + > + 0.5.0-incubating + </option> +</select> +</h5> +<h1 id="scheduler-configuration-reference">Scheduler Configuration Reference</h1> + +<p>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 <code>aurora-scheduler -help</code>.</p> + +<p>Please refer to the <a href="../operations/configuration.md">Operator Configuration Guide</a> for details on how +to properly set the most important options.</p> +<pre class="highlight plaintext"><code>$ aurora-scheduler -help +------------------------------------------------------------------------- +-h or -help to print this help message + +Required flags: +-backup_dir [not null] + Directory to store backups under. Will be created if it does not exist. +-cluster_name [not null] + Name to identify the cluster being served. +-framework_authentication_file + Properties file which contains framework credentials to authenticate with Mesosmaster. Must contain the properties 'aurora_authentication_principal' and 'aurora_authentication_secret'. +-mesos_master_address [not null] + Address for the mesos master, can be a socket address or zookeeper path. +-mesos_role + The Mesos role this framework will register as. The default is to left this empty, and the framework will register without any role and only receive unreserved resources in offer. +-serverset_path [not null, must be non-empty] + ZooKeeper ServerSet path to register at. +-shiro_after_auth_filter + Fully qualified class name of the servlet filter to be applied after the shiro auth filters are applied. +-thermos_executor_path + Path to the thermos executor entry point. +-tier_config [file must be readable] + Configuration file defining supported task tiers, task traits and behaviors. +-zk_digest_credentials + user:password to use when authenticating with ZooKeeper. +-zk_endpoints [must have at least 1 item] + Endpoint specification for the ZooKeeper servers. + +Optional flags: +-allow_docker_parameters (default false) + Allow to pass docker container parameters in the job. +-allowed_container_types (default [MESOS]) + Container types that are allowed to be used by jobs. +-async_slot_stat_update_interval (default (1, mins)) + Interval on which to try to update open slot stats. +-async_task_stat_update_interval (default (1, hrs)) + Interval on which to try to update resource consumption stats. +-async_worker_threads (default 8) + The number of worker threads to process async task operations with. +-backup_interval (default (1, hrs)) + Minimum interval on which to write a storage backup. +-cron_scheduler_num_threads (default 100) + Number of threads to use for the cron scheduler thread pool. +-cron_start_initial_backoff (default (1, secs)) + Initial backoff delay while waiting for a previous cron run to be killed. +-cron_start_max_backoff (default (1, mins)) + Max backoff delay while waiting for a previous cron run to be killed. +-cron_timezone (default GMT) + TimeZone to use for cron predictions. +-custom_executor_config [file must exist, file must be readable] + Path to custom executor settings configuration file. +-db_lock_timeout (default (1, mins)) + H2 table lock timeout +-db_row_gc_interval (default (2, hrs)) + Interval on which to scan the database for unused row references. +-default_docker_parameters (default {}) + Default docker parameters for any job that does not explicitly declare parameters. +-dlog_max_entry_size (default (512, KB)) + Specifies the maximum entry size to append to the log. Larger entries will be split across entry Frames. +-dlog_shutdown_grace_period (default (2, secs)) + Specifies the maximum time to wait for scheduled checkpoint and snapshot actions to complete before forcibly shutting down. +-dlog_snapshot_interval (default (1, hrs)) + Specifies the frequency at which snapshots of local storage are taken and written to the log. +-enable_cors_for + List of domains for which CORS support should be enabled. +-enable_h2_console (default false) + Enable H2 DB management console. +-enable_preemptor (default true) + Enable the preemptor and preemption +-executor_user (default root) + User to start the executor. Defaults to "root". Set this to an unprivileged user if the mesos master was started with "--no-root_submissions". If set to anything other than "root", the executor will ignore the "role" setting for jobs since it can't use setuid() anymore. This means that all your jobs will run under the specified user and the user has to exist on the mesos slaves. +-first_schedule_delay (default (1, ms)) + Initial amount of time to wait before first attempting to schedule a PENDING task. +-flapping_task_threshold (default (5, mins)) + A task that repeatedly runs for less than this time is considered to be flapping. +-framework_announce_principal (default false) + When 'framework_authentication_file' flag is set, the FrameworkInfo registered with the mesos master will also contain the principal. This is necessary if you intend to use mesos authorization via mesos ACLs. The default will change in a future release. +-framework_failover_timeout (default (21, days)) + Time after which a framework is considered deleted. SHOULD BE VERY HIGH. +-global_container_mounts (default []) + A comma separated list of mount points (in host:container form) to mount into all (non-mesos) containers. +-history_max_per_job_threshold (default 100) + Maximum number of terminated tasks to retain in a job history. +-history_min_retention_threshold (default (1, hrs)) + Minimum guaranteed time for task history retention before any pruning is attempted. +-history_prune_threshold (default (2, days)) + Time after which the scheduler will prune terminated task history. +-hostname + The hostname to advertise in ZooKeeper instead of the locally-resolved hostname. +-http_authentication_mechanism (default NONE) + HTTP Authentication mechanism to use. +-http_port (default 0) + The port to start an HTTP server on. Default value will choose a random port. +-initial_flapping_task_delay (default (30, secs)) + Initial amount of time to wait before attempting to schedule a flapping task. +-initial_schedule_penalty (default (1, secs)) + Initial amount of time to wait before attempting to schedule a task that has failed to schedule. +-initial_task_kill_retry_interval (default (5, secs)) + When killing a task, retry after this delay if mesos has not responded, backing off up to transient_task_state_timeout +-job_update_history_per_job_threshold (default 10) + Maximum number of completed job updates to retain in a job update history. +-job_update_history_pruning_interval (default (15, mins)) + Job update history pruning interval. +-job_update_history_pruning_threshold (default (30, days)) + Time after which the scheduler will prune completed job update history. +-kerberos_debug (default false) + Produce additional Kerberos debugging output. +-kerberos_server_keytab + Path to the server keytab. +-kerberos_server_principal + Kerberos server principal to use, usually of the form HTTP/[email protected] +-max_flapping_task_delay (default (5, mins)) + Maximum delay between attempts to schedule a flapping task. +-max_leading_duration (default (1, days)) + After leading for this duration, the scheduler should commit suicide. +-max_registration_delay (default (1, mins)) + Max allowable delay to allow the driver to register before aborting +-max_reschedule_task_delay_on_startup (default (30, secs)) + Upper bound of random delay for pending task rescheduling on scheduler startup. +-max_saved_backups (default 48) + Maximum number of backups to retain before deleting the oldest backups. +-max_schedule_attempts_per_sec (default 40.0) + Maximum number of scheduling attempts to make per second. +-max_schedule_penalty (default (1, mins)) + Maximum delay between attempts to schedule a PENDING tasks. +-max_status_update_batch_size (default 1000) [must be > 0] + The maximum number of status updates that can be processed in a batch. +-max_tasks_per_job (default 4000) [must be > 0] + Maximum number of allowed tasks in a single job. +-max_update_instance_failures (default 20000) [must be > 0] + Upper limit on the number of failures allowed during a job update. This helps cap potentially unbounded entries into storage. +-min_offer_hold_time (default (5, mins)) + Minimum amount of time to hold a resource offer before declining. +-native_log_election_retries (default 20) + The maximum number of attempts to obtain a new log writer. +-native_log_election_timeout (default (15, secs)) + The timeout for a single attempt to obtain a new log writer. +-native_log_file_path + Path to a file to store the native log data in. If the parent directory doesnot exist it will be created. +-native_log_quorum_size (default 1) + The size of the quorum required for all log mutations. +-native_log_read_timeout (default (5, secs)) + The timeout for doing log reads. +-native_log_write_timeout (default (3, secs)) + The timeout for doing log appends and truncations. +-native_log_zk_group_path + A zookeeper node for use by the native log to track the master coordinator. +-offer_hold_jitter_window (default (1, mins)) + Maximum amount of random jitter to add to the offer hold time window. +-offer_reservation_duration (default (3, mins)) + Time to reserve a slave's offers while trying to satisfy a task preempting another. +-populate_discovery_info (default false) + If true, Aurora populates DiscoveryInfo field of Mesos TaskInfo. +-preemption_delay (default (3, mins)) + Time interval after which a pending task becomes eligible to preempt other tasks +-preemption_slot_hold_time (default (5, mins)) + Time to hold a preemption slot found before it is discarded. +-preemption_slot_search_interval (default (1, mins)) + Time interval between pending task preemption slot searches. +-receive_revocable_resources (default false) + Allows receiving revocable resource offers from Mesos. +-reconciliation_explicit_interval (default (60, mins)) + Interval on which scheduler will ask Mesos for status updates of all non-terminal tasks known to scheduler. +-reconciliation_implicit_interval (default (60, mins)) + Interval on which scheduler will ask Mesos for status updates of all non-terminal tasks known to Mesos. +-reconciliation_initial_delay (default (1, mins)) + Initial amount of time to delay task reconciliation after scheduler start up. +-reconciliation_schedule_spread (default (30, mins)) + Difference between explicit and implicit reconciliation intervals intended to create a non-overlapping task reconciliation schedule. +-require_docker_use_executor (default true) + If false, Docker tasks may run without an executor (EXPERIMENTAL) +-shiro_ini_path + Path to shiro.ini for authentication and authorization configuration. +-shiro_realm_modules (default [org.apache.aurora.scheduler.app.MoreModules$1@2d3379b4]) + Guice modules for configuring Shiro Realms. +-sla_non_prod_metrics (default []) + Metric categories collected for non production tasks. +-sla_prod_metrics (default [JOB_UPTIMES, PLATFORM_UPTIME, MEDIANS]) + Metric categories collected for production tasks. +-sla_stat_refresh_interval (default (1, mins)) + The SLA stat refresh interval. +-slow_query_log_threshold (default (25, ms)) + Log all queries that take at least this long to execute. +-slow_query_log_threshold (default (25, ms)) + Log all queries that take at least this long to execute. +-stat_retention_period (default (1, hrs)) + Time for a stat to be retained in memory before expiring. +-stat_sampling_interval (default (1, secs)) + Statistic value sampling interval. +-thermos_executor_cpu (default 0.25) + The number of CPU cores to allocate for each instance of the executor. +-thermos_executor_flags + Extra arguments to be passed to the thermos executor +-thermos_executor_ram (default (128, MB)) + The amount of RAM to allocate for each instance of the executor. +-thermos_executor_resources (default []) + A comma separated list of additional resources to copy into the sandbox.Note: if thermos_executor_path is not the thermos_executor.pex file itself, this must include it. +-thermos_home_in_sandbox (default false) + If true, changes HOME to the sandbox before running the executor. This primarily has the effect of causing the executor and runner to extract themselves into the sandbox. +-thermos_observer_root (default /var/run/thermos) + Path to the thermos observer root (by default /var/run/thermos.) +-transient_task_state_timeout (default (5, mins)) + The amount of time after which to treat a task stuck in a transient state as LOST. +-use_beta_db_task_store (default false) + Whether to use the experimental database-backed task store. +-viz_job_url_prefix (default ) + URL prefix for job container stats. +-zk_chroot_path + chroot path to use for the ZooKeeper connections +-zk_in_proc (default false) + Launches an embedded zookeeper server for local testing causing -zk_endpoints to be ignored if specified. +-zk_session_timeout (default (4, secs)) + The ZooKeeper session timeout. +------------------------------------------------------------------------- +</code></pre> + +</div> + + </div> + </div> + <div class="container-fluid section-footer buffer"> + <div class="container"> + <div class="row"> + <div class="col-md-2 col-md-offset-1"><h3>Quick Links</h3> + <ul> + <li><a href="/downloads/">Downloads</a></li> + <li><a href="/community/">Mailing Lists</a></li> + <li><a href="http://issues.apache.org/jira/browse/AURORA";>Issue Tracking</a></li> + <li><a href="/documentation/latest/contributing/">How To Contribute</a></li> + </ul> + </div> + <div class="col-md-2"><h3>The ASF</h3> + <ul> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + </ul> + </div> + <div class="col-md-6"> + <p class="disclaimer">Copyright 2014 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. The <a href="https://www.flickr.com/photos/trondk/12706051375/";>Aurora Borealis IX photo</a> displayed on the homepage is available under a <a href="https://creativecommons.org/licenses/by-nc-nd/2.0/";>Creative Commons BY-NC-ND 2.0 license</a>. Apache, Apache Aurora, and the Apache feather logo are trademarks of The Apache Software Foundation.</p> + </div> + </div> + </div> + + </body> +</html>
Added: aurora/site/publish/documentation/latest/reference/scheduler-endpoints/index.html URL: http://svn.apache.org/viewvc/aurora/site/publish/documentation/latest/reference/scheduler-endpoints/index.html?rev=1739120&view=auto ============================================================================== --- aurora/site/publish/documentation/latest/reference/scheduler-endpoints/index.html (added) +++ aurora/site/publish/documentation/latest/reference/scheduler-endpoints/index.html Thu Apr 14 14:20:54 2016 @@ -0,0 +1,132 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <title>Apache Aurora</title> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css";> + <link href="/assets/css/main.css" rel="stylesheet"> + <!-- Analytics --> + <script type="text/javascript"> + var _gaq = _gaq || []; + _gaq.push(['_setAccount', 'UA-45879646-1']); + _gaq.push(['_setDomainName', 'apache.org']); + _gaq.push(['_trackPageview']); + + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); + })(); + </script> + </head> + <body> + <div class="container-fluid section-header"> + <div class="container"> + <div class="nav nav-bar"> + <a href="/"><img src="/assets/img/aurora_logo_dkbkg.svg" width="300" alt="Transparent Apache Aurora logo with dark background"/></a> + <ul class="nav navbar-nav navbar-right"> + <li><a href="/documentation/latest/">Documentation</a></li> + <li><a href="/community/">Community</a></li> + <li><a href="/downloads/">Downloads</a></li> + <li><a href="/blog/">Blog</a></li> + </ul> + </div> + </div> +</div> + + <div class="container-fluid"> + <div class="container content"> + <div class="col-md-12 documentation"> +<h5 class="page-header text-uppercase">Documentation +<select onChange="window.location.href='/documentation/' + this.value + '/reference/scheduler-endpoints/'" + value="latest"> + <option value="0.12.0" + > + 0.12.0 + (latest) + </option> + <option value="0.11.0" + > + 0.11.0 + </option> + <option value="0.10.0" + > + 0.10.0 + </option> + <option value="0.9.0" + > + 0.9.0 + </option> + <option value="0.8.0" + > + 0.8.0 + </option> + <option value="0.7.0-incubating" + > + 0.7.0-incubating + </option> + <option value="0.6.0-incubating" + > + 0.6.0-incubating + </option> + <option value="0.5.0-incubating" + > + 0.5.0-incubating + </option> +</select> +</h5> +<h1 id="http-endpoints">HTTP endpoints</h1> + +<p>There are a number of HTTP endpoints that the Aurora scheduler exposes. These allow various +operational tasks to be performed on the scheduler. Below is the list of all such endpoints +and a brief explanation of what they do.</p> + +<h2 id="leader-health">Leader health</h2> + +<p>The /leaderhealth endpoint enables performing health checks on the scheduler instances inorder +to forward requests to the leading scheduler. This is typically used by a load balancer such as +HAProxy or AWS ELB.</p> + +<p>When a HTTP GET request is issued on this endpoint, it responds as follows:</p> + +<ul> +<li>If the instance that received the GET request is the leading scheduler, a HTTP status code of +200 (OK) is returned.</li> +<li>If the instance that received the GET request is not the leading scheduler but a leader does +exist, a HTTP status code of 503 (SERVICE_UNAVAILABLE) is returned.</li> +<li>If no leader currently exists or the leader is unknown, a HTTP status code of 502 +(BAD_GATEWAY) is returned.</li> +</ul> + +</div> + + </div> + </div> + <div class="container-fluid section-footer buffer"> + <div class="container"> + <div class="row"> + <div class="col-md-2 col-md-offset-1"><h3>Quick Links</h3> + <ul> + <li><a href="/downloads/">Downloads</a></li> + <li><a href="/community/">Mailing Lists</a></li> + <li><a href="http://issues.apache.org/jira/browse/AURORA";>Issue Tracking</a></li> + <li><a href="/documentation/latest/contributing/">How To Contribute</a></li> + </ul> + </div> + <div class="col-md-2"><h3>The ASF</h3> + <ul> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + </ul> + </div> + <div class="col-md-6"> + <p class="disclaimer">Copyright 2014 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. The <a href="https://www.flickr.com/photos/trondk/12706051375/";>Aurora Borealis IX photo</a> displayed on the homepage is available under a <a href="https://creativecommons.org/licenses/by-nc-nd/2.0/";>Creative Commons BY-NC-ND 2.0 license</a>. Apache, Apache Aurora, and the Apache feather logo are trademarks of The Apache Software Foundation.</p> + </div> + </div> + </div> + + </body> +</html> Added: aurora/site/publish/documentation/latest/reference/task-lifecycle/index.html URL: http://svn.apache.org/viewvc/aurora/site/publish/documentation/latest/reference/task-lifecycle/index.html?rev=1739120&view=auto ============================================================================== --- aurora/site/publish/documentation/latest/reference/task-lifecycle/index.html (added) +++ aurora/site/publish/documentation/latest/reference/task-lifecycle/index.html Thu Apr 14 14:20:54 2016 @@ -0,0 +1,256 @@ +<!DOCTYPE html> +<html lang="en"> + <head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width, initial-scale=1"> + <title>Apache Aurora</title> + <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css";> + <link href="/assets/css/main.css" rel="stylesheet"> + <!-- Analytics --> + <script type="text/javascript"> + var _gaq = _gaq || []; + _gaq.push(['_setAccount', 'UA-45879646-1']); + _gaq.push(['_setDomainName', 'apache.org']); + _gaq.push(['_trackPageview']); + + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); + })(); + </script> + </head> + <body> + <div class="container-fluid section-header"> + <div class="container"> + <div class="nav nav-bar"> + <a href="/"><img src="/assets/img/aurora_logo_dkbkg.svg" width="300" alt="Transparent Apache Aurora logo with dark background"/></a> + <ul class="nav navbar-nav navbar-right"> + <li><a href="/documentation/latest/">Documentation</a></li> + <li><a href="/community/">Community</a></li> + <li><a href="/downloads/">Downloads</a></li> + <li><a href="/blog/">Blog</a></li> + </ul> + </div> + </div> +</div> + + <div class="container-fluid"> + <div class="container content"> + <div class="col-md-12 documentation"> +<h5 class="page-header text-uppercase">Documentation +<select onChange="window.location.href='/documentation/' + this.value + '/reference/task-lifecycle/'" + value="latest"> + <option value="0.12.0" + > + 0.12.0 + (latest) + </option> + <option value="0.11.0" + > + 0.11.0 + </option> + <option value="0.10.0" + > + 0.10.0 + </option> + <option value="0.9.0" + > + 0.9.0 + </option> + <option value="0.8.0" + > + 0.8.0 + </option> + <option value="0.7.0-incubating" + > + 0.7.0-incubating + </option> + <option value="0.6.0-incubating" + > + 0.6.0-incubating + </option> + <option value="0.5.0-incubating" + > + 0.5.0-incubating + </option> +</select> +</h5> +<h1 id="task-lifecycle">Task Lifecycle</h1> + +<p>When Aurora reads a configuration file and finds a <code>Job</code> definition, it:</p> + +<ol> +<li> Evaluates the <code>Job</code> definition.</li> +<li> Splits the <code>Job</code> into its constituent <code>Task</code>s.</li> +<li> Sends those <code>Task</code>s to the scheduler.</li> +<li> The scheduler puts the <code>Task</code>s into <code>PENDING</code> state, starting each +<code>Task</code>’s life cycle.</li> +</ol> + +<p><img alt="Life of a task" src="../../images/lifeofatask.png" /></p> + +<p>Please note, a couple of task states described below are missing from +this state diagram.</p> + +<h2 id="pending-to-running-states">PENDING to RUNNING states</h2> + +<p>When a <code>Task</code> is in the <code>PENDING</code> state, the scheduler constantly +searches for machines satisfying that <code>Task</code>’s resource request +requirements (RAM, disk space, CPU time) while maintaining configuration +constraints such as “a <code>Task</code> must run on machines dedicated to a +particular role” or attribute limit constraints such as “at most 2 +<code>Task</code>s from the same <code>Job</code> may run on each rack”. When the scheduler +finds a suitable match, it assigns the <code>Task</code> to a machine and puts the +<code>Task</code> into the <code>ASSIGNED</code> state.</p> + +<p>From the <code>ASSIGNED</code> state, the scheduler sends an RPC to the slave +machine containing <code>Task</code> configuration, which the slave uses to spawn +an executor responsible for the <code>Task</code>’s lifecycle. When the scheduler +receives an acknowledgment that the machine has accepted the <code>Task</code>, +the <code>Task</code> goes into <code>STARTING</code> state.</p> + +<p><code>STARTING</code> state initializes a <code>Task</code> sandbox. When the sandbox is fully +initialized, Thermos begins to invoke <code>Process</code>es. Also, the slave +machine sends an update to the scheduler that the <code>Task</code> is +in <code>RUNNING</code> state.</p> + +<h2 id="running-to-terminal-states">RUNNING to terminal states</h2> + +<p>There are various ways that an active <code>Task</code> can transition into a terminal +state. By definition, it can never leave this state. However, depending on +nature of the termination and the originating <code>Job</code> definition +(e.g. <code>service</code>, <code>max_task_failures</code>), a replacement <code>Task</code> might be +scheduled.</p> + +<h3 id="natural-termination-finished-failed">Natural Termination: FINISHED, FAILED</h3> + +<p>A <code>RUNNING</code> <code>Task</code> can terminate without direct user interaction. For +example, it may be a finite computation that finishes, even something as +simple as <code>echo hello world.</code>, or it could be an exceptional condition in +a long-lived service. If the <code>Task</code> is successful (its underlying +processes have succeeded with exit status <code>0</code> or finished without +reaching failure limits) it moves into <code>FINISHED</code> state. If it finished +after reaching a set of failure limits, it goes into <code>FAILED</code> state.</p> + +<p>A terminated <code>TASK</code> which is subject to rescheduling will be temporarily +<code>THROTTLED</code>, if it is considered to be flapping. A task is flapping, if its +previous invocation was terminated after less than 5 minutes (scheduler +default). The time penalty a task has to remain in the <code>THROTTLED</code> state, +before it is eligible for rescheduling, increases with each consecutive +failure.</p> + +<h3 id="forceful-termination-killing-restarting">Forceful Termination: KILLING, RESTARTING</h3> + +<p>You can terminate a <code>Task</code> by issuing an <code>aurora job kill</code> command, which +moves it into <code>KILLING</code> state. The scheduler then sends the slave a +request to terminate the <code>Task</code>. If the scheduler receives a successful +response, it moves the Task into <code>KILLED</code> state and never restarts it.</p> + +<p>If a <code>Task</code> is forced into the <code>RESTARTING</code> state via the <code>aurora job restart</code> +command, the scheduler kills the underlying task but in parallel schedules +an identical replacement for it.</p> + +<p>In any case, the responsible executor on the slave follows an escalation +sequence when killing a running task:</p> + +<ol> +<li>If a <code>HttpLifecycleConfig</code> is not present, skip to (4).</li> +<li>Send a POST to the <code>graceful_shutdown_endpoint</code> and wait 5 seconds.</li> +<li>Send a POST to the <code>shutdown_endpoint</code> and wait 5 seconds.</li> +<li>Send SIGTERM (<code>kill</code>) and wait at most <code>finalization_wait</code> seconds.</li> +<li>Send SIGKILL (<code>kill -9</code>).</li> +</ol> + +<p>If the executor notices that all <code>Process</code>es in a <code>Task</code> have aborted +during this sequence, it will not proceed with subsequent steps. +Note that graceful shutdown is best-effort, and due to the many +inevitable realities of distributed systems, it may not be performed.</p> + +<h3 id="unexpected-termination-lost">Unexpected Termination: LOST</h3> + +<p>If a <code>Task</code> stays in a transient task state for too long (such as <code>ASSIGNED</code> +or <code>STARTING</code>), the scheduler forces it into <code>LOST</code> state, creating a new +<code>Task</code> in its place that’s sent into <code>PENDING</code> state.</p> + +<p>In addition, if the Mesos core tells the scheduler that a slave has +become unhealthy (or outright disappeared), the <code>Task</code>s assigned to that +slave go into <code>LOST</code> state and new <code>Task</code>s are created in their place. +From <code>PENDING</code> state, there is no guarantee a <code>Task</code> will be reassigned +to the same machine unless job constraints explicitly force it there.</p> + +<h3 id="giving-priority-to-production-tasks-preempting">Giving Priority to Production Tasks: PREEMPTING</h3> + +<p>Sometimes a Task needs to be interrupted, such as when a non-production +Task’s resources are needed by a higher priority production Task. This +type of interruption is called a <em>pre-emption</em>. When this happens in +Aurora, the non-production Task is killed and moved into +the <code>PREEMPTING</code> state when both the following are true:</p> + +<ul> +<li>The task being killed is a non-production task.</li> +<li>The other task is a <code>PENDING</code> production task that hasn’t been +scheduled due to a lack of resources.</li> +</ul> + +<p>The scheduler UI shows the non-production task was preempted in favor of +the production task. At some point, tasks in <code>PREEMPTING</code> move to <code>KILLED</code>.</p> + +<p>Note that non-production tasks consuming many resources are likely to be +preempted in favor of production tasks.</p> + +<h3 id="making-room-for-maintenance-draining">Making Room for Maintenance: DRAINING</h3> + +<p>Cluster operators can set slave into maintenance mode. This will transition +all <code>Task</code> running on this slave into <code>DRAINING</code> and eventually to <code>KILLED</code>. +Drained <code>Task</code>s will be restarted on other slaves for which no maintenance +has been announced yet.</p> + +<h2 id="state-reconciliation">State Reconciliation</h2> + +<p>Due to the many inevitable realities of distributed systems, there might +be a mismatch of perceived and actual cluster state (e.g. a machine returns +from a <code>netsplit</code> but the scheduler has already marked all its <code>Task</code>s as +<code>LOST</code> and rescheduled them).</p> + +<p>Aurora regularly runs a state reconciliation process in order to detect +and correct such issues (e.g. by killing the errant <code>RUNNING</code> tasks). +By default, the proper detection of all failure scenarios and inconsistencies +may take up to an hour.</p> + +<p>To emphasize this point: there is no uniqueness guarantee for a single +instance of a job in the presence of network partitions. If the <code>Task</code> +requires that, it should be baked in at the application level using a +distributed coordination service such as Zookeeper.</p> + +</div> + + </div> + </div> + <div class="container-fluid section-footer buffer"> + <div class="container"> + <div class="row"> + <div class="col-md-2 col-md-offset-1"><h3>Quick Links</h3> + <ul> + <li><a href="/downloads/">Downloads</a></li> + <li><a href="/community/">Mailing Lists</a></li> + <li><a href="http://issues.apache.org/jira/browse/AURORA";>Issue Tracking</a></li> + <li><a href="/documentation/latest/contributing/">How To Contribute</a></li> + </ul> + </div> + <div class="col-md-2"><h3>The ASF</h3> + <ul> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li> + <li><a href="http://www.apache.org/security/";>Security</a></li> + </ul> + </div> + <div class="col-md-6"> + <p class="disclaimer">Copyright 2014 <a href="http://www.apache.org/";>Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/";>Apache License v2.0</a>. The <a href="https://www.flickr.com/photos/trondk/12706051375/";>Aurora Borealis IX photo</a> displayed on the homepage is available under a <a href="https://creativecommons.org/licenses/by-nc-nd/2.0/";>Creative Commons BY-NC-ND 2.0 license</a>. Apache, Apache Aurora, and the Apache feather logo are trademarks of The Apache Software Foundation.</p> + </div> + </div> + </div> + + </body> +</html> Modified: aurora/site/source/documentation/latest/index.html.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/latest/index.html.md?rev=1739120&r1=1739119&r2=1739120&view=diff ============================================================================== --- aurora/site/source/documentation/latest/index.html.md (original) +++ aurora/site/source/documentation/latest/index.html.md Thu Apr 14 14:20:54 2016 @@ -1,73 +1,44 @@ ## Introduction +Apache Aurora is a service scheduler that runs on top of Apache Mesos, enabling you to run long-running services that take advantage of Apache Mesos' scalability, fault-tolerance, and resource isolation. This documentation has been organized into sections with three audiences in mind: -Apache Aurora is a service scheduler that runs on top of Apache Mesos, enabling you to run -long-running services, cron jobs, and ad-hoc jobs that take advantage of Apache Mesos' scalability, -fault-tolerance, and resource isolation. - -We encourage you to ask questions on the [Aurora user list](http://aurora.apache.org/community/) or -the `#aurora` IRC channel on `irc.freenode.net`. - - -## Getting Started -Information for everyone new to Apache Aurora. - - * [Aurora System Overview](getting-started/overview.md) - * [Hello World Tutorial](getting-started/tutorial.md) - * [Local cluster with Vagrant](getting-started/vagrant.md) - -## Features -Description of important Aurora features. - - * [Containers](features/containers.md) - * [Cron Jobs](features/cron-jobs.md) - * [Job Updates](features/job-updates.md) - * [Multitenancy](features/multitenancy.md) - * [Resource Isolation](features/resource-isolation.md) - * [Scheduling Constraints](features/constraints.md) - * [Services](features/services.md) - * [Service Discovery](features/service-discovery.md) - * [SLA Metrics](features/sla-metrics.md) + * Users: General information about the project and to learn how to run an Aurora job. + * Operators: For those that wish to manage and fine-tune an Aurora cluster. + * Developers: All the information you need to start modifying Aurora and contributing back to the project. + +We encourage you to ask questions on the [Aurora user list](http://aurora.apache.org/community/) or the `#aurora` IRC channel on `irc.freenode.net`. + +## Users + * [Install Aurora on virtual machines on your private machine](/documentation/latest/vagrant/) + * [Hello World Tutorial](/documentation/latest/tutorial/) + * [User Guide](/documentation/latest/user-guide/) + * [Configuration Tutorial](/documentation/latest/configuration-tutorial/) + * [Aurora + Thermos Reference](/documentation/latest/configuration-reference/) + * [Command Line Client](/documentation/latest/client-commands/) + * [Client cluster configuration](/documentation/latest/client-cluster-configuration/) + * [Cron Jobs](/documentation/latest/cron-jobs/) ## Operators -For those that wish to manage and fine-tune an Aurora cluster. - - * [Installation](operations/installation.md) - * [Configuration](operations/configuration.md) - * [Monitoring](operations/monitoring.md) - * [Security](operations/security.md) - * [Storage](operations/storage.md) - * [Backup](operations/backup-restore.md) - -## Reference -The complete reference of commands, configuration options, and scheduler internals. - - * [Task lifecycle](reference/task-lifecycle.md) - * Configuration (`.aurora` files) - - [Configuration Reference](reference/configuration.md) - - [Configuration Tutorial](reference/configuration-tutorial.md) - - [Configuration Best Practices](reference/configuration-best-practices.md) - - [Configuration Templating](reference/configuration-templating.md) - * Aurora Client - - [Client Commands](reference/client-commands.md) - - [Client Hooks](reference/client-hooks.md) - - [Client Cluster Configuration](reference/client-cluster-configuration.md) - * [Scheduler Configuration](reference/scheduler-configuration.md) - -## Additional Resources - * [Tools integrating with Aurora](additional-resources/tools.md) - * [Presentation videos and slides](additional-resources/presentations.md) + * [Installation](/documentation/latest/installing/) + * [Deployment and cluster configuration](/documentation/latest/deploying-aurora-scheduler/) + * [Security](/documentation/latest/security/) + * [Monitoring](/documentation/latest/monitoring/) + * [Hooks for Aurora Client API](/documentation/latest/hooks/) + * [Scheduler Storage](/documentation/latest/storage/) + * [Scheduler Storage and Maintenance](/documentation/latest/storage-config/) + * [SLA Measurement](/documentation/latest/sla/) + * [Resource Isolation and Sizing](/documentation/latest/resources/) ## Developers -All the information you need to start modifying Aurora and contributing back to the project. - * [Contributing to the project](contributing/) - * [Committer's Guide](development/committers-guide.md) - * [Design Documents](development/design-documents.md) - * Developing the Aurora components: - - [Client](development/client.md) - - [Scheduler](development/scheduler.md) - - [Scheduler UI](development/ui.md) - - [Thermos](development/thermos.md) - - [Thrift structures](development/thrift.md) + * [Developing the Aurora Scheduler](/documentation/latest/developing-aurora-scheduler/) + * [Developing the Aurora Client](/documentation/latest/developing-aurora-client/) + * [Committers Guide](/documentation/latest/committers/) + * [Design Documents](/documentation/latest/design-documents/) + * [Deprecation Guide](/documentation/latest/thrift-deprecation/) + * [Build System](/documentation/latest/build-system/) + * [Generating test resources](/documentation/latest/test-resource-generation/) +## Additional Resources + * [Tools integrating with Aurora](/documentation/latest/tools/) + * [Presentation videos and slides](/documentation/latest/presentations/)
