Added: aurora/site/publish/documentation/0.18.0/reference/scheduler-configuration/index.html URL: http://svn.apache.org/viewvc/aurora/site/publish/documentation/0.18.0/reference/scheduler-configuration/index.html?rev=1799392&view=auto ============================================================================== --- aurora/site/publish/documentation/0.18.0/reference/scheduler-configuration/index.html (added) +++ aurora/site/publish/documentation/0.18.0/reference/scheduler-configuration/index.html Wed Jun 21 06:36:21 2017 @@ -0,0 +1,400 @@ +<!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="0.18.0"> + <option value="0.18.0" + selected="selected"> + 0.18.0 + (latest) + </option> + <option value="0.17.0" + > + 0.17.0 + </option> + <option value="0.16.0" + > + 0.16.0 + </option> + <option value="0.15.0" + > + 0.15.0 + </option> + <option value="0.14.0" + > + 0.14.0 + </option> + <option value="0.13.0" + > + 0.13.0 + </option> + <option value="0.12.0" + > + 0.12.0 + </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/">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. +-db_max_active_connection_count [must be > 0] + Max number of connections to use with database via MyBatis +-db_max_idle_connection_count [must be > 0] + Max number of idle connections to the database via MyBatis +-framework_authentication_file + Properties file which contains framework credentials to authenticate with Mesosmaster. Must contain the properties 'aurora_authentication_principal' and 'aurora_authentication_secret'. +-ip + The ip address to listen. If not set, the scheduler will listen on all interfaces. +-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. +-webhook_config [file must exist, file must be readable] + Path to webhook configuration file. +-zk_endpoints [must have at least 1 item] + Endpoint specification for the ZooKeeper servers. + +Optional flags: +-allow_container_volumes (default false) + Allow passing in volumes in the job. Enabling this could pose a privilege escalation threat. +-allow_docker_parameters (default false) + Allow to pass docker container parameters in the job. +-allow_gpu_resource (default false) + Allow jobs to request Mesos GPU resource. +-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 10) + Number of threads to use for the cron scheduler thread pool. +-cron_scheduling_max_batch_size (default 10) [must be > 0] + The maximum number of triggered cron jobs that can be processed in a batch. +-cron_start_initial_backoff (default (5, 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_db_metrics (default true) + Whether to use MyBatis interceptor to measure the timing of intercepted Statements. +-enable_h2_console (default false) + Enable H2 DB management console. +-enable_mesos_fetcher (default false) + Allow jobs to pass URIs to the Mesos Fetcher. Note that enabling this feature could pose a privilege escalation threat. +-enable_preemptor (default true) + Enable the preemptor and preemption +-enable_revocable_cpus (default true) + Treat CPUs as a revocable resource. +-enable_revocable_ram (default false) + Treat RAM as a revocable resource. +-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 agents. +-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. Changing this value is backwards incompatible. For details, see MESOS-703. +-framework_failover_timeout (default (21, days)) + Time after which a framework is considered deleted. SHOULD BE VERY HIGH. +-framework_name (default Aurora) + Name used to register the Aurora framework with Mesos. +-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_task_event_batch_size (default 300) [must be > 0] + The maximum number of task state change events 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_tasks_per_schedule_attempt (default 5) [must be > 0] + The maximum number of tasks to pick in a single scheduling attempt. +-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_filter_duration (default (5, secs)) + Duration after which we expect Mesos to re-offer unused resources. A short duration improves scheduling performance in smaller clusters, but might lead to resource starvation for other frameworks if you run many frameworks in your cluster. +-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 agent'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_finder_modules (default [class org.apache.aurora.scheduler.preemptor.PendingTaskProcessorModule, class org.apache.aurora.scheduler.preemptor.PreemptionVictimFilterModule]) + Guice modules for replacing preemption logic. +-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_batch_interval (default (5, secs)) + Interval between explicit batch reconciliation requests. +-reconciliation_explicit_batch_size (default 1000) [must be > 0] + Number of tasks in a single batch request sent to Mesos for explicit reconciliation. +-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) +-scheduling_max_batch_size (default 3) [must be > 0] + The maximum number of scheduling attempts that can be processed in a batch. +-serverset_endpoint_name (default http) + Name of the scheduler endpoint published in ZooKeeper. +-shiro_ini_path + Path to shiro.ini for authentication and authorization configuration. +-shiro_realm_modules (default [class org.apache.aurora.scheduler.http.api.security.IniShiroRealmModule]) + 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. +-snapshot_hydrate_stores (default [locks, hosts, quota, job_updates]) + Which H2-backed stores to fully hydrate on the Snapshot. +-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. +-task_assigner_modules (default [class org.apache.aurora.scheduler.state.FirstFitTaskAssignerModule]) + Guice modules for replacing task assignment logic. +-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. +-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_digest_credentials + user:password to use when authenticating with ZooKeeper. +-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. +-zk_use_curator (default true) + DEPRECATED: Uses Apache Curator as the zookeeper client; otherwise a copy of Twitter commons/zookeeper (the legacy library) is used. +------------------------------------------------------------------------- +</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">© 2014-2017 <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/0.18.0/reference/scheduler-endpoints/index.html URL: http://svn.apache.org/viewvc/aurora/site/publish/documentation/0.18.0/reference/scheduler-endpoints/index.html?rev=1799392&view=auto ============================================================================== --- aurora/site/publish/documentation/0.18.0/reference/scheduler-endpoints/index.html (added) +++ aurora/site/publish/documentation/0.18.0/reference/scheduler-endpoints/index.html Wed Jun 21 06:36:21 2017 @@ -0,0 +1,156 @@ +<!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="0.18.0"> + <option value="0.18.0" + selected="selected"> + 0.18.0 + (latest) + </option> + <option value="0.17.0" + > + 0.17.0 + </option> + <option value="0.16.0" + > + 0.16.0 + </option> + <option value="0.15.0" + > + 0.15.0 + </option> + <option value="0.14.0" + > + 0.14.0 + </option> + <option value="0.13.0" + > + 0.13.0 + </option> + <option value="0.12.0" + > + 0.12.0 + </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 an (incomplete) list of 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 +<code>200 OK</code> 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 <code>503 SERVICE_UNAVAILABLE</code> is returned.</li> +<li>If no leader currently exists or the leader is unknown, a HTTP status code of <code>502 BAD_GATEWAY</code> +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">© 2014-2017 <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/0.18.0/reference/task-lifecycle/index.html URL: http://svn.apache.org/viewvc/aurora/site/publish/documentation/0.18.0/reference/task-lifecycle/index.html?rev=1799392&view=auto ============================================================================== --- aurora/site/publish/documentation/0.18.0/reference/task-lifecycle/index.html (added) +++ aurora/site/publish/documentation/0.18.0/reference/task-lifecycle/index.html Wed Jun 21 06:36:21 2017 @@ -0,0 +1,282 @@ +<!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="0.18.0"> + <option value="0.18.0" + selected="selected"> + 0.18.0 + (latest) + </option> + <option value="0.17.0" + > + 0.17.0 + </option> + <option value="0.16.0" + > + 0.16.0 + </option> + <option value="0.15.0" + > + 0.15.0 + </option> + <option value="0.14.0" + > + 0.14.0 + </option> + <option value="0.13.0" + > + 0.13.0 + </option> + <option value="0.12.0" + > + 0.12.0 + </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 agent +machine containing <code>Task</code> configuration, which the agent 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 agent +machine sends an update to the scheduler that the <code>Task</code> is +in <code>RUNNING</code> state, only after the task satisfies the liveness requirements. +See <a href="../features/services#health-checking">Health Checking</a> for more details +for how to configure health checks.</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 agent 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 agent 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 agent has +become unhealthy (or outright disappeared), the <code>Task</code>s assigned to that +agent 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 agent into maintenance mode. This will transition +all <code>Task</code> running on this agent into <code>DRAINING</code> and eventually to <code>KILLED</code>. +Drained <code>Task</code>s will be restarted on other agents 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">© 2014-2017 <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/operations/troubleshooting/index.html URL: http://svn.apache.org/viewvc/aurora/site/publish/documentation/latest/operations/troubleshooting/index.html?rev=1799392&view=auto ============================================================================== --- aurora/site/publish/documentation/latest/operations/troubleshooting/index.html (added) +++ aurora/site/publish/documentation/latest/operations/troubleshooting/index.html Wed Jun 21 06:36:21 2017 @@ -0,0 +1,249 @@ +<!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 + '/operations/troubleshooting/'" + value="latest"> + <option value="0.18.0" + > + 0.18.0 + (latest) + </option> + <option value="0.17.0" + > + 0.17.0 + </option> + <option value="0.16.0" + > + 0.16.0 + </option> + <option value="0.15.0" + > + 0.15.0 + </option> + <option value="0.14.0" + > + 0.14.0 + </option> + <option value="0.13.0" + > + 0.13.0 + </option> + <option value="0.12.0" + > + 0.12.0 + </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="troubleshooting">Troubleshooting</h1> + +<p>So you’ve started your first cluster and are running into some issues? We’ve collected some common +stumbling blocks and solutions here to help get you moving.</p> + +<h2 id="replicated-log-not-initialized">Replicated log not initialized</h2> + +<h3 id="symptoms">Symptoms</h3> + +<ul> +<li>Scheduler RPCs and web interface claim <code>Storage is not READY</code></li> +<li>Scheduler log repeatedly prints messages like</li> +</ul> +<pre class="highlight plaintext"><code> I1016 16:12:27.234133 26081 replica.cpp:638] Replica in EMPTY status + received a broadcasted recover request + I1016 16:12:27.234256 26084 recover.cpp:188] Received a recover response + from a replica in EMPTY status +</code></pre> + +<h3 id="solution">Solution</h3> + +<p>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 <a href="../installation/#finalizing">initializing</a> 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.</p> + +<h2 id="no-distinct-leader-elected">No distinct leader elected</h2> + +<h3 id="symptoms">Symptoms</h3> + +<p>Either no scheduler or multiple scheduler believe to be leading.</p> + +<h3 id="solution">Solution</h3> + +<p>Verify the <a href="../configuration/#network-configuration">network configuration</a> of the Aurora +scheduler is correct:</p> + +<ul> +<li>The <code>LIBPROCESS_IP:LIBPROCESS_PORT</code> endpoints must be reachable from all coordinator nodes running +a scheduler or a Mesos master.</li> +<li>Hostname lookups have to resolve to public ips rather than local ones that cannot be reached +from another node.</li> +</ul> + +<p>In addition, double-check the <a href="../configuration/#replicated-log-configuration">quota settings</a> of the +replicated log.</p> + +<h2 id="scheduler-not-registered">Scheduler not registered</h2> + +<h3 id="symptoms">Symptoms</h3> + +<p>Scheduler log contains</p> +<pre class="highlight plaintext"><code>Framework has not been registered within the tolerated delay. +</code></pre> + +<h3 id="solution">Solution</h3> + +<p>Double-check that the scheduler is configured correctly to reach the Mesos master. If you are registering +the master in ZooKeeper, make sure command line argument to the master:</p> +<pre class="highlight plaintext"><code>--zk=zk://$ZK_HOST:2181/mesos/master +</code></pre> + +<p>is the same as the one on the scheduler:</p> +<pre class="highlight plaintext"><code>-mesos_master_address=zk://$ZK_HOST:2181/mesos/master +</code></pre> + +<h2 id="scheduler-not-running">Scheduler not running</h2> + +<h3 id="symptoms">Symptoms</h3> + +<p>The scheduler process commits suicide regularly. This happens under error conditions, but +also on purpose in regular intervals.</p> + +<h3 id="solution">Solution</h3> + +<p>Aurora is meant to be run under supervision. You have to configure a supervisor like +<a href="http://mmonit.com/monit/";>Monit</a>, <a href="http://supervisord.org/";>supervisord</a>, or systemd to run the +scheduler and restart it whenever it fails or exists on purpose.</p> + +<p>Aurora supports an active health checking protocol on its admin HTTP interface - if a <code>GET /health</code> +times out or returns anything other than <code>200 OK</code> the scheduler process is unhealthy and should be +restarted.</p> + +<p>For example, monit can be configured with</p> +<pre class="highlight plaintext"><code>if failed port 8081 send "GET /health HTTP/1.0\r\n" expect "OK\n" with timeout 2 seconds for 10 cycles then restart +</code></pre> + +<p>assuming you set <code>-http_port=8081</code>.</p> + +<h2 id="executor-crashing-or-hanging">Executor crashing or hanging</h2> + +<h3 id="symptoms">Symptoms</h3> + +<p>Launched task instances never transition to <code>STARTING</code> or <code>RUNNING</code> but immediately transition +to <code>FAILED</code> or <code>LOST</code>.</p> + +<h3 id="solution">Solution</h3> + +<p>The executor might be failing due to unknown internal errors such as a missing native dependency +of the Mesos executor library. Open the Mesos UI and navigate to the failing +task in question. Inspect the various log files in order to learn about what is going on.</p> + +<h2 id="observer-does-not-discover-tasks">Observer does not discover tasks</h2> + +<h3 id="symptoms">Symptoms</h3> + +<p>The observer UI does not list any tasks. When navigating from the scheduler UI to the state of +a particular task instance the observer returns <code>Error: 404 Not Found</code>.</p> + +<h3 id="solution">Solution</h3> + +<p>The observer is refreshing its internal state every couple of seconds. If waiting a few seconds +does not resolve the issue, check that the <code>--mesos-root</code> setting of the observer and the +<code>--work_dir</code> option of the Mesos agent are in sync. For details, see our +<a href="../installation/#worker-configuration">Install instructions</a>.</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">© 2014-2017 <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/operations/upgrades/index.html URL: http://svn.apache.org/viewvc/aurora/site/publish/documentation/latest/operations/upgrades/index.html?rev=1799392&view=auto ============================================================================== --- aurora/site/publish/documentation/latest/operations/upgrades/index.html (added) +++ aurora/site/publish/documentation/latest/operations/upgrades/index.html Wed Jun 21 06:36:21 2017 @@ -0,0 +1,177 @@ +<!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 + '/operations/upgrades/'" + value="latest"> + <option value="0.18.0" + > + 0.18.0 + (latest) + </option> + <option value="0.17.0" + > + 0.17.0 + </option> + <option value="0.16.0" + > + 0.16.0 + </option> + <option value="0.15.0" + > + 0.15.0 + </option> + <option value="0.14.0" + > + 0.14.0 + </option> + <option value="0.13.0" + > + 0.13.0 + </option> + <option value="0.12.0" + > + 0.12.0 + </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="upgrading-aurora">Upgrading Aurora</h1> + +<p>Aurora can be updated from one version to the next without any downtime or restarts of running +jobs. The same holds true for Mesos.</p> + +<p>Generally speaking, Mesos and Aurora strive for a +1/-1 version compatibility, i.e. all components +are meant to be forward and backwards compatible for at least one version. This implies it +does not really matter in which order updates are carried out.</p> + +<p>Exceptions to this rule are documented in the <a href="../../../RELEASE-NOTES/">Aurora release-notes</a> +and the <a href="https://mesos.apache.org/documentation/latest/upgrades/";>Mesos upgrade instructions</a>.</p> + +<h2 id="instructions">Instructions</h2> + +<p>To upgrade Aurora, follow these steps:</p> + +<ol> +<li>Update the first scheduler instance by updating its software and restarting its process.</li> +<li>Wait until the scheduler is up and its <a href="../configuration/#replicated-log-configuration">Replicated Log</a> +caught up with the other schedulers in the cluster. The log has caught up if <code>log/recovered</code> has +the value <code>1</code>. You can check the metric via <code>curl LIBPROCESS_IP:LIBPROCESS_PORT/metrics/snapshot</code>, +where ip and port refer to the <a href="../configuration/#network-configuration">libmesos configuration</a> +settings of the scheduler instance.</li> +<li>Proceed with the next scheduler until all instances are updated.</li> +<li>Update the Aurora executor deployed to the compute nodes of your cluster. Jobs will continue +running with the old version of the executor, and will only be launched by the new one once +they are restarted eventually due to natural cluster churn.</li> +<li>Distribute the new Aurora client to your users.</li> +</ol> + +<h2 id="best-practices">Best Practices</h2> + +<p>Even though not absolutely mandatory, we advice to adhere to the following rules:</p> + +<ul> +<li>Never skip any major or minor releases when updating. If you have to catch up several releases you +have to deploy all intermediary versions. Skipping bugfix releases is acceptable though.</li> +<li>Verify all updates on a test cluster before touching your production deployments.</li> +<li>To minimize the number of failovers during updates, update the currently leading scheduler +instance last.</li> +<li>Update the Aurora executor on a subset of compute nodes as a canary before deploying the change to +the whole fleet.</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">© 2014-2017 <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/observer-configuration/index.html URL: http://svn.apache.org/viewvc/aurora/site/publish/documentation/latest/reference/observer-configuration/index.html?rev=1799392&view=auto ============================================================================== --- aurora/site/publish/documentation/latest/reference/observer-configuration/index.html (added) +++ aurora/site/publish/documentation/latest/reference/observer-configuration/index.html Wed Jun 21 06:36:21 2017 @@ -0,0 +1,221 @@ +<!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/observer-configuration/'" + value="latest"> + <option value="0.18.0" + > + 0.18.0 + (latest) + </option> + <option value="0.17.0" + > + 0.17.0 + </option> + <option value="0.16.0" + > + 0.16.0 + </option> + <option value="0.15.0" + > + 0.15.0 + </option> + <option value="0.14.0" + > + 0.14.0 + </option> + <option value="0.13.0" + > + 0.13.0 + </option> + <option value="0.12.0" + > + 0.12.0 + </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="observer-configuration-reference">Observer Configuration Reference</h1> + +<p>The Aurora/Thermos observer can take a variety of configuration options through command-line arguments. +A list of the available options can be seen by running <code>thermos_observer --long-help</code>.</p> + +<p>Please refer to the <a href="../../operations/configuration/">Operator Configuration Guide</a> for details on how +to properly set the most important options.</p> +<pre class="highlight plaintext"><code>$ thermos_observer.pex --long-help +Options: + -h, --help, --short-help + show this help message and exit. + --long-help show options from all registered modules, not just the + __main__ module. + --mesos-root=MESOS_ROOT + The mesos root directory to search for Thermos + executor sandboxes [default: /var/lib/mesos] + --ip=IP The IP address the observer will bind to. [default: + 0.0.0.0] + --port=PORT The port on which the observer should listen. + [default: 1338] + --polling_interval_secs=POLLING_INTERVAL_SECS + The number of seconds between observer refresh + attempts. [default: 5] + --task_process_collection_interval_secs=TASK_PROCESS_COLLECTION_INTERVAL_SECS + The number of seconds between per task process + resource collections. [default: 20] + --task_disk_collection_interval_secs=TASK_DISK_COLLECTION_INTERVAL_SECS + The number of seconds between per task disk resource + collections. [default: 60] + + From module twitter.common.app: + --app_daemonize Daemonize this application. [default: False] + --app_profile_output=FILENAME + Dump the profiling output to a binary profiling + format. [default: None] + --app_daemon_stderr=TWITTER_COMMON_APP_DAEMON_STDERR + Direct this app's stderr to this file if daemonized. + [default: /dev/null] + --app_debug Print extra debugging information during application + initialization. [default: False] + --app_rc_filename Print the filename for the rc file and quit. [default: + False] + --app_daemon_stdout=TWITTER_COMMON_APP_DAEMON_STDOUT + Direct this app's stdout to this file if daemonized. + [default: /dev/null] + --app_profiling Run profiler on the code while it runs. Note this can + cause slowdowns. [default: False] + --app_ignore_rc_file + Ignore default arguments from the rc file. [default: + False] + --app_pidfile=TWITTER_COMMON_APP_PIDFILE + The pidfile to use if --app_daemonize is specified. + [default: None] + + From module twitter.common.log.options: + --log_to_stdout=[scheme:]LEVEL + OBSOLETE - legacy flag, use --log_to_stderr instead. + [default: ERROR] + --log_to_stderr=[scheme:]LEVEL + The level at which logging to stderr [default: ERROR]. + Takes either LEVEL or scheme:LEVEL, where LEVEL is one + of ['INFO', 'NONE', 'WARN', 'ERROR', 'DEBUG', 'FATAL'] + and scheme is one of ['google', 'plain']. + --log_to_disk=[scheme:]LEVEL + The level at which logging to disk [default: INFO]. + Takes either LEVEL or scheme:LEVEL, where LEVEL is one + of ['INFO', 'NONE', 'WARN', 'ERROR', 'DEBUG', 'FATAL'] + and scheme is one of ['google', 'plain']. + --log_dir=DIR The directory into which log files will be generated + [default: /var/tmp]. + --log_simple Write a single log file rather than one log file per + log level [default: False]. + --log_to_scribe=[scheme:]LEVEL + The level at which logging to scribe [default: NONE]. + Takes either LEVEL or scheme:LEVEL, where LEVEL is one + of ['INFO', 'NONE', 'WARN', 'ERROR', 'DEBUG', 'FATAL'] + and scheme is one of ['google', 'plain']. + --scribe_category=CATEGORY + The category used when logging to the scribe daemon. + [default: python_default]. + --scribe_buffer Buffer messages when scribe is unavailable rather than + dropping them. [default: False]. + --scribe_host=HOST The host running the scribe daemon. [default: + localhost]. + --scribe_port=PORT The port used to connect to the scribe daemon. + [default: 1463]. +</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">© 2014-2017 <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/source/blog/2017-06-20-aurora-0-18-0-released.md URL: http://svn.apache.org/viewvc/aurora/site/source/blog/2017-06-20-aurora-0-18-0-released.md?rev=1799392&view=auto ============================================================================== --- aurora/site/source/blog/2017-06-20-aurora-0-18-0-released.md (added) +++ aurora/site/source/blog/2017-06-20-aurora-0-18-0-released.md Wed Jun 21 06:36:21 2017 @@ -0,0 +1,83 @@ +--- +layout: post +title: 0.18.0 Released +permalink: /blog/aurora-0-18-0-released/ +published: true +post_author: + display_name: Santhosh Kumar Shanmugham + twitter: santhk +tags: Release +--- + +The latest Apache Aurora release, 0.18.0, is now available for +[download](http://aurora.apache.org/downloads/). Here are some highlights in this release. + +Major new features: + +- Added the `-mesos_driver` flag to the scheduler with three possible options: + `SCHEDULER_DRIVER`, `V0_MESOS`, `V1_MESOS`. The first uses the original driver + and the latter two use two new drivers from `libmesos`. `V0_MESOS` uses the + `SCHEDULER_DRIVER` under the hood and `V1_MESOS` uses a new HTTP API aware + driver. Users that want to use the HTTP API should use `V1_MESOS`. + Performance sensitive users should stick with the `SCHEDULER_DRIVER` or + `V0_MESOS` drivers. +- Add observer command line options to control the resource collection interval + for observed tasks. See [here](docs/reference/observer-configuration.md) for details. +- Added support for reserving agents during job updates, which can substantially reduce update times + in clusters with high contention for resources. Disabled by default, but can be enabled with + `enable_update_affinity` option, and the reservation timeout can be controlled via + `update_affinity_reservation_hold_time`. +- Add `task scp` command to the CLI client for easy transferring of files to/from/between task + instances. See [here](docs/reference/client-commands.md#scping-with-task-machines) for details. + Currently only fully supported for Mesos containers (you can copy files from the Docker container + sandbox but you cannot send files to it). +- Added ability to inject your own scheduling logic, via a lazy Guice module binding. This is an + alpha-level feature and not subject to backwards compatibility considerations. You can specify + your custom modules using the `task_assigner_modules` and `preemption_slot_finder_modules` options. +- Added support for resource bin-packing via the `-offer_order` option. You can choose from `CPU`, + `MEMORY`, `DISK`, `RANDOM` or `REVOCABLE_CPU`. You can also compose secondary sorts by combining + orders together: e.g. to bin-pack by CPU and MEMORY you could supply `CPU,MEMORY`. The current + default is `RANDOM`, which has the strong advantage that users can (usually) relocate their tasks + due to noisy neighbors or machine issues with a task restart. When you have deterministic + bin-packing, they may always end up on the same agent. So be careful enabling this without proper + monitoring and remediation of host failures. +- Modified job update behavior to create new instances, then update existing instances, and then + kill unwanted instances. Previously, a job update would modify each instance in the order of + their instance ID. +- Added ability to whitelist TaskStateChanges in the webhook configuration file. You can specify + a list of desired TaskStateChanges(represented by their task statuses) to be sent to a configured + endpoint. +- Add message parameter to `killTasks` RPC. +- Add `prune_tasks` endpoint to `aurora_admin`. See `aurora_admin prune_tasks -h` for usage information. +- Add support for per-task volume mounts for Mesos containers to the Aurora config DSL. + +Additional changes: + +- Update to Mesos 1.2.0. Please upgrade Aurora to 0.18 before upgrading Mesos to 1.2.0 if you rely + on Mesos filesystem images. + +Full release notes are available in the release +[CHANGELOG](https://git-wip-us.apache.org/repos/asf?p=aurora.git&f=CHANGELOG&hb=rel/0.18.0). + +## Getting Involved + +We encourage you to try out this release and let us know what you think. If you run into any issues, +please let us know on the [user mailing list and IRC](https://aurora.apache.org/community/). + +## Thanks + +Thanks to the 12 contributors who made Apache Aurora 0.18.0 possible: + +* Abhishek Jain +* Charles Raimbert +* Cody Gibb +* David McLaughlin +* Kai Huang +* Mehrdad Nurolahzade +* Nicolás Donatucci +* Reza Motamedi +* Santhosh Kumar Shanmugham +* Stephan Erb +* Takuya Kuwahara +* Zameer Manji + Added: aurora/site/source/documentation/0.18.0/additional-resources/presentations.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.18.0/additional-resources/presentations.md?rev=1799392&view=auto ============================================================================== --- aurora/site/source/documentation/0.18.0/additional-resources/presentations.md (added) +++ aurora/site/source/documentation/0.18.0/additional-resources/presentations.md Wed Jun 21 06:36:21 2017 @@ -0,0 +1,80 @@ +# Apache Aurora Presentations +Video and slides from presentations and panel discussions about Apache Aurora. + +_(Listed in date descending order)_ + +<table> + + <tr> + <td><img src="/documentation/0.18.0/images/presentations/10_08_2015_mesos_aurora_on_a_small_scale_thumb.png" alt="Mesos and Aurora on a Small Scale Thumbnail" /></td> + <td><strong><a href="https://www.youtube.com/watch?v=q5iIqhaCJ_o";>Mesos & Aurora on a Small Scale (Video)</a></strong> + <p>Presented by Florian Pfeiffer</p> + <p>October 8, 2015 at <a href="http://events.linuxfoundation.org/events/archive/2015/mesoscon-europe";>#MesosCon Europe 2015</a></p></td> + </tr> + <tr> + <td><img src="/documentation/0.18.0/images/presentations/10_08_2015_sla_aware_maintenance_for_operators_thumb.png" alt="SLA Aware Maintenance for Operators Thumbnail" /></td> + <td><strong><a href="https://www.youtube.com/watch?v=tZ0-SISvCis";>SLA Aware Maintenance for Operators (Video)</a></strong> + <p>Presented by Joe Smith</p> + <p>October 8, 2015 at <a href="http://events.linuxfoundation.org/events/archive/2015/mesoscon-europe";>#MesosCon Europe 2015</a></p></td> + </tr> + <tr> + <td><img src="/documentation/0.18.0/images/presentations/09_20_2015_shipping_code_with_aurora_thumb.png" alt="Shipping Code with Aurora Thumbnail" /></td> + <td><strong><a href="https://www.youtube.com/watch?v=y1hi7K1lPkk";>Shipping Code with Aurora (Video)</a></strong> + <p>Presented by Bill Farner</p> + <p>August 20, 2015 at <a href="http://events.linuxfoundation.org/events/archive/2015/mesoscon";>#MesosCon 2015</a></p></td> + </tr> + <tr> + <td><img src="/documentation/0.18.0/images/presentations/09_20_2015_twitter_production_scale_thumb.png" alt="Twitter Production Scale Thumbnail" /></td> + <td><strong><a href="https://www.youtube.com/watch?v=nNrh-gdu9m4";>Twitterâs Production Scale: Mesos and Aurora Operations (Video)</a></strong> + <p>Presented by Joe Smith</p> + <p>August 20, 2015 at <a href="http://events.linuxfoundation.org/events/archive/2015/mesoscon";>#MesosCon 2015</a></p></td> + </tr> + <tr> + <td><img src="/documentation/0.18.0/images/presentations/04_30_2015_monolith_to_microservices_thumb.png" alt="From Monolith to Microservices with Aurora Video Thumbnail" /></td> + <td><strong><a href="https://www.youtube.com/watch?v=yXkOgnyK4Hw";>>From Monolith to Microservices w/ Aurora (Video)</a></strong> + <p>Presented by Thanos Baskous, Tony Dong, Dobromir Montauk</p> + <p>April 30, 2015 at <a href="http://www.meetup.com/Bay-Area-Apache-Aurora-Users-Group/events/221219480/";>Bay Area Apache Aurora Users Group</a></p></td> + </tr> + <tr> + <td><img src="/documentation/0.18.0/images/presentations/03_07_2015_aurora_mesos_in_practice_at_twitter_thumb.png" alt="Aurora + Mesos in Practice at Twitter Thumbnail" /></td> + <td><strong><a href="https://www.youtube.com/watch?v=1XYJGX_qZVU";>Aurora + Mesos in Practice at Twitter (Video)</a></strong> + <p>Presented by Bill Farner</p> + <p>March 07, 2015 at <a href="http://www.bigeng.io/aurora-mesos-in-practice-at-twitter";>Bigcommerce TechTalk</a></p></td> + </tr> + <tr> + <td><img src="/documentation/0.18.0/images/presentations/02_28_2015_apache_aurora_thumb.png" alt="Apache Auroraã®å§ããã Slideshow Thumbnail" /></td> + <td><strong><a href="http://www.slideshare.net/zembutsu/apache-aurora-introduction-and-tutorial-osc15tk";>Apache Auroraã®å§ããã (Slides)</a></strong> + <p>Presented by Masahito Zembutsu</p> + <p>February 28, 2015 at <a href="http://www.ospn.jp/osc2015-spring/";>Open Source Conference 2015 Tokyo Spring</a></p></td> + </tr> + <tr> + <td><img src="/documentation/0.18.0/images/presentations/02_19_2015_aurora_adopters_panel_thumb.png" alt="Apache Aurora Adopters Panel Video Thumbnail" /></td> + <td><strong><a href="https://www.youtube.com/watch?v=2Jsj0zFdRlg";>Apache Aurora Adopters Panel (Video)</a></strong> + <p>Panelists Ben Staffin, Josh Adams, Bill Farner, Berk Demir</p> + <p>February 19, 2015 at <a href="http://www.meetup.com/Bay-Area-Mesos-User-Group/events/220279080/";>Bay Area Mesos Users Group</a></p></td> + </tr> + <tr> + <td><img src="/documentation/0.18.0/images/presentations/02_19_2015_aurora_at_twitter_thumb.png" alt="Operating Apache Aurora and Mesos at Twitter Video Thumbnail" /></td> + <td><strong><a href="https://www.youtube.com/watch?v=E4lxX6epM_U";>Operating Apache Aurora and Mesos at Twitter (Video)</a></strong> + <p>Presented by Joe Smith</p> + <p>February 19, 2015 at <a href="http://www.meetup.com/Bay-Area-Mesos-User-Group/events/220279080/";>Bay Area Mesos Users Group</a></p></td> + </tr> + <tr> + <td><img src="/documentation/0.18.0/images/presentations/02_19_2015_aurora_at_tellapart_thumb.png" alt="Apache Aurora and Mesos at TellApart" /></td> + <td><strong><a href="https://www.youtube.com/watch?v=ZZXtXLvTXAE";>Apache Aurora and Mesos at TellApart (Video)</a></strong> + <p>Presented by Steve Niemitz</p> + <p>February 19, 2015 at <a href="http://www.meetup.com/Bay-Area-Mesos-User-Group/events/220279080/";>Bay Area Mesos Users Group</a></p></td> + </tr> + <tr> + <td><img src="/documentation/0.18.0/images/presentations/08_21_2014_past_present_future_thumb.png" alt="Past, Present, and Future of the Aurora Scheduler Video Thumbnail" /></td> + <td><strong><a href="https://www.youtube.com/watch?v=Dsc5CPhKs4o";>Past, Present, and Future of the Aurora Scheduler (Video)</a></strong> + <p>Presented by Bill Farner</p> + <p>August 21, 2014 at <a href="http://events.linuxfoundation.org/events/archive/2014/mesoscon";>#MesosCon 2014</a></p></td> + </tr> + <tr> + <td><img src="/documentation/0.18.0/images/presentations/03_25_2014_introduction_to_aurora_thumb.png" alt="Introduction to Apache Aurora Video Thumbnail" /></td> + <td><strong><a href="https://www.youtube.com/watch?v=asd_h6VzaJc";>Introduction to Apache Aurora (Video)</a></strong> + <p>Presented by Bill Farner</p> + <p>March 25, 2014 at <a href="https://www.eventbrite.com/e/aurora-and-mesosframeworksmeetup-tickets-10850994617";>Aurora and Mesos Frameworks Meetup</a></p></td> + </tr> +</table> Added: aurora/site/source/documentation/0.18.0/additional-resources/tools.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.18.0/additional-resources/tools.md?rev=1799392&view=auto ============================================================================== --- aurora/site/source/documentation/0.18.0/additional-resources/tools.md (added) +++ aurora/site/source/documentation/0.18.0/additional-resources/tools.md Wed Jun 21 06:36:21 2017 @@ -0,0 +1,24 @@ +# Tools + +Various tools integrate with Aurora. Is there a tool missing? Let us know, or submit a patch to add it! + +* Load-balancing technology used to direct traffic to services running on Aurora: + - [synapse](https://github.com/airbnb/synapse) based on HAProxy + - [aurproxy](https://github.com/tellapart/aurproxy) based on nginx + - [jobhopper](https://github.com/benley/aurora-jobhopper) performs HTTP redirects for easy developer and administrator access + +* RPC libraries that integrate with the Aurora's [service discovery mechanism](../../features/service-discovery/): + - [linkerd](https://linkerd.io/) RPC proxy + - [finagle](https://twitter.github.io/finagle) (Scala) + - [scales](https://github.com/steveniemitz/scales) (Python) + +* Monitoring: + - [collectd-aurora](https://github.com/zircote/collectd-aurora) for cluster monitoring using collectd + - [Prometheus Aurora exporter](https://github.com/tommyulfsparre/aurora_exporter) for cluster monitoring using Prometheus + - [Prometheus service discovery integration](http://prometheus.io/docs/operating/configuration/#zookeeper-serverset-sd-configurations-serverset_sd_config) for discovering and monitoring services running on Aurora + +* Packaging and deployment: + - [aurora-packaging](https://github.com/apache/aurora-packaging), the source of the official Aurora packages + +* Thrift Clients: + - [gorealis](https://github.com/rdelval/gorealis) for communicating with the scheduler using Go Added: aurora/site/source/documentation/0.18.0/contributing.md URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/0.18.0/contributing.md?rev=1799392&view=auto ============================================================================== --- aurora/site/source/documentation/0.18.0/contributing.md (added) +++ aurora/site/source/documentation/0.18.0/contributing.md Wed Jun 21 06:36:21 2017 @@ -0,0 +1,93 @@ +## Get the Source Code + +First things first, you'll need the source! The Aurora source is available from Apache git: + + git clone https://git-wip-us.apache.org/repos/asf/aurora + +Read the Style Guides +--------------------- +Aurora's codebase is primarily Java and Python and conforms to the Twitter Commons styleguides for +both languages. + +- [Java Style Guide](https://github.com/twitter/commons/blob/master/src/java/com/twitter/common/styleguide.md) +- [Python Style Guide](https://github.com/twitter/commons/blob/master/src/python/twitter/common/styleguide.md) + +## Find Something to Do + +There are issues in [Jira](https://issues.apache.org/jira/browse/AURORA) with the +["newbie" label](https://issues.apache.org/jira/issues/?jql=project%20%3D%20AURORA%20AND%20labels%20%3D%20newbie%20and%20resolution%3Dunresolved) +that are good starting places for new Aurora contributors; pick one of these and dive in! To assign +a task to yourself, first ask for your JIRA id to be whitelisted by either asking in IRC/Slack or by +emailing [email protected]. Once your JIRA account has been whitelisted you can assign tickets +to yourself. The next step is to prepare your patch and finally post it for review. + +## Getting your ReviewBoard Account + +Go to https://reviews.apache.org and create an account. + +## Setting up your ReviewBoard Environment + +Run `./rbt status`. The first time this runs it will bootstrap and you will be asked to login. +Subsequent runs will cache your login credentials. + +## Submitting a Patch for Review + +Post a review with `rbt`, fill out the fields in your browser and hit Publish. + + ./rbt post -o + +If you're unsure about who to add as a reviewer, you can default to adding Zameer Manji (zmanji) and +Joshua Cohen (jcohen). They will take care of finding an appropriate reviewer for the patch. + +Once you've done this, you probably want to mark the associated Jira issue as Reviewable. + +## Updating an Existing Review + +Incorporate review feedback, make some more commits, update your existing review, fill out the +fields in your browser and hit Publish. + + ./rbt post -o -r <RB_ID> + +## Getting Your Review Merged + +If you're not an Aurora committer, one of the committers will merge your change in as described +below. Generally, the last reviewer to give the review a 'Ship It!' will be responsible. + +### Merging Your Own Review (Committers) + +Once you have shipits from the right committers, merge your changes in a single commit and mark +the review as submitted. The typical workflow is: + + git checkout master + git pull origin master + ./rbt patch -c <RB_ID> # Verify the automatically-generated commit message looks sane, + # editing if necessary. + git show master # Verify everything looks sane + git push origin master + ./rbt close <RB_ID> + +Note that even if you're developing using feature branches you will not use `git merge` - each +commit will be an atomic change accompanied by a ReviewBoard entry. + +### Merging Someone Else's Review + +Sometimes you'll need to merge someone else's RB. The typical workflow for this is + + git checkout master + git pull origin master + ./rbt patch -c <RB_ID> + git show master # Verify everything looks sane, author is correct + git push origin master + +Note for committers: while we generally use the commit message generated by `./rbt patch` some +changes are often required: + +1. Ensure the the commit message does not exceed 100 characters per line. +2. Remove the "Testing Done" section. It's generally redundant (can be seen by checking the linked + review) or entirely irrelevant to the commit itself. + +## Cleaning Up + +Your patch has landed, congratulations! The last thing you'll want to do before moving on to your +next fix is to clean up your Jira and Reviewboard. The former of which should be marked as +"Resolved" while the latter should be marked as "Submitted".
