Mailing-List: contact commits-help@airflow.incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@airflow.incubator.apache.org
Date: Tue, 11 Jul 2017 18:05:00 +0000 (UTC)
From: "Peter Dolan (JIRA)" <jira@apache.org>
To: commits@airflow.incubator.apache.org
Message-ID: <JIRA.13086333.1499796286000.219873.1499796300156@Atlassian.JIRA>
In-Reply-To: <JIRA.13086333.1499796286000@Atlassian.JIRA>
References: <JIRA.13086333.1499796286000@Atlassian.JIRA> <JIRA.13086333.1499796286348@jira-lw-us.apache.org>
Subject: [jira] [Created] (AIRFLOW-1401) Standardize GCP project, region,
 and zone argument names
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit
archived-at: Tue, 11 Jul 2017 18:06:56 -0000

Peter Dolan created AIRFLOW-1401:
------------------------------------

             Summary: Standardize GCP project, region, and zone argument names
                 Key: AIRFLOW-1401
                 URL: https://issues.apache.org/jira/browse/AIRFLOW-1401
             Project: Apache Airflow
          Issue Type: Improvement
          Components: contrib
    Affects Versions: 1.9.0
            Reporter: Peter Dolan
            Assignee: Peter Dolan


At the moment, there isn't perfectly standard usage of operator arguments for Google Cloud Platform across the contributions, primarily in the usage of the parameter meaning the GCP project name/id. This makes it difficult to specify default_arguments that work across all GCP-centric operators in a graph.

Using the command `grep -r project airflow/contrib/*`, we can see these uses:

project_id:
 * gcp_dataproc_hook
 * datastore_hook
 * gcp_api_base_hook
 * bigquery_hook
 * dataproc_operator
 * bigquery_sensor

project:
 * gcp_pubsub_hook (here 'project' means project id or project name, which does not fully understand the distinction within GCP between project id and project name as elements of the REST api)
 * dataflow_operator (see note below)
 * pubsub_operator

project_name:
 * gcp_cloudml_hook
 * cloudml_operator

Notably, the Dataflow Operator diverges from the pattern of using top-level operator parameters by specifying an options dict, which can be populated by the dataflow_default_options dict. This can contain 'project', and 'zone.'

This improvement proposes to standardize the above operators (at least) on
 * project_id (meaning '<project>' in this example request: GET https://www.googleapis.com/compute/v1/projects/<project>/zones/<zone>/instances/<instance>)
 * region
 * zone

This can be done by changing the names of parameters of operators and hooks that were not included in the 1.8.2 release, and by adding parameters to operators and hooks that were included in 1.8.2 (and internally copying the old parameter name to the new one, and deprecating the old one).


--
This message was sent by Atlassian JIRA
(v6.4.14#64029)