Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Running Job On Airflow Based On Webrequest

Tags:

python

airflow

I wanted to know if airflow tasks can be executed upon getting a request over HTTP. I am not interested in the scheduling part of Airflow. I just want to use it as a substitute for Celery.

So an example operation would be something like this.

  1. User submits a form requesting for some report.
  2. Backend receives the request and sends the user a notification that the request has been received.
  3. The backend then schedules a job using Airflow to run immediately.
  4. Airflow then executes a series of tasks associated with a DAG. For example, pull data from redshift first, pull data from MySQL, make some operations on the two result sets, combine them and then upload the results to Amazon S3, send an email.

From whatever I read online, you can run airflow jobs by executing airflow ... on the command line. I was wondering if there is a python api which can execute the same thing.

Thanks.

like image 643
Pravin Umamaheswaran Avatar asked Feb 22 '17 22:02

Pravin Umamaheswaran


People also ask

How do I call REST API from Airflow?

The first step to calling the Airflow REST API on Astronomer is to create a Deployment-level Service Account, which will assume a user role and set of permissions and output an API key that you can use to authenticate with your request. You can use the Software UI or the Astro CLI to create a Service account.

Does Airflow use crontab?

Airflow can utilize cron presets for common, basic schedules. For example, schedule_interval='@hourly' will schedule the DAG to run at the beginning of every hour. For the full list of presets, check out the Airflow documentation.


2 Answers

The Airflow REST API Plugin would help you out here. Once you have followed the instructions for installing the plugin you would just need to hit the following url: http://{HOST}:{PORT}/admin/rest_api/api/v1.0/trigger_dag?dag_id={dag_id}&run_id={run_id}&conf={url_encoded_json_parameters}, replacing dag_id with the id of your dag, either omitting run_id or specify a unique id, and passing a url encoded json for conf (with any of the parameters you need in the triggered dag).

Here is an example JavaScript function that uses jQuery to call the Airflow api:

function triggerDag(dagId, dagParameters){     var urlEncodedParameters = encodeURIComponent(dagParameters);     var dagRunUrl = "http://airflow:8080/admin/rest_api/api/v1.0/trigger_dag?dag_id="+dagId+"&conf="+urlEncodedParameters;     $.ajax({         url: dagRunUrl,         dataType: "json",         success: function(msg) {             console.log('Successfully started the dag');         },         error: function(e){            console.log('Failed to start the dag');         }     }); } 
like image 83
Jeremy Farrell Avatar answered Oct 13 '22 01:10

Jeremy Farrell


A new option in airflow is the experimental, but built-in, API endpoint in the more recent builds of 1.7 and 1.8. This allows you to run a REST service on your airflow server to listen to a port and accept cli jobs.

I only have limited experience myself, but I have run test dags with success. Per the docs:

/api/experimental/dags/<DAG_ID>/dag_runs creates a dag_run for a given dag id (POST).

That will schedule an immediate run of whatever dag you want to run. It does still use the scheduler, though, waiting for a heartbeat to see that dag is running and pass tasks to the worker. This is exactly the same behavior as the CLI, though, so I still believe it fits your use-case.

Documentation on how to configure it is available here: https://airflow.apache.org/api.html

There are some simple example clients in the github, too, under airflow/api/clients

like image 24
apathyman Avatar answered Oct 13 '22 00:10

apathyman