Add documentation for RAY_RUNTIME_ENV_BEARER_TOKEN env var#60136
Add documentation for RAY_RUNTIME_ENV_BEARER_TOKEN env var#60136edoakes merged 1 commit intoray-project:masterfrom
Conversation
Signed-off-by: Denis Khachyan <khachyanda@gmail.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds documentation for the RAY_RUNTIME_ENV_BEARER_TOKEN environment variable, which allows authenticating remote URIs in runtime_env using bearer tokens. The documentation is clear and covers both local usage and deployment on KubeRay with Kubernetes secrets. I've suggested a minor improvement to the Kubernetes example to follow common conventions for secret keys, which will enhance clarity for users.
| kubectl create secret generic bearer-token-secret \ | ||
| --from-literal=RAY_RUNTIME_ENV_BEARER_TOKEN="your_bearer_token_here" |
There was a problem hiding this comment.
For better convention and clarity in Kubernetes, it's recommended to use a simpler key for the secret, like token. The current key RAY_RUNTIME_ENV_BEARER_TOKEN is quite long and unconventional for a secret key. The environment variable inside the pod will still be set correctly.
This change will also require updating the secretKeyRef.key in the KubeRay config YAML in the following code blocks.
| kubectl create secret generic bearer-token-secret \ | |
| --from-literal=RAY_RUNTIME_ENV_BEARER_TOKEN="your_bearer_token_here" | |
| kubectl create secret generic bearer-token-secret \ | |
| --from-literal=token="your_bearer_token_here" |
| valueFrom: | ||
| secretKeyRef: | ||
| name: bearer-token-secret | ||
| key: RAY_RUNTIME_ENV_BEARER_TOKEN |
There was a problem hiding this comment.
To align with the suggested change of using a simpler secret key (token), the key here should be updated.
| key: RAY_RUNTIME_ENV_BEARER_TOKEN | |
| key: token |
| valueFrom: | ||
| secretKeyRef: | ||
| name: bearer-token-secret | ||
| key: RAY_RUNTIME_ENV_BEARER_TOKEN |
There was a problem hiding this comment.
To align with the suggested change of using a simpler secret key (token), the key here should be updated.
| key: RAY_RUNTIME_ENV_BEARER_TOKEN | |
| key: token |
ray-gardener
bot
added
usability
docs
…ct#60136) ## Description Added documentation about using RAY_RUNTIME_ENV_BEARER_TOKEN_ENV_VAR for authenticating remote URIs in runtime_env ## Related issues [ray-project#46833](ray-project#46833) ## Related PRs [ray-project#60050](ray-project#60050) Signed-off-by: Denis Khachyan <khachyanda@gmail.com> Signed-off-by: jeffery4011 <jefferyshen1015@gmail.com>
…ct#60136) ## Description Added documentation about using RAY_RUNTIME_ENV_BEARER_TOKEN_ENV_VAR for authenticating remote URIs in runtime_env ## Related issues [ray-project#46833](ray-project#46833) ## Related PRs [ray-project#60050](ray-project#60050) Signed-off-by: Denis Khachyan <khachyanda@gmail.com>
…ct#60136) ## Description Added documentation about using RAY_RUNTIME_ENV_BEARER_TOKEN_ENV_VAR for authenticating remote URIs in runtime_env ## Related issues [ray-project#46833](ray-project#46833) ## Related PRs [ray-project#60050](ray-project#60050) Signed-off-by: Denis Khachyan <khachyanda@gmail.com> Signed-off-by: peterxcli <peterxcli@gmail.com>
…ct#60136) ## Description Added documentation about using RAY_RUNTIME_ENV_BEARER_TOKEN_ENV_VAR for authenticating remote URIs in runtime_env ## Related issues [ray-project#46833](ray-project#46833) ## Related PRs [ray-project#60050](ray-project#60050) Signed-off-by: Denis Khachyan <khachyanda@gmail.com> Signed-off-by: peterxcli <peterxcli@gmail.com>
2 participants
Description
Added documentation about using RAY_RUNTIME_ENV_BEARER_TOKEN_ENV_VAR for authenticating remote URIs in runtime_env
Related issues
#46833
Related PRs
#60050