Repository: incubator-airflow-site Updated Branches: refs/heads/asf-site 4af0850c3 -> 5e5740122
http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/9c75ee9e/security.html ---------------------------------------------------------------------- diff --git a/security.html b/security.html index 25ada3c..d0156b7 100644 --- a/security.html +++ b/security.html @@ -30,8 +30,11 @@ + <link rel="index" title="Index" + href="genindex.html"/> + <link rel="search" title="Search" href="search.html"/> <link rel="top" title="Airflow Documentation" href="index.html"/> - <link rel="next" title="FAQ" href="faq.html"/> + <link rel="next" title="Experimental Rest API" href="api.html"/> <link rel="prev" title="Plugins" href="plugins.html"/> @@ -41,6 +44,7 @@ <body class="wy-body-for-nav" role="document"> + <div class="wy-grid-for-nav"> @@ -102,12 +106,27 @@ <li class="toctree-l3"><a class="reference internal" href="#limitations">Limitations</a></li> <li class="toctree-l3"><a class="reference internal" href="#enabling-kerberos">Enabling kerberos</a></li> <li class="toctree-l3"><a class="reference internal" href="#using-kerberos-authentication">Using kerberos authentication</a></li> -<li class="toctree-l3"><a class="reference internal" href="#github-enterprise-ghe-authentication">GitHub Enterprise (GHE) Authentication</a></li> -<li class="toctree-l3"><a class="reference internal" href="#setting-up-ghe-authentication">Setting up GHE Authentication</a></li> </ul> </li> +<li class="toctree-l2"><a class="reference internal" href="#oauth-authentication">OAuth Authentication</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#github-enterprise-ghe-authentication">GitHub Enterprise (GHE) Authentication</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#setting-up-ghe-authentication">Setting up GHE Authentication</a></li> +</ul> +</li> +<li class="toctree-l3"><a class="reference internal" href="#google-authentication">Google Authentication</a><ul> +<li class="toctree-l4"><a class="reference internal" href="#setting-up-google-authentication">Setting up Google Authentication</a></li> +</ul> +</li> +</ul> +</li> +<li class="toctree-l2"><a class="reference internal" href="#ssl">SSL</a><ul> +<li class="toctree-l3"><a class="reference internal" href="#impersonation">Impersonation</a></li> </ul> </li> +</ul> +</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="faq.html">FAQ</a></li> <li class="toctree-l1"><a class="reference internal" href="code.html">API Reference</a></li> </ul> @@ -122,8 +141,10 @@ <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="index.html">Airflow</a> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">Airflow</a> + </nav> @@ -132,23 +153,40 @@ <div class="rst-content"> - + + + + + + + + + + + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> - <li><a href="index.html">Docs</a> »</li> - - <li>Security</li> + + <li><a href="index.html">Docs</a> »</li> + + <li>Security</li> + + <li class="wy-breadcrumbs-aside"> - - <a href="_sources/security.txt" rel="nofollow"> View page source</a> + + <a href="_sources/security.rst.txt" rel="nofollow"> View page source</a> </li> + </ul> + + <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> @@ -156,13 +194,13 @@ <div class="section" id="security"> <h1>Security<a class="headerlink" href="#security" title="Permalink to this headline">¶</a></h1> -<div class="section" id="web-authentication"> -<h2>Web Authentication<a class="headerlink" href="#web-authentication" title="Permalink to this headline">¶</a></h2> <p>By default, all gates are opened. An easy way to restrict access to the web application is to do it at the network level, or by using SSH tunnels.</p> <p>It is however possible to switch on authentication by either using one of the supplied backends or create your own.</p> +<div class="section" id="web-authentication"> +<h2>Web Authentication<a class="headerlink" href="#web-authentication" title="Permalink to this headline">¶</a></h2> <div class="section" id="password"> <h3>Password<a class="headerlink" href="#password" title="Permalink to this headline">¶</a></h3> <p>One of the simplest mechanisms for authentication is requiring users to specify a password before logging in. @@ -331,6 +369,9 @@ section of the connection. For the login user specify the following as extra:</p </pre></div> </div> </div> +</div> +<div class="section" id="oauth-authentication"> +<h2>OAuth Authentication<a class="headerlink" href="#oauth-authentication" title="Permalink to this headline">¶</a></h2> <div class="section" id="github-enterprise-ghe-authentication"> <h3>GitHub Enterprise (GHE) Authentication<a class="headerlink" href="#github-enterprise-ghe-authentication" title="Permalink to this headline">¶</a></h3> <p>The GitHub Enterprise authentication backend can be used to authenticate users @@ -348,12 +389,11 @@ your GHE installation will be able to login to Airflow.</p> <span class="nv">client_id</span> <span class="o">=</span> oauth_key_from_github_enterprise <span class="nv">client_secret</span> <span class="o">=</span> oauth_secret_from_github_enterprise <span class="nv">oauth_callback_route</span> <span class="o">=</span> /example/ghe_oauth/callback -<span class="nv">allowed_teams</span> <span class="o">=</span> example_team_1, example_team_2 +<span class="nv">allowed_teams</span> <span class="o">=</span> 1, 345, 23 </pre></div> </div> -</div> <div class="section" id="setting-up-ghe-authentication"> -<h3>Setting up GHE Authentication<a class="headerlink" href="#setting-up-ghe-authentication" title="Permalink to this headline">¶</a></h3> +<h4>Setting up GHE Authentication<a class="headerlink" href="#setting-up-ghe-authentication" title="Permalink to this headline">¶</a></h4> <p>An application must be setup in GHE before you can use the GHE authentication backend. In order to setup an application:</p> <ol class="arabic simple"> @@ -367,19 +407,87 @@ backend. In order to setup an application:</p> </ol> </div> </div> +<div class="section" id="google-authentication"> +<h3>Google Authentication<a class="headerlink" href="#google-authentication" title="Permalink to this headline">¶</a></h3> +<p>The Google authentication backend can be used to authenticate users +against Google using OAuth2. You must specify a domain to restrict login +to only members of that domain.</p> +<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="o">[</span>webserver<span class="o">]</span> +<span class="nv">authenticate</span> <span class="o">=</span> True +<span class="nv">auth_backend</span> <span class="o">=</span> airflow.contrib.auth.backends.google_auth + +<span class="o">[</span>google<span class="o">]</span> +<span class="nv">client_id</span> <span class="o">=</span> google_client_id +<span class="nv">client_secret</span> <span class="o">=</span> google_client_secret +<span class="nv">oauth_callback_route</span> <span class="o">=</span> /oauth2callback +<span class="nv">domain</span> <span class="o">=</span> example.com +</pre></div> +</div> +<div class="section" id="setting-up-google-authentication"> +<h4>Setting up Google Authentication<a class="headerlink" href="#setting-up-google-authentication" title="Permalink to this headline">¶</a></h4> +<p>An application must be setup in the Google API Console before you can use the Google authentication +backend. In order to setup an application:</p> +<ol class="arabic simple"> +<li>Navigate to <a class="reference external" href="https://console.developers.google.com/apis/";>https://console.developers.google.com/apis/</a></li> +<li>Select ‘Credentials’ from the left hand nav</li> +<li>Click ‘Create credentials’ and choose ‘OAuth client ID’</li> +<li>Choose ‘Web application’</li> +<li>Fill in the required information (the ‘Authorized redirect URIs’ must be fully qualifed e.g. <a class="reference external" href="http://airflow.example.com/oauth2callback";>http://airflow.example.com/oauth2callback</a>)</li> +<li>Click ‘Create’</li> +<li>Copy ‘Client ID’, ‘Client Secret’, and your redirect URI to your airflow.cfg according to the above example</li> +</ol> +</div> +</div> +</div> +<div class="section" id="ssl"> +<h2>SSL<a class="headerlink" href="#ssl" title="Permalink to this headline">¶</a></h2> +<p>SSL can be enabled by providing a certificate and key. Once enabled, be sure to use +“<a class="reference external" href="https://";>https://</a>” in your browser.</p> +<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="o">[</span>webserver<span class="o">]</span> +<span class="nv">web_server_ssl_cert</span> <span class="o">=</span> <path to cert> +<span class="nv">web_server_ssl_key</span> <span class="o">=</span> <path to key> +</pre></div> +</div> +<p>Enabling SSL will not automatically change the web server port. If you want to use the +standard port 443, you’ll need to configure that too. Be aware that super user privileges +(or cap_net_bind_service on Linux) are required to listen on port 443.</p> +<div class="highlight-bash"><div class="highlight"><pre><span></span><span class="c1"># Optionally, set the server to listen on the standard SSL port.</span> +<span class="nv">web_server_port</span> <span class="o">=</span> 443 +<span class="nv">base_url</span> <span class="o">=</span> http://<hostname or IP>:443 +</pre></div> +</div> +<div class="section" id="impersonation"> +<h3>Impersonation<a class="headerlink" href="#impersonation" title="Permalink to this headline">¶</a></h3> +<p>Airflow has the ability to impersonate a unix user while running task +instances based on the task’s <code class="docutils literal"><span class="pre">run_as_user</span></code> parameter, which takes a user’s name.</p> +<p><em>NOTE</em> For impersonations to work, Airflow must be run with <cite>sudo</cite> as subtasks are run +with <cite>sudo -u</cite> and permissions of files are changed. Furthermore, the unix user needs to +exist on the worker. Here is what a simple sudoers file entry could look like to achieve +this, assuming as airflow is running as the <cite>airflow</cite> user. Note that this means that +the airflow user must be trusted and treated the same way as the root user.</p> +<p>Subtasks with impersonation will still log to the same folder, except that the files they +log to will have permissions changed such that only the unix user can write to it.</p> +<p><em>Default impersonation</em> To prevent tasks that don’t use impersonation to be run with +<cite>sudo</cite> privileges, you can set the <cite>default_impersonation</cite> config in <cite>core</cite> which sets a +default user impersonate if <cite>run_as_user</cite> is not set.</p> +</div> +</div> </div> </div> + <div class="articleComments"> + + </div> </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="faq.html" class="btn btn-neutral float-right" title="FAQ" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> + <a href="api.html" class="btn btn-neutral float-right" title="Experimental Rest API" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="plugins.html" class="btn btn-neutral" title="Plugins" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="plugins.html" class="btn btn-neutral" title="Plugins" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -412,7 +520,8 @@ backend. In order to setup an application:</p> VERSION:'', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' }; </script> <script type="text/javascript" src="_static/jquery.js"></script> http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/9c75ee9e/start.html ---------------------------------------------------------------------- diff --git a/start.html b/start.html index 215a4cc..511a95b 100644 --- a/start.html +++ b/start.html @@ -30,6 +30,9 @@ + <link rel="index" title="Index" + href="genindex.html"/> + <link rel="search" title="Search" href="search.html"/> <link rel="top" title="Airflow Documentation" href="index.html"/> <link rel="next" title="Installation" href="installation.html"/> <link rel="prev" title="License" href="license.html"/> @@ -41,6 +44,7 @@ <body class="wy-body-for-nav" role="document"> + <div class="wy-grid-for-nav"> @@ -94,6 +98,8 @@ <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="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="faq.html">FAQ</a></li> <li class="toctree-l1"><a class="reference internal" href="code.html">API Reference</a></li> </ul> @@ -108,8 +114,10 @@ <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="index.html">Airflow</a> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">Airflow</a> + </nav> @@ -118,23 +126,40 @@ <div class="rst-content"> - + + + + + + + + + + + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> - <li><a href="index.html">Docs</a> »</li> - - <li>Quick Start</li> + + <li><a href="index.html">Docs</a> »</li> + + <li>Quick Start</li> + + <li class="wy-breadcrumbs-aside"> - - <a href="_sources/start.txt" rel="nofollow"> View page source</a> + + <a href="_sources/start.rst.txt" rel="nofollow"> View page source</a> </li> + </ul> + + <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> @@ -187,15 +212,18 @@ airflow backfill example_bash_operator -s 2015-01-01 -e 2015-01-02 </div> + <div class="articleComments"> + + </div> </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="installation.html" class="btn btn-neutral float-right" title="Installation" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> + <a href="installation.html" class="btn btn-neutral float-right" title="Installation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="license.html" class="btn btn-neutral" title="License" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="license.html" class="btn btn-neutral" title="License" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -228,7 +256,8 @@ airflow backfill example_bash_operator -s 2015-01-01 -e 2015-01-02 VERSION:'', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' }; </script> <script type="text/javascript" src="_static/jquery.js"></script> http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/9c75ee9e/tutorial.html ---------------------------------------------------------------------- diff --git a/tutorial.html b/tutorial.html index 17148bb..2a55053 100644 --- a/tutorial.html +++ b/tutorial.html @@ -30,6 +30,9 @@ + <link rel="index" title="Index" + href="genindex.html"/> + <link rel="search" title="Search" href="search.html"/> <link rel="top" title="Airflow Documentation" href="index.html"/> <link rel="next" title="Configuration" href="configuration.html"/> <link rel="prev" title="Installation" href="installation.html"/> @@ -41,6 +44,7 @@ <body class="wy-body-for-nav" role="document"> + <div class="wy-grid-for-nav"> @@ -110,6 +114,8 @@ <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="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="faq.html">FAQ</a></li> <li class="toctree-l1"><a class="reference internal" href="code.html">API Reference</a></li> </ul> @@ -124,8 +130,10 @@ <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="index.html">Airflow</a> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">Airflow</a> + </nav> @@ -134,23 +142,40 @@ <div class="rst-content"> - + + + + + + + + + + + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> - <li><a href="index.html">Docs</a> »</li> - - <li>Tutorial</li> + + <li><a href="index.html">Docs</a> »</li> + + <li>Tutorial</li> + + <li class="wy-breadcrumbs-aside"> - - <a href="_sources/tutorial.txt" rel="nofollow"> View page source</a> + + <a href="_sources/tutorial.rst.txt" rel="nofollow"> View page source</a> </li> + </ul> + + <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> @@ -553,15 +578,18 @@ running against it should get it to get triggered and run every day.</p> </div> + <div class="articleComments"> + + </div> </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="configuration.html" class="btn btn-neutral float-right" title="Configuration" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> + <a href="configuration.html" class="btn btn-neutral float-right" title="Configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="installation.html" class="btn btn-neutral" title="Installation" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="installation.html" class="btn btn-neutral" title="Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -594,7 +622,8 @@ running against it should get it to get triggered and run every day.</p> VERSION:'', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' }; </script> <script type="text/javascript" src="_static/jquery.js"></script> http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/9c75ee9e/ui.html ---------------------------------------------------------------------- diff --git a/ui.html b/ui.html index 30632bf..5852c52 100644 --- a/ui.html +++ b/ui.html @@ -30,6 +30,9 @@ + <link rel="index" title="Index" + href="genindex.html"/> + <link rel="search" title="Search" href="search.html"/> <link rel="top" title="Airflow Documentation" href="index.html"/> <link rel="next" title="Concepts" href="concepts.html"/> <link rel="prev" title="Configuration" href="configuration.html"/> @@ -41,6 +44,7 @@ <body class="wy-body-for-nav" role="document"> + <div class="wy-grid-for-nav"> @@ -101,6 +105,8 @@ <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="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="faq.html">FAQ</a></li> <li class="toctree-l1"><a class="reference internal" href="code.html">API Reference</a></li> </ul> @@ -115,8 +121,10 @@ <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> - <i data-toggle="wy-nav-top" class="fa fa-bars"></i> - <a href="index.html">Airflow</a> + + <i data-toggle="wy-nav-top" class="fa fa-bars"></i> + <a href="index.html">Airflow</a> + </nav> @@ -125,23 +133,40 @@ <div class="rst-content"> - + + + + + + + + + + + <div role="navigation" aria-label="breadcrumbs navigation"> + <ul class="wy-breadcrumbs"> - <li><a href="index.html">Docs</a> »</li> - - <li>UI / Screenshots</li> + + <li><a href="index.html">Docs</a> »</li> + + <li>UI / Screenshots</li> + + <li class="wy-breadcrumbs-aside"> - - <a href="_sources/ui.txt" rel="nofollow"> View page source</a> + + <a href="_sources/ui.rst.txt" rel="nofollow"> View page source</a> </li> + </ul> + + <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article";> @@ -227,15 +252,18 @@ that can take you to more detailed metadata, and perform some actions.</p> </div> + <div class="articleComments"> + + </div> </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> - <a href="concepts.html" class="btn btn-neutral float-right" title="Concepts" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> + <a href="concepts.html" class="btn btn-neutral float-right" title="Concepts" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> - <a href="configuration.html" class="btn btn-neutral" title="Configuration" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> + <a href="configuration.html" class="btn btn-neutral" title="Configuration" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> @@ -268,7 +296,8 @@ that can take you to more detailed metadata, and perform some actions.</p> VERSION:'', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', - HAS_SOURCE: true + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt' }; </script> <script type="text/javascript" src="_static/jquery.js"></script>
