| |
| |
| |
| |
| <!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>Google Cloud Platform Connection — Airflow Documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="../../_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script> |
| <script type="text/javascript" src="../../_static/jquery.js"></script> |
| <script type="text/javascript" src="../../_static/underscore.js"></script> |
| <script type="text/javascript" src="../../_static/doctools.js"></script> |
| <script type="text/javascript" src="../../_static/language_data.js"></script> |
| |
| <script type="text/javascript" src="../../_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" /> |
| <link rel="index" title="Index" href="../../genindex.html" /> |
| <link rel="search" title="Search" href="../../search.html" /> |
| <link rel="next" title="Google Cloud SQL Connection" href="gcp_sql.html" /> |
| <link rel="prev" title="Amazon Web Services Connection" href="aws.html" /> |
| |
| <script> |
| document.addEventListener('DOMContentLoaded', function() { |
| var el = document.getElementById('changelog'); |
| if (el !== null ) { |
| // [AIRFLOW-...] |
| el.innerHTML = el.innerHTML.replace( |
| /\[(AIRFLOW-[\d]+)\]/g, |
| `<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>` |
| ); |
| // (#...) |
| el.innerHTML = el.innerHTML.replace( |
| /\(#([\d]+)\)/g, |
| `<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>` |
| ); |
| }; |
| }) |
| </script> |
| <style> |
| .example-header { |
| position: relative; |
| background: #9AAA7A; |
| padding: 8px 16px; |
| margin-bottom: 0; |
| } |
| .example-header--with-button { |
| padding-right: 166px; |
| } |
| .example-header:after{ |
| content: ''; |
| display: table; |
| clear: both; |
| } |
| .example-title { |
| display:block; |
| padding: 4px; |
| margin-right: 16px; |
| color: white; |
| overflow-x: auto; |
| } |
| .example-header-button { |
| top: 8px; |
| right: 16px; |
| position: absolute; |
| } |
| .example-header + .highlight-python { |
| margin-top: 0 !important; |
| } |
| .viewcode-button { |
| display: inline-block; |
| padding: 8px 16px; |
| border: 0; |
| margin: 0; |
| outline: 0; |
| border-radius: 2px; |
| -webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3); |
| box-shadow: 0 3px 6px 0 rgba(0,0,0,.3); |
| color: #404040; |
| background-color: #e7e7e7; |
| cursor: pointer; |
| font-size: 16px; |
| font-weight: 500; |
| line-height: 1; |
| text-decoration: none; |
| text-overflow: ellipsis; |
| overflow: hidden; |
| text-transform: uppercase; |
| -webkit-transition: background-color .2s; |
| transition: background-color .2s; |
| vertical-align: middle; |
| white-space: nowrap; |
| } |
| .viewcode-button:visited { |
| color: #404040; |
| } |
| .viewcode-button:hover, .viewcode-button:focus { |
| color: #404040; |
| background-color: #d6d6d6; |
| } |
| </style> |
| |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../../index.html" class="icon icon-home"> Airflow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 1.10.3 |
| </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 class="current"> |
| <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 current"><a class="reference internal" href="../index.html">How-to Guides</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="../set-config.html">Setting Configuration Options</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../initialize-database.html">Initializing a Database Backend</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../operator/index.html">Using Operators</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="index.html">Managing Connections</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="index.html#creating-a-connection-with-the-ui">Creating a Connection with the UI</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="index.html#editing-a-connection-with-the-ui">Editing a Connection with the UI</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="index.html#creating-a-connection-with-environment-variables">Creating a Connection with Environment Variables</a></li> |
| <li class="toctree-l3 current"><a class="reference internal" href="index.html#connection-types">Connection Types</a><ul class="current"> |
| <li class="toctree-l4"><a class="reference internal" href="aws.html">Amazon Web Services Connection</a></li> |
| <li class="toctree-l4 current"><a class="current reference internal" href="#">Google Cloud Platform Connection</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="gcp_sql.html">Google Cloud SQL Connection</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="mysql.html">MySQL Connection</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="oracle.html">Oracle Connection</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="postgres.html">PostgresSQL Connection</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="ssh.html">SSH Connection</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../secure-connections.html">Securing Connections</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../secure-connections.html#rotating-encryption-keys">Rotating encryption keys</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../write-logs.html">Writing Logs</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../executor/use-celery.html">Scaling Out with Celery</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../executor/use-dask.html">Scaling Out with Dask</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../executor/use-mesos.html">Scaling Out with Mesos (community contributed)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../run-behind-proxy.html">Running Airflow behind a reverse proxy</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../run-with-systemd.html">Running Airflow with systemd</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../run-with-upstart.html">Running Airflow with upstart</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../use-test-config.html">Using the Test Mode Configuration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../check-health.html">Checking Airflow Health Status</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../ui.html">UI / Screenshots</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../profiling.html">Data Profiling</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../cli.html">Command Line Interface</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../scheduler.html">Scheduling & Triggers</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../plugins.html">Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../security.html">Security</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../timezone.html">Time zones</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../api.html">Experimental Rest API</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../integration.html">Integration</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../metrics.html">Metrics</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../kubernetes.html">Kubernetes</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../lineage.html">Lineage</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../changelog.html">Changelog</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../faq.html">FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../macros.html">Macros reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../_api/index.html">API Reference</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="../../index.html">Airflow</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="../../index.html">Docs</a> »</li> |
| |
| <li><a href="../index.html">How-to Guides</a> »</li> |
| |
| <li><a href="index.html">Managing Connections</a> »</li> |
| |
| <li>Google Cloud Platform Connection</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../../_sources/howto/connection/gcp.rst.txt" rel="nofollow"> View page source</a> |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="google-cloud-platform-connection"> |
| <span id="howto-connection-gcp"></span><h1>Google Cloud Platform Connection<a class="headerlink" href="#google-cloud-platform-connection" title="Permalink to this headline">¶</a></h1> |
| <p>The Google Cloud Platform connection type enables the <a class="reference internal" href="../../integration.html#gcp"><span class="std std-ref">GCP Integrations</span></a>.</p> |
| <div class="section" id="authenticating-to-gcp"> |
| <h2>Authenticating to GCP<a class="headerlink" href="#authenticating-to-gcp" title="Permalink to this headline">¶</a></h2> |
| <p>There are two ways to connect to GCP using Airflow.</p> |
| <ol class="arabic simple"> |
| <li><p>Use <a class="reference external" href="https://google-auth.readthedocs.io/en/latest/reference/google.auth.html#google.auth.default">Application Default Credentials</a>, |
| such as via the metadata server when running on Google Compute Engine.</p></li> |
| <li><p>Use a <a class="reference external" href="https://cloud.google.com/docs/authentication/#service_accounts">service account</a> key |
| file (JSON format) on disk.</p></li> |
| </ol> |
| </div> |
| <div class="section" id="default-connection-ids"> |
| <h2>Default Connection IDs<a class="headerlink" href="#default-connection-ids" title="Permalink to this headline">¶</a></h2> |
| <p>The following connection IDs are used by default.</p> |
| <dl class="simple"> |
| <dt><code class="docutils literal notranslate"><span class="pre">bigquery_default</span></code></dt><dd><p>Used by the <a class="reference internal" href="../../_api/airflow/contrib/hooks/bigquery_hook/index.html#airflow.contrib.hooks.bigquery_hook.BigQueryHook" title="airflow.contrib.hooks.bigquery_hook.BigQueryHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">BigQueryHook</span></code></a> |
| hook.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">google_cloud_datastore_default</span></code></dt><dd><p>Used by the <a class="reference internal" href="../../_api/airflow/contrib/hooks/datastore_hook/index.html#airflow.contrib.hooks.datastore_hook.DatastoreHook" title="airflow.contrib.hooks.datastore_hook.DatastoreHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">DatastoreHook</span></code></a> |
| hook.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">google_cloud_default</span></code></dt><dd><p>Used by those hooks:</p> |
| <ul class="simple"> |
| <li><p><a class="reference internal" href="../../_api/airflow/contrib/hooks/gcp_api_base_hook/index.html#airflow.contrib.hooks.gcp_api_base_hook.GoogleCloudBaseHook" title="airflow.contrib.hooks.gcp_api_base_hook.GoogleCloudBaseHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">GoogleCloudBaseHook</span></code></a></p></li> |
| <li><p><a class="reference internal" href="../../_api/airflow/contrib/hooks/gcp_dataflow_hook/index.html#airflow.contrib.hooks.gcp_dataflow_hook.DataFlowHook" title="airflow.contrib.hooks.gcp_dataflow_hook.DataFlowHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataFlowHook</span></code></a></p></li> |
| <li><p><a class="reference internal" href="../../_api/airflow/contrib/hooks/gcp_dataproc_hook/index.html#airflow.contrib.hooks.gcp_dataproc_hook.DataProcHook" title="airflow.contrib.hooks.gcp_dataproc_hook.DataProcHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">DataProcHook</span></code></a></p></li> |
| <li><p><a class="reference internal" href="../../_api/airflow/contrib/hooks/gcp_mlengine_hook/index.html#airflow.contrib.hooks.gcp_mlengine_hook.MLEngineHook" title="airflow.contrib.hooks.gcp_mlengine_hook.MLEngineHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">MLEngineHook</span></code></a></p></li> |
| <li><p><a class="reference internal" href="../../_api/airflow/contrib/hooks/gcs_hook/index.html#airflow.contrib.hooks.gcs_hook.GoogleCloudStorageHook" title="airflow.contrib.hooks.gcs_hook.GoogleCloudStorageHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">GoogleCloudStorageHook</span></code></a></p></li> |
| <li><p><a class="reference internal" href="../../_api/airflow/contrib/hooks/gcp_bigtable_hook/index.html#airflow.contrib.hooks.gcp_bigtable_hook.BigtableHook" title="airflow.contrib.hooks.gcp_bigtable_hook.BigtableHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">BigtableHook</span></code></a></p></li> |
| <li><p><a class="reference internal" href="../../_api/airflow/contrib/hooks/gcp_compute_hook/index.html#airflow.contrib.hooks.gcp_compute_hook.GceHook" title="airflow.contrib.hooks.gcp_compute_hook.GceHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">GceHook</span></code></a></p></li> |
| <li><p><a class="reference internal" href="../../_api/airflow/contrib/hooks/gcp_function_hook/index.html#airflow.contrib.hooks.gcp_function_hook.GcfHook" title="airflow.contrib.hooks.gcp_function_hook.GcfHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">GcfHook</span></code></a></p></li> |
| <li><p><a class="reference internal" href="../../_api/airflow/contrib/hooks/gcp_spanner_hook/index.html#airflow.contrib.hooks.gcp_spanner_hook.CloudSpannerHook" title="airflow.contrib.hooks.gcp_spanner_hook.CloudSpannerHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">CloudSpannerHook</span></code></a></p></li> |
| <li><p><a class="reference internal" href="../../_api/airflow/contrib/hooks/gcp_sql_hook/index.html#airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook" title="airflow.contrib.hooks.gcp_sql_hook.CloudSqlHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">CloudSqlHook</span></code></a></p></li> |
| </ul> |
| </dd> |
| </dl> |
| </div> |
| <div class="section" id="configuring-the-connection"> |
| <h2>Configuring the Connection<a class="headerlink" href="#configuring-the-connection" title="Permalink to this headline">¶</a></h2> |
| <dl> |
| <dt>Project Id (optional)</dt><dd><p>The Google Cloud project ID to connect to. It is used as default project id by operators using it and |
| can usually be overridden at the operator level.</p> |
| </dd> |
| <dt>Keyfile Path</dt><dd><p>Path to a <a class="reference external" href="https://cloud.google.com/docs/authentication/#service_accounts">service account</a> key |
| file (JSON format) on disk.</p> |
| <p>Not required if using application default credentials.</p> |
| </dd> |
| <dt>Keyfile JSON</dt><dd><p>Contents of a <a class="reference external" href="https://cloud.google.com/docs/authentication/#service_accounts">service account</a> key |
| file (JSON format) on disk. It is recommended to <a class="reference internal" href="../secure-connections.html"><span class="doc">Secure your connections</span></a> if using this method to authenticate.</p> |
| <p>Not required if using application default credentials.</p> |
| </dd> |
| <dt>Scopes (comma separated)</dt><dd><p>A list of comma-separated <a class="reference external" href="https://developers.google.com/identity/protocols/googlescopes">Google Cloud scopes</a> to |
| authenticate with.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Scopes are ignored when using application default credentials. See |
| issue <a class="reference external" href="https://issues.apache.org/jira/browse/AIRFLOW-2522">AIRFLOW-2522</a>.</p> |
| </div> |
| <p>When specifying the connection in environment variable you should specify |
| it using URI syntax, with the following requirements:</p> |
| <blockquote> |
| <div><ul class="simple"> |
| <li><p>scheme part should be equals <code class="docutils literal notranslate"><span class="pre">google-cloud-platform</span></code> (Note: look for a |
| hyphen character)</p></li> |
| <li><p>authority (username, password, host, port), path is ignored</p></li> |
| <li><p>query parameters contains information specific to this type of |
| connection. The following keys are accepted:</p> |
| <ul> |
| <li><p><code class="docutils literal notranslate"><span class="pre">extra__google_cloud_platform__project</span></code> - Project Id</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">extra__google_cloud_platform__key_path</span></code> - Keyfile Path</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">extra__google_cloud_platform__key_dict</span></code> - Keyfile JSON</p></li> |
| <li><p><code class="docutils literal notranslate"><span class="pre">extra__google_cloud_platform__scope</span></code> - Scopes</p></li> |
| </ul> |
| </li> |
| </ul> |
| </div></blockquote> |
| <p>Note that all components of the URI should be URL-encoded.</p> |
| <p>For example:</p> |
| <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>google-cloud-platform://?extra__google_cloud_platform__key_path<span class="o">=</span>%2Fkeys%2Fkey.json<span class="p">&</span><span class="nv">extra__google_cloud_platform__scope</span><span class="o">=</span>https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fcloud-platform<span class="p">&</span><span class="nv">extra__google_cloud_platform__project</span><span class="o">=</span>airflow |
| </pre></div> |
| </div> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="gcp_sql.html" class="btn btn-neutral float-right" title="Google Cloud SQL Connection" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="aws.html" class="btn btn-neutral float-left" title="Amazon Web Services Connection" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
