| |
| |
| <!-- |
| 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.hooks.gcp_container_hook — 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="../hooks.html">airflow.contrib.hooks</a> »</li> |
| |
| <li>airflow.contrib.hooks.gcp_container_hook</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.hooks.gcp_container_hook</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">json</span> |
| <span class="kn">import</span> <span class="nn">time</span> |
| |
| <span class="kn">from</span> <span class="nn">airflow</span> <span class="k">import</span> <span class="n">AirflowException</span><span class="p">,</span> <span class="n">version</span> |
| <span class="kn">from</span> <span class="nn">airflow.contrib.hooks.gcp_api_base_hook</span> <span class="k">import</span> <span class="n">GoogleCloudBaseHook</span> |
| |
| <span class="kn">from</span> <span class="nn">google.api_core.exceptions</span> <span class="k">import</span> <span class="n">AlreadyExists</span><span class="p">,</span> <span class="n">NotFound</span> |
| <span class="kn">from</span> <span class="nn">google.api_core.gapic_v1.method</span> <span class="k">import</span> <span class="n">DEFAULT</span> |
| <span class="kn">from</span> <span class="nn">google.cloud</span> <span class="k">import</span> <span class="n">container_v1</span><span class="p">,</span> <span class="n">exceptions</span> |
| <span class="kn">from</span> <span class="nn">google.cloud.container_v1.gapic.enums</span> <span class="k">import</span> <span class="n">Operation</span> |
| <span class="kn">from</span> <span class="nn">google.cloud.container_v1.types</span> <span class="k">import</span> <span class="n">Cluster</span> |
| <span class="kn">from</span> <span class="nn">google.protobuf</span> <span class="k">import</span> <span class="n">json_format</span> |
| <span class="kn">from</span> <span class="nn">google.api_core.gapic_v1.client_info</span> <span class="k">import</span> <span class="n">ClientInfo</span> |
| |
| <div class="viewcode-block" id="OPERATIONAL_POLL_INTERVAL"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_container_hook/index.html#airflow.contrib.hooks.gcp_container_hook.OPERATIONAL_POLL_INTERVAL">[docs]</a><span class="n">OPERATIONAL_POLL_INTERVAL</span> <span class="o">=</span> <span class="mi">15</span></div> |
| |
| |
| <div class="viewcode-block" id="GKEClusterHook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_container_hook/index.html#airflow.contrib.hooks.gcp_container_hook.GKEClusterHook">[docs]</a><span class="k">class</span> <span class="nc">GKEClusterHook</span><span class="p">(</span><span class="n">GoogleCloudBaseHook</span><span class="p">):</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">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> |
| <span class="n">delegate_to</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">location</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">GKEClusterHook</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="n">gcp_conn_id</span><span class="o">=</span><span class="n">gcp_conn_id</span><span class="p">,</span> <span class="n">delegate_to</span><span class="o">=</span><span class="n">delegate_to</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="kc">None</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">location</span> <span class="o">=</span> <span class="n">location</span> |
| |
| <div class="viewcode-block" id="GKEClusterHook.get_client"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_container_hook/index.html#airflow.contrib.hooks.gcp_container_hook.GKEClusterHook.get_client">[docs]</a> <span class="k">def</span> <span class="nf">get_client</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">_client</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">credentials</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_credentials</span><span class="p">()</span> |
| <span class="c1"># Add client library info for better error tracking</span> |
| <span class="n">client_info</span> <span class="o">=</span> <span class="n">ClientInfo</span><span class="p">(</span><span class="n">client_library_version</span><span class="o">=</span><span class="s1">'airflow_v'</span> <span class="o">+</span> <span class="n">version</span><span class="o">.</span><span class="n">version</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="n">container_v1</span><span class="o">.</span><span class="n">ClusterManagerClient</span><span class="p">(</span><span class="n">credentials</span><span class="o">=</span><span class="n">credentials</span><span class="p">,</span> <span class="n">client_info</span><span class="o">=</span><span class="n">client_info</span><span class="p">)</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_client</span></div> |
| |
| <span class="nd">@staticmethod</span> |
| <div class="viewcode-block" id="GKEClusterHook._dict_to_proto"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_container_hook/index.html#airflow.contrib.hooks.gcp_container_hook.GKEClusterHook._dict_to_proto">[docs]</a> <span class="k">def</span> <span class="nf">_dict_to_proto</span><span class="p">(</span><span class="n">py_dict</span><span class="p">,</span> <span class="n">proto</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Converts a python dictionary to the proto supplied</span> |
| |
| <span class="sd"> :param py_dict: The dictionary to convert</span> |
| <span class="sd"> :type py_dict: dict</span> |
| <span class="sd"> :param proto: The proto object to merge with dictionary</span> |
| <span class="sd"> :type proto: protobuf</span> |
| <span class="sd"> :return: A parsed python dictionary in provided proto format</span> |
| <span class="sd"> :raises:</span> |
| <span class="sd"> ParseError: On JSON parsing problems.</span> |
| <span class="sd"> """</span> |
| <span class="n">dict_json_str</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="n">py_dict</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">json_format</span><span class="o">.</span><span class="n">Parse</span><span class="p">(</span><span class="n">dict_json_str</span><span class="p">,</span> <span class="n">proto</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="GKEClusterHook.wait_for_operation"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_container_hook/index.html#airflow.contrib.hooks.gcp_container_hook.GKEClusterHook.wait_for_operation">[docs]</a> <span class="k">def</span> <span class="nf">wait_for_operation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">operation</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Given an operation, continuously fetches the status from Google Cloud until either</span> |
| <span class="sd"> completion or an error occurring</span> |
| |
| <span class="sd"> :param operation: The Operation to wait for</span> |
| <span class="sd"> :type operation: google.cloud.container_V1.gapic.enums.Operation</span> |
| <span class="sd"> :param project_id: Google Cloud Platform project ID</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :return: A new, updated operation fetched from Google Cloud</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="s2">"Waiting for OPERATION_NAME </span><span class="si">%s</span><span class="s2">"</span><span class="p">,</span> <span class="n">operation</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> |
| <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">OPERATIONAL_POLL_INTERVAL</span><span class="p">)</span> |
| <span class="k">while</span> <span class="n">operation</span><span class="o">.</span><span class="n">status</span> <span class="o">!=</span> <span class="n">Operation</span><span class="o">.</span><span class="n">Status</span><span class="o">.</span><span class="n">DONE</span><span class="p">:</span> |
| <span class="k">if</span> <span class="n">operation</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> <span class="n">Operation</span><span class="o">.</span><span class="n">Status</span><span class="o">.</span><span class="n">RUNNING</span> <span class="ow">or</span> <span class="n">operation</span><span class="o">.</span><span class="n">status</span> <span class="o">==</span> \ |
| <span class="n">Operation</span><span class="o">.</span><span class="n">Status</span><span class="o">.</span><span class="n">PENDING</span><span class="p">:</span> |
| <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">OPERATIONAL_POLL_INTERVAL</span><span class="p">)</span> |
| <span class="k">else</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">exceptions</span><span class="o">.</span><span class="n">GoogleCloudError</span><span class="p">(</span> |
| <span class="s2">"Operation has failed with status: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="n">operation</span><span class="o">.</span><span class="n">status</span><span class="p">)</span> |
| <span class="c1"># To update status of operation</span> |
| <span class="n">operation</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_operation</span><span class="p">(</span><span class="n">operation</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="n">project_id</span> <span class="ow">or</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">operation</span></div> |
| |
| <div class="viewcode-block" id="GKEClusterHook.get_operation"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_container_hook/index.html#airflow.contrib.hooks.gcp_container_hook.GKEClusterHook.get_operation">[docs]</a> <span class="k">def</span> <span class="nf">get_operation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Fetches the operation from Google Cloud</span> |
| |
| <span class="sd"> :param operation_name: Name of operation to fetch</span> |
| <span class="sd"> :type operation_name: str</span> |
| <span class="sd"> :param project_id: Google Cloud Platform project ID</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :return: The new, updated operation from Google Cloud</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_client</span><span class="p">()</span><span class="o">.</span><span class="n">get_operation</span><span class="p">(</span><span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">zone</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">operation_id</span><span class="o">=</span><span class="n">operation_name</span><span class="p">)</span></div> |
| |
| <span class="nd">@staticmethod</span> |
| <div class="viewcode-block" id="GKEClusterHook._append_label"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_container_hook/index.html#airflow.contrib.hooks.gcp_container_hook.GKEClusterHook._append_label">[docs]</a> <span class="k">def</span> <span class="nf">_append_label</span><span class="p">(</span><span class="n">cluster_proto</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="n">val</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Append labels to provided Cluster Protobuf</span> |
| |
| <span class="sd"> Labels must fit the regex ``[a-z]([-a-z0-9]*[a-z0-9])?`` (current</span> |
| <span class="sd"> airflow version string follows semantic versioning spec: x.y.z).</span> |
| |
| <span class="sd"> :param cluster_proto: The proto to append resource_label airflow</span> |
| <span class="sd"> version to</span> |
| <span class="sd"> :type cluster_proto: google.cloud.container_v1.types.Cluster</span> |
| <span class="sd"> :param key: The key label</span> |
| <span class="sd"> :type key: str</span> |
| <span class="sd"> :param val:</span> |
| <span class="sd"> :type val: str</span> |
| <span class="sd"> :return: The cluster proto updated with new label</span> |
| <span class="sd"> """</span> |
| <span class="n">val</span> <span class="o">=</span> <span class="n">val</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'.'</span><span class="p">,</span> <span class="s1">'-'</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">'+'</span><span class="p">,</span> <span class="s1">'-'</span><span class="p">)</span> |
| <span class="n">cluster_proto</span><span class="o">.</span><span class="n">resource_labels</span><span class="o">.</span><span class="n">update</span><span class="p">({</span><span class="n">key</span><span class="p">:</span> <span class="n">val</span><span class="p">})</span> |
| <span class="k">return</span> <span class="n">cluster_proto</span></div> |
| |
| <div class="viewcode-block" id="GKEClusterHook.delete_cluster"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_container_hook/index.html#airflow.contrib.hooks.gcp_container_hook.GKEClusterHook.delete_cluster">[docs]</a> <span class="k">def</span> <span class="nf">delete_cluster</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">retry</span><span class="o">=</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="n">DEFAULT</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Deletes the cluster, including the Kubernetes endpoint and all</span> |
| <span class="sd"> worker nodes. Firewalls and routes that were configured during</span> |
| <span class="sd"> cluster creation are also deleted. Other Google Compute Engine</span> |
| <span class="sd"> resources that might be in use by the cluster (e.g. load balancer</span> |
| <span class="sd"> resources) will not be deleted if they weren’t present at the</span> |
| <span class="sd"> initial create time.</span> |
| |
| <span class="sd"> :param name: The name of the cluster to delete</span> |
| <span class="sd"> :type name: str</span> |
| <span class="sd"> :param project_id: Google Cloud Platform project ID</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param retry: Retry object used to determine when/if to retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: The amount of time, in seconds, to wait for the request to</span> |
| <span class="sd"> complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :return: The full url to the delete operation if successful, else None</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="s2">"Deleting (project_id=</span><span class="si">%s</span><span class="s2">, zone=</span><span class="si">%s</span><span class="s2">, cluster_id=</span><span class="si">%s</span><span class="s2">)"</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="n">name</span> |
| <span class="p">)</span> |
| |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">op</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_client</span><span class="p">()</span><span class="o">.</span><span class="n">delete_cluster</span><span class="p">(</span><span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">zone</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">cluster_id</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">)</span> |
| <span class="n">op</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">wait_for_operation</span><span class="p">(</span><span class="n">op</span><span class="p">)</span> |
| <span class="c1"># Returns server-defined url for the resource</span> |
| <span class="k">return</span> <span class="n">op</span><span class="o">.</span><span class="n">self_link</span> |
| <span class="k">except</span> <span class="n">NotFound</span> <span class="k">as</span> <span class="n">error</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">'Assuming Success: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">error</span><span class="o">.</span><span class="n">message</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="GKEClusterHook.create_cluster"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_container_hook/index.html#airflow.contrib.hooks.gcp_container_hook.GKEClusterHook.create_cluster">[docs]</a> <span class="k">def</span> <span class="nf">create_cluster</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cluster</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">retry</span><span class="o">=</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="n">DEFAULT</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Creates a cluster, consisting of the specified number and type of Google Compute</span> |
| <span class="sd"> Engine instances.</span> |
| |
| <span class="sd"> :param cluster: A Cluster protobuf or dict. If dict is provided, it must</span> |
| <span class="sd"> be of the same form as the protobuf message</span> |
| <span class="sd"> :class:`google.cloud.container_v1.types.Cluster`</span> |
| <span class="sd"> :type cluster: dict or google.cloud.container_v1.types.Cluster</span> |
| <span class="sd"> :param project_id: Google Cloud Platform project ID</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param retry: A retry object (``google.api_core.retry.Retry``) used to</span> |
| <span class="sd"> retry requests.</span> |
| <span class="sd"> If None is specified, requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: The amount of time, in seconds, to wait for the request to</span> |
| <span class="sd"> complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :return: The full url to the new, or existing, cluster</span> |
| <span class="sd"> :raises:</span> |
| <span class="sd"> ParseError: On JSON parsing problems when trying to convert dict</span> |
| <span class="sd"> AirflowException: cluster is not dict type nor Cluster proto type</span> |
| <span class="sd"> """</span> |
| |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">cluster</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span> |
| <span class="n">cluster_proto</span> <span class="o">=</span> <span class="n">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">_dict_to_proto</span><span class="p">(</span><span class="n">py_dict</span><span class="o">=</span><span class="n">cluster</span><span class="p">,</span> <span class="n">proto</span><span class="o">=</span><span class="n">cluster_proto</span><span class="p">)</span> |
| <span class="k">elif</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">cluster</span><span class="p">,</span> <span class="n">Cluster</span><span class="p">):</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"cluster is not instance of Cluster proto or python dict"</span><span class="p">)</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_append_label</span><span class="p">(</span><span class="n">cluster</span><span class="p">,</span> <span class="s1">'airflow-version'</span><span class="p">,</span> <span class="s1">'v'</span> <span class="o">+</span> <span class="n">version</span><span class="o">.</span><span class="n">version</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">"Creating (project_id=</span><span class="si">%s</span><span class="s2">, zone=</span><span class="si">%s</span><span class="s2">, cluster_name=</span><span class="si">%s</span><span class="s2">)"</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="n">cluster</span><span class="o">.</span><span class="n">name</span> |
| <span class="p">)</span> |
| <span class="k">try</span><span class="p">:</span> |
| <span class="n">op</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_client</span><span class="p">()</span><span class="o">.</span><span class="n">create_cluster</span><span class="p">(</span><span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">zone</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">cluster</span><span class="o">=</span><span class="n">cluster</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">)</span> |
| <span class="n">op</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">wait_for_operation</span><span class="p">(</span><span class="n">op</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">op</span><span class="o">.</span><span class="n">target_link</span> |
| <span class="k">except</span> <span class="n">AlreadyExists</span> <span class="k">as</span> <span class="n">error</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">'Assuming Success: </span><span class="si">%s</span><span class="s1">'</span><span class="p">,</span> <span class="n">error</span><span class="o">.</span><span class="n">message</span><span class="p">)</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_cluster</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="n">cluster</span><span class="o">.</span><span class="n">name</span><span class="p">)</span><span class="o">.</span><span class="n">self_link</span></div> |
| |
| <div class="viewcode-block" id="GKEClusterHook.get_cluster"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_container_hook/index.html#airflow.contrib.hooks.gcp_container_hook.GKEClusterHook.get_cluster">[docs]</a> <span class="k">def</span> <span class="nf">get_cluster</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">retry</span><span class="o">=</span><span class="n">DEFAULT</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="n">DEFAULT</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Gets details of specified cluster</span> |
| |
| <span class="sd"> :param name: The name of the cluster to retrieve</span> |
| <span class="sd"> :type name: str</span> |
| <span class="sd"> :param project_id: Google Cloud Platform project ID</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param retry: A retry object used to retry requests. If None is specified,</span> |
| <span class="sd"> requests will not be retried.</span> |
| <span class="sd"> :type retry: google.api_core.retry.Retry</span> |
| <span class="sd"> :param timeout: The amount of time, in seconds, to wait for the request to</span> |
| <span class="sd"> complete. Note that if retry is specified, the timeout applies to each</span> |
| <span class="sd"> individual attempt.</span> |
| <span class="sd"> :type timeout: float</span> |
| <span class="sd"> :return: google.cloud.container_v1.types.Cluster</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="s2">"Fetching cluster (project_id=</span><span class="si">%s</span><span class="s2">, zone=</span><span class="si">%s</span><span class="s2">, cluster_name=</span><span class="si">%s</span><span class="s2">)"</span><span class="p">,</span> |
| <span class="n">project_id</span> <span class="ow">or</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="n">name</span> |
| <span class="p">)</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_client</span><span class="p">()</span><span class="o">.</span><span class="n">get_cluster</span><span class="p">(</span><span class="n">project_id</span><span class="o">=</span><span class="n">project_id</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">,</span> |
| <span class="n">zone</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">cluster_id</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> |
| <span class="n">retry</span><span class="o">=</span><span class="n">retry</span><span class="p">,</span> |
| <span class="n">timeout</span><span class="o">=</span><span class="n">timeout</span><span class="p">)</span><span class="o">.</span><span class="n">self_link</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> |
