From e9ac3a9b54857683fefcc89bf74d06cdfda000bd Mon Sep 17 00:00:00 2001
From: Robert Metzger <rmetzger@apache.org>
Date: Wed, 15 Jul 2015 16:08:43 +0200
Subject: [PATCH] [docs] Document some missing configuration parameters

---
 docs/setup/config.md                          | 22 +++++++++++++++
 .../flink/configuration/ConfigConstants.java  | 28 +++++++++++++++++++
 2 files changed, 50 insertions(+)

diff --git a/docs/setup/config.md b/docs/setup/config.md
index 4f7378d6c7c59..ba541d4ba5a6c 100644
--- a/docs/setup/config.md
+++ b/docs/setup/config.md
@@ -39,6 +39,7 @@ file require restarting the Flink JobManager and TaskManagers.
 The configuration files for the TaskManagers can be different, Flink does not assume 
 uniform machines in the cluster.
 
+
 * This will be replaced by the TOC
 {:toc}
 
@@ -147,6 +148,27 @@ JVM's heap space for internal data buffers, leaving 20% of the JVM's heap space
 free for objects created by user-defined functions. (DEFAULT: 0.7)
 This parameter is only evaluated, if `taskmanager.memory.size` is not set.
 
+- `env.java.opts`: Set custom JVM options. This value is respected by Flink's start scripts
+and Flink's YARN client.
+This can be used to set different garbage collectors or to include remote debuggers into 
+the JVMs running Flink's services.
+
+- `state.backend`: The backend that will be used to store operator state checkpoints if checkpointing is enabled. 
+  
+  Supported backends: 
+  
+   -  `jobmanager` (in-memory)
+   -  `filesystem` (all filesystems supported by Flink, for example HDFS)
+
+- `state.backend.fs.checkpointdir`: Directory for storing checkpoints in a flink supported filesystem
+Note: State backend must be accessible from the JobManager, use file:// only for local setups. 
+
+- `blob.storage.directory`: Directory for storing blobs (such as user jar's) on the TaskManagers.
+
+- `execution-retries.delay`: Delay between execution retries. Default value "100 s". Note that values
+have to be specified as strings with a unit.
+
+- `execution-retries.default`: Default number of execution retries (Can also be set on a per-job basis).
 
 ## Full Reference
 
diff --git a/flink-core/src/main/java/org/apache/flink/configuration/ConfigConstants.java b/flink-core/src/main/java/org/apache/flink/configuration/ConfigConstants.java
index e3b8b53df160f..5f4cd6dec3673 100644
--- a/flink-core/src/main/java/org/apache/flink/configuration/ConfigConstants.java
+++ b/flink-core/src/main/java/org/apache/flink/configuration/ConfigConstants.java
@@ -18,6 +18,13 @@
 
 package org.apache.flink.configuration;
 
+import org.apache.commons.io.FileUtils;
+import org.apache.flink.util.StringUtils;
+
+import java.io.File;
+import java.lang.reflect.Field;
+import java.lang.reflect.Modifier;
+
 /**
  * This class contains all constants for the configuration. That includes the configuration keys and
  * the default values.
@@ -730,4 +737,25 @@ public final class ConfigConstants {
 	 * Not instantiable.
 	 */
 	private ConfigConstants() {}
+
+
+	/**
+	 * Config constants completeness checker utility
+	 */
+	public static void main(String[] args) throws Exception {
+		String configFileContents = FileUtils.readFileToString(new File("docs/setup/config.md"));
+		Field[] fields = ConfigConstants.class.getFields();
+		for(Field field : fields) {
+			if(Modifier.isStatic(field.getModifiers()) && field.getType().equals(String.class) && !field.getName().startsWith("DEFAULT")) {
+
+
+				Object val = field.get(ConfigConstants.class);
+
+				System.out.println("Found static field "+field+" = "+val);
+				if(!configFileContents.contains((String)val)) {
+					System.out.println("++++ "+val+" is not mentioned in the configuration file!!!");
+				}
+			}
+		}
+	}
 }