You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by zentol <gi...@git.apache.org> on 2018/02/12 17:20:51 UTC
[GitHub] flink pull request #5467: [FLINK-8475][config][docs] Integrate HA options
GitHub user zentol opened a pull request:
https://github.com/apache/flink/pull/5467
[FLINK-8475][config][docs] Integrate HA options
## What is the purpose of the change
This PR integrates the HA `ConfigOptions` into the configuration docs generator.
## Brief change log
* Add missing descriptions to config options (derived from existing description/javadocs)
* integrate HA configuration table into `config.md`
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/zentol/flink 8475_ha
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/5467.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #5467
----
commit ac26a32d8fa947706e8bc6f279a1fc5603c5cc41
Author: zentol <ch...@...>
Date: 2018-01-30T13:38:10Z
[FLINK-8475][config][docs] Integrate HA options
----
---
[GitHub] flink pull request #5467: [FLINK-8475][config][docs] Integrate HA options
Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on a diff in the pull request:
https://github.com/apache/flink/pull/5467#discussion_r167838921
--- Diff: docs/_includes/generated/high_availability_configuration.html ---
@@ -0,0 +1,36 @@
+<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>high-availability</h5></td>
+ <td>"NONE"</td>
+ <td>Defines high-availability mode used for the cluster execution. To enable high-availability, set this mode to "ZOOKEEPER".</td>
--- End diff --
high-availability: how Zookeeper-based HA works is/should be explained in the [HA docs](https://ci.apache.org/projects/flink/flink-docs-master/ops/jobmanager_high_availability.html#yarn-cluster-high-availability)
cluster-id: derived from javadocs, as the existing docs were entirely about ZK setups
job.delay: derived from javadocs, as i assume it to be more up-to-date than the ZK specific description
jobmanager.port: undocumented before
storageDir: derived from javadocs, as i assume it to be more up-to-date than the ZK specific description
---
[GitHub] flink pull request #5467: [FLINK-8475][config][docs] Integrate HA options
Posted by aljoscha <gi...@git.apache.org>.
Github user aljoscha commented on a diff in the pull request:
https://github.com/apache/flink/pull/5467#discussion_r167831138
--- Diff: docs/_includes/generated/high_availability_configuration.html ---
@@ -0,0 +1,36 @@
+<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>high-availability</h5></td>
+ <td>"NONE"</td>
+ <td>Defines high-availability mode used for the cluster execution. To enable high-availability, set this mode to "ZOOKEEPER".</td>
--- End diff --
Why do these not have all the description that the original doc has?
---
[GitHub] flink issue #5467: [FLINK-8475][config][docs] Integrate HA options
Posted by aljoscha <gi...@git.apache.org>.
Github user aljoscha commented on the issue:
https://github.com/apache/flink/pull/5467
Ok, then please go ahead.
---
[GitHub] flink issue #5467: [FLINK-8475][config][docs] Integrate HA options
Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on the issue:
https://github.com/apache/flink/pull/5467
merging
---
[GitHub] flink pull request #5467: [FLINK-8475][config][docs] Integrate HA options
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/flink/pull/5467
---