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

[Doc] [RayJob] Add documentation for submitterPodTemplate #1228

Merged

Conversation

architkulkarni
Copy link
Contributor

@architkulkarni architkulkarni commented Jul 10, 2023

Why are these changes needed?

  • Updates the sample YAML to include submitterPodTemplate. Commented out because it's optional.
  • Updates the markdown doc to include submitterPodTemplate.
  • Miscellaneous fixes, such as adding missing fields to the doc or sample YAML.

TODO before merge:

  • Manual test: run sample YAML with submitterPodTemplate uncommented.

Related issue number

Closes #1227

Checks

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

Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>

You can use `kubectl logs` to check the operator logs or the head/worker nodes logs.
You can also use `kubectl describe rayjobs rayjob-sample` to check the states and event logs of your RayJob instance:

```
```text
Status:
Copy link
Member

Choose a reason for hiding this comment

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

Does the status remain the same after the refactoring?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, it looks the same. I've pasted the status from a more recent run.

If the job doesn't run successfully, the above `describe` command will provide information about that too:
```

```text
Status:
Copy link
Member

Choose a reason for hiding this comment

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

Does the status remain the same after the refactoring?

Copy link
Member

@kevin85421 kevin85421 left a comment

Choose a reason for hiding this comment

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

I have just approved this PR due to the urgency of the release.

@architkulkarni
Copy link
Contributor Author

architkulkarni commented Jul 10, 2023 via email

Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
@architkulkarni
Copy link
Contributor Author

The sample YAML succeeded. I don't see a way to get the correct address parameter to ray job submit before runtime, because the ray cluster name has random letters appended at runtime. So I've written "specifying the command field in the SubmitterPodTemplate is not recommended."

Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
@kevin85421 kevin85421 added the v0.6.0 Must be included in v0.6.0. label Jul 11, 2023
@architkulkarni
Copy link
Contributor Author

The compatibility test is unrelated. @kevin85421 if no other comments after my latest changes, I will merge the PR.

@architkulkarni architkulkarni merged commit adde70c into ray-project:master Jul 11, 2023
19 of 20 checks passed
lowang-bh pushed a commit to lowang-bh/kuberay that referenced this pull request Sep 24, 2023
…t#1228)

Updates the sample YAML to include submitterPodTemplate. Commented out because it's optional.
Updates the markdown doc to include submitterPodTemplate.
Miscellaneous fixes, such as adding missing fields to the doc or sample YAML.
TODO before merge:

 Manual test: run sample YAML with submitterPodTemplate uncommented.
Related issue number
Closes ray-project#1227

---------

Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
v0.6.0 Must be included in v0.6.0.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc] [RayJob] Ensure doc and sample YAML uses new SubmitterPodSpec field
2 participants