# -*- coding: utf-8 -*-
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
#
"""
This module contains Google Dataproc operators.
"""
# pylint: disable=C0302
import ntpath
import os
import re
import time
import uuid
from datetime import timedelta
from airflow.contrib.hooks.gcp_dataproc_hook import DataProcHook
from airflow.contrib.hooks.gcs_hook import GoogleCloudStorageHook
from airflow.exceptions import AirflowException
from airflow.models import BaseOperator
from airflow.utils.decorators import apply_defaults
from airflow.version import version
from airflow.utils import timezone
[docs]class DataprocOperationBaseOperator(BaseOperator):
"""The base class for operators that poll on a Dataproc Operation."""
@apply_defaults
def __init__(self,
project_id,
region='global',
gcp_conn_id='google_cloud_default',
delegate_to=None,
*args,
**kwargs):
super(DataprocOperationBaseOperator, self).__init__(*args, **kwargs)
self.gcp_conn_id = gcp_conn_id
self.delegate_to = delegate_to
self.project_id = project_id
self.region = region
self.hook = DataProcHook(
gcp_conn_id=self.gcp_conn_id,
delegate_to=self.delegate_to,
api_version='v1beta2'
)
[docs] def execute(self, context):
# pylint: disable=no-value-for-parameter
self.hook.wait(self.start())
[docs] def start(self, context):
raise AirflowException('Please submit an operation')
# pylint: disable=too-many-instance-attributes
[docs]class DataprocClusterCreateOperator(DataprocOperationBaseOperator):
"""
Create a new cluster on Google Cloud Dataproc. The operator will wait until the
creation is successful or an error occurs in the creation process.
The parameters allow to configure the cluster. Please refer to
https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.clusters
for a detailed explanation on the different parameters. Most of the configuration
parameters detailed in the link are available as a parameter to this operator.
:param cluster_name: The name of the DataProc cluster to create. (templated)
:type cluster_name: str
:param project_id: The ID of the google cloud project in which
to create the cluster. (templated)
:type project_id: str
:param num_workers: The # of workers to spin up. If set to zero will
spin up cluster in a single node mode
:type num_workers: int
:param storage_bucket: The storage bucket to use, setting to None lets dataproc
generate a custom one for you
:type storage_bucket: str
:param init_actions_uris: List of GCS uri's containing
dataproc initialization scripts
:type init_actions_uris: list[str]
:param init_action_timeout: Amount of time executable scripts in
init_actions_uris has to complete
:type init_action_timeout: str
:param metadata: dict of key-value google compute engine metadata entries
to add to all instances
:type metadata: dict
:param image_version: the version of software inside the Dataproc cluster
:type image_version: str
:param custom_image: custom Dataproc image for more info see
https://cloud.google.com/dataproc/docs/guides/dataproc-images
:type custom_image: str
:param autoscaling_policy: The autoscaling policy used by the cluster. Only resource names
including projectid and location (region) are valid. Example:
``projects/[projectId]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]``
:type autoscaling_policy: str
:param properties: dict of properties to set on
config files (e.g. spark-defaults.conf), see
https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.clusters#SoftwareConfig
:type properties: dict
:param master_machine_type: Compute engine machine type to use for the master node
:type master_machine_type: str
:param master_disk_type: Type of the boot disk for the master node
(default is ``pd-standard``).
Valid values: ``pd-ssd`` (Persistent Disk Solid State Drive) or
``pd-standard`` (Persistent Disk Hard Disk Drive).
:type master_disk_type: str
:param master_disk_size: Disk size for the master node
:type master_disk_size: int
:param worker_machine_type: Compute engine machine type to use for the worker nodes
:type worker_machine_type: str
:param worker_disk_type: Type of the boot disk for the worker node
(default is ``pd-standard``).
Valid values: ``pd-ssd`` (Persistent Disk Solid State Drive) or
``pd-standard`` (Persistent Disk Hard Disk Drive).
:type worker_disk_type: str
:param worker_disk_size: Disk size for the worker nodes
:type worker_disk_size: int
:param num_preemptible_workers: The # of preemptible worker nodes to spin up
:type num_preemptible_workers: int
:param labels: dict of labels to add to the cluster
:type labels: dict
:param zone: The zone where the cluster will be located. Set to None to auto-zone. (templated)
:type zone: str
:param network_uri: The network uri to be used for machine communication, cannot be
specified with subnetwork_uri
:type network_uri: str
:param subnetwork_uri: The subnetwork uri to be used for machine communication,
cannot be specified with network_uri
:type subnetwork_uri: str
:param internal_ip_only: If true, all instances in the cluster will only
have internal IP addresses. This can only be enabled for subnetwork
enabled networks
:type internal_ip_only: bool
:param tags: The GCE tags to add to all instances
:type tags: list[str]
:param region: leave as 'global', might become relevant in the future. (templated)
:type region: str
:param gcp_conn_id: The connection ID to use connecting to Google Cloud Platform.
:type gcp_conn_id: str
:param delegate_to: The account to impersonate, if any.
For this to work, the service account making the request must have domain-wide
delegation enabled.
:type delegate_to: str
:param service_account: The service account of the dataproc instances.
:type service_account: str
:param service_account_scopes: The URIs of service account scopes to be included.
:type service_account_scopes: list[str]
:param idle_delete_ttl: The longest duration that cluster would keep alive while
staying idle. Passing this threshold will cause cluster to be auto-deleted.
A duration in seconds.
:type idle_delete_ttl: int
:param auto_delete_time: The time when cluster will be auto-deleted.
:type auto_delete_time: datetime.datetime
:param auto_delete_ttl: The life duration of cluster, the cluster will be
auto-deleted at the end of this duration.
A duration in seconds. (If auto_delete_time is set this parameter will be ignored)
:type auto_delete_ttl: int
:param customer_managed_key: The customer-managed key used for disk encryption
``projects/[PROJECT_STORING_KEYS]/locations/[LOCATION]/keyRings/[KEY_RING_NAME]/cryptoKeys/[KEY_NAME]`` # noqa # pylint: disable=line-too-long
:type customer_managed_key: str
"""
[docs] template_fields = ['cluster_name', 'project_id', 'zone', 'region']
# pylint: disable=too-many-arguments,too-many-locals
@apply_defaults
def __init__(self,
project_id,
cluster_name,
num_workers,
zone=None,
network_uri=None,
subnetwork_uri=None,
internal_ip_only=None,
tags=None,
storage_bucket=None,
init_actions_uris=None,
init_action_timeout="10m",
metadata=None,
custom_image=None,
image_version=None,
autoscaling_policy=None,
properties=None,
master_machine_type='n1-standard-4',
master_disk_type='pd-standard',
master_disk_size=500,
worker_machine_type='n1-standard-4',
worker_disk_type='pd-standard',
worker_disk_size=500,
num_preemptible_workers=0,
labels=None,
region='global',
service_account=None,
service_account_scopes=None,
idle_delete_ttl=None,
auto_delete_time=None,
auto_delete_ttl=None,
customer_managed_key=None,
*args,
**kwargs):
super(DataprocClusterCreateOperator, self).__init__(
project_id=project_id, region=region, *args, **kwargs)
self.cluster_name = cluster_name
self.num_workers = num_workers
self.num_preemptible_workers = num_preemptible_workers
self.storage_bucket = storage_bucket
self.init_actions_uris = init_actions_uris
self.init_action_timeout = init_action_timeout
self.metadata = metadata
self.custom_image = custom_image
self.image_version = image_version
self.properties = properties or dict()
self.master_machine_type = master_machine_type
self.master_disk_type = master_disk_type
self.master_disk_size = master_disk_size
self.autoscaling_policy = autoscaling_policy
self.worker_machine_type = worker_machine_type
self.worker_disk_type = worker_disk_type
self.worker_disk_size = worker_disk_size
self.labels = labels
self.zone = zone
self.network_uri = network_uri
self.subnetwork_uri = subnetwork_uri
self.internal_ip_only = internal_ip_only
self.tags = tags
self.service_account = service_account
self.service_account_scopes = service_account_scopes
self.idle_delete_ttl = idle_delete_ttl
self.auto_delete_time = auto_delete_time
self.auto_delete_ttl = auto_delete_ttl
self.customer_managed_key = customer_managed_key
self.single_node = num_workers == 0
assert not (self.custom_image and self.image_version), \
"custom_image and image_version can't be both set"
assert (
not self.single_node or (
self.single_node and self.num_preemptible_workers == 0
)
), "num_workers == 0 means single node mode - no preemptibles allowed"
[docs] def _get_init_action_timeout(self):
match = re.match(r"^(\d+)(s|m)$", self.init_action_timeout)
if match:
if match.group(2) == "s":
return self.init_action_timeout
elif match.group(2) == "m":
val = float(match.group(1))
return "{}s".format(timedelta(minutes=val).seconds)
raise AirflowException(
"DataprocClusterCreateOperator init_action_timeout"
" should be expressed in minutes or seconds. i.e. 10m, 30s")
[docs] def _build_gce_cluster_config(self, cluster_data):
if self.zone:
zone_uri = \
'https://www.googleapis.com/compute/v1/projects/{}/zones/{}'.format(
self.project_id, self.zone
)
cluster_data['config']['gceClusterConfig']['zoneUri'] = zone_uri
if self.metadata:
cluster_data['config']['gceClusterConfig']['metadata'] = self.metadata
if self.network_uri:
cluster_data['config']['gceClusterConfig']['networkUri'] = self.network_uri
if self.subnetwork_uri:
cluster_data['config']['gceClusterConfig']['subnetworkUri'] = \
self.subnetwork_uri
if self.internal_ip_only:
if not self.subnetwork_uri:
raise AirflowException("Set internal_ip_only to true only when"
" you pass a subnetwork_uri.")
cluster_data['config']['gceClusterConfig']['internalIpOnly'] = True
if self.tags:
cluster_data['config']['gceClusterConfig']['tags'] = self.tags
if self.service_account:
cluster_data['config']['gceClusterConfig']['serviceAccount'] = \
self.service_account
if self.service_account_scopes:
cluster_data['config']['gceClusterConfig']['serviceAccountScopes'] = \
self.service_account_scopes
return cluster_data
[docs] def _build_lifecycle_config(self, cluster_data):
if self.idle_delete_ttl:
cluster_data['config']['lifecycleConfig']['idleDeleteTtl'] = \
"{}s".format(self.idle_delete_ttl)
if self.auto_delete_time:
utc_auto_delete_time = timezone.convert_to_utc(self.auto_delete_time)
cluster_data['config']['lifecycleConfig']['autoDeleteTime'] = \
utc_auto_delete_time.format('%Y-%m-%dT%H:%M:%S.%fZ', formatter='classic')
elif self.auto_delete_ttl:
cluster_data['config']['lifecycleConfig']['autoDeleteTtl'] = \
"{}s".format(self.auto_delete_ttl)
return cluster_data
[docs] def _build_cluster_data(self):
if self.zone:
master_type_uri = \
"https://www.googleapis.com/compute/v1/projects/{}/zones/{}/machineTypes/{}"\
.format(self.project_id, self.zone, self.master_machine_type)
worker_type_uri = \
"https://www.googleapis.com/compute/v1/projects/{}/zones/{}/machineTypes/{}"\
.format(self.project_id, self.zone, self.worker_machine_type)
else:
master_type_uri = self.master_machine_type
worker_type_uri = self.worker_machine_type
cluster_data = {
'projectId': self.project_id,
'clusterName': self.cluster_name,
'config': {
'gceClusterConfig': {
},
'masterConfig': {
'numInstances': 1,
'machineTypeUri': master_type_uri,
'diskConfig': {
'bootDiskType': self.master_disk_type,
'bootDiskSizeGb': self.master_disk_size
}
},
'workerConfig': {
'numInstances': self.num_workers,
'machineTypeUri': worker_type_uri,
'diskConfig': {
'bootDiskType': self.worker_disk_type,
'bootDiskSizeGb': self.worker_disk_size
}
},
'secondaryWorkerConfig': {},
'softwareConfig': {},
'lifecycleConfig': {},
'encryptionConfig': {},
'autoscalingConfig': {},
}
}
if self.num_preemptible_workers > 0:
cluster_data['config']['secondaryWorkerConfig'] = {
'numInstances': self.num_preemptible_workers,
'machineTypeUri': worker_type_uri,
'diskConfig': {
'bootDiskType': self.worker_disk_type,
'bootDiskSizeGb': self.worker_disk_size
},
'isPreemptible': True
}
cluster_data['labels'] = self.labels or {}
# Dataproc labels must conform to the following regex:
# [a-z]([-a-z0-9]*[a-z0-9])? (current airflow version string follows
# semantic versioning spec: x.y.z).
cluster_data['labels'].update({'airflow-version':
'v' + version.replace('.', '-').replace('+', '-')})
if self.storage_bucket:
cluster_data['config']['configBucket'] = self.storage_bucket
if self.image_version:
cluster_data['config']['softwareConfig']['imageVersion'] = self.image_version
elif self.custom_image:
custom_image_url = 'https://www.googleapis.com/compute/beta/projects/' \
'{}/global/images/{}'.format(self.project_id,
self.custom_image)
cluster_data['config']['masterConfig']['imageUri'] = custom_image_url
if not self.single_node:
cluster_data['config']['workerConfig']['imageUri'] = custom_image_url
cluster_data = self._build_gce_cluster_config(cluster_data)
if self.single_node:
self.properties["dataproc:dataproc.allow.zero.workers"] = "true"
if self.properties:
cluster_data['config']['softwareConfig']['properties'] = self.properties
cluster_data = self._build_lifecycle_config(cluster_data)
if self.init_actions_uris:
init_actions_dict = [
{
'executableFile': uri,
'executionTimeout': self._get_init_action_timeout()
} for uri in self.init_actions_uris
]
cluster_data['config']['initializationActions'] = init_actions_dict
if self.customer_managed_key:
cluster_data['config']['encryptionConfig'] =\
{'gcePdKmsKeyName': self.customer_managed_key}
if self.autoscaling_policy:
cluster_data['config']['autoscalingConfig'] = {'policyUri': self.autoscaling_policy}
return cluster_data
[docs] def start(self):
"""
Create a new cluster on Google Cloud Dataproc.
"""
self.log.info('Creating cluster: %s', self.cluster_name)
cluster_data = self._build_cluster_data()
return (
self.hook.get_conn().projects().regions().clusters().create( # pylint: disable=no-member
projectId=self.project_id,
region=self.region,
body=cluster_data,
requestId=str(uuid.uuid4()),
).execute())
[docs]class DataprocClusterScaleOperator(DataprocOperationBaseOperator):
"""
Scale, up or down, a cluster on Google Cloud Dataproc.
The operator will wait until the cluster is re-scaled.
**Example**: ::
t1 = DataprocClusterScaleOperator(
task_id='dataproc_scale',
project_id='my-project',
cluster_name='cluster-1',
num_workers=10,
num_preemptible_workers=10,
graceful_decommission_timeout='1h',
dag=dag)
.. seealso::
For more detail on about scaling clusters have a look at the reference:
https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/scaling-clusters
:param cluster_name: The name of the cluster to scale. (templated)
:type cluster_name: str
:param project_id: The ID of the google cloud project in which
the cluster runs. (templated)
:type project_id: str
:param region: The region for the dataproc cluster. (templated)
:type region: str
:param gcp_conn_id: The connection ID to use connecting to Google Cloud Platform.
:type gcp_conn_id: str
:param num_workers: The new number of workers
:type num_workers: int
:param num_preemptible_workers: The new number of preemptible workers
:type num_preemptible_workers: int
:param graceful_decommission_timeout: Timeout for graceful YARN decomissioning.
Maximum value is 1d
:type graceful_decommission_timeout: str
:param delegate_to: The account to impersonate, if any.
For this to work, the service account making the request must have domain-wide
delegation enabled.
:type delegate_to: str
"""
[docs] template_fields = ['cluster_name', 'project_id', 'region']
@apply_defaults
def __init__(self,
cluster_name,
project_id,
region='global',
num_workers=2,
num_preemptible_workers=0,
graceful_decommission_timeout=None,
*args,
**kwargs):
super(DataprocClusterScaleOperator, self).__init__(
project_id=project_id, region=region, *args, **kwargs)
self.cluster_name = cluster_name
self.num_workers = num_workers
self.num_preemptible_workers = num_preemptible_workers
# Optional
self.optional_arguments = {}
if graceful_decommission_timeout:
self.optional_arguments['gracefulDecommissionTimeout'] = \
self._get_graceful_decommission_timeout(
graceful_decommission_timeout)
[docs] def _build_scale_cluster_data(self):
scale_data = {
'config': {
'workerConfig': {
'numInstances': self.num_workers
},
'secondaryWorkerConfig': {
'numInstances': self.num_preemptible_workers
}
}
}
return scale_data
@staticmethod
[docs] def _get_graceful_decommission_timeout(timeout):
match = re.match(r"^(\d+)(s|m|h|d)$", timeout)
if match:
if match.group(2) == "s":
return timeout
elif match.group(2) == "m":
val = float(match.group(1))
return "{}s".format(timedelta(minutes=val).seconds)
elif match.group(2) == "h":
val = float(match.group(1))
return "{}s".format(timedelta(hours=val).seconds)
elif match.group(2) == "d":
val = float(match.group(1))
return "{}s".format(timedelta(days=val).seconds)
raise AirflowException(
"DataprocClusterScaleOperator "
" should be expressed in day, hours, minutes or seconds. "
" i.e. 1d, 4h, 10m, 30s")
[docs] def start(self):
"""
Scale, up or down, a cluster on Google Cloud Dataproc.
"""
self.log.info("Scaling cluster: %s", self.cluster_name)
update_mask = "config.worker_config.num_instances," \
+ "config.secondary_worker_config.num_instances"
scaling_cluster_data = self._build_scale_cluster_data()
return (
self.hook.get_conn().projects().regions().clusters().patch( # pylint: disable=no-member
projectId=self.project_id,
region=self.region,
clusterName=self.cluster_name,
updateMask=update_mask,
body=scaling_cluster_data,
requestId=str(uuid.uuid4()),
**self.optional_arguments
).execute())
[docs]class DataprocClusterDeleteOperator(DataprocOperationBaseOperator):
"""
Delete a cluster on Google Cloud Dataproc. The operator will wait until the
cluster is destroyed.
:param cluster_name: The name of the cluster to delete. (templated)
:type cluster_name: str
:param project_id: The ID of the google cloud project in which
the cluster runs. (templated)
:type project_id: str
:param region: leave as 'global', might become relevant in the future. (templated)
:type region: str
:param gcp_conn_id: The connection ID to use connecting to Google Cloud Platform.
:type gcp_conn_id: str
:param delegate_to: The account to impersonate, if any.
For this to work, the service account making the request must have domain-wide
delegation enabled.
:type delegate_to: str
"""
[docs] template_fields = ['cluster_name', 'project_id', 'region']
@apply_defaults
def __init__(self,
cluster_name,
project_id,
region='global',
*args,
**kwargs):
super(DataprocClusterDeleteOperator, self).__init__(
project_id=project_id, region=region, *args, **kwargs)
self.cluster_name = cluster_name
[docs] def start(self):
"""
Delete a cluster on Google Cloud Dataproc.
"""
self.log.info('Deleting cluster: %s in %s', self.cluster_name, self.region)
return (
self.hook.get_conn().projects().regions().clusters().delete( # pylint: disable=no-member
projectId=self.project_id,
region=self.region,
clusterName=self.cluster_name,
requestId=str(uuid.uuid4()),
).execute())
[docs]class DataProcJobBaseOperator(BaseOperator):
"""
The base class for operators that launch job on DataProc.
:param job_name: The job name used in the DataProc cluster. This name by default
is the task_id appended with the execution data, but can be templated. The
name will always be appended with a random number to avoid name clashes.
:type job_name: str
:param cluster_name: The name of the DataProc cluster.
:type cluster_name: str
:param dataproc_properties: Map for the Hive properties. Ideal to put in
default arguments (templated)
:type dataproc_properties: dict
:param dataproc_jars: HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop
MapReduce (MR) tasks. Can contain Hive SerDes and UDFs. (templated)
:type dataproc_jars: list
:param gcp_conn_id: The connection ID to use connecting to Google Cloud Platform.
:type gcp_conn_id: str
:param delegate_to: The account to impersonate, if any.
For this to work, the service account making the request must have domain-wide
delegation enabled.
:type delegate_to: str
:param labels: The labels to associate with this job. Label keys must contain 1 to 63 characters,
and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63
characters, and must conform to RFC 1035. No more than 32 labels can be associated with a job.
:type labels: dict
:param region: The specified region where the dataproc cluster is created.
:type region: str
:param job_error_states: Job states that should be considered error states.
Any states in this set will result in an error being raised and failure of the
task. Eg, if the ``CANCELLED`` state should also be considered a task failure,
pass in ``{'ERROR', 'CANCELLED'}``. Possible values are currently only
``'ERROR'`` and ``'CANCELLED'``, but could change in the future. Defaults to
``{'ERROR'}``.
:type job_error_states: set
:var dataproc_job_id: The actual "jobId" as submitted to the Dataproc API.
This is useful for identifying or linking to the job in the Google Cloud Console
Dataproc UI, as the actual "jobId" submitted to the Dataproc API is appended with
an 8 character random string.
:vartype dataproc_job_id: str
"""
@apply_defaults
def __init__(self,
job_name='{{task.task_id}}_{{ds_nodash}}',
cluster_name="cluster-1",
dataproc_properties=None,
dataproc_jars=None,
gcp_conn_id='google_cloud_default',
delegate_to=None,
labels=None,
region='global',
job_error_states=None,
*args,
**kwargs):
super(DataProcJobBaseOperator, self).__init__(*args, **kwargs)
self.gcp_conn_id = gcp_conn_id
self.delegate_to = delegate_to
self.labels = labels
self.job_name = job_name
self.cluster_name = cluster_name
self.dataproc_properties = dataproc_properties
self.dataproc_jars = dataproc_jars
self.region = region
self.job_error_states = job_error_states if job_error_states is not None else {'ERROR'}
self.hook = DataProcHook(gcp_conn_id=gcp_conn_id,
delegate_to=delegate_to)
self.job_template = None
self.job = None
self.dataproc_job_id = None
[docs] def create_job_template(self):
"""
Initialize `self.job_template` with default values
"""
self.job_template = self.hook.create_job_template(self.task_id, self.cluster_name, self.job_type,
self.dataproc_properties)
self.job_template.set_job_name(self.job_name)
self.job_template.add_jar_file_uris(self.dataproc_jars)
self.job_template.add_labels(self.labels)
[docs] def execute(self, context):
"""
Build `self.job` based on the job template, and submit it.
:raises AirflowException if no template has been initialized (see create_job_template)
"""
if self.job_template:
self.job = self.job_template.build()
self.dataproc_job_id = self.job["job"]["reference"]["jobId"]
self.hook.submit(self.hook.project_id, self.job, self.region, self.job_error_states)
else:
raise AirflowException("Create a job template before")
[docs] def on_kill(self):
"""
Callback called when the operator is killed.
Cancel any running job.
"""
if self.dataproc_job_id:
self.hook.cancel(self.hook.project_id, self.dataproc_job_id, self.region)
[docs]class DataProcPigOperator(DataProcJobBaseOperator):
"""
Start a Pig query Job on a Cloud DataProc cluster. The parameters of the operation
will be passed to the cluster.
It's a good practice to define dataproc_* parameters in the default_args of the dag
like the cluster name and UDFs.
.. code-block:: python
default_args = {
'cluster_name': 'cluster-1',
'dataproc_pig_jars': [
'gs://example/udf/jar/datafu/1.2.0/datafu.jar',
'gs://example/udf/jar/gpig/1.2/gpig.jar'
]
}
You can pass a pig script as string or file reference. Use variables to pass on
variables for the pig script to be resolved on the cluster or use the parameters to
be resolved in the script as template parameters.
**Example**: ::
t1 = DataProcPigOperator(
task_id='dataproc_pig',
query='a_pig_script.pig',
variables={'out': 'gs://example/output/{{ds}}'},
dag=dag)
.. seealso::
For more detail on about job submission have a look at the reference:
https://cloud.google.com/dataproc/reference/rest/v1/projects.regions.jobs
:param query: The query or reference to the query
file (pg or pig extension). (templated)
:type query: str
:param query_uri: The HCFS URI of the script that contains the Pig queries.
:type query_uri: str
:param variables: Map of named parameters for the query. (templated)
:type variables: dict
:param dataproc_pig_properties: Map for the Pig properties. Ideal to put in
default arguments (templated)
:type dataproc_pig_properties: dict
:param dataproc_pig_jars: HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop
MapReduce (MR) tasks. Can contain Pig UDFs. (templated)
:type dataproc_pig_jars: list
"""
[docs] template_fields = ['query', 'variables', 'job_name', 'cluster_name', 'region',
'dataproc_pig_jars', 'dataproc_jars', 'dataproc_properties',
'dataproc_pig_properties']
[docs] template_ext = ('.pg', '.pig',)
@apply_defaults
def __init__(
self,
query=None,
query_uri=None,
variables=None,
dataproc_pig_properties=None,
dataproc_pig_jars=None,
*args,
**kwargs):
super(DataProcPigOperator, self).__init__(*args,
dataproc_properties=dataproc_pig_properties,
dataproc_jars=dataproc_pig_jars,
**kwargs)
self.query = query
self.query_uri = query_uri
self.variables = variables
[docs] def execute(self, context):
self.create_job_template()
if self.query is None:
self.job_template.add_query_uri(self.query_uri)
else:
self.job_template.add_query(self.query)
self.job_template.add_variables(self.variables)
super(DataProcPigOperator, self).execute(context)
[docs]class DataProcHiveOperator(DataProcJobBaseOperator):
"""
Start a Hive query Job on a Cloud DataProc cluster.
:param query: The query or reference to the query file (q extension).
:type query: str
:param query_uri: The HCFS URI of the script that contains the Hive queries.
:type query_uri: str
:param variables: Map of named parameters for the query.
:type variables: dict
:param dataproc_hive_properties: Map for the Pig properties. Ideal to put in
default arguments (templated)
:type dataproc_hive_properties: dict
:param dataproc_hive_jars: HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop
MapReduce (MR) tasks. Can contain Hive SerDes and UDFs. (templated)
:type dataproc_hive_jars: list
"""
[docs] template_fields = ['query', 'variables', 'job_name', 'cluster_name', 'region',
'dataproc_hive_jars', 'dataproc_jars', 'dataproc_hive_properties',
'dataproc_properties']
[docs] template_ext = ('.q', '.hql',)
@apply_defaults
def __init__(
self,
query=None,
query_uri=None,
variables=None,
dataproc_hive_properties=None,
dataproc_hive_jars=None,
*args,
**kwargs):
super(DataProcHiveOperator, self).__init__(*args,
dataproc_properties=dataproc_hive_properties,
dataproc_jars=dataproc_hive_jars,
**kwargs)
self.query = query
self.query_uri = query_uri
self.variables = variables
if self.query is not None and self.query_uri is not None:
raise AirflowException('Only one of `query` and `query_uri` can be passed.')
[docs] def execute(self, context):
self.create_job_template()
if self.query is None:
self.job_template.add_query_uri(self.query_uri)
else:
self.job_template.add_query(self.query)
self.job_template.add_variables(self.variables)
super(DataProcHiveOperator, self).execute(context)
[docs]class DataProcSparkSqlOperator(DataProcJobBaseOperator):
"""
Start a Spark SQL query Job on a Cloud DataProc cluster.
:param query: The query or reference to the query file (q extension). (templated)
:type query: str
:param query_uri: The HCFS URI of the script that contains the SQL queries.
:type query_uri: str
:param variables: Map of named parameters for the query. (templated)
:type variables: dict
:param dataproc_spark_properties: Map for the Pig properties. Ideal to put in
default arguments (templated)
:type dataproc_spark_properties: dict
:param dataproc_spark_jars: HCFS URIs of jar files to be added to the Spark CLASSPATH. (templated)
:type dataproc_spark_jars: list
"""
[docs] template_fields = ['query', 'variables', 'job_name', 'cluster_name', 'region',
'dataproc_spark_jars', 'dataproc_jars', 'dataproc_spark_properties',
'dataproc_properties']
[docs] job_type = 'sparkSqlJob'
@apply_defaults
def __init__(
self,
query=None,
query_uri=None,
variables=None,
dataproc_spark_properties=None,
dataproc_spark_jars=None,
*args,
**kwargs):
super(DataProcSparkSqlOperator, self).__init__(*args,
dataproc_properties=dataproc_spark_properties,
dataproc_jars=dataproc_spark_jars,
**kwargs)
self.query = query
self.query_uri = query_uri
self.variables = variables
if self.query is not None and self.query_uri is not None:
raise AirflowException('Only one of `query` and `query_uri` can be passed.')
[docs] def execute(self, context):
self.create_job_template()
if self.query is None:
self.job_template.add_query_uri(self.query_uri)
else:
self.job_template.add_query(self.query)
self.job_template.add_variables(self.variables)
super(DataProcSparkSqlOperator, self).execute(context)
[docs]class DataProcSparkOperator(DataProcJobBaseOperator):
"""
Start a Spark Job on a Cloud DataProc cluster.
:param main_jar: The HCFS URI of the jar file that contains the main class
(use this or the main_class, not both together).
:type main_jar: str
:param main_class: Name of the job class. (use this or the main_jar, not both
together).
:type main_class: str
:param arguments: Arguments for the job. (templated)
:type arguments: list
:param archives: List of archived files that will be unpacked in the work
directory. Should be stored in Cloud Storage.
:type archives: list
:param files: List of files to be copied to the working directory
:type files: list
:param dataproc_spark_properties: Map for the Pig properties. Ideal to put in
default arguments (templated)
:type dataproc_spark_properties: dict
:param dataproc_spark_jars: HCFS URIs of files to be copied to the working directory of Spark drivers
and distributed tasks. Useful for naively parallel tasks. (templated)
:type dataproc_spark_jars: list
"""
[docs] template_fields = ['arguments', 'job_name', 'cluster_name', 'region',
'dataproc_spark_jars', 'dataproc_jars', 'dataproc_spark_properties',
'dataproc_properties']
@apply_defaults
def __init__(
self,
main_jar=None,
main_class=None,
arguments=None,
archives=None,
files=None,
dataproc_spark_properties=None,
dataproc_spark_jars=None,
*args,
**kwargs):
super(DataProcSparkOperator, self).__init__(*args,
dataproc_properties=dataproc_spark_properties,
dataproc_jars=dataproc_spark_jars,
**kwargs)
self.main_jar = main_jar
self.main_class = main_class
self.arguments = arguments
self.archives = archives
self.files = files
[docs] def execute(self, context):
self.create_job_template()
self.job_template.set_main(self.main_jar, self.main_class)
self.job_template.add_args(self.arguments)
self.job_template.add_archive_uris(self.archives)
self.job_template.add_file_uris(self.files)
super(DataProcSparkOperator, self).execute(context)
[docs]class DataProcHadoopOperator(DataProcJobBaseOperator):
"""
Start a Hadoop Job on a Cloud DataProc cluster.
:param main_jar: The HCFS URI of the jar file containing the main class
(use this or the main_class, not both together).
:type main_jar: str
:param main_class: Name of the job class. (use this or the main_jar, not both
together).
:type main_class: str
:param arguments: Arguments for the job. (templated)
:type arguments: list
:param archives: List of archived files that will be unpacked in the work
directory. Should be stored in Cloud Storage.
:type archives: list
:param files: List of files to be copied to the working directory
:type files: list
:param dataproc_hadoop_properties: Map for the Pig properties. Ideal to put in
default arguments (tempplated)
:type dataproc_hadoop_properties: dict
:param dataproc_hadoop_jars: Jar file URIs to add to the CLASSPATHs of the Hadoop driver and
tasks. (tempplated)
:type dataproc_hadoop_jars: list
"""
[docs] template_fields = ['arguments', 'job_name', 'cluster_name', 'region',
'dataproc_hadoop_jars', 'dataproc_jars', 'dataproc_hadoop_properties',
'dataproc_properties']
@apply_defaults
def __init__(
self,
main_jar=None,
main_class=None,
arguments=None,
archives=None,
files=None,
dataproc_hadoop_properties=None,
dataproc_hadoop_jars=None,
*args,
**kwargs):
super(DataProcHadoopOperator, self).__init__(*args,
dataproc_properties=dataproc_hadoop_properties,
dataproc_jars=dataproc_hadoop_jars,
**kwargs)
self.main_jar = main_jar
self.main_class = main_class
self.arguments = arguments
self.archives = archives
self.files = files
[docs] def execute(self, context):
self.create_job_template()
self.job_template.set_main(self.main_jar, self.main_class)
self.job_template.add_args(self.arguments)
self.job_template.add_archive_uris(self.archives)
self.job_template.add_file_uris(self.files)
super(DataProcHadoopOperator, self).execute(context)
[docs]class DataProcPySparkOperator(DataProcJobBaseOperator):
"""
Start a PySpark Job on a Cloud DataProc cluster.
:param main: [Required] The Hadoop Compatible Filesystem (HCFS) URI of the main
Python file to use as the driver. Must be a .py file.
:type main: str
:param arguments: Arguments for the job. (templated)
:type arguments: list
:param archives: List of archived files that will be unpacked in the work
directory. Should be stored in Cloud Storage.
:type archives: list
:param files: List of files to be copied to the working directory
:type files: list
:param pyfiles: List of Python files to pass to the PySpark framework.
Supported file types: .py, .egg, and .zip
:type pyfiles: list
:param dataproc_pyspark_properties: Map for the Pig properties. Ideal to put in
default arguments (templated)
:type dataproc_pyspark_properties: dict
:param dataproc_pyspark_jars: HCFS URIs of jar files to add to the CLASSPATHs of the Python
driver and tasks. (templated)
:type dataproc_pyspark_jars: list
"""
[docs] template_fields = ['arguments', 'job_name', 'cluster_name', 'region',
'dataproc_pyspark_jars', 'dataproc_jars', 'dataproc_pyspark_properties',
'dataproc_properties']
[docs] job_type = 'pysparkJob'
@staticmethod
[docs] def _generate_temp_filename(filename):
date = time.strftime('%Y%m%d%H%M%S')
return "{}_{}_{}".format(date, str(uuid.uuid4())[:8], ntpath.basename(filename))
[docs] def _upload_file_temp(self, bucket, local_file):
"""
Upload a local file to a Google Cloud Storage bucket.
"""
temp_filename = self._generate_temp_filename(local_file)
if not bucket:
raise AirflowException(
"If you want Airflow to upload the local file to a temporary bucket, set "
"the 'temp_bucket' key in the connection string")
self.log.info("Uploading %s to %s", local_file, temp_filename)
GoogleCloudStorageHook(
google_cloud_storage_conn_id=self.gcp_conn_id
).upload(
bucket_name=bucket,
object_name=temp_filename,
mime_type='application/x-python',
filename=local_file
)
return "gs://{}/{}".format(bucket, temp_filename)
@apply_defaults
def __init__(
self,
main,
arguments=None,
archives=None,
pyfiles=None,
files=None,
dataproc_pyspark_properties=None,
dataproc_pyspark_jars=None,
*args,
**kwargs):
super(DataProcPySparkOperator, self).__init__(*args,
dataproc_properties=dataproc_pyspark_properties,
dataproc_jars=dataproc_pyspark_jars,
**kwargs)
self.main = main
self.arguments = arguments
self.archives = archives
self.files = files
self.pyfiles = pyfiles
[docs] def execute(self, context):
self.create_job_template()
# Check if the file is local, if that is the case, upload it to a bucket
if os.path.isfile(self.main):
cluster_info = self.hook.get_cluster(
project_id=self.hook.project_id,
region=self.region,
cluster_name=self.cluster_name
)
bucket = cluster_info['config']['configBucket']
self.main = self._upload_file_temp(bucket, self.main)
self.job_template.set_python_main(self.main)
self.job_template.add_args(self.arguments)
self.job_template.add_archive_uris(self.archives)
self.job_template.add_file_uris(self.files)
self.job_template.add_python_file_uris(self.pyfiles)
super(DataProcPySparkOperator, self).execute(context)
[docs]class DataprocWorkflowTemplateInstantiateOperator(DataprocOperationBaseOperator):
"""
Instantiate a WorkflowTemplate on Google Cloud Dataproc. The operator will wait
until the WorkflowTemplate is finished executing.
.. seealso::
Please refer to:
https://cloud.google.com/dataproc/docs/reference/rest/v1beta2/projects.regions.workflowTemplates/instantiate
:param template_id: The id of the template. (templated)
:type template_id: str
:param project_id: The ID of the google cloud project in which
the template runs
:type project_id: str
:param region: leave as 'global', might become relevant in the future
:type region: str
:param gcp_conn_id: The connection ID to use connecting to Google Cloud Platform.
:type gcp_conn_id: str
:param delegate_to: The account to impersonate, if any.
For this to work, the service account making the request must have domain-wide
delegation enabled.
:type delegate_to: str
"""
[docs] template_fields = ['template_id']
@apply_defaults
def __init__(self, template_id, *args, **kwargs):
(super(DataprocWorkflowTemplateInstantiateOperator, self)
.__init__(*args, **kwargs))
self.template_id = template_id
[docs] def start(self):
"""
Instantiate a WorkflowTemplate on Google Cloud Dataproc.
"""
self.log.info('Instantiating Template: %s', self.template_id)
return (
self.hook.get_conn().projects().regions().workflowTemplates() # pylint: disable=no-member
.instantiate(
name=('projects/%s/regions/%s/workflowTemplates/%s' %
(self.project_id, self.region, self.template_id)),
body={'requestId': str(uuid.uuid4())})
.execute())
[docs]class DataprocWorkflowTemplateInstantiateInlineOperator(
DataprocOperationBaseOperator):
"""
Instantiate a WorkflowTemplate Inline on Google Cloud Dataproc. The operator will
wait until the WorkflowTemplate is finished executing.
.. seealso::
Please refer to:
https://cloud.google.com/dataproc/docs/reference/rest/v1beta2/projects.regions.workflowTemplates/instantiateInline
:param template: The template contents. (templated)
:type template: map
:param project_id: The ID of the google cloud project in which
the template runs
:type project_id: str
:param region: leave as 'global', might become relevant in the future
:type region: str
:param gcp_conn_id: The connection ID to use connecting to Google Cloud Platform.
:type gcp_conn_id: str
:param delegate_to: The account to impersonate, if any.
For this to work, the service account making the request must have domain-wide
delegation enabled.
:type delegate_to: str
"""
[docs] template_fields = ['template']
@apply_defaults
def __init__(self, template, *args, **kwargs):
(super(DataprocWorkflowTemplateInstantiateInlineOperator, self)
.__init__(*args, **kwargs))
self.template = template
[docs] def start(self):
"""
Instantiate a WorkflowTemplate Inline on Google Cloud Dataproc.
"""
self.log.info('Instantiating Inline Template')
return (
self.hook.get_conn().projects().regions().workflowTemplates() # pylint: disable=no-member
.instantiateInline(
parent='projects/%s/regions/%s' % (self.project_id, self.region),
requestId=str(uuid.uuid4()),
body=self.template)
.execute())