Skip to content

Add Trino Scheduler as add on #799

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

karranikhilreddy99
Copy link

Summary

This PR adds new documentation under overview/:

Starburst Scheduler Guidestarburst-scheduler.md


Starburst Scheduler Guide

Introduction to Starburst Scheduler — an open-source Python package to automate Starburst queries:

  • Run and schedule queries via CLI
  • Integrate with Slack / Mattermost
  • Monitor cluster health and automate reporting
  • Lightweight alternative to heavy orchestration tools

👉 GitHub: https://github.com/karranikhilreddy99/starburst_scheduler


I have signed the Individual CLA.
Looking forward to feedback — thank you!

Best regards,
Nikhil Reddy Karra

Copy link

cla-bot bot commented Jun 12, 2025

Thank you for your pull request and welcome to the Trino community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. Continue to work with us on the review and improvements in this PR, and submit the signed CLA to cla@trino.io. Photos, scans, or digitally-signed PDF files are all suitable. Processing may take a few days. The CLA needs to be on file before we merge your changes. For more information, see https://github.com/trinodb/cla

@karranikhilreddy99
Copy link
Author

@karranikhilreddy99
Copy link
Author

karranikhilreddy99 commented Jun 12, 2025

Hi I have moved the Starburst Scheduler Guide here, as suggested in https://github.com/trinodb

All checks are passing — looking forward to your feedback!

Additionally, for your reference, I have developed a Python package (starburst-scheduler) that automates query scheduling and alerting for Starburst. We are actively using this in our project.

Python PyPI: (https://pypi.org/project/starburst-scheduler)

Blog post: https://medium.com/@knikhilreddy99/automate-starburst-io-queries-with-ease-meet-starburst-scheduler-542467ee7539

Please advise on the best way to share this more broadly with the community.

Thank you again!

Fix YAML error and improve formatting.
Copy link

cla-bot bot commented Jun 12, 2025

Thank you for your pull request and welcome to the Trino community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. Continue to work with us on the review and improvements in this PR, and submit the signed CLA to cla@trino.io. Photos, scans, or digitally-signed PDF files are all suitable. Processing may take a few days. The CLA needs to be on file before we merge your changes. For more information, see https://github.com/trinodb/cla

@mosabua
Copy link
Member

mosabua commented Jun 13, 2025

The CLA needs to be emailed and then processed by @martint

In terms of the actual content of this PR .. we do not host actual documentation for project.. you will have to put that with the code of the scheduler. You can add a section to the scheduled to the add-ons page by adding a section into _data/tools.yml file .. it is alphabetically sorted and I can help with a review.

Also in terms of naming the project .. I assume you have to get approval from Starburst to actually use that name .. from a trino project perspective you should talk about how it works with Trino itself.. and if it works with other distributions of Trino thats fine and you can mention that but Trino should be first.

Copy link

cla-bot bot commented Jun 13, 2025

Thank you for your pull request and welcome to the Trino community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. Continue to work with us on the review and improvements in this PR, and submit the signed CLA to cla@trino.io. Photos, scans, or digitally-signed PDF files are all suitable. Processing may take a few days. The CLA needs to be on file before we merge your changes. For more information, see https://github.com/trinodb/cla

Copy link
Author

@karranikhilreddy99 karranikhilreddy99 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @mosabua ,

I have resolved and updated the PR:

✅ Full documentation is now only in my GitHub repo.
✅ PR only contains the tools.yml entry (addons section), with owner: community as discussed.
✅ I have removed the standalone doc as requested.

Thank you again for your guidance — looking forward to your review!

Copy link
Member

@mosabua mosabua left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You might want to add a logo as well. I dont know what happens without. Also make sure to verify the render locally or the deploy preview here.

_data/tools.yml Outdated
@@ -1958,6 +1958,12 @@
url: https://www.youtube.com/watch?v=2qwBcKmQSn0
- urltext: Announcement blog post
url: /blog/2023/09/28/trino-gateway
- name: Trino Scheduler (Starburst-compatible)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- name: Trino Scheduler (Starburst-compatible)
- name: Trino Scheduler

move the Starburst compatible into the description or the docs.

_data/tools.yml Outdated
- name: Trino Scheduler (Starburst-compatible)
category: addons
owner: community
description: Python CLI tool to automate and schedule Trino queries. Works with Trino OSS, Starburst Enterprise, and Starburst Galaxy. Supports multi-cluster usage and Mattermost alert integration.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: Python CLI tool to automate and schedule Trino queries. Works with Trino OSS, Starburst Enterprise, and Starburst Galaxy. Supports multi-cluster usage and Mattermost alert integration.
description: The Trino Scheduler is a Python command line tool to automate and schedule Trino queries. Works with Trino, Starburst Enterprise, and Starburst Galaxy. Supports multi-cluster usage and Mattermost alert integration.

Also fix wrapping to 80 columns with

_data/tools.yml Outdated
category: addons
owner: community
description: Python CLI tool to automate and schedule Trino queries. Works with Trino OSS, Starburst Enterprise, and Starburst Galaxy. Supports multi-cluster usage and Mattermost alert integration.
link: https://github.com/karranikhilreddy99/starburst_scheduler
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fix to correct data format with urltext and url as in the other section otherwise it wont render

Copy link

cla-bot bot commented Jun 13, 2025

Thank you for your pull request and welcome to the Trino community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. Continue to work with us on the review and improvements in this PR, and submit the signed CLA to cla@trino.io. Photos, scans, or digitally-signed PDF files are all suitable. Processing may take a few days. The CLA needs to be on file before we merge your changes. For more information, see https://github.com/trinodb/cla

@karranikhilreddy99
Copy link
Author

Hi Mosabua,

I have updated the tools.yml entry per your feedback:

  • Moved Starburst mention to description
  • Wrapped description to 80 columns
  • Updated links block
  • Added logo

Please let me know if any further adjustments are needed — thanks again for the review!

Starburst Galaxy. Supports multi-cluster usage and Mattermost alert
integration.
links:
- urltext: GitHub Repository
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- urltext: GitHub Repository
- urltext: GitHub repository

@mosabua
Copy link
Member

mosabua commented Jun 20, 2025

@martint can you please process the CLA?

@mosabua mosabua changed the title Add Starburst Scheduler Guide Add Trino Scheduler as add on Jun 20, 2025
@mosabua
Copy link
Member

mosabua commented Jun 20, 2025

I am not sure if the logo design is ok with the TSF guidelines .. its a bit too similar to the official logo in my opinion. Thoughts @martint @dain @electrum ?

@mosabua
Copy link
Member

mosabua commented Jun 23, 2025

TSF feedback.. please update the image to be more unique and not be a derivative of the Trino logo that damages the overall branding consistency. You could even give it a unique name and just refer to Trino and whatever engine it works for in the description.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants