You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by al...@apache.org on 2019/01/16 14:05:51 UTC

[flink] branch master updated: [FLINK-11295][conf] Rename configuration options of queryable-state from query.x to queryable-state.x

This is an automated email from the ASF dual-hosted git repository.

aljoscha pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git


The following commit(s) were added to refs/heads/master by this push:
     new f61d112  [FLINK-11295][conf] Rename configuration options of queryable-state from query.x to queryable-state.x
f61d112 is described below

commit f61d1129e277a23fcf6113211c344e8b89da49e8
Author: eaglewatcherwb <wb...@gmail.com>
AuthorDate: Sun Jan 13 10:23:08 2019 +0800

    [FLINK-11295][conf] Rename configuration options of queryable-state from query.x to queryable-state.x
    
    Change-Id: Idb561da3982de07e77a05ffef9ad227094f527b0
---
 .../generated/queryable_state_configuration.html   | 24 +++++++--------
 docs/dev/stream/state/queryable_state.md           | 12 ++++----
 .../kubernetes/job-cluster-job.yaml.template       |  2 +-
 .../flink/configuration/QueryableStateOptions.java | 35 +++++++++++++---------
 flink-end-to-end-tests/test-scripts/common.sh      |  4 +--
 .../job-cluster-job.yaml.template                  |  2 +-
 6 files changed, 43 insertions(+), 36 deletions(-)

diff --git a/docs/_includes/generated/queryable_state_configuration.html b/docs/_includes/generated/queryable_state_configuration.html
index 5940fdc..91eaf91 100644
--- a/docs/_includes/generated/queryable_state_configuration.html
+++ b/docs/_includes/generated/queryable_state_configuration.html
@@ -8,44 +8,44 @@
     </thead>
     <tbody>
         <tr>
-            <td><h5>query.client.network-threads</h5></td>
+            <td><h5>queryable-state.client.network-threads</h5></td>
             <td style="word-wrap: break-word;">0</td>
             <td>Number of network (Netty's event loop) Threads for queryable state client.</td>
         </tr>
         <tr>
-            <td><h5>query.proxy.network-threads</h5></td>
+            <td><h5>queryable-state.enable</h5></td>
+            <td style="word-wrap: break-word;">false</td>
+            <td>Option whether the queryable state proxy and server should be enabled where possible and configurable.</td>
+        </tr>
+        <tr>
+            <td><h5>queryable-state.proxy.network-threads</h5></td>
             <td style="word-wrap: break-word;">0</td>
             <td>Number of network (Netty's event loop) Threads for queryable state proxy.</td>
         </tr>
         <tr>
-            <td><h5>query.proxy.ports</h5></td>
+            <td><h5>queryable-state.proxy.ports</h5></td>
             <td style="word-wrap: break-word;">"9069"</td>
             <td>The port range of the queryable state proxy. The specified range can be a single port: "9123", a range of ports: "50100-50200", or a list of ranges and ports: "50100-50200,50300-50400,51234".</td>
         </tr>
         <tr>
-            <td><h5>query.proxy.query-threads</h5></td>
+            <td><h5>queryable-state.proxy.query-threads</h5></td>
             <td style="word-wrap: break-word;">0</td>
             <td>Number of query Threads for queryable state proxy. Uses the number of slots if set to 0.</td>
         </tr>
         <tr>
-            <td><h5>query.server.network-threads</h5></td>
+            <td><h5>queryable-state.server.network-threads</h5></td>
             <td style="word-wrap: break-word;">0</td>
             <td>Number of network (Netty's event loop) Threads for queryable state server.</td>
         </tr>
         <tr>
-            <td><h5>query.server.ports</h5></td>
+            <td><h5>queryable-state.server.ports</h5></td>
             <td style="word-wrap: break-word;">"9067"</td>
             <td>The port range of the queryable state server. The specified range can be a single port: "9123", a range of ports: "50100-50200", or a list of ranges and ports: "50100-50200,50300-50400,51234".</td>
         </tr>
         <tr>
-            <td><h5>query.server.query-threads</h5></td>
+            <td><h5>queryable-state.server.query-threads</h5></td>
             <td style="word-wrap: break-word;">0</td>
             <td>Number of query Threads for queryable state server. Uses the number of slots if set to 0.</td>
         </tr>
-        <tr>
-            <td><h5>queryable-state.enable</h5></td>
-            <td style="word-wrap: break-word;">false</td>
-            <td>Option whether the queryable state proxy and server should be enabled where possible and configurable.</td>
-        </tr>
     </tbody>
 </table>
diff --git a/docs/dev/stream/state/queryable_state.md b/docs/dev/stream/state/queryable_state.md
index 4fd2186..7963487 100644
--- a/docs/dev/stream/state/queryable_state.md
+++ b/docs/dev/stream/state/queryable_state.md
@@ -290,19 +290,19 @@ The following configuration parameters influence the behaviour of the queryable
 They are defined in `QueryableStateOptions`.
 
 ### State Server
-* `query.server.ports`: the server port range of the queryable state server. This is useful to avoid port clashes if more 
+* `queryable-state.server.ports`: the server port range of the queryable state server. This is useful to avoid port clashes if more 
    than 1 task managers run on the same machine. The specified range can be: a port: "9123", a range of ports: "50100-50200",
    or a list of ranges and or points: "50100-50200,50300-50400,51234". The default port is 9067.
-* `query.server.network-threads`: number of network (event loop) threads receiving incoming requests for the state server (0 => #slots)
-* `query.server.query-threads`: number of threads handling/serving incoming requests for the state server (0 => #slots).
+* `queryable-state.server.network-threads`: number of network (event loop) threads receiving incoming requests for the state server (0 => #slots)
+* `queryable-state.server.query-threads`: number of threads handling/serving incoming requests for the state server (0 => #slots).
 
 
 ### Proxy
-* `query.proxy.ports`: the server port range of the queryable state proxy. This is useful to avoid port clashes if more 
+* `queryable-state.proxy.ports`: the server port range of the queryable state proxy. This is useful to avoid port clashes if more 
   than 1 task managers run on the same machine. The specified range can be: a port: "9123", a range of ports: "50100-50200",
   or a list of ranges and or points: "50100-50200,50300-50400,51234". The default port is 9069.
-* `query.proxy.network-threads`: number of network (event loop) threads receiving incoming requests for the client proxy (0 => #slots)
-* `query.proxy.query-threads`: number of threads handling/serving incoming requests for the client proxy (0 => #slots).
+* `queryable-state.proxy.network-threads`: number of network (event loop) threads receiving incoming requests for the client proxy (0 => #slots)
+* `queryable-state.proxy.query-threads`: number of threads handling/serving incoming requests for the client proxy (0 => #slots).
 
 ## Limitations
 
diff --git a/flink-container/kubernetes/job-cluster-job.yaml.template b/flink-container/kubernetes/job-cluster-job.yaml.template
index 0bbb1a1..86db3c7 100644
--- a/flink-container/kubernetes/job-cluster-job.yaml.template
+++ b/flink-container/kubernetes/job-cluster-job.yaml.template
@@ -32,7 +32,7 @@ spec:
       - name: flink-job-cluster
         image: ${FLINK_IMAGE_NAME}
         args: ["job-cluster", "--job-classname", "${FLINK_JOB}", "-Djobmanager.rpc.address=flink-job-cluster",
-               "-Dparallelism.default=${FLINK_JOB_PARALLELISM}", "-Dblob.server.port=6124", "-Dquery.server.ports=6125"]
+               "-Dparallelism.default=${FLINK_JOB_PARALLELISM}", "-Dblob.server.port=6124", "-Dqueryable-state.server.ports=6125"]
         ports:
         - containerPort: 6123
           name: rpc
diff --git a/flink-core/src/main/java/org/apache/flink/configuration/QueryableStateOptions.java b/flink-core/src/main/java/org/apache/flink/configuration/QueryableStateOptions.java
index 20c6b53..253d4f3 100644
--- a/flink-core/src/main/java/org/apache/flink/configuration/QueryableStateOptions.java
+++ b/flink-core/src/main/java/org/apache/flink/configuration/QueryableStateOptions.java
@@ -51,23 +51,26 @@ public class QueryableStateOptions {
 	 * <p><b>The default port is 9069.</b>
 	 */
 	public static final ConfigOption<String> PROXY_PORT_RANGE =
-		key("query.proxy.ports")
+		key("queryable-state.proxy.ports")
 			.defaultValue("9069")
 			.withDescription("The port range of the queryable state proxy. The specified range can be a single " +
 				"port: \"9123\", a range of ports: \"50100-50200\", " +
-				"or a list of ranges and ports: \"50100-50200,50300-50400,51234\".");
+				"or a list of ranges and ports: \"50100-50200,50300-50400,51234\".")
+			.withDeprecatedKeys("query.proxy.ports");
 
 	/** Number of network (event loop) threads for the client proxy (0 => #slots). */
 	public static final ConfigOption<Integer> PROXY_NETWORK_THREADS =
-		key("query.proxy.network-threads")
+		key("queryable-state.proxy.network-threads")
 			.defaultValue(0)
-			.withDescription("Number of network (Netty's event loop) Threads for queryable state proxy.");
+			.withDescription("Number of network (Netty's event loop) Threads for queryable state proxy.")
+			.withDeprecatedKeys("query.proxy.network-threads");
 
 	/** Number of async query threads for the client proxy (0 => #slots). */
 	public static final ConfigOption<Integer> PROXY_ASYNC_QUERY_THREADS =
-		key("query.proxy.query-threads")
+		key("queryable-state.proxy.query-threads")
 			.defaultValue(0)
-			.withDescription("Number of query Threads for queryable state proxy. Uses the number of slots if set to 0.");
+			.withDescription("Number of query Threads for queryable state proxy. Uses the number of slots if set to 0.")
+			.withDeprecatedKeys("query.proxy.query-threads");
 
 	/**
 	 * The config parameter defining the server port range of the queryable state server.
@@ -88,23 +91,26 @@ public class QueryableStateOptions {
 	 * <p><b>The default port is 9067.</b>
 	 */
 	public static final ConfigOption<String> SERVER_PORT_RANGE =
-		key("query.server.ports")
+		key("queryable-state.server.ports")
 			.defaultValue("9067")
 			.withDescription("The port range of the queryable state server. The specified range can be a single " +
 				"port: \"9123\", a range of ports: \"50100-50200\", " +
-				"or a list of ranges and ports: \"50100-50200,50300-50400,51234\".");
+				"or a list of ranges and ports: \"50100-50200,50300-50400,51234\".")
+			.withDeprecatedKeys("query.server.ports");
 
 	/** Number of network (event loop) threads for the KvState server (0 => #slots). */
 	public static final ConfigOption<Integer> SERVER_NETWORK_THREADS =
-		key("query.server.network-threads")
+		key("queryable-state.server.network-threads")
 			.defaultValue(0)
-			.withDescription("Number of network (Netty's event loop) Threads for queryable state server.");
+			.withDescription("Number of network (Netty's event loop) Threads for queryable state server.")
+			.withDeprecatedKeys("query.server.network-threads");
 
 	/** Number of async query threads for the KvStateServerHandler (0 => #slots). */
 	public static final ConfigOption<Integer> SERVER_ASYNC_QUERY_THREADS =
-		key("query.server.query-threads")
+		key("queryable-state.server.query-threads")
 			.defaultValue(0)
-			.withDescription("Number of query Threads for queryable state server. Uses the number of slots if set to 0.");
+			.withDescription("Number of query Threads for queryable state server. Uses the number of slots if set to 0.")
+			.withDeprecatedKeys("query.server.query-threads");
 
 	/** Option whether the queryable state proxy and server should be enabled where possible and configurable.
 	 *
@@ -122,9 +128,10 @@ public class QueryableStateOptions {
 
 	/** Number of network (event loop) threads for the KvState client (0 => Use number of available cores). */
 	public static final ConfigOption<Integer> CLIENT_NETWORK_THREADS =
-		key("query.client.network-threads")
+		key("queryable-state.client.network-threads")
 			.defaultValue(0)
-			.withDescription("Number of network (Netty's event loop) Threads for queryable state client.");
+			.withDescription("Number of network (Netty's event loop) Threads for queryable state client.")
+			.withDeprecatedKeys("query.client.network-threads");
 
 	// ------------------------------------------------------------------------
 
diff --git a/flink-end-to-end-tests/test-scripts/common.sh b/flink-end-to-end-tests/test-scripts/common.sh
index 645cf2a..cb2f551 100644
--- a/flink-end-to-end-tests/test-scripts/common.sh
+++ b/flink-end-to-end-tests/test-scripts/common.sh
@@ -152,8 +152,8 @@ function create_ha_config() {
 
     rest.port: 8081
 
-    query.server.ports: 9000-9009
-    query.proxy.ports: 9010-9019
+    queryable-state.server.ports: 9000-9009
+    queryable-state.proxy.ports: 9010-9019
 EOL
 }
 
diff --git a/flink-end-to-end-tests/test-scripts/container-scripts/job-cluster-job.yaml.template b/flink-end-to-end-tests/test-scripts/container-scripts/job-cluster-job.yaml.template
index 3785e6f..5823191 100644
--- a/flink-end-to-end-tests/test-scripts/container-scripts/job-cluster-job.yaml.template
+++ b/flink-end-to-end-tests/test-scripts/container-scripts/job-cluster-job.yaml.template
@@ -33,7 +33,7 @@ spec:
         image: ${FLINK_IMAGE_NAME}
         imagePullPolicy: Never
         args: ["job-cluster", "--job-classname", "${FLINK_JOB}", "-Djobmanager.rpc.address=flink-job-cluster",
-               "-Dparallelism.default=${FLINK_JOB_PARALLELISM}", "-Dblob.server.port=6124", "-Dquery.server.ports=6125",
+               "-Dparallelism.default=${FLINK_JOB_PARALLELISM}", "-Dblob.server.port=6124", "-Dqueryable-state.server.ports=6125",
                ${FLINK_JOB_ARGUMENTS}]
         ports:
         - containerPort: 6123