| |
| |
| |
| |
| <!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>airflow.contrib.operators.kubernetes_pod_operator — 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" /> |
| |
| <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> |
| |
| </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.4 |
| </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> |
| <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"><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="../../../../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><a href="../../../index.html">Module code</a> »</li> |
| |
| <li><a href="../operators.html">airflow.contrib.operators</a> »</li> |
| |
| <li>airflow.contrib.operators.kubernetes_pod_operator</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <h1>Source code for airflow.contrib.operators.kubernetes_pod_operator</h1><div class="highlight"><pre> |
| <span></span><span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="c1"># or more contributor license agreements. See the NOTICE file</span> |
| <span class="c1"># distributed with this work for additional information</span> |
| <span class="c1"># regarding copyright ownership. The ASF licenses this file</span> |
| <span class="c1"># to you under the Apache License, Version 2.0 (the</span> |
| <span class="c1"># "License"); you may not use this file except in compliance</span> |
| <span class="c1"># with the License. You may obtain a copy of the License at</span> |
| <span class="c1">#</span> |
| <span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="c1">#</span> |
| <span class="c1"># Unless required by applicable law or agreed to in writing,</span> |
| <span class="c1"># software distributed under the License is distributed on an</span> |
| <span class="c1"># "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span> |
| <span class="c1"># KIND, either express or implied. See the License for the</span> |
| <span class="c1"># specific language governing permissions and limitations</span> |
| <span class="c1"># under the License.</span> |
| |
| <span class="kn">from</span> <span class="nn">airflow.exceptions</span> <span class="k">import</span> <span class="n">AirflowException</span> |
| <span class="kn">from</span> <span class="nn">airflow.models</span> <span class="k">import</span> <span class="n">BaseOperator</span> |
| <span class="kn">from</span> <span class="nn">airflow.utils.decorators</span> <span class="k">import</span> <span class="n">apply_defaults</span> |
| <span class="kn">from</span> <span class="nn">airflow.contrib.kubernetes</span> <span class="k">import</span> <span class="n">kube_client</span><span class="p">,</span> <span class="n">pod_generator</span><span class="p">,</span> <span class="n">pod_launcher</span> |
| <span class="kn">from</span> <span class="nn">airflow.contrib.kubernetes.pod</span> <span class="k">import</span> <span class="n">Resources</span> |
| <span class="kn">from</span> <span class="nn">airflow.utils.state</span> <span class="k">import</span> <span class="n">State</span> |
| |
| |
| <div class="viewcode-block" id="KubernetesPodOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/kubernetes_pod_operator/index.html#airflow.contrib.operators.kubernetes_pod_operator.KubernetesPodOperator">[docs]</a><span class="k">class</span> <span class="nc">KubernetesPodOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Execute a task in a Kubernetes Pod</span> |
| |
| <span class="sd"> :param image: Docker image you wish to launch. Defaults to dockerhub.io,</span> |
| <span class="sd"> but fully qualified URLS will point to custom repositories</span> |
| <span class="sd"> :type image: str</span> |
| <span class="sd"> :param namespace: the namespace to run within kubernetes</span> |
| <span class="sd"> :type namespace: str</span> |
| <span class="sd"> :param cmds: entrypoint of the container. (templated)</span> |
| <span class="sd"> The docker images's entrypoint is used if this is not provide.</span> |
| <span class="sd"> :type cmds: list[str]</span> |
| <span class="sd"> :param arguments: arguments of the entrypoint. (templated)</span> |
| <span class="sd"> The docker image's CMD is used if this is not provided.</span> |
| <span class="sd"> :type arguments: list[str]</span> |
| <span class="sd"> :param image_pull_policy: Specify a policy to cache or always pull an image</span> |
| <span class="sd"> :type image_pull_policy: str</span> |
| <span class="sd"> :param image_pull_secrets: Any image pull secrets to be given to the pod.</span> |
| <span class="sd"> If more than one secret is required, provide a</span> |
| <span class="sd"> comma separated list: secret_a,secret_b</span> |
| <span class="sd"> :type image_pull_secrets: str</span> |
| <span class="sd"> :param ports: ports for launched pod</span> |
| <span class="sd"> :type ports: list[airflow.contrib.kubernetes.pod.Port]</span> |
| <span class="sd"> :param volume_mounts: volumeMounts for launched pod</span> |
| <span class="sd"> :type volume_mounts: list[airflow.contrib.kubernetes.volume_mount.VolumeMount]</span> |
| <span class="sd"> :param volumes: volumes for launched pod. Includes ConfigMaps and PersistentVolumes</span> |
| <span class="sd"> :type volumes: list[airflow.contrib.kubernetes.volume.Volume]</span> |
| <span class="sd"> :param labels: labels to apply to the Pod</span> |
| <span class="sd"> :type labels: dict</span> |
| <span class="sd"> :param startup_timeout_seconds: timeout in seconds to startup the pod</span> |
| <span class="sd"> :type startup_timeout_seconds: int</span> |
| <span class="sd"> :param name: name of the task you want to run,</span> |
| <span class="sd"> will be used to generate a pod id</span> |
| <span class="sd"> :type name: str</span> |
| <span class="sd"> :param env_vars: Environment variables initialized in the container. (templated)</span> |
| <span class="sd"> :type env_vars: dict</span> |
| <span class="sd"> :param secrets: Kubernetes secrets to inject in the container,</span> |
| <span class="sd"> They can be exposed as environment vars or files in a volume.</span> |
| <span class="sd"> :type secrets: list[airflow.contrib.kubernetes.secret.Secret]</span> |
| <span class="sd"> :param in_cluster: run kubernetes client with in_cluster configuration</span> |
| <span class="sd"> :type in_cluster: bool</span> |
| <span class="sd"> :param cluster_context: context that points to kubernetes cluster.</span> |
| <span class="sd"> Ignored when in_cluster is True. If None, current-context is used.</span> |
| <span class="sd"> :type cluster_context: str</span> |
| <span class="sd"> :param get_logs: get the stdout of the container as logs of the tasks</span> |
| <span class="sd"> :type get_logs: bool</span> |
| <span class="sd"> :param annotations: non-identifying metadata you can attach to the Pod.</span> |
| <span class="sd"> Can be a large range of data, and can include characters</span> |
| <span class="sd"> that are not permitted by labels.</span> |
| <span class="sd"> :type annotations: dict</span> |
| <span class="sd"> :param resources: A dict containing a group of resources requests and limits</span> |
| <span class="sd"> :type resources: dict</span> |
| <span class="sd"> :param affinity: A dict containing a group of affinity scheduling rules</span> |
| <span class="sd"> :type affinity: dict</span> |
| <span class="sd"> :param node_selectors: A dict containing a group of scheduling rules</span> |
| <span class="sd"> :type node_selectors: dict</span> |
| <span class="sd"> :param config_file: The path to the Kubernetes config file</span> |
| <span class="sd"> :type config_file: str</span> |
| <span class="sd"> :param xcom_push: If xcom_push is True, the content of the file</span> |
| <span class="sd"> /airflow/xcom/return.json in the container will also be pushed to an</span> |
| <span class="sd"> XCom when the container completes.</span> |
| <span class="sd"> :type xcom_push: bool</span> |
| <span class="sd"> :param is_delete_operator_pod: What to do when the pod reaches its final</span> |
| <span class="sd"> state, or the execution is interrupted.</span> |
| <span class="sd"> If False (default): do nothing, If True: delete the pod</span> |
| <span class="sd"> :type is_delete_operator_pod: bool</span> |
| <span class="sd"> :param hostnetwork: If True enable host networking on the pod</span> |
| <span class="sd"> :type hostnetwork: bool</span> |
| <span class="sd"> :param tolerations: A list of kubernetes tolerations</span> |
| <span class="sd"> :type tolerations: list tolerations</span> |
| <span class="sd"> :param configmaps: A list of configmap names objects that we</span> |
| <span class="sd"> want mount as env variables</span> |
| <span class="sd"> :type configmaps: list[str]</span> |
| <span class="sd"> :param pod_runtime_info_envs: environment variables about</span> |
| <span class="sd"> pod runtime information (ip, namespace, nodeName, podName)</span> |
| <span class="sd"> :type pod_runtime_info_envs: list[PodRuntimeEnv]</span> |
| <span class="sd"> :param dnspolicy: Specify a dnspolicy for the pod</span> |
| <span class="sd"> :type dnspolicy: str</span> |
| <span class="sd"> """</span> |
| <div class="viewcode-block" id="KubernetesPodOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/kubernetes_pod_operator/index.html#airflow.contrib.operators.kubernetes_pod_operator.KubernetesPodOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'cmds'</span><span class="p">,</span> <span class="s1">'arguments'</span><span class="p">,</span> <span class="s1">'env_vars'</span><span class="p">,</span> <span class="s1">'config_file'</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="KubernetesPodOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/kubernetes_pod_operator/index.html#airflow.contrib.operators.kubernetes_pod_operator.KubernetesPodOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">client</span> <span class="o">=</span> <span class="n">kube_client</span><span class="o">.</span><span class="n">get_kube_client</span><span class="p">(</span><span class="n">in_cluster</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">in_cluster</span><span class="p">,</span> |
| <span class="n">cluster_context</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">cluster_context</span><span class="p">,</span> |
| <span class="n">config_file</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">config_file</span><span class="p">)</span> |
| <span class="n">gen</span> <span class="o">=</span> <span class="n">pod_generator</span><span class="o">.</span><span class="n">PodGenerator</span><span class="p">()</span> |
| |
| <span class="k">for</span> <span class="n">port</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">ports</span><span class="p">:</span> |
| <span class="n">gen</span><span class="o">.</span><span class="n">add_port</span><span class="p">(</span><span class="n">port</span><span class="p">)</span> |
| <span class="k">for</span> <span class="n">mount</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">volume_mounts</span><span class="p">:</span> |
| <span class="n">gen</span><span class="o">.</span><span class="n">add_mount</span><span class="p">(</span><span class="n">mount</span><span class="p">)</span> |
| <span class="k">for</span> <span class="n">volume</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">volumes</span><span class="p">:</span> |
| <span class="n">gen</span><span class="o">.</span><span class="n">add_volume</span><span class="p">(</span><span class="n">volume</span><span class="p">)</span> |
| |
| <span class="n">pod</span> <span class="o">=</span> <span class="n">gen</span><span class="o">.</span><span class="n">make_pod</span><span class="p">(</span> |
| <span class="n">namespace</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">namespace</span><span class="p">,</span> |
| <span class="n">image</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">image</span><span class="p">,</span> |
| <span class="n">pod_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> |
| <span class="n">cmds</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">cmds</span><span class="p">,</span> |
| <span class="n">arguments</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">arguments</span><span class="p">,</span> |
| <span class="n">labels</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">labels</span><span class="p">,</span> |
| <span class="p">)</span> |
| |
| <span class="n">pod</span><span class="o">.</span><span class="n">service_account_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">service_account_name</span> |
| <span class="n">pod</span><span class="o">.</span><span class="n">secrets</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">secrets</span> |
| <span class="n">pod</span><span class="o">.</span><span class="n">envs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">env_vars</span> |
| <span class="n">pod</span><span class="o">.</span><span class="n">image_pull_policy</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">image_pull_policy</span> |
| <span class="n">pod</span><span class="o">.</span><span class="n">image_pull_secrets</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">image_pull_secrets</span> |
| <span class="n">pod</span><span class="o">.</span><span class="n">annotations</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">annotations</span> |
| <span class="n">pod</span><span class="o">.</span><span class="n">resources</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">resources</span> |
| <span class="n">pod</span><span class="o">.</span><span class="n">affinity</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">affinity</span> |
| <span class="n">pod</span><span class="o">.</span><span class="n">node_selectors</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">node_selectors</span> |
| <span class="n">pod</span><span class="o">.</span><span class="n">hostnetwork</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">hostnetwork</span> |
| <span class="n">pod</span><span class="o">.</span><span class="n">tolerations</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">tolerations</span> |
| <span class="n">pod</span><span class="o">.</span><span class="n">configmaps</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">configmaps</span> |
| <span class="n">pod</span><span class="o">.</span><span class="n">security_context</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">security_context</span> |
| <span class="n">pod</span><span class="o">.</span><span class="n">pod_runtime_info_envs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">pod_runtime_info_envs</span> |
| <span class="n">pod</span><span class="o">.</span><span class="n">dnspolicy</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">dnspolicy</span> |
| |
| <span class="n">launcher</span> <span class="o">=</span> <span class="n">pod_launcher</span><span class="o">.</span><span class="n">PodLauncher</span><span class="p">(</span><span class="n">kube_client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span> |
| <span class="n">extract_xcom</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">xcom_push</span><span class="p">)</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="p">(</span><span class="n">final_state</span><span class="p">,</span> <span class="n">result</span><span class="p">)</span> <span class="o">=</span> <span class="n">launcher</span><span class="o">.</span><span class="n">run_pod</span><span class="p">(</span> |
| <span class="n">pod</span><span class="p">,</span> |
| <span class="n">startup_timeout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">startup_timeout_seconds</span><span class="p">,</span> |
| <span class="n">get_logs</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">get_logs</span><span class="p">)</span> |
| <span class="k">finally</span><span class="p">:</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_delete_operator_pod</span><span class="p">:</span> |
| <span class="n">launcher</span><span class="o">.</span><span class="n">delete_pod</span><span class="p">(</span><span class="n">pod</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">final_state</span> <span class="o">!=</span> <span class="n">State</span><span class="o">.</span><span class="n">SUCCESS</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s1">'Pod returned a failure: </span><span class="si">{state}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">state</span><span class="o">=</span><span class="n">final_state</span><span class="p">)</span> |
| <span class="p">)</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">xcom_push</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">result</span> |
| <span class="k">except</span> <span class="n">AirflowException</span> <span class="k">as</span> <span class="n">ex</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s1">'Pod Launching failed: </span><span class="si">{error}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">error</span><span class="o">=</span><span class="n">ex</span><span class="p">))</span></div> |
| |
| <div class="viewcode-block" id="KubernetesPodOperator._set_resources"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/kubernetes_pod_operator/index.html#airflow.contrib.operators.kubernetes_pod_operator.KubernetesPodOperator._set_resources">[docs]</a> <span class="k">def</span> <span class="nf">_set_resources</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resources</span><span class="p">):</span> |
| <span class="n">inputResource</span> <span class="o">=</span> <span class="n">Resources</span><span class="p">()</span> |
| <span class="k">if</span> <span class="n">resources</span><span class="p">:</span> |
| <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">resources</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span> |
| <span class="nb">setattr</span><span class="p">(</span><span class="n">inputResource</span><span class="p">,</span> <span class="n">item</span><span class="p">,</span> <span class="n">resources</span><span class="p">[</span><span class="n">item</span><span class="p">])</span> |
| <span class="k">return</span> <span class="n">inputResource</span></div> |
| |
| <span class="nd">@apply_defaults</span> |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> |
| <span class="n">namespace</span><span class="p">,</span> |
| <span class="n">image</span><span class="p">,</span> |
| <span class="n">name</span><span class="p">,</span> |
| <span class="n">cmds</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">arguments</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">ports</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">volume_mounts</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">volumes</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">env_vars</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">secrets</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">in_cluster</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">cluster_context</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">labels</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">startup_timeout_seconds</span><span class="o">=</span><span class="mi">120</span><span class="p">,</span> |
| <span class="n">get_logs</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> |
| <span class="n">image_pull_policy</span><span class="o">=</span><span class="s1">'IfNotPresent'</span><span class="p">,</span> |
| <span class="n">annotations</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">resources</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">affinity</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">config_file</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">xcom_push</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">node_selectors</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">image_pull_secrets</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">service_account_name</span><span class="o">=</span><span class="s2">"default"</span><span class="p">,</span> |
| <span class="n">is_delete_operator_pod</span><span class="o">=</span><span class="kc">False</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="kc">None</span><span class="p">,</span> |
| <span class="n">configmaps</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">security_context</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">pod_runtime_info_envs</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">dnspolicy</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="o">*</span><span class="n">args</span><span class="p">,</span> |
| <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">KubernetesPodOperator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">image</span> <span class="o">=</span> <span class="n">image</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">namespace</span> <span class="o">=</span> <span class="n">namespace</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">cmds</span> <span class="o">=</span> <span class="n">cmds</span> <span class="ow">or</span> <span class="p">[]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">arguments</span> <span class="o">=</span> <span class="n">arguments</span> <span class="ow">or</span> <span class="p">[]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">labels</span> <span class="o">=</span> <span class="n">labels</span> <span class="ow">or</span> <span class="p">{}</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">startup_timeout_seconds</span> <span class="o">=</span> <span class="n">startup_timeout_seconds</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">env_vars</span> <span class="o">=</span> <span class="n">env_vars</span> <span class="ow">or</span> <span class="p">{}</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">ports</span> <span class="o">=</span> <span class="n">ports</span> <span class="ow">or</span> <span class="p">[]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">volume_mounts</span> <span class="o">=</span> <span class="n">volume_mounts</span> <span class="ow">or</span> <span class="p">[]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">volumes</span> <span class="o">=</span> <span class="n">volumes</span> <span class="ow">or</span> <span class="p">[]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">secrets</span> <span class="o">=</span> <span class="n">secrets</span> <span class="ow">or</span> <span class="p">[]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">in_cluster</span> <span class="o">=</span> <span class="n">in_cluster</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">cluster_context</span> <span class="o">=</span> <span class="n">cluster_context</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">get_logs</span> <span class="o">=</span> <span class="n">get_logs</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">image_pull_policy</span> <span class="o">=</span> <span class="n">image_pull_policy</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">node_selectors</span> <span class="o">=</span> <span class="n">node_selectors</span> <span class="ow">or</span> <span class="p">{}</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">annotations</span> <span class="o">=</span> <span class="n">annotations</span> <span class="ow">or</span> <span class="p">{}</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">affinity</span> <span class="o">=</span> <span class="n">affinity</span> <span class="ow">or</span> <span class="p">{}</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">xcom_push</span> <span class="o">=</span> <span class="n">xcom_push</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">resources</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_set_resources</span><span class="p">(</span><span class="n">resources</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span> <span class="o">=</span> <span class="n">config_file</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">image_pull_secrets</span> <span class="o">=</span> <span class="n">image_pull_secrets</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">service_account_name</span> <span class="o">=</span> <span class="n">service_account_name</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">is_delete_operator_pod</span> <span class="o">=</span> <span class="n">is_delete_operator_pod</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">hostnetwork</span> <span class="o">=</span> <span class="n">hostnetwork</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">tolerations</span> <span class="o">=</span> <span class="n">tolerations</span> <span class="ow">or</span> <span class="p">[]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">configmaps</span> <span class="o">=</span> <span class="n">configmaps</span> <span class="ow">or</span> <span class="p">[]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">security_context</span> <span class="o">=</span> <span class="n">security_context</span> <span class="ow">or</span> <span class="p">{}</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">pod_runtime_info_envs</span> <span class="o">=</span> <span class="n">pod_runtime_info_envs</span> <span class="ow">or</span> <span class="p">[]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">dnspolicy</span> <span class="o">=</span> <span class="n">dnspolicy</span></div> |
| </pre></div> |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| |
| <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> |