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

[RayService][Doc] RayService troubleshooting handbook #1221

Merged
merged 11 commits into from
Jul 7, 2023

Conversation

kevin85421
Copy link
Member

@kevin85421 kevin85421 commented Jul 6, 2023

Why are these changes needed?

Related issue number

Closes #610

Checks

  • I've made sure the tests are passing.
  • Testing Strategy
    • Unit tests
    • Manual tests
    • This PR is not tested :(

@kevin85421 kevin85421 marked this pull request as ready for review July 6, 2023 19:59
docs/guidance/rayservice-troubleshooting.md Outdated Show resolved Hide resolved
docs/guidance/rayservice-troubleshooting.md Outdated Show resolved Hide resolved
docs/guidance/rayservice-troubleshooting.md Outdated Show resolved Hide resolved
docs/guidance/rayservice-troubleshooting.md Show resolved Hide resolved
docs/guidance/rayservice-troubleshooting.md Show resolved Hide resolved
docs/guidance/rayservice-troubleshooting.md Outdated Show resolved Hide resolved
docs/guidance/rayservice-troubleshooting.md Outdated Show resolved Hide resolved
docs/guidance/rayservice-troubleshooting.md Outdated Show resolved Hide resolved
Comment on lines 56 to 58
#### Issue 3: The Ray image does not include the required dependencies.

You have two options to resolve this issue:
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it be helpful here (and in the other issues where this may be relevant) to show an example of a sign/error that would help indicate to the user that this is the exact issue they are running into?

For instance, for the image not having the required dependencies, they will likely see DEPLOY_FAILED as the application status when using kubectl describe rayservice, and the status message should indicate that Serve failed to load the application because of some dependency issue.

Copy link
Member Author

Choose a reason for hiding this comment

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

I added two examples for dependency issues.

kevin85421 and others added 8 commits July 6, 2023 13:28
Co-authored-by: Cindy Zhang <cindyzyx9@gmail.com>
Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
Co-authored-by: Cindy Zhang <cindyzyx9@gmail.com>
Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
Co-authored-by: Cindy Zhang <cindyzyx9@gmail.com>
Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
Co-authored-by: Cindy Zhang <cindyzyx9@gmail.com>
Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
Co-authored-by: Cindy Zhang <cindyzyx9@gmail.com>
Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
@kevin85421 kevin85421 requested a review from zcin July 7, 2023 00:30
Copy link
Contributor

@zcin zcin left a comment

Choose a reason for hiding this comment

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

Nice, thanks for addressing comments!

@kevin85421 kevin85421 merged commit 19054cb into ray-project:master Jul 7, 2023
20 checks passed
lowang-bh pushed a commit to lowang-bh/kuberay that referenced this pull request Sep 24, 2023
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.

[Feature] [RayService] [Doc] Explain how to access Serve application logs
2 participants