Skip to content

Add astro cli project + kind Raycluster setup instruction#83

Merged
pankajastro merged 11 commits into
mainfrom
setup
Oct 30, 2024
Merged

Add astro cli project + kind Raycluster setup instruction#83
pankajastro merged 11 commits into
mainfrom
setup

Conversation

@pankajastro
Copy link
Copy Markdown
Contributor

@pankajastro pankajastro commented Oct 25, 2024

This PR introduces several enhancements aimed at improving the setup and local testing

  • Documentation for RayCluster Setup: Added comprehensive instruction documents to facilitate the setup of RayCluster using Kind.
  • Example Connection for Local Kind RayCluster: Included an example configuration to demonstrate how to connect to a local RayCluster deployed with Kind.
  • Introduce Astro-CLI: Introduced the astro-cli Airflow project, allowing users to easily spin up Airflow and execute example DAGs from this repository.
  • Makefile: Added a Makefile that wraps astro-cli and pip commands, simplifying the process for testing local changes.

Docs generated HTML
Screenshot 2024-10-26 at 1 03 09 AM

Created follow-up tickets: #89 and #88

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Oct 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.22%. Comparing base (4a362a2) to head (85a5357).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #83   +/-   ##
=======================================
  Coverage   98.22%   98.22%           
=======================================
  Files           5        5           
  Lines         564      564           
=======================================
  Hits          554      554           
  Misses         10       10           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Copy Markdown
Collaborator

@pankajkoti pankajkoti left a comment

Choose a reason for hiding this comment

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

Great work on having this guide in place. Have some minor suggestions/questions inline.

Should we also log a follow-up ticket for guiding on how to deploy to Astro deployment & how to create an Airflow connection there with mounting/using the needed Kubeconfig file?

Comment thread dev/Dockerfile
Comment thread dev/README.md Outdated
Comment thread dev/README.md Outdated
Comment thread docs/getting_started/kind_ray.rst Outdated
Comment thread docs/getting_started/kind_ray.rst Outdated
Comment thread docs/getting_started/kind_ray.rst
Comment thread docs/getting_started/kind_ray.rst Outdated
Comment thread docs/getting_started/kind_ray.rst
Comment thread docs/getting_started/setup.rst Outdated
@pankajastro
Copy link
Copy Markdown
Contributor Author

Should we also log a follow-up ticket for guiding on how to deploy to Astro deployment & how to create an Airflow connection there with mounting/using the needed Kubeconfig file?

Created #89 to improve contributing guide and #88 for Astro deployment guide

pankajkoti
pankajkoti previously approved these changes Oct 30, 2024
Copy link
Copy Markdown
Collaborator

@pankajkoti pankajkoti left a comment

Choose a reason for hiding this comment

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

LGTM. Tested the make docker-run command & was able to successfully spin up & run a DAG.
One question for the Dockerfile and some minor nits inline.

Comment thread dev/Dockerfile
Comment thread docs/getting_started/code_samples.rst Outdated
Comment thread docs/getting_started/code_samples.rst Outdated
Comment thread docs/getting_started/code_samples.rst Outdated
Comment thread docs/getting_started/code_samples.rst Outdated
Comment thread docs/getting_started/code_samples.rst Outdated
Comment thread docs/getting_started/local_development_setup.rst
@pankajastro pankajastro merged commit cf599b8 into main Oct 30, 2024
@pankajastro pankajastro deleted the setup branch October 30, 2024 08:47
@tatiana tatiana added this to the Astro Ray Provider 0.3.0 milestone Nov 29, 2024
@tatiana tatiana mentioned this pull request Nov 29, 2024
tatiana added a commit that referenced this pull request Nov 29, 2024
**Breaking changes**

* Removal of ``SubmitRayJob.terminal_states``. The same values are now available at ``ray_provider.constants.TERMINAL_JOB_STATUSES``.
* Simplify the project structure and debugging by @tatiana in #93

In order to improve the development and troubleshooting DAGs created with this provider, we introduced breaking changes
to the folder structure. It was flattened and the import paths to existing decorators, hooks, operators and trigger
changed, as documented in the table below:
  | Type      | Previous import path                        | Current import path                     |
  |-----------|---------------------------------------------|-----------------------------------------|
  | Decorator | ray_provider.decorators.ray.ray             | ray_provider.decorators.ray             |
  | Hook      | ray_provider.hooks.ray.RayHook              | ray_provider.hooks.RayHook              |
  | Operator  | ray_provider.operators.ray.DeleteRayCluster | ray_provider.operators.DeleteRayCluster |
  | Operator  | ray_provider.operators.ray.SetupRayCluster  | ray_provider.operators.SetupRayCluster  |
  | Operator  | ray_provider.operators.ray.SubmitRayJob     | ray_provider.operators.SubmitRayJob     |
  | Trigger   | ray_provider.triggers.ray.RayJobTrigger     | ray_provider.triggers.RayJobTrigger     |


**Features**

* Support using callable ``config`` in ``@ray.task`` by @tatiana in #103
* Support running Ray jobs indefinitely without timing out by @venkatajagannath and @tatiana in #74

**Bug fixes**

* Fix integration test and bug in load balancer wait logic by @pankajastro in #85
* Bugfix: Better exception handling and cluster clean up by @venkatajagannath in #68
* Stop catching generic ``Exception`` in operators by @tatiana in #100
* Stop catching generic ``Exception`` in trigger by @tatiana in #99

**Docs**

* Add docs to deploy project on Astro Cloud by @pankajastro in #90
* Fix dead reference in docs index page by @pankajastro in #87
* Cloud Auth documentation update by @venkatajagannath in #58
* Improve main docs page by @TJaniF in #71

**Others**

Local development

* Fix the local development environment and update documentation by @tatiana in #92
* Enable secret detection precommit check by @pankajastro in #91
* Add astro cli project + kind Raycluster setup instruction by @pankajastro in #83
* Remove pytest durations from tests by @tatiana in #102
* Fix running make docker-run when there is a new version by @tatiana in #99 and #101
* Improve Astro CLI DAGs test so running hatch test-cov locally doesn't fail by @tatiana in #97

CI

* CI improvement by @venkatajagannath in #73
* CI fix related to broken coverage upload artifact by @pankajkoti in #60
* Allow tests to run for PRs from forked repos by @venkatajagannath in #72
* Update CODEOWNERS by @tatiana in #84
* Add Airflow 2.10 (released in August 2024) to tests by @tatiana in #96
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants