[SPARK-28639][CORE][DOC] Configuration doc for Barrier Execution Mode#25370
[SPARK-28639][CORE][DOC] Configuration doc for Barrier Execution Mode#25370sarutak wants to merge 4 commits intoapache:masterfrom
Conversation
| </table> | ||
|
|
||
| ### Barrier Mode Execution | ||
|
|
There was a problem hiding this comment.
I put this section below the scheduling section because this is related to scheduling.
|
CC: @jiangxb1987 |
|
Test build #108730 has finished for PR 25370 at commit
|
srowen
left a comment
There was a problem hiding this comment.
This is probably good, but are you sure they're meant to be public / documented?
|
I think so because private properties are marked as but those properties are not marked. In particular, But I'd like to confirm to @jiangxb1987 who introduced those properties, whether he intended they are public, just in case. |
|
Thanks for adding the document, I agree we shall allow end user to customize these config values, though I won't encourage changing the default value. |
docs/configuration.md
Outdated
| ### Barrier Execution Mode | ||
|
|
||
| <table class="table"> | ||
| <tr><th>Property Name></th><th>Default</th><th>Meaning</th></tr> |
There was a problem hiding this comment.
Shall we remove the extra > at Property Name>?
If you don't mind, please generate the doc and post the screenshot into the PR description.
That is helpful to spot this kind of typo-related bugs and the broken tables.
There was a problem hiding this comment.
Thanks. I've attached below.
docs/configuration.md
Outdated
| <td><code>spark.barrier.sync.timeout</code></td> | ||
| <td>365d</td> | ||
| <td> | ||
| The timeout in seconds for each barrier() call from a barrier task. If the |
docs/configuration.md
Outdated
| The timeout in seconds for each barrier() call from a barrier task. If the | ||
| coordinator didn't receive all the sync messages from barrier tasks within the | ||
| configed time, throw a SparkException to fail all the tasks. The default value is set | ||
| to 31536000(3600 * 24 * 365) so the barrier() call shall wait for one year. |
|
Test build #108865 has finished for PR 25370 at commit
|
docs/configuration.md
Outdated
| <td> | ||
| The timeout in seconds for each <code>barrier()</code> call from a barrier task. If the | ||
| coordinator didn't receive all the sync messages from barrier tasks within the | ||
| configed time, throw a SparkException to fail all the tasks. The default value is set |
There was a problem hiding this comment.
Thanks! Actually, this description is from here. So it might be better to modify it too.
There was a problem hiding this comment.
Yes, I think so. This is because other sections use configured.
|
Test build #108883 has finished for PR 25370 at commit
|
|
Merged to master |

What changes were proposed in this pull request?
SPARK-24817 and SPARK-24819 introduced new 3 non-internal properties for barrier-execution mode but they are not documented.
So I've added a section into configuration.md for barrier-mode execution.
How was this patch tested?
Built using jekyll and confirm the layout by browser.