Skip to content

Commit

Permalink
Update api-docs
Browse files Browse the repository at this point in the history
Signed-off-by: Shingo Omura <[email protected]>
  • Loading branch information
everpeace committed Jan 17, 2025
1 parent ccbde9b commit 4c5b807
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions docs/api-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,12 +79,18 @@ string
<td></td>
</tr><tr><td><p>&#34;PENDING_RERUN&#34;</p></td>
<td></td>
</tr><tr><td><p>&#34;RESUMING&#34;</p></td>
<td></td>
</tr><tr><td><p>&#34;RUNNING&#34;</p></td>
<td></td>
</tr><tr><td><p>&#34;SUBMITTED&#34;</p></td>
<td></td>
</tr><tr><td><p>&#34;SUCCEEDING&#34;</p></td>
<td></td>
</tr><tr><td><p>&#34;SUSPENDED&#34;</p></td>
<td></td>
</tr><tr><td><p>&#34;SUSPENDING&#34;</p></td>
<td></td>
</tr><tr><td><p>&#34;UNKNOWN&#34;</p></td>
<td></td>
</tr></tbody>
Expand Down Expand Up @@ -1807,6 +1813,22 @@ SparkApplicationSpec
<table>
<tr>
<td>
<code>suspend</code><br/>
<em>
bool
</em>
</td>
<td>
<p>Suspend specifies whether the Spark operator should create Pods or not.
If a SparkApplication is created with suspend set to true, no Pods are created
by the Spark operator. If a SparkApplication is suspended after creation
(i.e. the flag goes from false to true), the Spark operator will delete
all active Pods associated with this SparkApplication.
Users must design their Spark application to gracefully handle this.</p>
</td>
</tr>
<tr>
<td>
<code>type</code><br/>
<em>
<a href="#sparkoperator.k8s.io/v1beta2.SparkApplicationType">
Expand Down Expand Up @@ -2248,6 +2270,22 @@ It carries every pieces of information a spark-submit command takes and recogniz
<tbody>
<tr>
<td>
<code>suspend</code><br/>
<em>
bool
</em>
</td>
<td>
<p>Suspend specifies whether the Spark operator should create Pods or not.
If a SparkApplication is created with suspend set to true, no Pods are created
by the Spark operator. If a SparkApplication is suspended after creation
(i.e. the flag goes from false to true), the Spark operator will delete
all active Pods associated with this SparkApplication.
Users must design their Spark application to gracefully handle this.</p>
</td>
</tr>
<tr>
<td>
<code>type</code><br/>
<em>
<a href="#sparkoperator.k8s.io/v1beta2.SparkApplicationType">
Expand Down

0 comments on commit 4c5b807

Please sign in to comment.