| |
| |
| <!-- |
| 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.contrib.operators.ecs_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.contrib.operators</a> »</li> |
| |
| <li>airflow.contrib.operators.ecs_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.ecs_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="kn">import</span> <span class="nn">sys</span> |
| <span class="kn">import</span> <span class="nn">re</span> |
| <span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">datetime</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</span> <span class="kn">import</span> <span class="n">apply_defaults</span> |
| |
| <span class="kn">from</span> <span class="nn">airflow.contrib.hooks.aws_hook</span> <span class="kn">import</span> <span class="n">AwsHook</span> |
| <span class="kn">from</span> <span class="nn">airflow.contrib.hooks.aws_logs_hook</span> <span class="kn">import</span> <span class="n">AwsLogsHook</span> |
| |
| |
| <div class="viewcode-block" id="ECSOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/ecs_operator/index.html#airflow.contrib.operators.ecs_operator.ECSOperator">[docs]</a><span class="k">class</span> <span class="nc">ECSOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Execute a task on AWS EC2 Container Service</span> |
| |
| <span class="sd"> :param task_definition: the task definition name on EC2 Container Service</span> |
| <span class="sd"> :type task_definition: str</span> |
| <span class="sd"> :param cluster: the cluster name on EC2 Container Service</span> |
| <span class="sd"> :type cluster: str</span> |
| <span class="sd"> :param overrides: the same parameter that boto3 will receive (templated):</span> |
| <span class="sd"> http://boto3.readthedocs.org/en/latest/reference/services/ecs.html#ECS.Client.run_task</span> |
| <span class="sd"> :type overrides: dict</span> |
| <span class="sd"> :param aws_conn_id: connection id of AWS credentials / region name. If None,</span> |
| <span class="sd"> credential boto3 strategy will be used</span> |
| <span class="sd"> (http://boto3.readthedocs.io/en/latest/guide/configuration.html).</span> |
| <span class="sd"> :type aws_conn_id: str</span> |
| <span class="sd"> :param region_name: region name to use in AWS Hook.</span> |
| <span class="sd"> Override the region_name in connection (if provided)</span> |
| <span class="sd"> :type region_name: str</span> |
| <span class="sd"> :param launch_type: the launch type on which to run your task ('EC2' or 'FARGATE')</span> |
| <span class="sd"> :type launch_type: str</span> |
| <span class="sd"> :param group: the name of the task group associated with the task</span> |
| <span class="sd"> :type group: str</span> |
| <span class="sd"> :param placement_constraints: an array of placement constraint objects to use for</span> |
| <span class="sd"> the task</span> |
| <span class="sd"> :type placement_constraints: list</span> |
| <span class="sd"> :param platform_version: the platform version on which your task is running</span> |
| <span class="sd"> :type platform_version: str</span> |
| <span class="sd"> :param network_configuration: the network configuration for the task</span> |
| <span class="sd"> :type network_configuration: dict</span> |
| <span class="sd"> :param tags: a dictionary of tags in the form of {'tagKey': 'tagValue'}.</span> |
| <span class="sd"> :type tags: dict</span> |
| <span class="sd"> :param awslogs_group: the CloudWatch group where your ECS container logs are stored.</span> |
| <span class="sd"> Only required if you want logs to be shown in the Airflow UI after your job has</span> |
| <span class="sd"> finished.</span> |
| <span class="sd"> :type awslogs_group: str</span> |
| <span class="sd"> :param awslogs_region: the region in which your CloudWatch logs are stored.</span> |
| <span class="sd"> If None, this is the same as the `region_name` parameter. If that is also None,</span> |
| <span class="sd"> this is the default AWS region based on your connection settings.</span> |
| <span class="sd"> :type awslogs_region: str</span> |
| <span class="sd"> :param awslogs_stream_prefix: the stream prefix that is used for the CloudWatch logs.</span> |
| <span class="sd"> This is usually based on some custom name combined with the name of the container.</span> |
| <span class="sd"> Only required if you want logs to be shown in the Airflow UI after your job has</span> |
| <span class="sd"> finished.</span> |
| <span class="sd"> :type awslogs_stream_prefix: str</span> |
| <span class="sd"> """</span> |
| |
| <div class="viewcode-block" id="ECSOperator.ui_color"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/ecs_operator/index.html#airflow.contrib.operators.ecs_operator.ECSOperator.ui_color">[docs]</a> <span class="n">ui_color</span> <span class="o">=</span> <span class="s1">'#f0ede4'</span></div> |
| <div class="viewcode-block" id="ECSOperator.client"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/ecs_operator/index.html#airflow.contrib.operators.ecs_operator.ECSOperator.client">[docs]</a> <span class="n">client</span> <span class="o">=</span> <span class="kc">None</span></div> |
| <div class="viewcode-block" id="ECSOperator.arn"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/ecs_operator/index.html#airflow.contrib.operators.ecs_operator.ECSOperator.arn">[docs]</a> <span class="n">arn</span> <span class="o">=</span> <span class="kc">None</span></div> |
| <div class="viewcode-block" id="ECSOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/ecs_operator/index.html#airflow.contrib.operators.ecs_operator.ECSOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'overrides'</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">task_definition</span><span class="p">,</span> <span class="n">cluster</span><span class="p">,</span> <span class="n">overrides</span><span class="p">,</span> |
| <span class="n">aws_conn_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">region_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">launch_type</span><span class="o">=</span><span class="s1">'EC2'</span><span class="p">,</span> |
| <span class="n">group</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">placement_constraints</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">platform_version</span><span class="o">=</span><span class="s1">'LATEST'</span><span class="p">,</span> |
| <span class="n">network_configuration</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">tags</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">awslogs_group</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">awslogs_region</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">awslogs_stream_prefix</span><span class="o">=</span><span class="kc">None</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">ECSOperator</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">kwargs</span><span class="p">)</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">aws_conn_id</span> <span class="o">=</span> <span class="n">aws_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">region_name</span> <span class="o">=</span> <span class="n">region_name</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">task_definition</span> <span class="o">=</span> <span class="n">task_definition</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">cluster</span> <span class="o">=</span> <span class="n">cluster</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">overrides</span> <span class="o">=</span> <span class="n">overrides</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">launch_type</span> <span class="o">=</span> <span class="n">launch_type</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">group</span> <span class="o">=</span> <span class="n">group</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">placement_constraints</span> <span class="o">=</span> <span class="n">placement_constraints</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">platform_version</span> <span class="o">=</span> <span class="n">platform_version</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">network_configuration</span> <span class="o">=</span> <span class="n">network_configuration</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">tags</span> <span class="o">=</span> <span class="n">tags</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">awslogs_group</span> <span class="o">=</span> <span class="n">awslogs_group</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">awslogs_stream_prefix</span> <span class="o">=</span> <span class="n">awslogs_stream_prefix</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">awslogs_region</span> <span class="o">=</span> <span class="n">awslogs_region</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">awslogs_region</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">awslogs_region</span> <span class="o">=</span> <span class="n">region_name</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">hook</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_hook</span><span class="p">()</span> |
| |
| <div class="viewcode-block" id="ECSOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/ecs_operator/index.html#airflow.contrib.operators.ecs_operator.ECSOperator.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="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">'Running ECS Task - Task definition: </span><span class="si">%s</span><span class="s1"> - on cluster </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">task_definition</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">cluster</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">'ECSOperator overrides: </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">overrides</span><span class="p">)</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">client</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">hook</span><span class="o">.</span><span class="n">get_client_type</span><span class="p">(</span> |
| <span class="s1">'ecs'</span><span class="p">,</span> |
| <span class="n">region_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">region_name</span> |
| <span class="p">)</span> |
| |
| <span class="n">run_opts</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="s1">'cluster'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">cluster</span><span class="p">,</span> |
| <span class="s1">'taskDefinition'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">task_definition</span><span class="p">,</span> |
| <span class="s1">'overrides'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">overrides</span><span class="p">,</span> |
| <span class="s1">'startedBy'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">owner</span><span class="p">,</span> |
| <span class="s1">'launchType'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">launch_type</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">launch_type</span> <span class="o">==</span> <span class="s1">'FARGATE'</span><span class="p">:</span> |
| <span class="n">run_opts</span><span class="p">[</span><span class="s1">'platformVersion'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">platform_version</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">group</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">run_opts</span><span class="p">[</span><span class="s1">'group'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">group</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">placement_constraints</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">run_opts</span><span class="p">[</span><span class="s1">'placementConstraints'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">placement_constraints</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">network_configuration</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">run_opts</span><span class="p">[</span><span class="s1">'networkConfiguration'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">network_configuration</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">tags</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">run_opts</span><span class="p">[</span><span class="s1">'tags'</span><span class="p">]</span> <span class="o">=</span> <span class="p">[{</span><span class="s1">'key'</span><span class="p">:</span> <span class="n">k</span><span class="p">,</span> <span class="s1">'value'</span><span class="p">:</span> <span class="n">v</span><span class="p">}</span> <span class="k">for</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">tags</span><span class="o">.</span><span class="n">items</span><span class="p">()]</span> |
| |
| <span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">run_task</span><span class="p">(</span><span class="o">**</span><span class="n">run_opts</span><span class="p">)</span> |
| |
| <span class="n">failures</span> <span class="o">=</span> <span class="n">response</span><span class="p">[</span><span class="s1">'failures'</span><span class="p">]</span> |
| <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">failures</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="n">response</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">'ECS Task started: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">response</span><span class="p">)</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">arn</span> <span class="o">=</span> <span class="n">response</span><span class="p">[</span><span class="s1">'tasks'</span><span class="p">][</span><span class="mi">0</span><span class="p">][</span><span class="s1">'taskArn'</span><span class="p">]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_wait_for_task_ended</span><span class="p">()</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_check_success_task</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">'ECS Task has been successfully executed: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">response</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="ECSOperator._wait_for_task_ended"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/ecs_operator/index.html#airflow.contrib.operators.ecs_operator.ECSOperator._wait_for_task_ended">[docs]</a> <span class="k">def</span> <span class="nf">_wait_for_task_ended</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="n">waiter</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">get_waiter</span><span class="p">(</span><span class="s1">'tasks_stopped'</span><span class="p">)</span> |
| <span class="n">waiter</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">max_attempts</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">maxsize</span> <span class="c1"># timeout is managed by airflow</span> |
| <span class="n">waiter</span><span class="o">.</span><span class="n">wait</span><span class="p">(</span> |
| <span class="n">cluster</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">cluster</span><span class="p">,</span> |
| <span class="n">tasks</span><span class="o">=</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">arn</span><span class="p">]</span></div> |
| <span class="p">)</span> |
| |
| <div class="viewcode-block" id="ECSOperator._check_success_task"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/ecs_operator/index.html#airflow.contrib.operators.ecs_operator.ECSOperator._check_success_task">[docs]</a> <span class="k">def</span> <span class="nf">_check_success_task</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">describe_tasks</span><span class="p">(</span> |
| <span class="n">cluster</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">cluster</span><span class="p">,</span> |
| <span class="n">tasks</span><span class="o">=</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">arn</span><span class="p">]</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">'ECS Task stopped, check status: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">response</span><span class="p">)</span> |
| |
| <span class="c1"># Get logs from CloudWatch if the awslogs log driver was used</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">awslogs_group</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">awslogs_stream_prefix</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">'ECS Task logs output:'</span><span class="p">)</span> |
| <span class="n">task_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">arn</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"/"</span><span class="p">)[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> |
| <span class="n">stream_name</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{}</span><span class="s2">/</span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">awslogs_stream_prefix</span><span class="p">,</span> <span class="n">task_id</span><span class="p">)</span> |
| <span class="k">for</span> <span class="n">event</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_logs_hook</span><span class="p">()</span><span class="o">.</span><span class="n">get_log_events</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">awslogs_group</span><span class="p">,</span> <span class="n">stream_name</span><span class="p">):</span> |
| <span class="n">dt</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">fromtimestamp</span><span class="p">(</span><span class="n">event</span><span class="p">[</span><span class="s1">'timestamp'</span><span class="p">]</span> <span class="o">/</span> <span class="mf">1000.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="s2">"[</span><span class="si">{}</span><span class="s2">] </span><span class="si">{}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">dt</span><span class="o">.</span><span class="n">isoformat</span><span class="p">(),</span> <span class="n">event</span><span class="p">[</span><span class="s1">'message'</span><span class="p">]))</span> |
| |
| <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'failures'</span><span class="p">,</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="n">response</span><span class="p">)</span> |
| |
| <span class="k">for</span> <span class="n">task</span> <span class="ow">in</span> <span class="n">response</span><span class="p">[</span><span class="s1">'tasks'</span><span class="p">]:</span> |
| <span class="c1"># This is a `stoppedReason` that indicates a task has not</span> |
| <span class="c1"># successfully finished, but there is no other indication of failure</span> |
| <span class="c1"># in the response.</span> |
| <span class="c1"># See, https://docs.aws.amazon.com/AmazonECS/latest/developerguide/stopped-task-errors.html # noqa E501</span> |
| <span class="k">if</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="sa">r</span><span class="s1">'Host EC2 \(instance .+?\) (stopped|terminated)\.'</span><span class="p">,</span> |
| <span class="n">task</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'stoppedReason'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)):</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s1">'The task was stopped because the host instance terminated: </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span> |
| <span class="nb">format</span><span class="p">(</span><span class="n">task</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'stoppedReason'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)))</span> |
| <span class="n">containers</span> <span class="o">=</span> <span class="n">task</span><span class="p">[</span><span class="s1">'containers'</span><span class="p">]</span> |
| <span class="k">for</span> <span class="n">container</span> <span class="ow">in</span> <span class="n">containers</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">container</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'lastStatus'</span><span class="p">)</span> <span class="o">==</span> <span class="s1">'STOPPED'</span> <span class="ow">and</span> \ |
| <span class="n">container</span><span class="p">[</span><span class="s1">'exitCode'</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">'This task is not in success state </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">task</span><span class="p">))</span> |
| <span class="k">elif</span> <span class="n">container</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'lastStatus'</span><span class="p">)</span> <span class="o">==</span> <span class="s1">'PENDING'</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s1">'This task is still pending </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">task</span><span class="p">))</span> |
| <span class="k">elif</span> <span class="s1">'error'</span> <span class="ow">in</span> <span class="n">container</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'reason'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">():</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s1">'This containers encounter an error during launching : </span><span class="si">{}</span><span class="s1">'</span><span class="o">.</span> |
| <span class="nb">format</span><span class="p">(</span><span class="n">container</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'reason'</span><span class="p">,</span> <span class="s1">''</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()))</span></div> |
| |
| <div class="viewcode-block" id="ECSOperator.get_hook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/ecs_operator/index.html#airflow.contrib.operators.ecs_operator.ECSOperator.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">AwsHook</span><span class="p">(</span> |
| <span class="n">aws_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">aws_conn_id</span></div> |
| <span class="p">)</span> |
| |
| <div class="viewcode-block" id="ECSOperator.get_logs_hook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/ecs_operator/index.html#airflow.contrib.operators.ecs_operator.ECSOperator.get_logs_hook">[docs]</a> <span class="k">def</span> <span class="nf">get_logs_hook</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">AwsLogsHook</span><span class="p">(</span> |
| <span class="n">aws_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">aws_conn_id</span><span class="p">,</span> |
| <span class="n">region_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">awslogs_region</span></div> |
| <span class="p">)</span> |
| |
| <div class="viewcode-block" id="ECSOperator.on_kill"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/ecs_operator/index.html#airflow.contrib.operators.ecs_operator.ECSOperator.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="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="o">.</span><span class="n">stop_task</span><span class="p">(</span> |
| <span class="n">cluster</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">cluster</span><span class="p">,</span> |
| <span class="n">task</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">arn</span><span class="p">,</span> |
| <span class="n">reason</span><span class="o">=</span><span class="s1">'Task killed by the user'</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">response</span><span class="p">)</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> |