-
Notifications
You must be signed in to change notification settings - Fork 6.8k
docs(aws): add Quickstart checklist for launching clusters #57650
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
base: master
Are you sure you want to change the base?
docs(aws): add Quickstart checklist for launching clusters #57650
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request adds a helpful Quickstart checklist to the AWS cluster launch guide. The intention is great for new users. I've provided a couple of suggestions to improve the clarity and consistency of the documentation. One suggestion is to make the quickstart self-contained by adding the command to download the example configuration file and to use a consistent filename throughout the document. The other is a minor formatting fix to ensure consistency in the Markdown syntax.
**2) Bring up a cluster** using the example configuration: | ||
```bash | ||
ray up cluster.yaml | ||
``` | ||
See the Cluster Configuration section for details. | ||
**3) Access the Ray Dashboard** at `http://<head-node-ip>:8265`. | ||
Ensure inbound TCP **8265** is allowed in your AWS Security Group. | ||
**4) Check cluster status:** | ||
```bash | ||
ray status | ||
``` | ||
Optional: enable autoscaling by adjusting node settings in `cluster.yaml`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The quickstart guide is a great addition for new users! However, there are a couple of points that could be improved for clarity and consistency:
- The command
ray up cluster.yaml
assumes the user has a file namedcluster.yaml
. A new user following the quickstart won't have this file. It would be helpful to include the step to download the example configuration file. - The rest of this document refers to
example-full.yaml
. Usingcluster.yaml
in the quickstart is inconsistent.
I suggest using example-full.yaml
consistently and adding the wget
command to download it.
**2) Bring up a cluster** using the example configuration: | |
```bash | |
ray up cluster.yaml | |
``` | |
See the Cluster Configuration section for details. | |
**3) Access the Ray Dashboard** at `http://<head-node-ip>:8265`. | |
Ensure inbound TCP **8265** is allowed in your AWS Security Group. | |
**4) Check cluster status:** | |
```bash | |
ray status | |
``` | |
Optional: enable autoscaling by adjusting node settings in `cluster.yaml`. | |
**2) Bring up a cluster** using the example configuration: | |
```bash | |
wget https://raw.githubusercontent.com/ray-project/ray/master/python/ray/autoscaler/aws/example-full.yaml | |
ray up example-full.yaml |
See the Cluster Configuration section for details.
3) Access the Ray Dashboard at http://<head-node-ip>:8265
.
Ensure inbound TCP 8265 is allowed in your AWS Security Group.
4) Check cluster status:
ray status
Optional: enable autoscaling by adjusting node settings in example-full.yaml
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for catching these two things.
Added a new step to download the example cluster configuration file via curl.
Updated filename from cluster.yaml → example-full.yaml for consistency with the rest of the doc.
Rebuilt locally (make html) — renders cleanly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks everyone for the quick review — glad to contribute to Ray docs!
You can apply changes to the CloudWatch Logs, Metrics, Dashboard, and Alarms for your cluster by simply modifying the CloudWatch config files referenced by your Ray cluster config YAML and re-running ``ray up example-cloudwatch.yaml``. | ||
The Unified CloudWatch Agent will be automatically restarted on all cluster nodes, and your config changes will be applied. | ||
``` | ||
```` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While technically valid in MyST-Parser (closing fence must be at least as long as the opening one), using a different number of backticks for opening and closing a fenced block is inconsistent and can be confusing for future editors. The eval-rst
block starting on line 180 opens with three backticks (```), so it would be more consistent to close it with three backticks as well.
```` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch, I have fixed the backticks to make it consistent
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🙏 Thanks everyone for the thoughtful and speedy reviews!
I’ve incorporated all the feedback — added the step to download example-full.yaml, aligned the filename throughout, and fixed the fenced-block consistency.
Confirmed the build and render locally — everything looks good on my side.
Really appreciate the clear guidance and support on my first contribution to Ray docs! ⚡️
2c3f2f1
to
661714e
Compare
To start an AWS Ray cluster, you should use the Ray cluster launcher with the AWS Python SDK. | ||
## Install Ray cluster launcher | ||
# Install Ray cluster launcher |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It should be ##
since it's under # Launching Ray Clusters on AWS
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated, thanks Jiajun!
4508587
to
f2807b2
Compare
Adds a MyST note block with a four-step Quickstart (credentials, 'ray up', dashboard on port 8265 with Security Group reminder, 'ray status' + optional autoscaling). Inserted below the page title in doc/source/cluster/vms/user-guides/launching-clusters/aws.md. Built docs locally (SPHINXOPTS='-a -E -j auto' make html) and verified the note renders as expected. Signed-off-by: Josh Kodi <[email protected]> (cherry picked from commit 516be9f) Signed-off-by: Josh Kodi <[email protected]>
…with main docs Signed-off-by: Josh Kodi <[email protected]> (cherry picked from commit b73afe9) Signed-off-by: Josh Kodi <[email protected]>
Signed-off-by: Josh Kodi <[email protected]> (cherry picked from commit 2718d1e) Signed-off-by: Josh Kodi <[email protected]>
Signed-off-by: Josh Kodi <[email protected]> (cherry picked from commit f2bd71d) Signed-off-by: Josh Kodi <[email protected]>
Signed-off-by: Josh Kodi <[email protected]> (cherry picked from commit d285c29) Signed-off-by: Josh Kodi <[email protected]>
…cell IDs Signed-off-by: Josh Kodi <[email protected]> (cherry picked from commit 20acf66) Signed-off-by: Josh Kodi <[email protected]>
…cell IDs Signed-off-by: Josh Kodi <[email protected]> (cherry picked from commit 3880b08) Signed-off-by: Josh Kodi <[email protected]>
Signed-off-by: Josh Kodi <[email protected]> (cherry picked from commit f2807b2) Signed-off-by: Josh Kodi <[email protected]>
f2807b2
to
3575e60
Compare
What
Adds a Quickstart checklist at the top of the "Launching Ray Clusters on AWS" guide.
Why
Many new users want a short, actionable set of steps. This 4-step checklist (credentials,
ray up
, dashboard, andray status
) gives them a clear quickstart path.How
doc/source/cluster/vms/user-guides/launching-clusters/aws.md
Verification
make html
locally and confirmed note block renders correctly.