Skip to content

Conversation

joshkodi
Copy link

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, and ray status) gives them a clear quickstart path.

How

  • Edited doc/source/cluster/vms/user-guides/launching-clusters/aws.md
  • Added a MyST note block with clean Markdown fencing and syntax-highlighted code.

Verification

  • Ran make html locally and confirmed note block renders correctly.

@joshkodi joshkodi requested review from a team as code owners October 12, 2025 04:51
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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.

Comment on lines 12 to 29
**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`.
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

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:

  1. The command ray up cluster.yaml assumes the user has a file named cluster.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.
  2. The rest of this document refers to example-full.yaml. Using cluster.yaml in the quickstart is inconsistent.

I suggest using example-full.yaml consistently and adding the wget command to download it.

Suggested change
**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.

Copy link
Author

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.

Copy link
Author

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.
```
````
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

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.

Suggested change
````

Copy link
Author

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

Copy link
Author

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! ⚡️

cursor[bot]

This comment was marked as outdated.

@ray-gardener ray-gardener bot added core Issues that should be addressed in Ray Core community-contribution Contributed by the community labels Oct 12, 2025
@joshkodi joshkodi force-pushed the docs/aws-quickstart-checklist branch 2 times, most recently from 2c3f2f1 to 661714e Compare October 12, 2025 23:40
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
Copy link
Collaborator

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

Copy link
Author

Choose a reason for hiding this comment

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

Updated, thanks Jiajun!

cursor[bot]

This comment was marked as outdated.

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]>
@joshkodi joshkodi force-pushed the docs/aws-quickstart-checklist branch from f2807b2 to 3575e60 Compare October 13, 2025 06:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community-contribution Contributed by the community core Issues that should be addressed in Ray Core

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants