Skip to content

Conversation

@apoorva-u-r
Copy link

Added documentation for using Azure Files as a persistent storage option in Ray Train.

  • Setup instructions
  • Notes for Kubernetes usage
  • Performance considerations

Fixes #54054

@apoorva-u-r apoorva-u-r requested review from a team as code owners August 23, 2025 07:07
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 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.

Comment on lines +94 to +98
3. Configure Ray to write to this location by setting:

.. code-block:: bash
export RAY_STORAGE_PATH=/mnt/azurefiles
Copy link
Contributor

Choose a reason for hiding this comment

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

high

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.

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

Choose a reason for hiding this comment

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

high

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.

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

@ray-gardener ray-gardener bot added docs An issue or change related to documentation train Ray Train Related Issue community-contribution Contributed by the community labels Aug 23, 2025
@github-actions
Copy link

github-actions bot commented Sep 7, 2025

This pull request has been automatically marked as stale because it has not had
any activity for 14 days. It will be closed in another 14 days if no further activity occurs.
Thank you for your contributions.

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.

@github-actions github-actions bot added the stale The issue is stale. It will be closed within 7 days unless there are further conversation label Sep 7, 2025
@github-actions
Copy link

This pull request has been automatically closed because there has been no more activity in the 14 days
since being marked stale.

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!

@github-actions github-actions bot closed this Sep 21, 2025
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 docs An issue or change related to documentation stale The issue is stale. It will be closed within 7 days unless there are further conversation train Ray Train Related Issue

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[train] Add Azure Files support to persistent storage documentation

1 participant