Skip to content

Commit e2c2b7a

Browse files
committed
Update api-docs
Signed-off-by: Shingo Omura <[email protected]>
1 parent ed7e7fd commit e2c2b7a

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

docs/api-docs.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,12 +79,18 @@ string
7979
<td></td>
8080
</tr><tr><td><p>&#34;PENDING_RERUN&#34;</p></td>
8181
<td></td>
82+
</tr><tr><td><p>&#34;RESUMING&#34;</p></td>
83+
<td></td>
8284
</tr><tr><td><p>&#34;RUNNING&#34;</p></td>
8385
<td></td>
8486
</tr><tr><td><p>&#34;SUBMITTED&#34;</p></td>
8587
<td></td>
8688
</tr><tr><td><p>&#34;SUCCEEDING&#34;</p></td>
8789
<td></td>
90+
</tr><tr><td><p>&#34;SUSPENDED&#34;</p></td>
91+
<td></td>
92+
</tr><tr><td><p>&#34;SUSPENDING&#34;</p></td>
93+
<td></td>
8894
</tr><tr><td><p>&#34;UNKNOWN&#34;</p></td>
8995
<td></td>
9096
</tr></tbody>
@@ -1807,6 +1813,22 @@ SparkApplicationSpec
18071813
<table>
18081814
<tr>
18091815
<td>
1816+
<code>suspend</code><br/>
1817+
<em>
1818+
bool
1819+
</em>
1820+
</td>
1821+
<td>
1822+
<p>Suspend specifies whether the Spark operator should create Pods or not.
1823+
If a SparkApplication is created with suspend set to true, no Pods are created
1824+
by the Spark operator. If a SparkApplication is suspended after creation
1825+
(i.e. the flag goes from false to true), the Spark operator will delete
1826+
all active Pods associated with this SparkApplication.
1827+
Users must design their Spark application to gracefully handle this.</p>
1828+
</td>
1829+
</tr>
1830+
<tr>
1831+
<td>
18101832
<code>type</code><br/>
18111833
<em>
18121834
<a href="#sparkoperator.k8s.io/v1beta2.SparkApplicationType">
@@ -2248,6 +2270,22 @@ It carries every pieces of information a spark-submit command takes and recogniz
22482270
<tbody>
22492271
<tr>
22502272
<td>
2273+
<code>suspend</code><br/>
2274+
<em>
2275+
bool
2276+
</em>
2277+
</td>
2278+
<td>
2279+
<p>Suspend specifies whether the Spark operator should create Pods or not.
2280+
If a SparkApplication is created with suspend set to true, no Pods are created
2281+
by the Spark operator. If a SparkApplication is suspended after creation
2282+
(i.e. the flag goes from false to true), the Spark operator will delete
2283+
all active Pods associated with this SparkApplication.
2284+
Users must design their Spark application to gracefully handle this.</p>
2285+
</td>
2286+
</tr>
2287+
<tr>
2288+
<td>
22512289
<code>type</code><br/>
22522290
<em>
22532291
<a href="#sparkoperator.k8s.io/v1beta2.SparkApplicationType">

0 commit comments

Comments
 (0)