blob: 74ea2104355961a4335e509c1a86204fce356ed7 [file] [log] [blame]
<!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_white_bkg.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">
<h1 id="documentation">Documentation</h1>
<h2 id="introduction">Introduction</h2>
<p>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&#39; scalability, fault-tolerance, and resource isolation. This documentation has been organized into sections with three audiences in mind:</p>
<ul>
<li>Users: General information about the project and to learn how to run an Aurora job.</li>
<li>Operators: For those that wish to manage and fine-tune an Aurora cluster.</li>
<li>Developers: All the information you need to start modifying Aurora and contributing back to the project.</li>
</ul>
<p>This documentation is a work in progress, and we encourage you to ask questions on the <a href="http://aurora.incubator.apache.org/community/">Aurora developer list</a> or the <code>#aurora</code> IRC channel on <code>irc.freenode.net</code>.</p>
<h2 id="users">Users</h2>
<ul>
<li><a href="/documentation/latest/vagrant/">Install Aurora on virtual machines on your private machine</a></li>
<li><a href="/documentation/latest/tutorial/">Hello World Tutorial</a></li>
<li><a href="/documentation/latest/user-guide/">User Guide</a></li>
<li><a href="/documentation/latest/configuration-tutorial/">Configuration Tutorial</a></li>
<li><a href="/documentation/latest/configuration-reference/">Aurora + Thermos Reference</a></li>
<li><a href="/documentation/latest/client-commands/">Command Line Client</a></li>
<li><a href="/documentation/latest/clientv2/">Aurora Client v2</a></li>
<li><a href="/documentation/latest/cron-jobs/">Cron Jobs</a></li>
</ul>
<h2 id="operators">Operators</h2>
<ul>
<li><a href="/documentation/latest/deploying-aurora-scheduler/">Deploy Aurora</a></li>
<li><a href="/documentation/latest/monitoring/">Monitoring</a></li>
<li><a href="/documentation/latest/hooks/">Hooks for Aurora Client API</a></li>
<li><a href="/documentation/latest/storage/">Scheduler Storage</a></li>
<li><a href="/documentation/latest/storage-config/">Scheduler Storage and Maintenance</a></li>
<li><a href="/documentation/latest/sla/">SLA Measurement</a></li>
<li><a href="/documentation/latest/resource-isolation/">Resource Isolation and Sizing</a></li>
<li><a href="/documentation/latest/test-resource-generation/">Generating test resources</a></li>
</ul>
<h2 id="developers">Developers</h2>
<ul>
<li><a href="/documentation/latest/contributing/">Contributing to the project</a></li>
<li><a href="/documentation/latest/developing-aurora-scheduler/">Developing the Aurora Scheduler</a></li>
<li><a href="/documentation/latest/developing-aurora-client/">Developing the Aurora Client</a></li>
<li><a href="/documentation/latest/committers/">Committers Guide</a></li>
</ul>
</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">Apache Aurora is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p>
<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>