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.

Sign up for GitHub

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

Jump to bottom

[Doc] [KubeRay] Add tutorial for connecting to google cloud storage bucket from GKE RayCluster #38858

Merged
merged 66 commits into from Aug 31, 2023
Merged

[Doc] [KubeRay] Add tutorial for connecting to google cloud storage bucket from GKE RayCluster #38858

merged 66 commits into from Aug 31, 2023

Conversation

architkulkarni
Copy link
Contributor

@architkulkarni architkulkarni commented Aug 24, 2023 •
edited

Why are these changes needed?

This PR adds a self contained tutorial for connecting to a google cloud storage bucket. (Mostly self contained, we do link out to the google cloud docs for creating a bucket.)

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 :(

kevin85421 and others added 30 commits August 20, 2023 16:58
@kevin85421
add docs
d34a528
@kevin85421
update
8030e26
@kevin85421
add rayservice doc
7f1c300
@kevin85421
remove RayService
f2ab31b
@kevin85421
update
7225343
@kevin85421
update
b92099f
@kevin85421
kubeflow doc
9d602ba
@kevin85421
update
e5564a8
@kevin85421
update
26bc93a
@kevin85421
update
7a573d3
@kevin85421
update
743f078
@kevin85421
update
70928ce
@kevin85421
update
e7f4a58
@kevin85421
update
0a46948
@kevin85421
update
5d2b814
@kevin85421
update
702f129
@kevin85421
update
dbe0bb5
@kevin85421
update
b5b6437
@kevin85421
update
8c0dab7
@kevin85421 @angelinalg
Update doc/source/cluster/kubernetes/benchmarks/memory-scalability-be…
3f43229 
…nchmark.md

Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
@kevin85421 @angelinalg
Update doc/source/cluster/kubernetes/k8s-ecosystem/prometheus-grafana.md
c8e4fbc 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
@kevin85421 @angelinalg
Update doc/source/cluster/kubernetes/benchmarks/memory-scalability-be…
856d8bc 
…nchmark.md

Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
@kevin85421 @angelinalg
Update doc/source/cluster/kubernetes/benchmarks/memory-scalability-be…
5b7c2b0 
…nchmark.md

Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
@kevin85421 @angelinalg
Update doc/source/cluster/kubernetes/benchmarks/memory-scalability-be…
4d86c7c 
…nchmark.md

Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
@kevin85421 @angelinalg
Update doc/source/cluster/kubernetes/k8s-ecosystem/prometheus-grafana.md
d2df3ed 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
@kevin85421 @angelinalg
Apply suggestions from code review
76831fd 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
@kevin85421 @angelinalg
Apply suggestions from code review
99a97d7 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
@kevin85421 @angelinalg
Apply suggestions from code review
7bc8d3d 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
@kevin85421
update
22730dd
@kevin85421 @angelinalg
Apply suggestions from code review
2f2794d 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
kevin85421
kevin85421 reviewed Aug 31, 2023
View reviewed changes
doc/source/cluster/kubernetes/user-guides/gke-gcs-bucket.md Outdated Show resolved Hide resolved
doc/source/cluster/kubernetes/user-guides/gke-gcs-bucket.md
RAY_GCS_BUCKET = "my-bucket"
RAY_GCS_FILE = "test_file.txt"

ray.init(address="auto")
Copy link
Member

Choose a reason for hiding this comment

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

remote Ray processes can still access the bucket

If we install google-cloud-storage only on the head Pod, will a task scheduled on a worker node still succeed?

doc/source/cluster/kubernetes/user-guides/gke-gcs-bucket.md Outdated Show resolved Hide resolved
architkulkarni and others added 10 commits August 31, 2023 12:21
@architkulkarni @angelinalg
Update doc/source/cluster/kubernetes/user-guides/gke-gcs-bucket.md
77875d1 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
@architkulkarni @angelinalg
Update doc/source/cluster/kubernetes/user-guides/gke-gcs-bucket.md
0cdf429 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
@architkulkarni @angelinalg
Update doc/source/cluster/kubernetes/user-guides/gke-gcs-bucket.md
484e028 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
@architkulkarni @angelinalg
Update doc/source/cluster/kubernetes/user-guides/gke-gcs-bucket.md
f835f3e 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
@architkulkarni @angelinalg
Update doc/source/cluster/kubernetes/user-guides/gke-gcs-bucket.md
ea8e899 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
@architkulkarni @angelinalg
Update doc/source/cluster/kubernetes/user-guides/gke-gcs-bucket.md
7746a44 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
@architkulkarni @angelinalg
Update doc/source/cluster/kubernetes/user-guides/gke-gcs-bucket.md
e163585 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
@architkulkarni @angelinalg
Update doc/source/cluster/kubernetes/user-guides/gke-gcs-bucket.md
9dd9691 
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
@architkulkarni
rename RAY to GCP and remove shutdown()
cbfaa0c
@architkulkarni
Merge branch 'master' into gcs-gke-bucket-doc
671ee6c
@architkulkarni
Copy link
Contributor Author

@kevin85421 Thanks, I addressed the comments

@architkulkarni
Update doc/source/cluster/kubernetes/user-guides/gke-gcs-bucket.md
58f81a7 
Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
@architkulkarni
Copy link
Contributor Author

Addressed the dependency issue here. 58f81a7

architkulkarni added a commit to ray-project/kuberay that referenced this pull request Aug 31, 2023
@architkulkarni
[Doc] Add gke bucket yaml (#1372)
41018bc 
Adds a new YAML file for the GKE bucket tutorial. Resolves ray-project/ray#38858 (comment)

---------

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

Test failures:

  • FAILED bazel/::data-loading-preprocessing.rst
  • tests:test_multiprocessing
  • tests:test_task_events_2
  • tests:test_namespace

These are all unrelated

@architkulkarni architkulkarni added the tests-ok The tagger certifies test failures are unrelated and assumes personal liability. label Aug 31, 2023
@architkulkarni architkulkarni merged commit 3034965 into ray-project:master Aug 31, 2023
12 of 16 checks passed
architkulkarni added a commit to architkulkarni/ray that referenced this pull request Aug 31, 2023
@architkulkarni @kevin85421 @angelinalg
[Doc] [KubeRay] Add tutorial for connecting to google cloud storage b…
8886fae 
…ucket from GKE RayCluster (ray-project#38858)

This PR adds a self contained tutorial for connecting to a google cloud storage bucket. (Mostly self contained, we do link out to the google cloud docs for creating a bucket.)

---------

Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
Co-authored-by: Kai-Hsun Chen <kaihsun@anyscale.com>
Co-authored-by: Kai-Hsun Chen <kaihsun@apache.org>
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
@architkulkarni architkulkarni mentioned this pull request Aug 31, 2023
Merged
8 tasks
GeneDer pushed a commit that referenced this pull request Sep 1, 2023
@architkulkarni @kevin85421 @angelinalg
[Doc] [KubeRay] Add two kuberay tutorials (Cherry-pick of #38858 and #…
cec81c5 
…38857) (#39186)

* [Doc] [KubeRay] Add tutorial for connecting to google cloud storage bucket from GKE RayCluster (#38858)

This PR adds a self contained tutorial for connecting to a google cloud storage bucket. (Mostly self contained, we do link out to the google cloud docs for creating a bucket.)

---------

Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
Co-authored-by: Kai-Hsun Chen <kaihsun@anyscale.com>
Co-authored-by: Kai-Hsun Chen <kaihsun@apache.org>
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>

* [Doc] [KubeRay] Add end-to-end tutorial for real-world RayJob workload (batch inference) (#38857)

This PR adds a tutorial for running a batch inference workload on KubeRay using the RayJob CRD.

It also updates the GPU/GKE doc (which is used as a subroutine in this tutorial) to remove the instructions related to taints and tolerations and GPU driver installation, both of which are currently handled automatically by GKE.

---------

Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
Co-authored-by: Kai-Hsun Chen <kaihsun@anyscale.com>
Co-authored-by: Kai-Hsun Chen <kaihsun@apache.org>
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>

---------

Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
Co-authored-by: Kai-Hsun Chen <kaihsun@anyscale.com>
Co-authored-by: Kai-Hsun Chen <kaihsun@apache.org>
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
LeonLuttenberger pushed a commit to jaidisido/ray that referenced this pull request Sep 5, 2023
@architkulkarni @kevin85421
@angelinalg @LeonLuttenberger
[Doc] [KubeRay] Add tutorial for connecting to google cloud storage b…
5779c7a 
…ucket from GKE RayCluster (ray-project#38858)

This PR adds a self contained tutorial for connecting to a google cloud storage bucket. (Mostly self contained, we do link out to the google cloud docs for creating a bucket.)

---------

Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
Co-authored-by: Kai-Hsun Chen <kaihsun@anyscale.com>
Co-authored-by: Kai-Hsun Chen <kaihsun@apache.org>
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
harborn pushed a commit to harborn/ray that referenced this pull request Sep 8, 2023
@architkulkarni @kevin85421
@angelinalg @harborn
[Doc] [KubeRay] Add tutorial for connecting to google cloud storage b…
0692052 
…ucket from GKE RayCluster (ray-project#38858)

This PR adds a self contained tutorial for connecting to a google cloud storage bucket. (Mostly self contained, we do link out to the google cloud docs for creating a bucket.)

---------

Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
Co-authored-by: Kai-Hsun Chen <kaihsun@anyscale.com>
Co-authored-by: Kai-Hsun Chen <kaihsun@apache.org>
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
jimthompson5802 pushed a commit to jimthompson5802/ray that referenced this pull request Sep 12, 2023
@architkulkarni @kevin85421
@angelinalg @jimthompson5802
[Doc] [KubeRay] Add tutorial for connecting to google cloud storage b…
b6c3024 
…ucket from GKE RayCluster (ray-project#38858)

This PR adds a self contained tutorial for connecting to a google cloud storage bucket. (Mostly self contained, we do link out to the google cloud docs for creating a bucket.)

---------

Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
Co-authored-by: Kai-Hsun Chen <kaihsun@anyscale.com>
Co-authored-by: Kai-Hsun Chen <kaihsun@apache.org>
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Jim Thompson <jimthompson5802@gmail.com>
lowang-bh pushed a commit to lowang-bh/kuberay that referenced this pull request Sep 24, 2023
@architkulkarni
[Doc] Add gke bucket yaml (ray-project#1372)
678411b 
Adds a new YAML file for the GKE bucket tutorial. Resolves ray-project/ray#38858 (comment)

---------

Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
vymao pushed a commit to vymao/ray that referenced this pull request Oct 11, 2023
@architkulkarni @kevin85421 @angelinalg
[Doc] [KubeRay] Add tutorial for connecting to google cloud storage b…
d7207a3 
…ucket from GKE RayCluster (ray-project#38858)

This PR adds a self contained tutorial for connecting to a google cloud storage bucket. (Mostly self contained, we do link out to the google cloud docs for creating a bucket.)

---------

Signed-off-by: Kai-Hsun Chen <kaihsun@apache.org>
Signed-off-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
Co-authored-by: Kai-Hsun Chen <kaihsun@anyscale.com>
Co-authored-by: Kai-Hsun Chen <kaihsun@apache.org>
Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com>
Signed-off-by: Victor <vctr.y.m@example.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kevin85421 kevin85421 kevin85421 approved these changes

@angelinalg angelinalg angelinalg approved these changes

@wuisawesome wuisawesome Awaiting requested review from wuisawesome

@DmitriGekhtman DmitriGekhtman Awaiting requested review from DmitriGekhtman

@maxpumperla maxpumperla Awaiting requested review from maxpumperla maxpumperla is a code owner

@pcmoritz pcmoritz Awaiting requested review from pcmoritz pcmoritz is a code owner

Assignees

@kevin85421 kevin85421

@angelinalg angelinalg

Labels
tests-ok The tagger certifies test failures are unrelated and assumes personal liability.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@architkulkarni @kevin85421 @angelinalg