[FLINK-8475][config][docs] Integrate REST options

This closes #5389.


Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/00cae708
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/00cae708
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/00cae708

Branch: refs/heads/master
Commit: 00cae7089ff698f23644169ccdb30f100aeb1545
Parents: b5d7d7c
Author: zentol <ches...@apache.org>
Authored: Tue Jan 23 14:52:22 2018 +0100
Committer: zentol <ches...@apache.org>
Committed: Mon Feb 12 18:48:54 2018 +0100

----------------------------------------------------------------------
 .../_includes/generated/rest_configuration.html | 41 ++++++++++++++++++++
 docs/ops/config.md                              |  4 ++
 2 files changed, 45 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flink/blob/00cae708/docs/_includes/generated/rest_configuration.html
----------------------------------------------------------------------
diff --git a/docs/_includes/generated/rest_configuration.html 
b/docs/_includes/generated/rest_configuration.html
new file mode 100644
index 0000000..af72387
--- /dev/null
+++ b/docs/_includes/generated/rest_configuration.html
@@ -0,0 +1,41 @@
+<table class="table table-bordered">
+    <thead>
+        <tr>
+            <th class="text-left" style="width: 20%">Key</th>
+            <th class="text-left" style="width: 15%">Default</th>
+            <th class="text-left" style="width: 65%">Description</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td><h5>rest.address</h5></td>
+            <td>"localhost"</td>
+            <td>The address that the server binds itself to / the client 
connects to.</td>
+        </tr>
+        <tr>
+            <td><h5>rest.await-leader-timeout</h5></td>
+            <td>30000</td>
+            <td>The time in ms that the client waits for the leader address, 
e.g., Dispatcher or WebMonitorEndpoint</td>
+        </tr>
+        <tr>
+            <td><h5>rest.connection-timeout</h5></td>
+            <td>15000</td>
+            <td>The maximum time in ms for the client to establish a TCP 
connection.</td>
+        </tr>
+        <tr>
+            <td><h5>rest.port</h5></td>
+            <td>9065</td>
+            <td>The port that the server listens on / the client connects 
to.</td>
+        </tr>
+        <tr>
+            <td><h5>rest.retry.delay</h5></td>
+            <td>3000</td>
+            <td>The time in ms that the client waits between retries (See also 
`rest.retry.max-attempts`).</td>
+        </tr>
+        <tr>
+            <td><h5>rest.retry.max-attempts</h5></td>
+            <td>20</td>
+            <td>The number of retries the client will attempt if a retryable 
operations fails.</td>
+        </tr>
+    </tbody>
+</table>

http://git-wip-us.apache.org/repos/asf/flink/blob/00cae708/docs/ops/config.md
----------------------------------------------------------------------
diff --git a/docs/ops/config.md b/docs/ops/config.md
index cf77546..dc24955 100644
--- a/docs/ops/config.md
+++ b/docs/ops/config.md
@@ -328,6 +328,10 @@ The following parameters configure Flink's JobManager and 
TaskManagers.
 
 {% include generated/akka_configuration.html %}
 
+### REST
+
+{% include generated/rest_configuration.html %}
+
 ### SSL Settings
 
 - `security.ssl.enabled`: Turns on SSL for internal network communication. 
This can be optionally overridden by flags defined in different transport 
modules (DEFAULT: **false**).

Reply via email to