| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>Installation — Airflow Documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="Tutorial" href="tutorial.html" /> |
| <link rel="prev" title="Quick Start" href="start.html" /> |
| |
| |
| <script src="_static/js/modernizr.min.js"></script> |
| <!-- Matomo --> |
| <script> |
| var _paq = window._paq = window._paq || []; |
| _paq.push(['disableCookies']); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '13']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script> |
| <!-- End Matomo --> |
| <link rel="canonical" href="https://airflow.apache.org/docs/apache-airflow/stable/installation.html" /> |
| </head> |
| |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search"> |
| |
| |
| |
| <a href="index.html" class="icon icon-home"> Airflow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 1.10.2 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="project.html">Project</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="start.html">Quick Start</a></li> |
| <li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="#getting-airflow">Getting Airflow</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="#extra-packages">Extra Packages</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="#initiating-airflow-database">Initiating Airflow Database</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="howto/index.html">How-to Guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="ui.html">UI / Screenshots</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="profiling.html">Data Profiling</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="cli.html">Command Line Interface</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="scheduler.html">Scheduling & Triggers</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="plugins.html">Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="security.html">Security</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="timezone.html">Time zones</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="api.html">Experimental Rest API</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="integration.html">Integration</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="metrics.html">Metrics</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="kubernetes.html">Kubernetes</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="lineage.html">Lineage</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="code.html">API Reference</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="index.html">Airflow</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="index.html">Docs</a> »</li> |
| |
| <li>Installation</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/installation.rst.txt" rel="nofollow"> View page source</a> |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="installation"> |
| <h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="getting-airflow"> |
| <h2>Getting Airflow<a class="headerlink" href="#getting-airflow" title="Permalink to this headline">¶</a></h2> |
| <p>The easiest way to install the latest stable version of Airflow is with <code class="docutils literal notranslate"><span class="pre">pip</span></code>:</p> |
| <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install apache-airflow |
| </pre></div> |
| </div> |
| <p>You can also install Airflow with support for extra features like <code class="docutils literal notranslate"><span class="pre">s3</span></code> or <code class="docutils literal notranslate"><span class="pre">postgres</span></code>:</p> |
| <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip install apache-airflow<span class="o">[</span>postgres,s3<span class="o">]</span> |
| </pre></div> |
| </div> |
| <div class="admonition note"> |
| <p class="first admonition-title">Note</p> |
| <p>GPL dependency</p> |
| <p class="last">One of the dependencies of Apache Airflow by default pulls in a GPL library (‘unidecode’). |
| In case this is a concern you can force a non GPL library by issuing |
| <code class="docutils literal notranslate"><span class="pre">export</span> <span class="pre">SLUGIFY_USES_TEXT_UNIDECODE=yes</span></code> and then proceed with the normal installation. |
| Please note that this needs to be specified at every upgrade. Also note that if <cite>unidecode</cite> |
| is already present on the system the dependency will still be used.</p> |
| </div> |
| </div> |
| <div class="section" id="extra-packages"> |
| <h2>Extra Packages<a class="headerlink" href="#extra-packages" title="Permalink to this headline">¶</a></h2> |
| <p>The <code class="docutils literal notranslate"><span class="pre">apache-airflow</span></code> PyPI basic package only installs what’s needed to get started. |
| Subpackages can be installed depending on what will be useful in your |
| environment. For instance, if you don’t need connectivity with Postgres, |
| you won’t have to go through the trouble of installing the <code class="docutils literal notranslate"><span class="pre">postgres-devel</span></code> |
| yum package, or whatever equivalent applies on the distribution you are using.</p> |
| <p>Behind the scenes, Airflow does conditional imports of operators that require |
| these extra dependencies.</p> |
| <p>Here’s the list of the subpackages and what they enable:</p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="17%" /> |
| <col width="42%" /> |
| <col width="40%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">subpackage</th> |
| <th class="head">install command</th> |
| <th class="head">enables</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td>all</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[all]</span></code></td> |
| <td>All Airflow features known to man</td> |
| </tr> |
| <tr class="row-odd"><td>all_dbs</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[all_dbs]</span></code></td> |
| <td>All databases integrations</td> |
| </tr> |
| <tr class="row-even"><td>async</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[async]</span></code></td> |
| <td>Async worker classes for Gunicorn</td> |
| </tr> |
| <tr class="row-odd"><td>celery</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[celery]</span></code></td> |
| <td>CeleryExecutor</td> |
| </tr> |
| <tr class="row-even"><td>cloudant</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[cloudant]</span></code></td> |
| <td>Cloudant hook</td> |
| </tr> |
| <tr class="row-odd"><td>crypto</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[crypto]</span></code></td> |
| <td>Encrypt connection passwords in metadata db</td> |
| </tr> |
| <tr class="row-even"><td>devel</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[devel]</span></code></td> |
| <td>Minimum dev tools requirements</td> |
| </tr> |
| <tr class="row-odd"><td>devel_hadoop</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[devel_hadoop]</span></code></td> |
| <td>Airflow + dependencies on the Hadoop stack</td> |
| </tr> |
| <tr class="row-even"><td>druid</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[druid]</span></code></td> |
| <td>Druid related operators & hooks</td> |
| </tr> |
| <tr class="row-odd"><td>gcp_api</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[gcp_api]</span></code></td> |
| <td>Google Cloud Platform hooks and operators |
| (using <code class="docutils literal notranslate"><span class="pre">google-api-python-client</span></code>)</td> |
| </tr> |
| <tr class="row-even"><td>github_enterprise</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[github_enterprise]</span></code></td> |
| <td>Github Enterprise auth backend</td> |
| </tr> |
| <tr class="row-odd"><td>google_auth</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[google_auth]</span></code></td> |
| <td>Google auth backend</td> |
| </tr> |
| <tr class="row-even"><td>hdfs</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[hdfs]</span></code></td> |
| <td>HDFS hooks and operators</td> |
| </tr> |
| <tr class="row-odd"><td>hive</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[hive]</span></code></td> |
| <td>All Hive related operators</td> |
| </tr> |
| <tr class="row-even"><td>jdbc</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[jdbc]</span></code></td> |
| <td>JDBC hooks and operators</td> |
| </tr> |
| <tr class="row-odd"><td>kerberos</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[kerberos]</span></code></td> |
| <td>Kerberos integration for Kerberized Hadoop</td> |
| </tr> |
| <tr class="row-even"><td>kubernetes</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[kubernetes]</span></code></td> |
| <td>Kubernetes Executor and operator</td> |
| </tr> |
| <tr class="row-odd"><td>ldap</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[ldap]</span></code></td> |
| <td>LDAP authentication for users</td> |
| </tr> |
| <tr class="row-even"><td>mssql</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[mssql]</span></code></td> |
| <td>Microsoft SQL Server operators and hook, |
| support as an Airflow backend</td> |
| </tr> |
| <tr class="row-odd"><td>mysql</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[mysql]</span></code></td> |
| <td>MySQL operators and hook, support as an Airflow |
| backend. The version of MySQL server has to be |
| 5.6.4+. The exact version upper bound depends |
| on version of <code class="docutils literal notranslate"><span class="pre">mysqlclient</span></code> package. For |
| example, <code class="docutils literal notranslate"><span class="pre">mysqlclient</span></code> 1.3.12 can only be |
| used with MySQL server 5.6.4 through 5.7.</td> |
| </tr> |
| <tr class="row-even"><td>password</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[password]</span></code></td> |
| <td>Password authentication for users</td> |
| </tr> |
| <tr class="row-odd"><td>postgres</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[postgres]</span></code></td> |
| <td>PostgreSQL operators and hook, support as an |
| Airflow backend</td> |
| </tr> |
| <tr class="row-even"><td>qds</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[qds]</span></code></td> |
| <td>Enable QDS (Qubole Data Service) support</td> |
| </tr> |
| <tr class="row-odd"><td>rabbitmq</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[rabbitmq]</span></code></td> |
| <td>RabbitMQ support as a Celery backend</td> |
| </tr> |
| <tr class="row-even"><td>redis</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[redis]</span></code></td> |
| <td>Redis hooks and sensors</td> |
| </tr> |
| <tr class="row-odd"><td>s3</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[s3]</span></code></td> |
| <td><code class="docutils literal notranslate"><span class="pre">S3KeySensor</span></code>, <code class="docutils literal notranslate"><span class="pre">S3PrefixSensor</span></code></td> |
| </tr> |
| <tr class="row-even"><td>samba</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[samba]</span></code></td> |
| <td><code class="docutils literal notranslate"><span class="pre">Hive2SambaOperator</span></code></td> |
| </tr> |
| <tr class="row-odd"><td>slack</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[slack]</span></code></td> |
| <td><code class="docutils literal notranslate"><span class="pre">SlackAPIPostOperator</span></code></td> |
| </tr> |
| <tr class="row-even"><td>ssh</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[ssh]</span></code></td> |
| <td>SSH hooks and Operator</td> |
| </tr> |
| <tr class="row-odd"><td>vertica</td> |
| <td><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">apache-airflow[vertica]</span></code></td> |
| <td>Vertica hook support as an Airflow backend</td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <div class="section" id="initiating-airflow-database"> |
| <h2>Initiating Airflow Database<a class="headerlink" href="#initiating-airflow-database" title="Permalink to this headline">¶</a></h2> |
| <p>Airflow requires a database to be initiated before you can run tasks. If |
| you’re just experimenting and learning Airflow, you can stick with the |
| default SQLite option. If you don’t want to use SQLite, then take a look at |
| <a class="reference internal" href="howto/initialize-database.html"><span class="doc">Initializing a Database Backend</span></a> to setup a different database.</p> |
| <p>After configuration, you’ll need to initialize the database before you can |
| run tasks:</p> |
| <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>airflow initdb |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="tutorial.html" class="btn btn-neutral float-right" title="Tutorial" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="start.html" class="btn btn-neutral" title="Quick Start" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> |
| <script type="text/javascript" src="_static/jquery.js"></script> |
| <script type="text/javascript" src="_static/underscore.js"></script> |
| <script type="text/javascript" src="_static/doctools.js"></script> |
| <script type="text/javascript" src="_static/language_data.js"></script> |
| |
| |
| |
| |
| <script type="text/javascript" src="_static/js/theme.js"></script> |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
