Skip to content

Commit

Permalink
docs(ray): Update ray version compatibility in warning and add wget t…
Browse files Browse the repository at this point in the history
…o ImageSpec (#1557)

Signed-off-by: Chi-Sheng Liu <[email protected]>
  • Loading branch information
MortalHappiness authored Apr 13, 2024
1 parent 4275d9b commit e7d36be
Showing 1 changed file with 5 additions and 13 deletions.
18 changes: 5 additions & 13 deletions examples/ray_plugin/ray_plugin/ray_example.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,9 @@
# or by creating a new Ray cluster using the Ray operator.
#
# :::{Warning}
# **Known Bugs and Compatibility Issue with Kuberay Operator Versions**
# Please note that there have been reports of various bugs and compatibility issues with recent versions of the Kuberay operator.
# - Kuberay Operator Version 0.4: In this version, the reconcile logic of the operator was changed.
# As a result, when running a Ray job, the status of the job will always remain "pending."
# It is important to note that this change was not thoroughly tested by the Kuberay community before its release.
# - Kuberay Operator Version 0.5: In this version, an init container is injected into the worker nodes.
# However, the operator failed to set the required resource limits (CPU, memory) for this init container.
# Consequently, running Ray jobs becomes problematic in Flyte because Kubernetes imposes resource quotas in every project-domain namespace,
# and these quotas necessitate that every container sets the CPU and memory limits.
#
# **Given these issues, it is crucial to be aware that the current Ray extension is compatible only
# with version 0.3.0 and 0.5.2+ of the Kuberay operator.** It is recommended to use this specific version to
# ensure the proper functioning of the Ray extension.
# **Version Compatibility**
# - flyte >= 1.11.1-b1 only works with kuberay 1.1.0
# - Although flyte < 1.11.0 can work with kuberay 0.6.0 and 1.1.0, we strongly recommend upgrading to the latest flyte and kuberay 1.1.0 for stability and usability
# :::
#
# To begin, load the libraries.
Expand All @@ -32,6 +22,8 @@
custom_image = ImageSpec(
registry="ghcr.io/flyteorg",
packages=["flytekitplugins-ray"],
# kuberay operator needs wget for readiness probe
apt_packages=["wget"],
)

# %% [markdown]
Expand Down

0 comments on commit e7d36be

Please sign in to comment.