[FLINK-11779] Update documentation about ‘RestOptions’

mbalassi · Sep 23, 2020 · 6878d7c · 6878d7c
1 parent 0baa1c4
commit 6878d7c
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/docs/_includes/generated/common_host_port_section.html b/docs/_includes/generated/common_host_port_section.html
@@ -30,7 +30,7 @@
  <td><h5>rest.address</h5></td>
  <td style="word-wrap: break-word;">(none)</td>
  <td>String</td>
- <td>The address that should be used by clients to connect to the server.</td>
+ <td>The address that should be used by clients to connect to the server. Attention: This option is respected only if the high-availability configuration is NONE.</td>
  </tr>
  <tr>
  <td><h5>rest.bind-address</h5></td>
@@ -48,7 +48,7 @@
  <td><h5>rest.port</h5></td>
  <td style="word-wrap: break-word;">8081</td>
  <td>Integer</td>
- <td>The port that the client connects to. If rest.bind-port has not been specified, then the REST server will bind to this port.</td>
+ <td>The port that the client connects to. If rest.bind-port has not been specified, then the REST server will bind to this port. Attention: This option is respected only if the high-availability configuration is NONE.</td>
  </tr>
  <tr>
  <td><h5>taskmanager.data.port</h5></td>

diff --git a/docs/_includes/generated/rest_configuration.html b/docs/_includes/generated/rest_configuration.html
@@ -12,7 +12,7 @@
  <td><h5>rest.address</h5></td>
  <td style="word-wrap: break-word;">(none)</td>
  <td>String</td>
- <td>The address that should be used by clients to connect to the server.</td>
+ <td>The address that should be used by clients to connect to the server. Attention: This option is respected only if the high-availability configuration is NONE.</td>
  </tr>
  <tr>
  <td><h5>rest.await-leader-timeout</h5></td>
@@ -54,7 +54,7 @@
  <td><h5>rest.port</h5></td>
  <td style="word-wrap: break-word;">8081</td>
  <td>Integer</td>
- <td>The port that the client connects to. If rest.bind-port has not been specified, then the REST server will bind to this port.</td>
+ <td>The port that the client connects to. If rest.bind-port has not been specified, then the REST server will bind to this port. Attention: This option is respected only if the high-availability configuration is NONE.</td>
  </tr>
  <tr>
  <td><h5>rest.retry.delay</h5></td>