diff options
| author | Dhruve Ashar <dhruveashar@gmail.com> | 2016-04-14 10:29:14 -0500 |
|---|---|---|
| committer | Tom Graves <tgraves@yahoo-inc.com> | 2016-04-14 10:29:14 -0500 |
| commit | f83ba454a507bec0cc389d9a382cd71add7f17c1 (patch) | |
| tree | 20d43659775eafa6729794c4a43e29e3bdbc9876 /docs/configuration.md | |
| parent | 3cf3db17b35c98a408014e1810cb797d8415ffd3 (diff) | |
| download | spark-f83ba454a507bec0cc389d9a382cd71add7f17c1.tar.gz spark-f83ba454a507bec0cc389d9a382cd71add7f17c1.tar.bz2 spark-f83ba454a507bec0cc389d9a382cd71add7f17c1.zip | |
[SPARK-14572][DOC] Update config docs to allow -Xms in extraJavaOptions
## What changes were proposed in this pull request?
The configuration docs are updated to reflect the changes introduced with [SPARK-12384](https://issues.apache.org/jira/browse/SPARK-12384). This allows the user to specify initial heap memory settings through the extraJavaOptions for executor, driver and am.
## How was this patch tested?
The changes are tested in [SPARK-12384](https://issues.apache.org/jira/browse/SPARK-12384). This is just documenting the changes made.
Author: Dhruve Ashar <dhruveashar@gmail.com>
Closes #12333 from dhruve/doc/SPARK-14572.
Diffstat (limited to 'docs/configuration.md')
| -rw-r--r-- | docs/configuration.md | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/docs/configuration.md b/docs/configuration.md index 937852ffde..16d5be62f9 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -225,11 +225,14 @@ Apart from these, the following properties are also available, and may be useful <td>(none)</td> <td> A string of extra JVM options to pass to the driver. For instance, GC settings or other logging. + Note that it is illegal to set maximum heap size (-Xmx) settings with this option. Maximum heap + size settings can be set with <code>spark.driver.memory</code> in the cluster mode and through + the <code>--driver-memory</code> command line option in the client mode. <br /><em>Note:</em> In client mode, this config must not be set through the <code>SparkConf</code> directly in your application, because the driver JVM has already started at that point. Instead, please set this through the <code>--driver-java-options</code> command line option or in - your default properties file.</td> + your default properties file. </td> </tr> <tr> @@ -269,9 +272,9 @@ Apart from these, the following properties are also available, and may be useful <td>(none)</td> <td> A string of extra JVM options to pass to executors. For instance, GC settings or other logging. - Note that it is illegal to set Spark properties or heap size settings with this option. Spark - properties should be set using a SparkConf object or the spark-defaults.conf file used with the - spark-submit script. Heap size settings can be set with spark.executor.memory. + Note that it is illegal to set Spark properties or maximum heap size (-Xmx) settings with this + option. Spark properties should be set using a SparkConf object or the spark-defaults.conf file + used with the spark-submit script. Maximum heap size settings can be set with spark.executor.memory. </td> </tr> <tr> |