Skip to content
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

[Docs] Add Slurm agent setup #6231

Merged
merged 9 commits into from
Feb 22, 2025

Conversation

JiangJiaWei1103
Copy link
Contributor

@JiangJiaWei1103 JiangJiaWei1103 commented Feb 8, 2025

Tracking issue

Issue: #3936

Related to flyteorg/flytekit#3005

Why are the changes needed?

Provide users with a step-by-step guide to setting up the Slurm agent from scratch.

What changes were proposed in this pull request?

Add documentation on setting up the Slurm agent for both local testing and deployment. The documentation includes following sections:

  1. Spin up a Slurm cluster
  2. Test your Slurm agent locally

How was this patch tested?

Labels

  • added: For new features.

Setup process

Screenshots

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Related PRs

flyteorg/flytekit#3005

Docs link

https://flyte--6231.org.readthedocs.build/en/6231/deployment/agents/slurm.html

Summary by Bito

Documentation enhancement PR focused on Slurm agent setup and configuration in Flyte. Provides detailed instructions for cluster setup, SSH configuration, AWS S3 integration, and deployment scenarios. Includes both local testing and production deployment guidelines. Minor updates to Databricks agent documentation included.

Unit tests added: False

Estimated effort to review (1-5, lower is better): 2

Signed-off-by: JiangJiaWei1103 <[email protected]>
@flyte-bot
Copy link
Collaborator

Code Review Agent Run Status

  • Limitations and other issues: ❌ Failure - The AI Code Review Agent skipped reviewing this change because it is configured to exclude certain pull requests based on the source/target branch or the pull request status. You can change the settings here, or contact the agent instance creator at [email protected].

Copy link

codecov bot commented Feb 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.88%. Comparing base (34205dd) to head (8ebc3b8).
Report is 18 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #6231      +/-   ##
==========================================
+ Coverage   36.87%   36.88%   +0.01%     
==========================================
  Files        1318     1318              
  Lines      134647   134829     +182     
==========================================
+ Hits        49647    49728      +81     
- Misses      80679    80767      +88     
- Partials     4321     4334      +13     
Flag Coverage Δ
unittests-datacatalog 51.58% <ø> (ø)
unittests-flyteadmin 51.87% <ø> (-0.09%) ⬇️
unittests-flytecopilot 30.99% <ø> (ø)
unittests-flytectl 62.29% <ø> (ø)
unittests-flyteidl 7.22% <ø> (-0.01%) ⬇️
unittests-flyteplugins 53.98% <ø> (-0.04%) ⬇️
unittests-flytepropeller 42.86% <ø> (+0.07%) ⬆️
unittests-flytestdlib 55.33% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

Signed-off-by: JiangJiaWei1103 <[email protected]>
@flyte-bot
Copy link
Collaborator

Code Review Agent Run Status

  • Limitations and other issues: ❌ Failure - The AI Code Review Agent skipped reviewing this change because it is configured to exclude certain pull requests based on the source/target branch or the pull request status. You can change the settings here, or contact the agent instance creator at [email protected].

@flyte-bot
Copy link
Collaborator

Code Review Agent Run Status

  • Limitations and other issues: ❌ Failure - The AI Code Review Agent skipped reviewing this change because it is configured to exclude certain pull requests based on the source/target branch or the pull request status. You can change the settings here, or contact the agent instance creator at [email protected].

@flyte-bot
Copy link
Collaborator

Code Review Agent Run Status

  • Limitations and other issues: ❌ Failure - The AI Code Review Agent skipped reviewing this change because it is configured to exclude certain pull requests based on the source/target branch or the pull request status. You can change the settings here, or contact the agent instance creator at [email protected].

@flyte-bot
Copy link
Collaborator

Code Review Agent Run Status

  • Limitations and other issues: ❌ Failure - The AI Code Review Agent skipped reviewing this change because it is configured to exclude certain pull requests based on the source/target branch or the pull request status. You can change the settings here, or contact the agent instance creator at [email protected].

Signed-off-by: Future-Outlier <[email protected]>
@Future-Outlier Future-Outlier changed the title [WIP] Add Slurm agent setup [flyteagent] Add Slurm agent setup Feb 22, 2025
@Future-Outlier Future-Outlier marked this pull request as ready for review February 22, 2025 04:38
Signed-off-by: Future-Outlier <[email protected]>
@Future-Outlier Future-Outlier changed the title [flyteagent] Add Slurm agent setup [Docs] Add Slurm agent setup Feb 22, 2025
Signed-off-by: Future-Outlier <[email protected]>
@flyte-bot
Copy link
Collaborator

flyte-bot commented Feb 22, 2025

Code Review Agent Run #9a6330

Actionable Suggestions - 0
Review Details
  • Files reviewed - 2 · Commit Range: 7c35da6..8ebc3b8
    • docs/deployment/agents/databricks.rst
    • docs/deployment/agents/slurm.rst
  • Files skipped - 1
    • docs/deployment/agents/index.md - Reason: Filter setting
  • Tools
    • Golangci-lint (Linter) - ✖︎ Failed
    • Whispers (Secret Scanner) - ✔︎ Successful
    • Detect-secrets (Secret Scanner) - ✔︎ Successful

AI Code Review powered by Bito Logo

@flyte-bot
Copy link
Collaborator

Changelist by Bito

This pull request implements the following key changes.

Key Change Files Impacted
Documentation - Add Slurm Agent Setup Documentation

databricks.rst - Update emphasis line numbers in documentation

slurm.rst - Add comprehensive guide for setting up and configuring Slurm agent

@Future-Outlier Future-Outlier enabled auto-merge (squash) February 22, 2025 05:43
@Future-Outlier Future-Outlier merged commit 8fc3b5b into flyteorg:master Feb 22, 2025
50 of 51 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants