| |
| |
| <!-- |
| 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.gcp_container_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/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="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> |
| <script type="text/javascript"> |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-140539454-1']); |
| _gaq.push(['_trackPageview']); |
| </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.6 |
| </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="../../../../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="../../../../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">Python API 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> |
| </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.gcp_container_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.gcp_container_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="c1">#</span> |
| <span class="kn">import</span> <span class="nn">os</span> |
| <span class="kn">import</span> <span class="nn">subprocess</span> |
| <span class="kn">import</span> <span class="nn">tempfile</span> |
| |
| <span class="kn">from</span> <span class="nn">google.auth.environment_vars</span> <span class="k">import</span> <span class="n">CREDENTIALS</span> |
| |
| <span class="kn">from</span> <span class="nn">airflow</span> <span class="k">import</span> <span class="n">AirflowException</span> |
| <span class="kn">from</span> <span class="nn">airflow.contrib.hooks.gcp_container_hook</span> <span class="k">import</span> <span class="n">GKEClusterHook</span> |
| <span class="kn">from</span> <span class="nn">airflow.contrib.operators.kubernetes_pod_operator</span> <span class="k">import</span> <span class="n">KubernetesPodOperator</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> |
| |
| |
| <div class="viewcode-block" id="GKEClusterDeleteOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_container_operator/index.html#airflow.contrib.operators.gcp_container_operator.GKEClusterDeleteOperator">[docs]</a><span class="k">class</span> <span class="nc">GKEClusterDeleteOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Deletes the cluster, including the Kubernetes endpoint and all worker nodes.</span> |
| |
| <span class="sd"> To delete a certain cluster, you must specify the ``project_id``, the ``name``</span> |
| <span class="sd"> of the cluster, the ``location`` that the cluster is in, and the ``task_id``.</span> |
| |
| <span class="sd"> **Operator Creation**: ::</span> |
| |
| <span class="sd"> operator = GKEClusterDeleteOperator(</span> |
| <span class="sd"> task_id='cluster_delete',</span> |
| <span class="sd"> project_id='my-project',</span> |
| <span class="sd"> location='cluster-location'</span> |
| <span class="sd"> name='cluster-name')</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more detail about deleting clusters have a look at the reference:</span> |
| <span class="sd"> https://google-cloud-python.readthedocs.io/en/latest/container/gapic/v1/api.html#google.cloud.container_v1.ClusterManagerClient.delete_cluster</span> |
| |
| <span class="sd"> :param project_id: The Google Developers Console [project ID or project number]</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param name: The name of the resource to delete, in this case cluster name</span> |
| <span class="sd"> :type name: str</span> |
| <span class="sd"> :param location: The name of the Google Compute Engine zone in which the cluster</span> |
| <span class="sd"> resides.</span> |
| <span class="sd"> :type location: str</span> |
| <span class="sd"> :param gcp_conn_id: The connection ID to use connecting to Google Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> :param api_version: The api version to use</span> |
| <span class="sd"> :type api_version: str</span> |
| <span class="sd"> """</span> |
| <div class="viewcode-block" id="GKEClusterDeleteOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_container_operator/index.html#airflow.contrib.operators.gcp_container_operator.GKEClusterDeleteOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'project_id'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">,</span> <span class="s1">'name'</span><span class="p">,</span> <span class="s1">'location'</span><span class="p">,</span> <span class="s1">'api_version'</span><span class="p">]</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">project_id</span><span class="p">,</span> |
| <span class="n">name</span><span class="p">,</span> |
| <span class="n">location</span><span class="p">,</span> |
| <span class="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> |
| <span class="n">api_version</span><span class="o">=</span><span class="s1">'v2'</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">GKEClusterDeleteOperator</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">project_id</span> <span class="o">=</span> <span class="n">project_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">location</span> <span class="o">=</span> <span class="n">location</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">name</span> <span class="o">=</span> <span class="n">name</span> |
| |
| <div class="viewcode-block" id="GKEClusterDeleteOperator._check_input"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_container_operator/index.html#airflow.contrib.operators.gcp_container_operator.GKEClusterDeleteOperator._check_input">[docs]</a> <span class="k">def</span> <span class="nf">_check_input</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">all</span><span class="p">([</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">location</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">error</span><span class="p">(</span> |
| <span class="s1">'One of (project_id, name, location) is missing or incorrect'</span><span class="p">)</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s1">'Operator has incorrect or missing input.'</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="GKEClusterDeleteOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_container_operator/index.html#airflow.contrib.operators.gcp_container_operator.GKEClusterDeleteOperator.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">_check_input</span><span class="p">()</span> |
| <span class="n">hook</span> <span class="o">=</span> <span class="n">GKEClusterHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">,</span> <span class="n">location</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">)</span> |
| <span class="n">delete_result</span> <span class="o">=</span> <span class="n">hook</span><span class="o">.</span><span class="n">delete_cluster</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">name</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">delete_result</span></div></div> |
| |
| |
| <div class="viewcode-block" id="GKEClusterCreateOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_container_operator/index.html#airflow.contrib.operators.gcp_container_operator.GKEClusterCreateOperator">[docs]</a><span class="k">class</span> <span class="nc">GKEClusterCreateOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Create a Google Kubernetes Engine Cluster of specified dimensions</span> |
| <span class="sd"> The operator will wait until the cluster is created.</span> |
| |
| <span class="sd"> The **minimum** required to define a cluster to create is:</span> |
| |
| <span class="sd"> ``dict()`` ::</span> |
| <span class="sd"> cluster_def = {'name': 'my-cluster-name',</span> |
| <span class="sd"> 'initial_node_count': 1}</span> |
| |
| <span class="sd"> or</span> |
| |
| <span class="sd"> ``Cluster`` proto ::</span> |
| <span class="sd"> from google.cloud.container_v1.types import Cluster</span> |
| |
| <span class="sd"> cluster_def = Cluster(name='my-cluster-name', initial_node_count=1)</span> |
| |
| <span class="sd"> **Operator Creation**: ::</span> |
| |
| <span class="sd"> operator = GKEClusterCreateOperator(</span> |
| <span class="sd"> task_id='cluster_create',</span> |
| <span class="sd"> project_id='my-project',</span> |
| <span class="sd"> location='my-location'</span> |
| <span class="sd"> body=cluster_def)</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more detail on about creating clusters have a look at the reference:</span> |
| <span class="sd"> :class:`google.cloud.container_v1.types.Cluster`</span> |
| |
| <span class="sd"> :param project_id: The Google Developers Console [project ID or project number]</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param location: The name of the Google Compute Engine zone in which the cluster</span> |
| <span class="sd"> resides.</span> |
| <span class="sd"> :type location: str</span> |
| <span class="sd"> :param body: The Cluster definition to create, can be protobuf or python dict, if</span> |
| <span class="sd"> dict it must match protobuf message Cluster</span> |
| <span class="sd"> :type body: dict or google.cloud.container_v1.types.Cluster</span> |
| <span class="sd"> :param gcp_conn_id: The connection ID to use connecting to Google Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> :param api_version: The api version to use</span> |
| <span class="sd"> :type api_version: str</span> |
| <span class="sd"> """</span> |
| <div class="viewcode-block" id="GKEClusterCreateOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_container_operator/index.html#airflow.contrib.operators.gcp_container_operator.GKEClusterCreateOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'project_id'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">,</span> <span class="s1">'location'</span><span class="p">,</span> <span class="s1">'api_version'</span><span class="p">,</span> <span class="s1">'body'</span><span class="p">]</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">project_id</span><span class="p">,</span> |
| <span class="n">location</span><span class="p">,</span> |
| <span class="n">body</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> |
| <span class="n">api_version</span><span class="o">=</span><span class="s1">'v2'</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">GKEClusterCreateOperator</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="k">if</span> <span class="n">body</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">body</span> <span class="o">=</span> <span class="p">{}</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">location</span> <span class="o">=</span> <span class="n">location</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">body</span> <span class="o">=</span> <span class="n">body</span> |
| |
| <div class="viewcode-block" id="GKEClusterCreateOperator._check_input"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_container_operator/index.html#airflow.contrib.operators.gcp_container_operator.GKEClusterCreateOperator._check_input">[docs]</a> <span class="k">def</span> <span class="nf">_check_input</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="nb">all</span><span class="p">([</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">]):</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">body</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)</span> \ |
| <span class="ow">and</span> <span class="s1">'name'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span> \ |
| <span class="ow">and</span> <span class="s1">'initial_node_count'</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">:</span> |
| <span class="c1"># Don't throw error</span> |
| <span class="k">return</span> |
| <span class="c1"># If not dict, then must</span> |
| <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="o">.</span><span class="n">name</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="o">.</span><span class="n">initial_node_count</span><span class="p">:</span> |
| <span class="k">return</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">error</span><span class="p">(</span> |
| <span class="s1">'One of (project_id, location, body, body[</span><span class="se">\'</span><span class="s1">name</span><span class="se">\'</span><span class="s1">], '</span> |
| <span class="s1">'body[</span><span class="se">\'</span><span class="s1">initial_node_count</span><span class="se">\'</span><span class="s1">]) is missing or incorrect'</span><span class="p">)</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s1">'Operator has incorrect or missing input.'</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="GKEClusterCreateOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_container_operator/index.html#airflow.contrib.operators.gcp_container_operator.GKEClusterCreateOperator.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">_check_input</span><span class="p">()</span> |
| <span class="n">hook</span> <span class="o">=</span> <span class="n">GKEClusterHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">,</span> <span class="n">location</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">)</span> |
| <span class="n">create_op</span> <span class="o">=</span> <span class="n">hook</span><span class="o">.</span><span class="n">create_cluster</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">body</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">create_op</span></div></div> |
| |
| |
| <div class="viewcode-block" id="KUBE_CONFIG_ENV_VAR"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_container_operator/index.html#airflow.contrib.operators.gcp_container_operator.KUBE_CONFIG_ENV_VAR">[docs]</a><span class="n">KUBE_CONFIG_ENV_VAR</span> <span class="o">=</span> <span class="s2">"KUBECONFIG"</span></div> |
| |
| |
| <div class="viewcode-block" id="GKEPodOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_container_operator/index.html#airflow.contrib.operators.gcp_container_operator.GKEPodOperator">[docs]</a><span class="k">class</span> <span class="nc">GKEPodOperator</span><span class="p">(</span><span class="n">KubernetesPodOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Executes a task in a Kubernetes pod in the specified Google Kubernetes</span> |
| <span class="sd"> Engine cluster</span> |
| |
| <span class="sd"> This Operator assumes that the system has gcloud installed and either</span> |
| <span class="sd"> has working default application credentials or has configured a</span> |
| <span class="sd"> connection id with a service account.</span> |
| |
| <span class="sd"> The **minimum** required to define a cluster to create are the variables</span> |
| <span class="sd"> ``task_id``, ``project_id``, ``location``, ``cluster_name``, ``name``,</span> |
| <span class="sd"> ``namespace``, and ``image``</span> |
| |
| <span class="sd"> **Operator Creation**: ::</span> |
| |
| <span class="sd"> operator = GKEPodOperator(task_id='pod_op',</span> |
| <span class="sd"> project_id='my-project',</span> |
| <span class="sd"> location='us-central1-a',</span> |
| <span class="sd"> cluster_name='my-cluster-name',</span> |
| <span class="sd"> name='task-name',</span> |
| <span class="sd"> namespace='default',</span> |
| <span class="sd"> image='perl')</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more detail about application authentication have a look at the reference:</span> |
| <span class="sd"> https://cloud.google.com/docs/authentication/production#providing_credentials_to_your_application</span> |
| |
| <span class="sd"> :param project_id: The Google Developers Console project id</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param location: The name of the Google Kubernetes Engine zone in which the</span> |
| <span class="sd"> cluster resides, e.g. 'us-central1-a'</span> |
| <span class="sd"> :type location: str</span> |
| <span class="sd"> :param cluster_name: The name of the Google Kubernetes Engine cluster the pod</span> |
| <span class="sd"> should be spawned in</span> |
| <span class="sd"> :type cluster_name: str</span> |
| <span class="sd"> :param gcp_conn_id: The google cloud connection id to use. This allows for</span> |
| <span class="sd"> users to specify a service account.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> """</span> |
| <div class="viewcode-block" id="GKEPodOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_container_operator/index.html#airflow.contrib.operators.gcp_container_operator.GKEPodOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'project_id'</span><span class="p">,</span> <span class="s1">'location'</span><span class="p">,</span> |
| <span class="s1">'cluster_name'</span><span class="p">)</span> <span class="o">+</span> <span class="n">KubernetesPodOperator</span><span class="o">.</span><span class="n">template_fields</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">project_id</span><span class="p">,</span> |
| <span class="n">location</span><span class="p">,</span> |
| <span class="n">cluster_name</span><span class="p">,</span> |
| <span class="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</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">GKEPodOperator</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">project_id</span> <span class="o">=</span> <span class="n">project_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">location</span> <span class="o">=</span> <span class="n">location</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">cluster_name</span> <span class="o">=</span> <span class="n">cluster_name</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| |
| <div class="viewcode-block" id="GKEPodOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_container_operator/index.html#airflow.contrib.operators.gcp_container_operator.GKEPodOperator.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="c1"># Specifying a service account file allows the user to using non default</span> |
| <span class="c1"># authentication for creating a Kubernetes Pod. This is done by setting the</span> |
| <span class="c1"># environment variable `GOOGLE_APPLICATION_CREDENTIALS` that gcloud looks at.</span> |
| <span class="n">key_file</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <span class="c1"># If gcp_conn_id is not specified gcloud will use the default</span> |
| <span class="c1"># service account credentials.</span> |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">:</span> |
| <span class="kn">from</span> <span class="nn">airflow.hooks.base_hook</span> <span class="k">import</span> <span class="n">BaseHook</span> |
| <span class="c1"># extras is a deserialized json object</span> |
| <span class="n">extras</span> <span class="o">=</span> <span class="n">BaseHook</span><span class="o">.</span><span class="n">get_connection</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span><span class="o">.</span><span class="n">extra_dejson</span> |
| <span class="c1"># key_file only gets set if a json file is created from a JSON string in</span> |
| <span class="c1"># the web ui, else none</span> |
| <span class="n">key_file</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_set_env_from_extras</span><span class="p">(</span><span class="n">extras</span><span class="o">=</span><span class="n">extras</span><span class="p">)</span> |
| |
| <span class="c1"># Write config to a temp file and set the environment variable to point to it.</span> |
| <span class="c1"># This is to avoid race conditions of reading/writing a single file</span> |
| <span class="k">with</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">NamedTemporaryFile</span><span class="p">()</span> <span class="k">as</span> <span class="n">conf_file</span><span class="p">:</span> |
| <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">KUBE_CONFIG_ENV_VAR</span><span class="p">]</span> <span class="o">=</span> <span class="n">conf_file</span><span class="o">.</span><span class="n">name</span> |
| <span class="c1"># Attempt to get/update credentials</span> |
| <span class="c1"># We call gcloud directly instead of using google-cloud-python api</span> |
| <span class="c1"># because there is no way to write kubernetes config to a file, which is</span> |
| <span class="c1"># required by KubernetesPodOperator.</span> |
| <span class="c1"># The gcloud command looks at the env variable `KUBECONFIG` for where to save</span> |
| <span class="c1"># the kubernetes config file.</span> |
| <span class="n">subprocess</span><span class="o">.</span><span class="n">check_call</span><span class="p">(</span> |
| <span class="p">[</span><span class="s2">"gcloud"</span><span class="p">,</span> <span class="s2">"container"</span><span class="p">,</span> <span class="s2">"clusters"</span><span class="p">,</span> <span class="s2">"get-credentials"</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">cluster_name</span><span class="p">,</span> |
| <span class="s2">"--zone"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">location</span><span class="p">,</span> |
| <span class="s2">"--project"</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">])</span> |
| |
| <span class="c1"># Since the key file is of type mkstemp() closing the file will delete it from</span> |
| <span class="c1"># the file system so it cannot be accessed after we don't need it anymore</span> |
| <span class="k">if</span> <span class="n">key_file</span><span class="p">:</span> |
| <span class="n">key_file</span><span class="o">.</span><span class="n">close</span><span class="p">()</span> |
| |
| <span class="c1"># Tell `KubernetesPodOperator` where the config file is located</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">config_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">KUBE_CONFIG_ENV_VAR</span><span class="p">]</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">GKEPodOperator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">context</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="GKEPodOperator._set_env_from_extras"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_container_operator/index.html#airflow.contrib.operators.gcp_container_operator.GKEPodOperator._set_env_from_extras">[docs]</a> <span class="k">def</span> <span class="nf">_set_env_from_extras</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">extras</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Sets the environment variable `GOOGLE_APPLICATION_CREDENTIALS` with either:</span> |
| |
| <span class="sd"> - The path to the keyfile from the specified connection id</span> |
| <span class="sd"> - A generated file's path if the user specified JSON in the connection id. The</span> |
| <span class="sd"> file is assumed to be deleted after the process dies due to how mkstemp()</span> |
| <span class="sd"> works.</span> |
| |
| <span class="sd"> The environment variable is used inside the gcloud command to determine correct</span> |
| <span class="sd"> service account to use.</span> |
| <span class="sd"> """</span> |
| <span class="n">key_path</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_field</span><span class="p">(</span><span class="n">extras</span><span class="p">,</span> <span class="s1">'key_path'</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span> |
| <span class="n">keyfile_json_str</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_field</span><span class="p">(</span><span class="n">extras</span><span class="p">,</span> <span class="s1">'keyfile_dict'</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">key_path</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">keyfile_json_str</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">'Using gcloud with application default credentials.'</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="n">key_path</span><span class="p">:</span> |
| <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">CREDENTIALS</span><span class="p">]</span> <span class="o">=</span> <span class="n">key_path</span> |
| <span class="k">return</span> <span class="kc">None</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="c1"># Write service account JSON to secure file for gcloud to reference</span> |
| <span class="n">service_key</span> <span class="o">=</span> <span class="n">tempfile</span><span class="o">.</span><span class="n">NamedTemporaryFile</span><span class="p">(</span><span class="n">delete</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> |
| <span class="n">service_key</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">keyfile_json_str</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s1">'utf-8'</span><span class="p">))</span> |
| <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="n">CREDENTIALS</span><span class="p">]</span> <span class="o">=</span> <span class="n">service_key</span><span class="o">.</span><span class="n">name</span> |
| <span class="c1"># Return file object to have a pointer to close after use,</span> |
| <span class="c1"># thus deleting from file system.</span> |
| <span class="k">return</span> <span class="n">service_key</span></div> |
| |
| <div class="viewcode-block" id="GKEPodOperator._get_field"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_container_operator/index.html#airflow.contrib.operators.gcp_container_operator.GKEPodOperator._get_field">[docs]</a> <span class="k">def</span> <span class="nf">_get_field</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">extras</span><span class="p">,</span> <span class="n">field</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Fetches a field from extras, and returns it. This is some Airflow</span> |
| <span class="sd"> magic. The google_cloud_platform hook type adds custom UI elements</span> |
| <span class="sd"> to the hook page, which allow admins to specify service_account,</span> |
| <span class="sd"> key_path, etc. They get formatted as shown below.</span> |
| <span class="sd"> """</span> |
| <span class="n">long_f</span> <span class="o">=</span> <span class="s1">'extra__google_cloud_platform__</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">field</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">long_f</span> <span class="ow">in</span> <span class="n">extras</span><span class="p">:</span> |
| <span class="k">return</span> <span class="n">extras</span><span class="p">[</span><span class="n">long_f</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">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">'Field </span><span class="si">%s</span><span class="s1"> not found in extras.'</span><span class="p">,</span> <span class="n">field</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">default</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. |
| <script type="text/javascript"> |
| (function() { |
| var ga = document.createElement('script'); |
| ga.src = ('https:' == document.location.protocol ? |
| 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| ga.setAttribute('async', 'true'); |
| var nodes = document.documentElement.childNodes; |
| var i = -1; |
| var node; |
| do { |
| i++; |
| node = nodes[i] |
| } while(node.nodeType !== Node.ELEMENT_NODE); |
| node.appendChild(ga); |
| })(); |
| </script> |
| </div> |
| |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
