Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/layouts/shortcodes/generated/all_jobmanager_section.html
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,12 @@
<td><p>Enum</p></td>
<td>Determines which scheduler implementation is used to schedule tasks. If this option is not explicitly set, batch jobs will use the 'AdaptiveBatch' scheduler as the default, while streaming jobs will default to the 'Default' scheduler. <br /><br />Possible values:<ul><li>"Default": Default scheduler</li><li>"Adaptive": Adaptive scheduler. More details can be found <a href="{{.Site.BaseURL}}{{.Site.LanguagePrefix}}/docs/deployment/elastic_scaling#adaptive-scheduler">here</a>.</li><li>"AdaptiveBatch": Adaptive batch scheduler. More details can be found <a href="{{.Site.BaseURL}}{{.Site.LanguagePrefix}}/docs/deployment/elastic_scaling#adaptive-batch-scheduler">here</a>.</li></ul></td>
</tr>
<tr>
<td><h5>web.adaptive-scheduler.rescale-history.size</h5></td>
<td style="word-wrap: break-word;">0</td>
<td>Integer</td>
<td>The maximum number of the rescale records per job whose scheduler is <code class="highlighter-rouge">AdaptiveScheduler</code>. The feature will be disabled when the configuration value is smaller or equals to 0.</td>
</tr>
<tr>
<td><h5>web.exception-history-size</h5></td>
<td style="word-wrap: break-word;">16</td>
Expand Down
246 changes: 246 additions & 0 deletions docs/layouts/shortcodes/generated/rest_v1_dispatcher.html
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,62 @@
</tr>
</tbody>
</table>
<table class="rest-api table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><h5><strong>/applications/:applicationid/jobmanager/config</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Returns the jobmanager's configuration of a specific application.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>applicationid</code> - 32-character hexadecimal string value that identifies an application.</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<label>
<details>
<summary>Request</summary>
<pre><code>{}</code></pre>
</label>
</td>
</tr>
<tr>
<td colspan="2">
<label>
<details>
<summary>Response</summary>
<pre><code>{
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ConfigurationInfoEntry",
"properties" : {
"key" : {
"type" : "string"
},
"value" : {
"type" : "string"
}
}
}
}</code></pre>
</label>
</td>
</tr>
</tbody>
</table>
<table class="rest-api table table-bordered">
<tbody>
<tr>
Expand Down Expand Up @@ -3418,6 +3474,196 @@
</tr>
</tbody>
</table>
<table class="rest-api table table-bordered">
<tbody>
<tr>
<td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/rescales/details/:rescaleuuid</strong></h5></td>
</tr>
<tr>
<td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
<td class="text-left">Response code: <code>200 OK</code></td>
</tr>
<tr>
<td colspan="2">Return a job rescale details.</td>
</tr>
<tr>
<td colspan="2">Path parameters</td>
</tr>
<tr>
<td colspan="2">
<ul>
<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
<li><code>rescaleuuid</code> - String value that identifies a job rescale.</li>
</ul>
</td>
</tr>
<tr>
<td colspan="2">
<label>
<details>
<summary>Request</summary>
<pre><code>{}</code></pre>
</label>
</td>
</tr>
<tr>
<td colspan="2">
<label>
<details>
<summary>Response</summary>
<pre><code>{
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:rescales:JobRescaleDetails",
"properties" : {
"endTimestampInMillis" : {
"type" : "integer"
},
"rescaleAttemptId" : {
"type" : "integer"
},
"rescaleUuid" : {
"type" : "string"
},
"resourceRequirementsUuid" : {
"type" : "string"
},
"schedulerStates" : {
"type" : "array",
"items" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:rescales:SchedulerStateSpan",
"properties" : {
"durationInMillis" : {
"type" : "integer"
},
"enterTimestampInMillis" : {
"type" : "integer"
},
"leaveTimestampInMillis" : {
"type" : "integer"
},
"state" : {
"type" : "string"
},
"stringifiedException" : {
"type" : "string"
}
}
}
},
"slots" : {
"type" : "object",
"additionalProperties" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:rescales:JobRescaleDetails:SlotSharingGroupRescaleInfo",
"properties" : {
"acquiredResourceProfile" : {
"type" : "object",
"$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ResourceProfileInfo"
},
"desiredSlots" : {
"type" : "integer"
},
"minimalRequiredSlots" : {
"type" : "integer"
},
"postRescaleSlots" : {
"type" : "integer"
},
"preRescaleSlots" : {
"type" : "integer"
},
"requestResourceProfile" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ResourceProfileInfo",
"properties" : {
"cpuCores" : {
"type" : "number"
},
"extendedResources" : {
"type" : "object",
"additionalProperties" : {
"type" : "number"
}
},
"managedMemory" : {
"type" : "integer"
},
"networkMemory" : {
"type" : "integer"
},
"taskHeapMemory" : {
"type" : "integer"
},
"taskOffHeapMemory" : {
"type" : "integer"
}
}
},
"slotSharingGroupId" : {
"type" : "any"
},
"slotSharingGroupName" : {
"type" : "string"
}
}
}
},
"startTimestampInMillis" : {
"type" : "integer"
},
"terminalState" : {
"type" : "string",
"enum" : [ "COMPLETED", "FAILED", "IGNORED" ]
},
"terminatedReason" : {
"type" : "string",
"enum" : [ "SUCCEEDED", "EXCEPTION_OCCURRED", "RESOURCE_REQUIREMENTS_UPDATED", "NO_RESOURCES_OR_PARALLELISMS_CHANGE", "JOB_FINISHED", "JOB_FAILED", "JOB_CANCELED", "JOB_FAILOVER_RESTARTING" ]
},
"triggerCause" : {
"type" : "string",
"enum" : [ "INITIAL_SCHEDULE", "UPDATE_REQUIREMENT", "NEW_RESOURCE_AVAILABLE", "RECOVERABLE_FAILOVER" ]
},
"vertices" : {
"type" : "object",
"additionalProperties" : {
"type" : "object",
"id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:rescales:JobRescaleDetails:VertexParallelismRescaleInfo",
"properties" : {
"desiredParallelism" : {
"type" : "integer"
},
"jobVertexId" : {
"type" : "any"
},
"jobVertexName" : {
"type" : "string"
},
"postRescaleParallelism" : {
"type" : "integer"
},
"preRescaleParallelism" : {
"type" : "integer"
},
"slotSharingGroupId" : {
"type" : "any"
},
"slotSharingGroupName" : {
"type" : "string"
},
"sufficientParallelism" : {
"type" : "integer"
}
}
}
}
}
}</code></pre>
</label>
</td>
</tr>
</tbody>
</table>
<table class="rest-api table table-bordered">
<tbody>
<tr>
Expand Down
6 changes: 6 additions & 0 deletions docs/layouts/shortcodes/generated/web_configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@
<td>String</td>
<td>Access-Control-Allow-Origin header for all responses from the web-frontend.</td>
</tr>
<tr>
<td><h5>web.adaptive-scheduler.rescale-history.size</h5></td>
<td style="word-wrap: break-word;">0</td>
<td>Integer</td>
<td>The maximum number of the rescale records per job whose scheduler is <code class="highlighter-rouge">AdaptiveScheduler</code>. The feature will be disabled when the configuration value is smaller or equals to 0.</td>
</tr>
<tr>
<td><h5>web.cancel.enable</h5></td>
<td style="word-wrap: break-word;">true</td>
Expand Down
Loading