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] [Clusters] Add missing steps and simplify YAML in top-level clusters quickstart #41131

Merged

Conversation

architkulkarni
Copy link
Contributor

Why are these changes needed?

Closes #35299 by adding missing steps and using a minimal cluster YAML file.

Addresses #33026 for the AWS example-minimal.yaml by adding min_workers, max_workers and the instance type. The issue will remain open until it's fixed for all the other cluster provider example-minimal YAML files as well.

I'll run through the final tutorial manually once before merging.

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

@architkulkarni architkulkarni requested review from ericl and a team as code owners November 14, 2023 20:00
@architkulkarni architkulkarni changed the title [Doc] [Clusters] Fix top-level clusters quickstart [Doc] [Clusters] Add missing steps and simplify YAML in top-level clusters quickstart Nov 14, 2023
# For more documentation on available fields, see:
# http:https://boto3.readthedocs.io/en/latest/reference/services/ec2.html#EC2.ServiceResource.create_instances
node_config:
InstanceType: m5.large
Copy link
Contributor

Choose a reason for hiding this comment

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

newline?

doc/source/ray-overview/getting-started.md Outdated Show resolved Hide resolved
doc/source/ray-overview/getting-started.md Outdated Show resolved Hide resolved
doc/source/ray-overview/getting-started.md Outdated Show resolved Hide resolved
doc/source/ray-overview/getting-started.md Outdated Show resolved Hide resolved
doc/source/ray-overview/getting-started.md Outdated Show resolved Hide resolved
python/ray/autoscaler/aws/example-minimal.yaml Outdated Show resolved Hide resolved
python/ray/autoscaler/aws/example-minimal.yaml Outdated Show resolved Hide resolved
python/ray/autoscaler/aws/example-minimal.yaml Outdated Show resolved Hide resolved
python/ray/autoscaler/aws/example-minimal.yaml Outdated Show resolved Hide resolved
python/ray/autoscaler/aws/example-minimal.yaml Outdated Show resolved Hide resolved
architkulkarni and others added 18 commits November 20, 2023 14:53
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
@architkulkarni
Copy link
Contributor Author

The script passed:

[...]
Counter({('ip-10-0-218-191', 'ip-10-0-228-193'): 8, ('ip-10-0-225-188', 'ip-10-0-225-188'): 8, ('ip-10-0-225-188', 'ip-10-0-218-191'): 8, ('ip-10-0-218-191', 'ip-10-0-218-191'): 8, ('ip-10-0-225-188', 'ip-10-0-215-149'): 8, ('ip-10-0-218-191', 'ip-10-0-225-188'): 7, ('ip-10-0-225-188', 'ip-10-0-228-193'): 7, ('ip-10-0-215-149', 'ip-10-0-218-191'): 7, ('ip-10-0-228-193', 'ip-10-0-225-188'): 7, ('ip-10-0-215-149', 'ip-10-0-215-149'): 6, ('ip-10-0-215-149', 'ip-10-0-228-193'): 6, ('ip-10-0-218-191', 'ip-10-0-215-149'): 6, ('ip-10-0-215-149', 'ip-10-0-225-188'): 5, ('ip-10-0-228-193', 'ip-10-0-215-149'): 4, ('ip-10-0-228-193', 'ip-10-0-228-193'): 3, ('ip-10-0-228-193', 'ip-10-0-218-191'): 2})
Success!
Shared connection to 44.229.14.251 closed.

@architkulkarni architkulkarni merged commit eb42870 into ray-project:master Nov 21, 2023
17 of 21 checks passed
ujjawal-khare pushed a commit to ujjawal-khare-27/ray that referenced this pull request Nov 29, 2023
…sters quickstart (ray-project#41131)

Closes ray-project#35299 by adding missing steps and using a minimal cluster YAML file.

Addresses ray-project#33026 for the AWS example-minimal.yaml by adding min_workers, max_workers and the instance type. The issue will remain open until it's fixed for all the other cluster provider example-minimal YAML files as well.

---------

Signed-off-by: Archit Kulkarni <[email protected]>
Signed-off-by: Archit Kulkarni <[email protected]>
Co-authored-by: angelinalg <[email protected]>
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.

[docs][clusters] Getting Started for Clusters is missing steps
4 participants