| |
| |
| |
| |
| <!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>Kubernetes — Airflow Documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="_static/js/modernizr.min.js"></script> |
| |
| |
| <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> |
| |
| |
| |
| |
| <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="Lineage" href="lineage.html" /> |
| <link rel="prev" title="Metrics" href="metrics.html" /> |
| |
| <script> |
| document.addEventListener('DOMContentLoaded', function() { |
| var el = document.getElementById('changelog'); |
| if (el !== null ) { |
| // [AIRFLOW-...] |
| el.innerHTML = el.innerHTML.replace( |
| /\[(AIRFLOW-[\d]+)\]/g, |
| `<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>` |
| ); |
| // (#...) |
| el.innerHTML = el.innerHTML.replace( |
| /\(#([\d]+)\)/g, |
| `<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>` |
| ); |
| }; |
| }) |
| </script> |
| <style> |
| .example-header { |
| position: relative; |
| background: #9AAA7A; |
| padding: 8px 16px; |
| margin-bottom: 0; |
| } |
| .example-header--with-button { |
| padding-right: 166px; |
| } |
| .example-header:after{ |
| content: ''; |
| display: table; |
| clear: both; |
| } |
| .example-title { |
| display:block; |
| padding: 4px; |
| margin-right: 16px; |
| color: white; |
| overflow-x: auto; |
| } |
| .example-header-button { |
| top: 8px; |
| right: 16px; |
| position: absolute; |
| } |
| .example-header + .highlight-python { |
| margin-top: 0 !important; |
| } |
| .viewcode-button { |
| display: inline-block; |
| padding: 8px 16px; |
| border: 0; |
| margin: 0; |
| outline: 0; |
| border-radius: 2px; |
| -webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3); |
| box-shadow: 0 3px 6px 0 rgba(0,0,0,.3); |
| color: #404040; |
| background-color: #e7e7e7; |
| cursor: pointer; |
| font-size: 16px; |
| font-weight: 500; |
| line-height: 1; |
| text-decoration: none; |
| text-overflow: ellipsis; |
| overflow: hidden; |
| text-transform: uppercase; |
| -webkit-transition: background-color .2s; |
| transition: background-color .2s; |
| vertical-align: middle; |
| white-space: nowrap; |
| } |
| .viewcode-button:visited { |
| color: #404040; |
| } |
| .viewcode-button:hover, .viewcode-button:focus { |
| color: #404040; |
| background-color: #d6d6d6; |
| } |
| </style> |
| <!-- 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 --> |
| </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.3 |
| </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"><a class="reference internal" href="installation.html">Installation</a></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 current"><a class="current reference internal" href="#">Kubernetes</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="#kubernetes-executor">Kubernetes Executor</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="#kubernetes-operator">Kubernetes Operator</a></li> |
| </ul> |
| </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="macros.html">Macros reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="_api/index.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>Kubernetes</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/kubernetes.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="kubernetes"> |
| <h1>Kubernetes<a class="headerlink" href="#kubernetes" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="kubernetes-executor"> |
| <h2>Kubernetes Executor<a class="headerlink" href="#kubernetes-executor" title="Permalink to this headline">¶</a></h2> |
| <p>The kubernetes executor is introduced in Apache Airflow 1.10.0. The Kubernetes executor will create a new pod for every task instance.</p> |
| <p>Example helm charts are available at <code class="docutils literal notranslate"><span class="pre">scripts/ci/kubernetes/kube/{airflow,volumes,postgres}.yaml</span></code> in the source distribution. |
| The volumes are optional and depend on your configuration. There are two volumes available:</p> |
| <ul class="simple"> |
| <li><p><strong>Dags</strong>:</p> |
| <ul> |
| <li><p>By storing dags onto persistent disk, it will be made available to all workers</p></li> |
| <li><p>Another option is to use <code class="docutils literal notranslate"><span class="pre">git-sync</span></code>. Before starting the container, a git pull of the dags repository will be performed and used throughout the lifecycle of the pod</p></li> |
| </ul> |
| </li> |
| <li><p><strong>Logs</strong>:</p> |
| <ul> |
| <li><p>By storing logs onto a persistent disk, the files are accessible by workers and the webserver. If you don’t configure this, the logs will be lost after the worker pods shuts down</p></li> |
| <li><p>Another option is to use S3/GCS/etc to store logs</p></li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="section" id="kubernetes-operator"> |
| <h2>Kubernetes Operator<a class="headerlink" href="#kubernetes-operator" title="Permalink to this headline">¶</a></h2> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">airflow.contrib.operators</span> <span class="kn">import</span> <span class="n">KubernetesOperator</span> |
| <span class="kn">from</span> <span class="nn">airflow.contrib.operators.kubernetes_pod_operator</span> <span class="kn">import</span> <span class="n">KubernetesPodOperator</span> |
| <span class="kn">from</span> <span class="nn">airflow.contrib.kubernetes.secret</span> <span class="kn">import</span> <span class="n">Secret</span> |
| |
| <span class="n">secret_file</span> <span class="o">=</span> <span class="n">Secret</span><span class="p">(</span><span class="s1">'volume'</span><span class="p">,</span> <span class="s1">'/etc/sql_conn'</span><span class="p">,</span> <span class="s1">'airflow-secrets'</span><span class="p">,</span> <span class="s1">'sql_alchemy_conn'</span><span class="p">)</span> |
| <span class="n">secret_env</span> <span class="o">=</span> <span class="n">Secret</span><span class="p">(</span><span class="s1">'env'</span><span class="p">,</span> <span class="s1">'SQL_CONN'</span><span class="p">,</span> <span class="s1">'airflow-secrets'</span><span class="p">,</span> <span class="s1">'sql_alchemy_conn'</span><span class="p">)</span> |
| <span class="n">secret_all_keys</span> <span class="o">=</span> <span class="n">Secret</span><span class="p">(</span><span class="s1">'env'</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="s1">'airflow-secrets-2'</span><span class="p">)</span> |
| <span class="n">volume_mount</span> <span class="o">=</span> <span class="n">VolumeMount</span><span class="p">(</span><span class="s1">'test-volume'</span><span class="p">,</span> |
| <span class="n">mount_path</span><span class="o">=</span><span class="s1">'/root/mount_file'</span><span class="p">,</span> |
| <span class="n">sub_path</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> |
| <span class="n">read_only</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span> |
| |
| <span class="n">configmaps</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'test-configmap-1'</span><span class="p">,</span> <span class="s1">'test-configmap-2'</span><span class="p">]</span> |
| |
| <span class="n">volume_config</span><span class="o">=</span> <span class="p">{</span> |
| <span class="s1">'persistentVolumeClaim'</span><span class="p">:</span> |
| <span class="p">{</span> |
| <span class="s1">'claimName'</span><span class="p">:</span> <span class="s1">'test-volume'</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| <span class="n">volume</span> <span class="o">=</span> <span class="n">Volume</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">'test-volume'</span><span class="p">,</span> <span class="n">configs</span><span class="o">=</span><span class="n">volume_config</span><span class="p">)</span> |
| |
| <span class="n">affinity</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="s1">'nodeAffinity'</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s1">'preferredDuringSchedulingIgnoredDuringExecution'</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"weight"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> |
| <span class="s2">"preference"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"matchExpressions"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"disktype"</span><span class="p">,</span> |
| <span class="s2">"operator"</span><span class="p">:</span> <span class="s2">"In"</span><span class="p">,</span> |
| <span class="s2">"values"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"ssd"</span><span class="p">]</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| <span class="p">]</span> |
| <span class="p">},</span> |
| <span class="s2">"podAffinity"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"requiredDuringSchedulingIgnoredDuringExecution"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"labelSelector"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"matchExpressions"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"security"</span><span class="p">,</span> |
| <span class="s2">"operator"</span><span class="p">:</span> <span class="s2">"In"</span><span class="p">,</span> |
| <span class="s2">"values"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"S1"</span><span class="p">]</span> |
| <span class="p">}</span> |
| <span class="p">]</span> |
| <span class="p">},</span> |
| <span class="s2">"topologyKey"</span><span class="p">:</span> <span class="s2">"failure-domain.beta.kubernetes.io/zone"</span> |
| <span class="p">}</span> |
| <span class="p">]</span> |
| <span class="p">},</span> |
| <span class="s2">"podAntiAffinity"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"requiredDuringSchedulingIgnoredDuringExecution"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"labelSelector"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"matchExpressions"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"security"</span><span class="p">,</span> |
| <span class="s2">"operator"</span><span class="p">:</span> <span class="s2">"In"</span><span class="p">,</span> |
| <span class="s2">"values"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"S2"</span><span class="p">]</span> |
| <span class="p">}</span> |
| <span class="p">]</span> |
| <span class="p">},</span> |
| <span class="s2">"topologyKey"</span><span class="p">:</span> <span class="s2">"kubernetes.io/hostname"</span> |
| <span class="p">}</span> |
| <span class="p">]</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| |
| <span class="n">tolerations</span> <span class="o">=</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s1">'key'</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span> |
| <span class="s1">'operator'</span><span class="p">:</span> <span class="s1">'Equal'</span><span class="p">,</span> |
| <span class="s1">'value'</span><span class="p">:</span> <span class="s1">'value'</span> |
| <span class="p">}</span> |
| <span class="p">]</span> |
| |
| <span class="n">k</span> <span class="o">=</span> <span class="n">KubernetesPodOperator</span><span class="p">(</span><span class="n">namespace</span><span class="o">=</span><span class="s1">'default'</span><span class="p">,</span> |
| <span class="n">image</span><span class="o">=</span><span class="s2">"ubuntu:16.04"</span><span class="p">,</span> |
| <span class="n">cmds</span><span class="o">=</span><span class="p">[</span><span class="s2">"bash"</span><span class="p">,</span> <span class="s2">"-cx"</span><span class="p">],</span> |
| <span class="n">arguments</span><span class="o">=</span><span class="p">[</span><span class="s2">"echo"</span><span class="p">,</span> <span class="s2">"10"</span><span class="p">],</span> |
| <span class="n">labels</span><span class="o">=</span><span class="p">{</span><span class="s2">"foo"</span><span class="p">:</span> <span class="s2">"bar"</span><span class="p">},</span> |
| <span class="n">secrets</span><span class="o">=</span><span class="p">[</span><span class="n">secret_file</span><span class="p">,</span> <span class="n">secret_env</span><span class="p">,</span> <span class="n">secret_all_keys</span><span class="p">],</span> |
| <span class="n">volumes</span><span class="o">=</span><span class="p">[</span><span class="n">volume</span><span class="p">],</span> |
| <span class="n">volume_mounts</span><span class="o">=</span><span class="p">[</span><span class="n">volume_mount</span><span class="p">]</span> |
| <span class="n">name</span><span class="o">=</span><span class="s2">"test"</span><span class="p">,</span> |
| <span class="n">task_id</span><span class="o">=</span><span class="s2">"task"</span><span class="p">,</span> |
| <span class="n">affinity</span><span class="o">=</span><span class="n">affinity</span><span class="p">,</span> |
| <span class="n">is_delete_operator_pod</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> |
| <span class="n">hostnetwork</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> |
| <span class="n">tolerations</span><span class="o">=</span><span class="n">tolerations</span><span class="p">,</span> |
| <span class="n">configmaps</span><span class="o">=</span><span class="n">configmaps</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>See <a class="reference internal" href="_api/airflow/contrib/operators/kubernetes_pod_operator/index.html#airflow.contrib.operators.kubernetes_pod_operator.KubernetesPodOperator" title="airflow.contrib.operators.kubernetes_pod_operator.KubernetesPodOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.contrib.operators.kubernetes_pod_operator.KubernetesPodOperator</span></code></a></p> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="lineage.html" class="btn btn-neutral float-right" title="Lineage" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="metrics.html" class="btn btn-neutral float-left" title="Metrics" 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"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |