-
Notifications
You must be signed in to change notification settings - Fork 7k
docs: add Azure Files support as persistent storage option #55862
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
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 documentation for using Azure Files as a persistent storage option. The new section provides setup instructions and notes for Kubernetes and performance. My review identifies a critical issue where the documentation suggests using an incorrect environment variable (RAY_STORAGE_PATH) for configuration. I've provided suggestions to correct this to use the standard RunConfig(storage_path=...) method, ensuring consistency with other shared filesystem configurations in the documentation and reflecting the correct usage in Ray Train.
| 3. Configure Ray to write to this location by setting: | ||
|
|
||
| .. code-block:: bash | ||
| export RAY_STORAGE_PATH=/mnt/azurefiles |
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 documentation suggests using export RAY_STORAGE_PATH=/mnt/azurefiles to configure the storage path for Azure Files. However, RAY_STORAGE_PATH does not appear to be a valid environment variable used by Ray Train for this purpose.
Using RunConfig(storage_path=...) is the correct and consistent way to configure a shared filesystem path, as shown in other parts of this document (e.g., for NFS/HDFS). Please update the configuration instructions to use RunConfig.
| 3. Configure Ray to write to this location by setting: | |
| .. code-block:: bash | |
| export RAY_STORAGE_PATH=/mnt/azurefiles | |
| 3. Configure your Ray Train or Tune script to use this path via ``RunConfig(storage_path)``: | |
| .. code-block:: python | |
| # In your Trainer/Tuner setup | |
| run_config=train.RunConfig(storage_path="/mnt/azurefiles") |
| **Notes** | ||
|
|
||
| - Ensure the share is mounted with read/write permissions on all nodes (head + workers). | ||
| - For Kubernetes deployments, mount the Azure Files share as a volume on every pod and set ``RAY_STORAGE_PATH`` as an environment variable. |
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.
Similar to the main setup instructions, the note for Kubernetes deployments incorrectly references the RAY_STORAGE_PATH environment variable. The correct approach is to configure the mounted volume path using RunConfig(storage_path=...) in the training script.
| - For Kubernetes deployments, mount the Azure Files share as a volume on every pod and set ``RAY_STORAGE_PATH`` as an environment variable. | |
| - For Kubernetes deployments, mount the Azure Files share as a volume on every pod and configure ``RunConfig(storage_path=...)`` to point to the mount path. |
|
This pull request has been automatically marked as stale because it has not had You can always ask for help on our discussion forum or Ray's public slack channel. If you'd like to keep this open, just leave any comment, and the stale label will be removed. |
|
This pull request has been automatically closed because there has been no more activity in the 14 days Please feel free to reopen or open a new pull request if you'd still like this to be addressed. Again, you can always ask for help on our discussion forum or Ray's public slack channel. Thanks again for your contribution! |
Added documentation for using Azure Files as a persistent storage option in Ray Train.
Fixes #54054