| |
| |
| <!-- |
| 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>airflow.operators.docker_operator — 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" /> |
| |
| <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> |
| <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 & 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"><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="../../../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> »</li> |
| |
| <li><a href="../../index.html">Module code</a> »</li> |
| |
| <li><a href="../operators.html">airflow.operators</a> »</li> |
| |
| <li>airflow.operators.docker_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.operators.docker_operator</h1><div class="highlight"><pre> |
| <span></span><span class="c1"># -*- coding: utf-8 -*-</span> |
| <span class="c1">#</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="sd">"""</span> |
| <span class="sd">Implements Docker operator</span> |
| <span class="sd">"""</span> |
| <span class="kn">import</span> <span class="nn">json</span> |
| |
| <span class="kn">import</span> <span class="nn">ast</span> |
| <span class="kn">from</span> <span class="nn">docker</span> <span class="kn">import</span> <span class="n">APIClient</span><span class="p">,</span> <span class="n">tls</span> |
| |
| <span class="kn">from</span> <span class="nn">airflow.hooks.docker_hook</span> <span class="kn">import</span> <span class="n">DockerHook</span> |
| <span class="kn">from</span> <span class="nn">airflow.exceptions</span> <span class="kn">import</span> <span class="n">AirflowException</span> |
| <span class="kn">from</span> <span class="nn">airflow.models</span> <span class="kn">import</span> <span class="n">BaseOperator</span> |
| <span class="kn">from</span> <span class="nn">airflow.utils.decorators</span> <span class="kn">import</span> <span class="n">apply_defaults</span> |
| <span class="kn">from</span> <span class="nn">airflow.utils.file</span> <span class="kn">import</span> <span class="n">TemporaryDirectory</span> |
| |
| |
| <div class="viewcode-block" id="DockerOperator"><a class="viewcode-back" href="../../../_api/airflow/operators/docker_operator/index.html#airflow.operators.docker_operator.DockerOperator">[docs]</a><span class="k">class</span> <span class="nc">DockerOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Execute a command inside a docker container.</span> |
| |
| <span class="sd"> A temporary directory is created on the host and</span> |
| <span class="sd"> mounted into a container to allow storing files</span> |
| <span class="sd"> that together exceed the default disk size of 10GB in a container.</span> |
| <span class="sd"> The path to the mounted directory can be accessed</span> |
| <span class="sd"> via the environment variable ``AIRFLOW_TMP_DIR``.</span> |
| |
| <span class="sd"> If a login to a private registry is required prior to pulling the image, a</span> |
| <span class="sd"> Docker connection needs to be configured in Airflow and the connection ID</span> |
| <span class="sd"> be provided with the parameter ``docker_conn_id``.</span> |
| |
| <span class="sd"> :param image: Docker image from which to create the container.</span> |
| <span class="sd"> If image tag is omitted, "latest" will be used.</span> |
| <span class="sd"> :type image: str</span> |
| <span class="sd"> :param api_version: Remote API version. Set to ``auto`` to automatically</span> |
| <span class="sd"> detect the server's version.</span> |
| <span class="sd"> :type api_version: str</span> |
| <span class="sd"> :param auto_remove: Auto-removal of the container on daemon side when the</span> |
| <span class="sd"> container's process exits.</span> |
| <span class="sd"> The default is False.</span> |
| <span class="sd"> :type auto_remove: bool</span> |
| <span class="sd"> :param command: Command to be run in the container. (templated)</span> |
| <span class="sd"> :type command: str or list</span> |
| <span class="sd"> :param container_name: Name of the container. Optional (templated)</span> |
| <span class="sd"> :type container_name: str or None</span> |
| <span class="sd"> :param cpus: Number of CPUs to assign to the container.</span> |
| <span class="sd"> This value gets multiplied with 1024. See</span> |
| <span class="sd"> https://docs.docker.com/engine/reference/run/#cpu-share-constraint</span> |
| <span class="sd"> :type cpus: float</span> |
| <span class="sd"> :param dns: Docker custom DNS servers</span> |
| <span class="sd"> :type dns: list[str]</span> |
| <span class="sd"> :param dns_search: Docker custom DNS search domain</span> |
| <span class="sd"> :type dns_search: list[str]</span> |
| <span class="sd"> :param docker_url: URL of the host running the docker daemon.</span> |
| <span class="sd"> Default is unix://var/run/docker.sock</span> |
| <span class="sd"> :type docker_url: str</span> |
| <span class="sd"> :param environment: Environment variables to set in the container. (templated)</span> |
| <span class="sd"> :type environment: dict</span> |
| <span class="sd"> :param force_pull: Pull the docker image on every run. Default is False.</span> |
| <span class="sd"> :type force_pull: bool</span> |
| <span class="sd"> :param mem_limit: Maximum amount of memory the container can use.</span> |
| <span class="sd"> Either a float value, which represents the limit in bytes,</span> |
| <span class="sd"> or a string like ``128m`` or ``1g``.</span> |
| <span class="sd"> :type mem_limit: float or str</span> |
| <span class="sd"> :param host_tmp_dir: Specify the location of the temporary directory on the host which will</span> |
| <span class="sd"> be mapped to tmp_dir. If not provided defaults to using the standard system temp directory.</span> |
| <span class="sd"> :type host_tmp_dir: str</span> |
| <span class="sd"> :param network_mode: Network mode for the container.</span> |
| <span class="sd"> :type network_mode: str</span> |
| <span class="sd"> :param tls_ca_cert: Path to a PEM-encoded certificate authority</span> |
| <span class="sd"> to secure the docker connection.</span> |
| <span class="sd"> :type tls_ca_cert: str</span> |
| <span class="sd"> :param tls_client_cert: Path to the PEM-encoded certificate</span> |
| <span class="sd"> used to authenticate docker client.</span> |
| <span class="sd"> :type tls_client_cert: str</span> |
| <span class="sd"> :param tls_client_key: Path to the PEM-encoded key used to authenticate docker client.</span> |
| <span class="sd"> :type tls_client_key: str</span> |
| <span class="sd"> :param tls_hostname: Hostname to match against</span> |
| <span class="sd"> the docker server certificate or False to disable the check.</span> |
| <span class="sd"> :type tls_hostname: str or bool</span> |
| <span class="sd"> :param tls_ssl_version: Version of SSL to use when communicating with docker daemon.</span> |
| <span class="sd"> :type tls_ssl_version: str</span> |
| <span class="sd"> :param tmp_dir: Mount point inside the container to</span> |
| <span class="sd"> a temporary directory created on the host by the operator.</span> |
| <span class="sd"> The path is also made available via the environment variable</span> |
| <span class="sd"> ``AIRFLOW_TMP_DIR`` inside the container.</span> |
| <span class="sd"> :type tmp_dir: str</span> |
| <span class="sd"> :param user: Default user inside the docker container.</span> |
| <span class="sd"> :type user: int or str</span> |
| <span class="sd"> :param volumes: List of volumes to mount into the container, e.g.</span> |
| <span class="sd"> ``['/host/path:/container/path', '/host/path2:/container/path2:ro']``.</span> |
| <span class="sd"> :type volumes: list</span> |
| <span class="sd"> :param working_dir: Working directory to</span> |
| <span class="sd"> set on the container (equivalent to the -w switch the docker client)</span> |
| <span class="sd"> :type working_dir: str</span> |
| <span class="sd"> :param xcom_push: Does the stdout will be pushed to the next step using XCom.</span> |
| <span class="sd"> The default is False.</span> |
| <span class="sd"> :type xcom_push: bool</span> |
| <span class="sd"> :param xcom_all: Push all the stdout or just the last line.</span> |
| <span class="sd"> The default is False (last line).</span> |
| <span class="sd"> :type xcom_all: bool</span> |
| <span class="sd"> :param docker_conn_id: ID of the Airflow connection to use</span> |
| <span class="sd"> :type docker_conn_id: str</span> |
| <span class="sd"> :param shm_size: Size of ``/dev/shm`` in bytes. The size must be</span> |
| <span class="sd"> greater than 0. If omitted uses system default.</span> |
| <span class="sd"> :type shm_size: int</span> |
| <span class="sd"> :param tty: Allocate pseudo-TTY to the container</span> |
| <span class="sd"> This needs to be set see logs of the Docker container.</span> |
| <span class="sd"> :type tty: bool</span> |
| <span class="sd"> """</span> |
| <div class="viewcode-block" id="DockerOperator.template_fields"><a class="viewcode-back" href="../../../_api/airflow/operators/docker_operator/index.html#airflow.operators.docker_operator.DockerOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'command'</span><span class="p">,</span> <span class="s1">'environment'</span><span class="p">,</span> <span class="s1">'container_name'</span><span class="p">)</span></div> |
| <div class="viewcode-block" id="DockerOperator.template_ext"><a class="viewcode-back" href="../../../_api/airflow/operators/docker_operator/index.html#airflow.operators.docker_operator.DockerOperator.template_ext">[docs]</a> <span class="n">template_ext</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'.sh'</span><span class="p">,</span> <span class="s1">'.bash'</span><span class="p">,)</span></div> |
| |
| <span class="nd">@apply_defaults</span> |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">image</span><span class="p">,</span> |
| <span class="n">api_version</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">command</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">container_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">cpus</span><span class="o">=</span><span class="mf">1.0</span><span class="p">,</span> |
| <span class="n">docker_url</span><span class="o">=</span><span class="s1">'unix://var/run/docker.sock'</span><span class="p">,</span> |
| <span class="n">environment</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">force_pull</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">mem_limit</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">host_tmp_dir</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">network_mode</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">tls_ca_cert</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">tls_client_cert</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">tls_client_key</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">tls_hostname</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">tls_ssl_version</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">tmp_dir</span><span class="o">=</span><span class="s1">'/tmp/airflow'</span><span class="p">,</span> |
| <span class="n">user</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">working_dir</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">xcom_all</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">docker_conn_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">dns</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">dns_search</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">auto_remove</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> |
| <span class="n">shm_size</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">tty</span><span class="o">=</span><span class="kc">False</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">DockerOperator</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">api_version</span> <span class="o">=</span> <span class="n">api_version</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">auto_remove</span> <span class="o">=</span> <span class="n">auto_remove</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">command</span> <span class="o">=</span> <span class="n">command</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">container_name</span> <span class="o">=</span> <span class="n">container_name</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">cpus</span> <span class="o">=</span> <span class="n">cpus</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">dns</span> <span class="o">=</span> <span class="n">dns</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">dns_search</span> <span class="o">=</span> <span class="n">dns_search</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">docker_url</span> <span class="o">=</span> <span class="n">docker_url</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">environment</span> <span class="o">=</span> <span class="n">environment</span> <span class="ow">or</span> <span class="p">{}</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">force_pull</span> <span class="o">=</span> <span class="n">force_pull</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">mem_limit</span> <span class="o">=</span> <span class="n">mem_limit</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">host_tmp_dir</span> <span class="o">=</span> <span class="n">host_tmp_dir</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">network_mode</span> <span class="o">=</span> <span class="n">network_mode</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">tls_ca_cert</span> <span class="o">=</span> <span class="n">tls_ca_cert</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">tls_client_cert</span> <span class="o">=</span> <span class="n">tls_client_cert</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">tls_client_key</span> <span class="o">=</span> <span class="n">tls_client_key</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">tls_hostname</span> <span class="o">=</span> <span class="n">tls_hostname</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">tls_ssl_version</span> <span class="o">=</span> <span class="n">tls_ssl_version</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">tmp_dir</span> <span class="o">=</span> <span class="n">tmp_dir</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">user</span> <span class="o">=</span> <span class="n">user</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">working_dir</span> <span class="o">=</span> <span class="n">working_dir</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">xcom_push_flag</span> <span class="o">=</span> <span class="n">xcom_push</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">xcom_all</span> <span class="o">=</span> <span class="n">xcom_all</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">docker_conn_id</span> <span class="o">=</span> <span class="n">docker_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">shm_size</span> <span class="o">=</span> <span class="n">shm_size</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">tty</span> <span class="o">=</span> <span class="n">tty</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">cli</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">container</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <div class="viewcode-block" id="DockerOperator.get_hook"><a class="viewcode-back" href="../../../_api/airflow/operators/docker_operator/index.html#airflow.operators.docker_operator.DockerOperator.get_hook">[docs]</a> <span class="k">def</span> <span class="nf">get_hook</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">DockerHook</span><span class="p">(</span> |
| <span class="n">docker_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">docker_conn_id</span><span class="p">,</span> |
| <span class="n">base_url</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">docker_url</span><span class="p">,</span> |
| <span class="n">version</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">api_version</span><span class="p">,</span> |
| <span class="n">tls</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">__get_tls_config</span><span class="p">()</span></div> |
| <span class="p">)</span> |
| |
| <div class="viewcode-block" id="DockerOperator._run_image"><a class="viewcode-back" href="../../../_api/airflow/operators/docker_operator/index.html#airflow.operators.docker_operator.DockerOperator._run_image">[docs]</a> <span class="k">def</span> <span class="nf">_run_image</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Run a Docker container with the provided image</span> |
| <span class="sd"> """</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Starting docker container from image </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">image</span><span class="p">)</span> |
| |
| <span class="k">with</span> <span class="n">TemporaryDirectory</span><span class="p">(</span><span class="n">prefix</span><span class="o">=</span><span class="s1">'airflowtmp'</span><span class="p">,</span> <span class="nb">dir</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">host_tmp_dir</span><span class="p">)</span> <span class="k">as</span> <span class="n">host_tmp_dir</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">append</span><span class="p">(</span><span class="s1">'</span><span class="si">{0}</span><span class="s1">:</span><span class="si">{1}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">host_tmp_dir</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">tmp_dir</span><span class="p">))</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">container</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cli</span><span class="o">.</span><span class="n">create_container</span><span class="p">(</span> |
| <span class="n">command</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">get_command</span><span class="p">(),</span> |
| <span class="n">name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">container_name</span><span class="p">,</span> |
| <span class="n">environment</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">environment</span><span class="p">,</span> |
| <span class="n">host_config</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">cli</span><span class="o">.</span><span class="n">create_host_config</span><span class="p">(</span> |
| <span class="n">auto_remove</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">auto_remove</span><span class="p">,</span> |
| <span class="n">binds</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">volumes</span><span class="p">,</span> |
| <span class="n">network_mode</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">network_mode</span><span class="p">,</span> |
| <span class="n">shm_size</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">shm_size</span><span class="p">,</span> |
| <span class="n">dns</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">dns</span><span class="p">,</span> |
| <span class="n">dns_search</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">dns_search</span><span class="p">,</span> |
| <span class="n">cpu_shares</span><span class="o">=</span><span class="nb">int</span><span class="p">(</span><span class="nb">round</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cpus</span> <span class="o">*</span> <span class="mi">1024</span><span class="p">)),</span> |
| <span class="n">mem_limit</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">mem_limit</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">user</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">user</span><span class="p">,</span> |
| <span class="n">working_dir</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">working_dir</span><span class="p">,</span> |
| <span class="n">tty</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">tty</span><span class="p">,</span> |
| <span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">cli</span><span class="o">.</span><span class="n">start</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">container</span><span class="p">[</span><span class="s1">'Id'</span><span class="p">])</span> |
| |
| <span class="n">line</span> <span class="o">=</span> <span class="s1">''</span> |
| <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cli</span><span class="o">.</span><span class="n">attach</span><span class="p">(</span><span class="n">container</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">container</span><span class="p">[</span><span class="s1">'Id'</span><span class="p">],</span> |
| <span class="n">stdout</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> |
| <span class="n">stderr</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> |
| <span class="n">stream</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span> |
| <span class="n">line</span> <span class="o">=</span> <span class="n">line</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> |
| <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">line</span><span class="p">,</span> <span class="s1">'decode'</span><span class="p">):</span> |
| <span class="n">line</span> <span class="o">=</span> <span class="n">line</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="n">line</span><span class="p">)</span> |
| |
| <span class="n">result</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">cli</span><span class="o">.</span><span class="n">wait</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">container</span><span class="p">[</span><span class="s1">'Id'</span><span class="p">])</span> |
| <span class="k">if</span> <span class="n">result</span><span class="p">[</span><span class="s1">'StatusCode'</span><span class="p">]</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s1">'docker container failed: '</span> <span class="o">+</span> <span class="nb">repr</span><span class="p">(</span><span class="n">result</span><span class="p">))</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">xcom_push_flag</span><span class="p">:</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">cli</span><span class="o">.</span><span class="n">logs</span><span class="p">(</span><span class="n">container</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">container</span><span class="p">[</span><span class="s1">'Id'</span><span class="p">])</span> \ |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">xcom_all</span> <span class="k">else</span> <span class="nb">str</span><span class="p">(</span><span class="n">line</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="DockerOperator.execute"><a class="viewcode-back" href="../../../_api/airflow/operators/docker_operator/index.html#airflow.operators.docker_operator.DockerOperator.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="n">tls_config</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__get_tls_config</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">docker_conn_id</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">cli</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_hook</span><span class="p">()</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">cli</span> <span class="o">=</span> <span class="n">APIClient</span><span class="p">(</span> |
| <span class="n">base_url</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">docker_url</span><span class="p">,</span> |
| <span class="n">version</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">api_version</span><span class="p">,</span> |
| <span class="n">tls</span><span class="o">=</span><span class="n">tls_config</span> |
| <span class="p">)</span> |
| |
| <span class="c1"># Pull the docker image if `force_pull` is set or image does not exist locally</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">force_pull</span> <span class="ow">or</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">cli</span><span class="o">.</span><span class="n">images</span><span class="p">(</span><span class="n">name</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="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Pulling docker image </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">image</span><span class="p">)</span> |
| <span class="k">for</span> <span class="n">l</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">cli</span><span class="o">.</span><span class="n">pull</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">image</span><span class="p">,</span> <span class="n">stream</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span> |
| <span class="n">output</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">loads</span><span class="p">(</span><span class="n">l</span><span class="o">.</span><span class="n">decode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">())</span> |
| <span class="k">if</span> <span class="s1">'status'</span> <span class="ow">in</span> <span class="n">output</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s2">"</span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">output</span><span class="p">[</span><span class="s1">'status'</span><span class="p">])</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">environment</span><span class="p">[</span><span class="s1">'AIRFLOW_TMP_DIR'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">tmp_dir</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_run_image</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="DockerOperator.get_command"><a class="viewcode-back" href="../../../_api/airflow/operators/docker_operator/index.html#airflow.operators.docker_operator.DockerOperator.get_command">[docs]</a> <span class="k">def</span> <span class="nf">get_command</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Retrieve command(s). if command string starts with [, it returns the command list)</span> |
| |
| <span class="sd"> :return: the command (or commands)</span> |
| <span class="sd"> :rtype: str | List[str]</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">command</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">command</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">'['</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span> |
| <span class="n">commands</span> <span class="o">=</span> <span class="n">ast</span><span class="o">.</span><span class="n">literal_eval</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">command</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="n">commands</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">command</span> |
| <span class="k">return</span> <span class="n">commands</span></div> |
| |
| <div class="viewcode-block" id="DockerOperator.on_kill"><a class="viewcode-back" href="../../../_api/airflow/operators/docker_operator/index.html#airflow.operators.docker_operator.DockerOperator.on_kill">[docs]</a> <span class="k">def</span> <span class="nf">on_kill</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">cli</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Stopping docker container'</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">cli</span><span class="o">.</span><span class="n">stop</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">container</span><span class="p">[</span><span class="s1">'Id'</span><span class="p">])</span></div> |
| |
| <div class="viewcode-block" id="DockerOperator.__get_tls_config"><a class="viewcode-back" href="../../../_api/airflow/operators/docker_operator/index.html#airflow.operators.docker_operator.DockerOperator.__get_tls_config">[docs]</a> <span class="k">def</span> <span class="nf">__get_tls_config</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="n">tls_config</span> <span class="o">=</span> <span class="kc">None</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">tls_ca_cert</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">tls_client_cert</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">tls_client_key</span><span class="p">:</span> |
| <span class="c1"># Ignore type error on SSL version here - it is deprecated and type annotation is wrong</span> |
| <span class="c1"># it should be string</span> |
| <span class="c1"># noinspection PyTypeChecker</span> |
| <span class="n">tls_config</span> <span class="o">=</span> <span class="n">tls</span><span class="o">.</span><span class="n">TLSConfig</span><span class="p">(</span> |
| <span class="n">ca_cert</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">tls_ca_cert</span><span class="p">,</span> |
| <span class="n">client_cert</span><span class="o">=</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">tls_client_cert</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">tls_client_key</span><span class="p">),</span> |
| <span class="n">verify</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> |
| <span class="n">ssl_version</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">tls_ssl_version</span><span class="p">,</span> <span class="c1"># type: ignore</span> |
| <span class="n">assert_hostname</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">tls_hostname</span> |
| <span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">docker_url</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">docker_url</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'tcp://'</span><span class="p">,</span> <span class="s1">'https://'</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">tls_config</span></div></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>. |
| <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> |