Repository navigation
Google CloudRun job operator #24730
Description
Activity
feel free to submit PR
Oh yeah, I would like to have this operator. I am using Cloud Run Jobs to execute light data processing and scripting. It would be really nice to have a dedicated operator to trigger this flow in Cloud Composer (apart from the bash operator).
Reacted by Patrick Beekman, Victor (Hunting) Shytiuk and Jessie DaubnerOh yeah, I would like to have this operator. I am using Cloud Run Jobs to execute light data processing and scripting. It would be really nice to have a dedicated operator to trigger this flow in Cloud Composer (apart from the bash operator).
Why not contribute it then ?
Oh yeah, I would like to have this operator. I am using Cloud Run Jobs to execute light data processing and scripting. It would be really nice to have a dedicated operator to trigger this flow in Cloud Composer (apart from the bash operator).
Why not contribute it then ?
I would love to. But I do not have a single idea on how to do it. Is there an established process to work on it?
Includes:
- intro
- step-by-step-guide how to approach contribution
- links to <10 minutes setup of development environment
- quick contribution guides which provide quick-and-dirty way how to start with screenshots depending on which IDE you use (PyCharm/VCcode or even gitpod or codespaces if you feel like developing in remote env) if you just want to "do" without reading too much of "why and how".
I think that is a good starting point - and you can choose the learning path that is best for you
I think, I also can contribute on this, if required
Possible solution with this PR
Brief Thoughts/Notes
I've done a little bit of work on this and here are some notes.
A PR for this feature should include operators for both:
- Cloud Run services: Used to run code that responds to web requests, or events.
- Cloud Run jobs: Used to run code that performs work (a job) and quits when the work is done.
It looks like #27638 only include the services operator. This would be a good start but it looks like it also uses transport instead of the official client. Other GCP operators (e.g. tasks and others) use the official clients so it would be best to go the same route with this one.
In my mind the biggest benefit comes from the jobs operators since that would allow users who do not want to deal with/manage K8s to use Cloud Run Jobs with arbitrary containers.
The Google team is great and recently released support for jobs in the official Cloud Run Python client (see googleapis/python-run#65) but it won't be available until v0.5.0 with no ETA. It also currently won't build with
apache-airflow-providers-googlebecause of incompatible protobuf support (see googleapis/python-run#70).I created my own plugin for this if anyone is interested in using Cloud Run Jobs (currently does not support services) before these issues are resolved and I plan to use the official client once that is ready.
https://github.com/mharrisb1/airflow-google-cloud-run-plugin
Please note that this plugin will only be supported until this is available in Airflow.
Requirements Proposal
Cloud Run Services and Jobs would be great additions to GCP resources in Airflow. I think a PR to add these features should cover the following:
-
CloudRunHook- manage w/ create, read, update, delete, list resources including services, revisions, jobs, executions, and tasks (see https://github.com/googleapis/python-run/tree/main/google/cloud/run_v2/services) - Custom links for resources (I'm still fuzzy around what should be needed here). See other GCP resource custom link examples https://github.com/apache/airflow/tree/main/airflow/providers/google/cloud/links.
- CRUD-based operators for all resource types (see task operators as an example https://github.com/apache/airflow/blob/main/airflow/providers/google/cloud/operators/tasks.py).
- Sensors 🤷 (again, fuzzy on this one).
Some additional thoughts:
- There seems to be a pretty low quota for sequential requests so any ping mechanism should try to respect this otherwise tasks will fail often.
- For Cloud Run jobs operators specifically, it would be nice if instead of only having CRUD-based operators, the main job run operator could also have an option to "create if not exists" and "deleted on exit" to avoid extra tasks. This is simply a personal preference (I added it to my plugin see example).
Would love to contribute and collaborate with anyone on this. I do think we're blocked on progress until v0.5.0 of the official client is released w/ support for compatible protofbuf lib but we can definitely go ahead and start progressing on this in preparation for those to be released in the near future (also go comment/like this issue to increase awareness to Google team googleapis/python-run#70).
Reacted by Mukund Reddy T and Vincent LegendreHi guys,
I'm sorry for not responding for a while. (I'm in Ukraine, so I think you understand why).
The question is - is it still actual? If yes, I can contribute. But I can't promise it will be too fast.Hey guys, just found out about this issue !
@mharrisb1 happy to collaborate with you on this one.
I think we should be be able to merge the CRUD operations you introduced in your plugin with the changes I proposed in this PR : #28525.What I had in mind was to design the execution of an existing job in the same way as
DataflowStartFlexTemplateOperatordoes with flex templates.Would you have any thoughts on this ?
After a closer look a this plugin, here are some thoughts :
CloudRunHookshould extendGoogleBaseHookto ease authentication and GCP configuration- As gcloud CLI propose the
--execute-nowflag when creating jobs, I think the following logic/naming convention may be more straightforward :- Have a
CloudRunCreateJobOperatorwithexecute_now,update_if_existsanddelete_on_exitcapabilities, to allow job definition, run and deletion from Airflow - Have a separate
CloudRunExecuteJobOperator, allowing one to execute a pre-created job in a GCP project
- Have a
CloudRunListJobsandCloudRunDeleteJoboperators to complete CRUD capabilities for jobs, as introduced in the plugin documentation- Regarding executions, is the DELETE operation mandatory to support ? I may miss some use cases here
Happy to have this issue assigned if necessary @v-hunt , as I think this would be a game changer for many GCP users!
I guess the required development would be mostly based on @mharrisb1 's really good plugin (congrats btw 👏 )Reacted by d-axel-b and Lars Haugseth@VinceLegendre all great thoughts.
I think most of my plugin is obsolete once someone can get https://github.com/googleapis/python-run to build correctly with the rest of the Google Cloud providers code https://pypi.org/project/apache-airflow-providers-google/. The only issue is resolving protobuf versions between the 2 (see googleapis/python-run#70). The Google team will not solve this on their side so someone will need to solve it in the Google providers code.
The official python-run library is definitely preferred over my custom client. Then yes, taking the same approach as other Google Cloud providers would be the goal. And exactly as you pointed out: extend
GoogleBaseHookfor auth, etc.Once the protobuf issue is resolved then it should be an easy path to just implement operators for all CRUD and execution options. I think sensors, custom links, etc. are nice to have but could potentially be introduced in subsequent versions if someone doesn't want to implement it all at once. I would though consider all the CRUD operators as part of the completion requirements since that allows full control over the resource lifecycle.
@mharrisb1 Is the build issue you mention specific to cloud-run v2 API ?
As v2 does not seem to support jobs & executions CRUD for the moment, maybe we can stick to v1 for the time being ?If so, v1 API seems to build correctly with the rest of google cloud providers, at least locally.
CloudRunJobHook.get_connworked well in breeze with this piece of code : https://github.com/VinceLegendre/airflow/blob/add_google_cloud_run_execute_job_operator/airflow/providers/google/cloud/hooks/cloud_run.py#L166When will the official CloudRun Job operator be ready to use in production? Is there an alternative for this?
- The alternative is to use a BashOperator with the gcloud command. El El vie, 3 de feb. de 2023 a la(s) 09:41, Mohith G < ***@***.***> escribió:When will the official CloudRun Job operator be ready to use in production? Is there an alternative for this? — Reply to this email directly, view it on GitHub <#24730 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AZEPOZUYLVM3M2DJOBK7CXLWVT4GHANCNFSM52FAD4XQ> . You are receiving this because you commented.Message ID: ***@***.***>-- *Juan MantegazzaLead Data Engineer* *E: ***@***.*** ***@***.***>W: www.zubale.com <http://www.zubale.com/>*
It also currently won't build with apache-airflow-providers-google because of incompatible protobuf support (see googleapis/python-run#70).
The only issue is resolving protobuf versions between the 2 (see googleapis/python-run#70). The Google team will not solve this on their side so someone will need to solve it in the Google providers code.
Edit
#29644 has been merged which should solve the protobuf==3.2.0 issue.Reacted by Michael HarrisGlad this sparks a lot of interest.
One thought once the operators have migrated to the official SDK is to consider a new
CloudRunExecutoras an alternative to k8s - in a different github thread.It could combine with parallelism: inject arbitrary py code + number of tasks to run concurrently, with default of one (=current executor behavior).
I have a few use cases where 100+ similar tasks run in parallel and I don't need/want each to be defined as an airflow task (would kill the UI, among others).
Reacted by Michael HarrisCloud run jobs can now last up to 24 hours, making this viable for the vast majority of tasks.
Description
Like AWS ECS, In Google Cloud Service has Cloud Run Job beta. So does anyone need to use this feature from GCS?
Use case/motivation
No response
Related issues
No response
Are you willing to submit a PR?
Code of Conduct