[SPARK-49176][K8S][DOCS] Fix spark.ui.custom.executor.log.url docs by adding K8s
#47681
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…entation by adding K8s
Member
Author
|
cc @viirya |
yaooqinn
approved these changes
Aug 9, 2024
Member
Author
|
Oh, thank you for review, @yaooqinn ! |
viirya
approved these changes
Aug 9, 2024
Member
Author
|
Thank you, @viirya . |
HyukjinKwon
approved these changes
Aug 9, 2024
Member
|
Merged to master. |
Member
Author
|
Thank you, @HyukjinKwon ! |
Member
Author
|
Let me backport this documentation update to the live release branches because this has been supported for a long time already. Thank you all again. |
dongjoon-hyun
added a commit
that referenced
this pull request
Aug 9, 2024
…by adding K8s ### What changes were proposed in this pull request? This PR aims to fix `spark.ui.custom.executor.log.url` configuration's documentation by adding K8s on top of YARN. ``` - For now, only YARN mode supports this configuration + For now, only YARN and K8s cluster manager supports this configuration ``` In addition, K8s example is added to `running-on-kubernetes.md` docs to help users refer the existing environment variables, `SPARK_APPLICATION_ID` and `SPARK_EXECUTOR_ID`, more easily to enable this feature. - https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/#using-environment-variables-inside-of-your-config ### Why are the changes needed? To fix a wrong description. ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? Manual review. This is a doc-only PR. ### Was this patch authored or co-authored using generative AI tooling? No. Closes #47681 from dongjoon-hyun/SPARK-49176. Authored-by: Dongjoon Hyun <dhyun@apple.com> Signed-off-by: Hyukjin Kwon <gurwls223@apache.org>
dongjoon-hyun
added a commit
that referenced
this pull request
Aug 9, 2024
…by adding K8s ### What changes were proposed in this pull request? This PR aims to fix `spark.ui.custom.executor.log.url` configuration's documentation by adding K8s on top of YARN. ``` - For now, only YARN mode supports this configuration + For now, only YARN and K8s cluster manager supports this configuration ``` In addition, K8s example is added to `running-on-kubernetes.md` docs to help users refer the existing environment variables, `SPARK_APPLICATION_ID` and `SPARK_EXECUTOR_ID`, more easily to enable this feature. - https://kubernetes.io/docs/tasks/inject-data-application/define-environment-variable-container/#using-environment-variables-inside-of-your-config ### Why are the changes needed? To fix a wrong description. ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? Manual review. This is a doc-only PR. ### Was this patch authored or co-authored using generative AI tooling? No. Closes #47681 from dongjoon-hyun/SPARK-49176. Authored-by: Dongjoon Hyun <dhyun@apple.com> Signed-off-by: Hyukjin Kwon <gurwls223@apache.org>
dongjoon-hyun
added a commit
that referenced
this pull request
Aug 10, 2024
…f `CUSTOM_EXECUTOR_LOG_URL` is defined ### What changes were proposed in this pull request? This PR aims to add `SPARK_EXECUTOR_ATTRIBUTE_(APP|EXECUTOR)_ID` if `CUSTOM_EXECUTOR_LOG_URL` is defined. ### Why are the changes needed? Apache Spark has been supported `spark.ui.custom.executor.log.url` in K8s environment well. - #47681 This PR aims to help users use it more easily by providing the required `SPARK_EXECUTOR_ATTRIBUTE_APP_ID` and `SPARK_EXECUTOR_ATTRIBUTE_EXECUTOR_ID` automatically if `spark.ui.custom.executor.log.url` is defined. ### Does this PR introduce _any_ user-facing change? - No by default because `spark.ui.custom.executor.log.url` is not used. - When `spark.ui.custom.executor.log.url` is used, - For YARN users, there is no change for YARN users because this is K8s only change. - For K8s users, this will reduce the existing steps by providing the same environment variables. In addition, the user variables always overwrite this built-in environment variables by design. ### How was this patch tested? No. ### Was this patch authored or co-authored using generative AI tooling? No. Closes #47692 from dongjoon-hyun/SPARK-49190. Authored-by: Dongjoon Hyun <dhyun@apple.com> Signed-off-by: Dongjoon Hyun <dhyun@apple.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
This PR aims to fix
spark.ui.custom.executor.log.urlconfiguration's documentation by adding K8s on top of YARN.In addition, K8s example is added to
running-on-kubernetes.mddocs to help users refer the existing environment variables,SPARK_APPLICATION_IDandSPARK_EXECUTOR_ID, more easily to enable this feature.Why are the changes needed?
To fix a wrong description.
Does this PR introduce any user-facing change?
No.
How was this patch tested?
Manual review. This is a doc-only PR.
Was this patch authored or co-authored using generative AI tooling?
No.