Google Git
Sign in
apache / airflow-site / 77c6dabb9587337a8dd0fa948e813ca7eca6183e / . / docs-archive / 1.10.8 / kubernetes.html
blob: 98f97f9fdad26c7d695d7a884c74bb2b00d34514 [file] [log] [blame]
<!--
Javascript to render AIRFLOW-XXX and PR references in text
as HTML links.
Overrides extrahead block from sphinx_rtd_theme
https://www.sphinx-doc.org/en/master/templating.html
-->
<!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 &mdash; Airflow Documentation</title>
<link rel="shortcut icon" href="_static/pin_32.png"/>
<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/jira-links.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="stylesheet" href="_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="_static/exampleinclude.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="Error Tracking" href="errors.html" />
<script>
</script>
<style>
</style>
</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.8
</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 Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="scheduler.html">Scheduling &amp; Triggers</a></li>
<li class="toctree-l1"><a class="reference internal" href="executor/index.html">Executor</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">REST API Reference</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="errors.html">Error Tracking</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>
<li class="toctree-l2"><a class="reference internal" href="#pod-mutation-hook">Pod Mutation Hook</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="dag-serialization.html">DAG Serialization</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="best-practices.html">Best Practices</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="privacy_notice.html">Privacy Notice</a></li>
</ul>
<p class="caption"><span class="caption-text">References</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="_api/index.html">Python API</a></li>
<li class="toctree-l1"><a class="reference internal" href="configurations-ref.html">Configurations</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> &raquo;</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">
<blockquote>
<div></div></blockquote>
<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 <a class="reference internal" href="executor/kubernetes.html"><span class="doc">Kubernetes Executor</span></a> allows you to run tasks on Kubernetes as Pods.</p>
</div>
<div class="section" id="kubernetes-operator">
<h2>Kubernetes Operator<a class="headerlink" href="#kubernetes-operator" title="Permalink to this headline">ΒΆ</a></h2>
<p>The <a class="reference internal" href="executor/kubernetes.html"><span class="doc">KubernetesPodOperator</span></a> allows you to create Pods on Kubernetes. It works with
any type of executor.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></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="kn">from</span> <span class="nn">airflow.contrib.kubernetes.volume</span> <span class="kn">import</span> <span class="n">Volume</span>
<span class="kn">from</span> <span class="nn">airflow.contrib.kubernetes.volume_mount</span> <span class="kn">import</span> <span class="n">VolumeMount</span>
<span class="kn">from</span> <span class="nn">airflow.contrib.kubernetes.pod</span> <span class="kn">import</span> <span class="n">Port</span>
<span class="n">secret_file</span> <span class="o">=</span> <span class="n">Secret</span><span class="p">(</span><span class="s1">&#39;volume&#39;</span><span class="p">,</span> <span class="s1">&#39;/etc/sql_conn&#39;</span><span class="p">,</span> <span class="s1">&#39;airflow-secrets&#39;</span><span class="p">,</span> <span class="s1">&#39;sql_alchemy_conn&#39;</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">&#39;env&#39;</span><span class="p">,</span> <span class="s1">&#39;SQL_CONN&#39;</span><span class="p">,</span> <span class="s1">&#39;airflow-secrets&#39;</span><span class="p">,</span> <span class="s1">&#39;sql_alchemy_conn&#39;</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">&#39;env&#39;</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="s1">&#39;airflow-secrets-2&#39;</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">&#39;test-volume&#39;</span><span class="p">,</span>
<span class="n">mount_path</span><span class="o">=</span><span class="s1">&#39;/root/mount_file&#39;</span><span class="p">,</span>
<span class="n">sub_path</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">read_only</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
<span class="n">port</span> <span class="o">=</span> <span class="n">Port</span><span class="p">(</span><span class="s1">&#39;http&#39;</span><span class="p">,</span> <span class="mi">80</span><span class="p">)</span>
<span class="n">configmaps</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;test-configmap-1&#39;</span><span class="p">,</span> <span class="s1">&#39;test-configmap-2&#39;</span><span class="p">]</span>
<span class="n">volume_config</span><span class="o">=</span> <span class="p">{</span>
<span class="s1">&#39;persistentVolumeClaim&#39;</span><span class="p">:</span>
<span class="p">{</span>
<span class="s1">&#39;claimName&#39;</span><span class="p">:</span> <span class="s1">&#39;test-volume&#39;</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">&#39;test-volume&#39;</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">&#39;nodeAffinity&#39;</span><span class="p">:</span> <span class="p">{</span>
<span class="s1">&#39;preferredDuringSchedulingIgnoredDuringExecution&#39;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;weight&quot;</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
<span class="s2">&quot;preference&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">&quot;matchExpressions&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">&quot;key&quot;</span><span class="p">:</span> <span class="s2">&quot;disktype&quot;</span><span class="p">,</span>
<span class="s2">&quot;operator&quot;</span><span class="p">:</span> <span class="s2">&quot;In&quot;</span><span class="p">,</span>
<span class="s2">&quot;values&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;ssd&quot;</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">&quot;podAffinity&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">&quot;requiredDuringSchedulingIgnoredDuringExecution&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;labelSelector&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">&quot;matchExpressions&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;key&quot;</span><span class="p">:</span> <span class="s2">&quot;security&quot;</span><span class="p">,</span>
<span class="s2">&quot;operator&quot;</span><span class="p">:</span> <span class="s2">&quot;In&quot;</span><span class="p">,</span>
<span class="s2">&quot;values&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;S1&quot;</span><span class="p">]</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
<span class="s2">&quot;topologyKey&quot;</span><span class="p">:</span> <span class="s2">&quot;failure-domain.beta.kubernetes.io/zone&quot;</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
<span class="s2">&quot;podAntiAffinity&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">&quot;requiredDuringSchedulingIgnoredDuringExecution&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;labelSelector&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="s2">&quot;matchExpressions&quot;</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">&quot;key&quot;</span><span class="p">:</span> <span class="s2">&quot;security&quot;</span><span class="p">,</span>
<span class="s2">&quot;operator&quot;</span><span class="p">:</span> <span class="s2">&quot;In&quot;</span><span class="p">,</span>
<span class="s2">&quot;values&quot;</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;S2&quot;</span><span class="p">]</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
<span class="s2">&quot;topologyKey&quot;</span><span class="p">:</span> <span class="s2">&quot;kubernetes.io/hostname&quot;</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">&#39;key&#39;</span><span class="p">:</span> <span class="s2">&quot;key&quot;</span><span class="p">,</span>
<span class="s1">&#39;operator&#39;</span><span class="p">:</span> <span class="s1">&#39;Equal&#39;</span><span class="p">,</span>
<span class="s1">&#39;value&#39;</span><span class="p">:</span> <span class="s1">&#39;value&#39;</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">&#39;default&#39;</span><span class="p">,</span>
<span class="n">image</span><span class="o">=</span><span class="s2">&quot;ubuntu:16.04&quot;</span><span class="p">,</span>
<span class="n">cmds</span><span class="o">=</span><span class="p">[</span><span class="s2">&quot;bash&quot;</span><span class="p">,</span> <span class="s2">&quot;-cx&quot;</span><span class="p">],</span>
<span class="n">arguments</span><span class="o">=</span><span class="p">[</span><span class="s2">&quot;echo&quot;</span><span class="p">,</span> <span class="s2">&quot;10&quot;</span><span class="p">],</span>
<span class="n">labels</span><span class="o">=</span><span class="p">{</span><span class="s2">&quot;foo&quot;</span><span class="p">:</span> <span class="s2">&quot;bar&quot;</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">ports</span><span class="o">=</span><span class="p">[</span><span class="n">port</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">&quot;test&quot;</span><span class="p">,</span>
<span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;task&quot;</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="kc">True</span><span class="p">,</span>
<span class="n">hostnetwork</span><span class="o">=</span><span class="kc">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>
</div>
<div class="section" id="pod-mutation-hook">
<h2>Pod Mutation Hook<a class="headerlink" href="#pod-mutation-hook" title="Permalink to this headline">ΒΆ</a></h2>
<p>Your local Airflow settings file can define a <code class="docutils literal notranslate"><span class="pre">pod_mutation_hook</span></code> function that
has the ability to mutate pod objects before sending them to the Kubernetes client
for scheduling. It receives a single argument as a reference to pod objects, and
is expected to alter its attributes.</p>
<p>This could be used, for instance, to add sidecar or init containers
to every worker pod launched by KubernetesExecutor or KubernetesPodOperator.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">pod_mutation_hook</span><span class="p">(</span><span class="n">pod</span><span class="p">:</span> <span class="n">Pod</span><span class="p">):</span>
<span class="n">pod</span><span class="o">.</span><span class="n">annotations</span><span class="p">[</span><span class="s1">&#39;airflow.apache.org/launched-by&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="s1">&#39;Tests&#39;</span>
</pre></div>
</div>
</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="errors.html" class="btn btn-neutral float-left" title="Error Tracking" 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>.
<div class="footer">This page uses <a href="https://analytics.google.com/">
Google Analytics</a> to collect statistics. You can disable it by blocking
the JavaScript coming from www.google-analytics.com. Check our
<a href="privacy_notice.html">Privacy Policy</a>
for more details.
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<!-- Theme Analytics -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-140539454-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>