You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by tz...@apache.org on 2020/03/26 14:00:19 UTC
[flink-statefun] 01/13: [FLINK-16758][docs] Import Jekyll Setup
This is an automated email from the ASF dual-hosted git repository.
tzulitai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink-statefun.git
commit 8c7bbd0fbccc01d87bb5856b8f6a2ed7cebbeffe
Author: Seth Wiesman <sj...@gmail.com>
AuthorDate: Tue Mar 24 09:14:47 2020 -0500
[FLINK-16758][docs] Import Jekyll Setup
---
docs/.gitignore | 8 +
docs/404.md | 26 +
docs/Gemfile | 35 +
docs/Gemfile.lock | 94 +
docs/README.md | 157 +
docs/_config.yml | 110 +
docs/_config_dev_en.yml | 25 +
docs/_config_dev_zh.yml | 28 +
docs/_includes/generated/akka_configuration.html | 156 +
.../generated/algorithm_configuration.html | 30 +
.../generated/all_jobmanager_section.html | 66 +
.../generated/all_taskmanager_network_section.html | 96 +
.../generated/all_taskmanager_section.html | 115 +
.../generated/blob_server_configuration.html | 72 +
.../generated/checkpointing_configuration.html | 72 +
.../_includes/generated/cluster_configuration.html | 48 +
.../common_high_availability_section.html | 30 +
.../common_high_availability_zk_section.html | 24 +
.../generated/common_host_port_section.html | 72 +
.../_includes/generated/common_memory_section.html | 102 +
.../generated/common_miscellaneous_section.html | 30 +
.../generated/common_state_backends_section.html | 54 +
docs/_includes/generated/core_configuration.html | 66 +
.../generated/deployment_configuration.html | 30 +
.../generated/deprecated_file_sinks_section.html | 24 +
.../generated/environment_configuration.html | 66 +
.../execution_checkpointing_configuration.html | 60 +
.../generated/execution_config_configuration.html | 106 +
.../generated/execution_configuration.html | 24 +
.../generated/expert_class_loading_section.html | 30 +
.../generated/expert_fault_tolerance_section.html | 60 +
.../expert_high_availability_section.html | 18 +
.../expert_high_availability_zk_section.html | 84 +
docs/_includes/generated/expert_rest_section.html | 66 +
.../generated/expert_rocksdb_section.html | 36 +
.../generated/expert_scheduling_section.html | 30 +
.../generated/expert_security_ssl_section.html | 42 +
.../generated/expert_state_backends_section.html | 30 +
...ailure_rate_restart_strategy_configuration.html | 30 +
.../generated/file_system_configuration.html | 30 +
...fixed_delay_restart_strategy_configuration.html | 24 +
.../generated/heartbeat_manager_configuration.html | 24 +
.../generated/high_availability_configuration.html | 120 +
.../high_availability_zookeeper_configuration.html | 96 +
.../generated/history_server_configuration.html | 60 +
.../generated/influxdb_reporter_configuration.html | 66 +
.../generated/job_manager_configuration.html | 78 +
.../generated/kerberos_configuration.html | 36 +
.../generated/kubernetes_config_configuration.html | 114 +
docs/_includes/generated/mesos_configuration.html | 84 +
.../mesos_task_manager_configuration.html | 96 +
docs/_includes/generated/metric_configuration.html | 126 +
.../netty_shuffle_environment_configuration.html | 108 +
.../generated/network_netty_configuration.html | 54 +
.../generated/optimizer_config_configuration.html | 63 +
.../generated/optimizer_configuration.html | 30 +
.../generated/pipeline_configuration.html | 114 +
...etheus_push_gateway_reporter_configuration.html | 54 +
docs/_includes/generated/python_configuration.html | 42 +
.../generated/queryable_state_configuration.html | 60 +
.../generated/resource_manager_configuration.html | 48 +
docs/_includes/generated/rest_configuration.html | 90 +
docs/_includes/generated/rest_v1_dispatcher.html | 4196 ++++++++++++++++++++
.../generated/restart_strategy_configuration.html | 18 +
.../rocks_db_configurable_configuration.html | 84 +
.../generated/rocks_db_configuration.html | 66 +
.../rocks_db_native_metric_configuration.html | 168 +
.../generated/savepoint_config_configuration.html | 24 +
.../generated/security_auth_kerberos_section.html | 36 +
.../generated/security_auth_zk_section.html | 30 +
.../generated/security_configuration.html | 204 +
docs/_includes/generated/security_ssl_section.html | 120 +
.../generated/shuffle_service_configuration.html | 18 +
.../generated/state_backend_rocksdb_section.html | 42 +
.../generated/stream_pipeline_configuration.html | 18 +
.../generated/task_manager_configuration.html | 97 +
.../task_manager_memory_configuration.html | 108 +
docs/_includes/generated/web_configuration.html | 90 +
.../generated/yarn_config_configuration.html | 138 +
.../generated/zoo_keeper_configuration.html | 30 +
docs/_includes/latex_commands.html | 38 +
docs/_includes/sidenav.html | 187 +
docs/_layouts/404_base.html | 39 +
docs/_layouts/base.html | 118 +
docs/_layouts/plain.html | 78 +
docs/_layouts/redirect.html | 39 +
docs/_plugins/build_time.rb | 31 +
docs/_plugins/gh_link.rb | 52 +
docs/_plugins/info.rb | 37 +
docs/_plugins/panel.rb | 33 +
docs/_plugins/removeDuplicateLicenseHeaders.rb | 75 +
docs/_plugins/top.rb | 31 +
docs/_plugins/warn.rb | 41 +
docs/annotations.xml | 66 +
docs/build_docs.bat | 57 +
docs/build_docs.sh | 107 +
docs/check_links.sh | 39 +
docs/cse.xml | 85 +
docs/docker/Dockerfile | 31 +
docs/docker/run.sh | 73 +
docs/fig/LICENSE.txt | 17 +
docs/index.md | 74 +
docs/page/css/codetabs.css | 66 +
docs/page/css/flink.css | 316 ++
docs/page/css/syntax.css | 79 +
docs/page/favicon.ico | Bin 0 -> 1150 bytes
docs/page/font-awesome/css/font-awesome.css | 2199 ++++++++++
docs/page/font-awesome/css/font-awesome.min.css | 4 +
docs/page/font-awesome/fonts/FontAwesome.otf | Bin 0 -> 124988 bytes
.../font-awesome/fonts/fontawesome-webfont.eot | Bin 0 -> 76518 bytes
.../font-awesome/fonts/fontawesome-webfont.svg | 685 ++++
.../font-awesome/fonts/fontawesome-webfont.ttf | Bin 0 -> 152796 bytes
.../font-awesome/fonts/fontawesome-webfont.woff | Bin 0 -> 90412 bytes
.../font-awesome/fonts/fontawesome-webfont.woff2 | Bin 0 -> 71896 bytes
docs/page/img/LICENSE.txt | 17 +
docs/page/img/navbar-brand-logo.jpg | Bin 0 -> 18470 bytes
docs/page/js/flink.js | 127 +
docs/page/js/jquery.min.js | 4 +
docs/search-results.md | 36 +
119 files changed, 14237 insertions(+)
diff --git a/docs/.gitignore b/docs/.gitignore
new file mode 100644
index 0000000..3d6212d
--- /dev/null
+++ b/docs/.gitignore
@@ -0,0 +1,8 @@
+.bundle/
+.jekyll-metadata
+.jekyll-cache/
+.rubydeps/
+content/
+content_*/
+ruby2/.bundle/
+ruby2/.rubydeps/
diff --git a/docs/404.md b/docs/404.md
new file mode 100644
index 0000000..286c29f
--- /dev/null
+++ b/docs/404.md
@@ -0,0 +1,26 @@
+---
+title: "404"
+permalink: /404.html
+layout: 404_base
+---
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+The page you are looking for has been moved. This could be because of a recent reorganization of the
+documentation. Redirecting to [Documentation Home Page]({{ site.baseurl }}) in 5 seconds.
diff --git a/docs/Gemfile b/docs/Gemfile
new file mode 100644
index 0000000..3edc85d
--- /dev/null
+++ b/docs/Gemfile
@@ -0,0 +1,35 @@
+################################################################################
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+################################################################################
+
+source 'https://rubygems.org'
+
+ruby '>= 2.4.0'
+
+gem 'jekyll', '4.0.0'
+gem 'addressable', '2.7.0'
+gem 'octokit', '4.14.0'
+gem 'therubyracer', '0.12.3'
+gem 'json', '2.2.0'
+gem 'jekyll-multiple-languages', '2.0.3'
+gem 'jekyll-paginate', '1.1.0'
+gem 'liquid-c', '4.0.0' # speed-up site generation
+gem 'sassc', '2.2.1' # speed-up site generation
+
+# group :jekyll_plugins do
+# gem 'hawkins'
+# end
diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock
new file mode 100644
index 0000000..9af2cbf
--- /dev/null
+++ b/docs/Gemfile.lock
@@ -0,0 +1,94 @@
+GEM
+ remote: https://rubygems.org/
+ specs:
+ addressable (2.7.0)
+ public_suffix (>= 2.0.2, < 5.0)
+ colorator (1.1.0)
+ concurrent-ruby (1.1.5)
+ em-websocket (0.5.1)
+ eventmachine (>= 0.12.9)
+ http_parser.rb (~> 0.6.0)
+ eventmachine (1.2.7)
+ faraday (0.17.0)
+ multipart-post (>= 1.2, < 3)
+ ffi (1.11.2)
+ forwardable-extended (2.6.0)
+ http_parser.rb (0.6.0)
+ i18n (1.7.0)
+ concurrent-ruby (~> 1.0)
+ jekyll (4.0.0)
+ addressable (~> 2.4)
+ colorator (~> 1.0)
+ em-websocket (~> 0.5)
+ i18n (>= 0.9.5, < 2)
+ jekyll-sass-converter (~> 2.0)
+ jekyll-watch (~> 2.0)
+ kramdown (~> 2.1)
+ kramdown-parser-gfm (~> 1.0)
+ liquid (~> 4.0)
+ mercenary (~> 0.3.3)
+ pathutil (~> 0.9)
+ rouge (~> 3.0)
+ safe_yaml (~> 1.0)
+ terminal-table (~> 1.8)
+ jekyll-multiple-languages (2.0.3)
+ jekyll-paginate (1.1.0)
+ jekyll-sass-converter (2.0.1)
+ sassc (> 2.0.1, < 3.0)
+ jekyll-watch (2.2.1)
+ listen (~> 3.0)
+ json (2.2.0)
+ kramdown (2.1.0)
+ kramdown-parser-gfm (1.1.0)
+ kramdown (~> 2.0)
+ libv8 (3.16.14.19)
+ liquid (4.0.3)
+ liquid-c (4.0.0)
+ liquid (>= 3.0.0)
+ listen (3.2.0)
+ rb-fsevent (~> 0.10, >= 0.10.3)
+ rb-inotify (~> 0.9, >= 0.9.10)
+ mercenary (0.3.6)
+ multipart-post (2.1.1)
+ octokit (4.14.0)
+ sawyer (~> 0.8.0, >= 0.5.3)
+ pathutil (0.16.2)
+ forwardable-extended (~> 2.6)
+ public_suffix (4.0.1)
+ rb-fsevent (0.10.3)
+ rb-inotify (0.10.0)
+ ffi (~> 1.0)
+ ref (2.0.0)
+ rouge (3.13.0)
+ safe_yaml (1.0.5)
+ sassc (2.2.1)
+ ffi (~> 1.9)
+ sawyer (0.8.2)
+ addressable (>= 2.3.5)
+ faraday (> 0.8, < 2.0)
+ terminal-table (1.8.0)
+ unicode-display_width (~> 1.1, >= 1.1.1)
+ therubyracer (0.12.3)
+ libv8 (~> 3.16.14.15)
+ ref
+ unicode-display_width (1.6.0)
+
+PLATFORMS
+ ruby
+
+DEPENDENCIES
+ addressable (= 2.7.0)
+ jekyll (= 4.0.0)
+ jekyll-multiple-languages (= 2.0.3)
+ jekyll-paginate (= 1.1.0)
+ json (= 2.2.0)
+ liquid-c (= 4.0.0)
+ octokit (= 4.14.0)
+ sassc (= 2.2.1)
+ therubyracer (= 0.12.3)
+
+RUBY VERSION
+ ruby 2.6.3p62
+
+BUNDLED WITH
+ 1.17.2
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..c3d5f63
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,157 @@
+This README gives an overview of how to build and contribute to the documentation of Apache Flink.
+
+The documentation is included with the source of Apache Flink in order to ensure that you always
+have docs corresponding to your checked out version. The online documentation at
+https://flink.apache.org/ is also generated from the files found here.
+
+# Requirements
+
+The dependencies are declared in the Gemfile in this directory. We use Markdown
+to write and Jekyll to translate the documentation to static HTML. All required
+dependencies are installed locally when you build the documentation through the
+`build_docs.sh` script. If you want to install the software manually, use Ruby's
+Bundler Gem to install all dependencies:
+
+ gem install bundler -v 1.16.1
+ bundle install
+
+Note that in Ubuntu based systems, it may be necessary to install the following
+packages: `rubygems ruby-dev libssl-dev build-essential`.
+
+# Using Dockerized Jekyll
+
+We dockerized the jekyll environment above. If you have [docker](https://docs.docker.com/),
+you can run following command to start the container.
+
+```
+cd flink/docs/docker
+./run.sh
+```
+
+It takes a few moment to build the image for the first time, but will be a second from the second time.
+The run.sh command brings you in a bash session where you run the `./build_docs.sh` script mentioned above.
+
+
+# Build
+
+The `docs/build_docs.sh` script installs dependencies locally, calls Jekyll, and
+generates the documentation in `docs/content`. You can then point your browser
+to `docs/content/index.html` and start reading.
+
+If you call the script with the preview flag `build_docs.sh -p`, Jekyll will
+start a web server at `localhost:4000` and watch the docs directory for
+updates. Use this mode to preview changes locally.
+
+You can call the script with the incremental flag `build_docs.sh -i`.
+Jekyll will then serve a live preview at `localhost:4000`,
+and it will be much faster because it will only rebuild the pages corresponding
+to files that are modified. Note that if you are making changes that affect
+the sidebar navigation, you'll have to build the entire site to see
+those changes reflected on every page.
+
+| Flag | Action |
+| -----| -------|
+| -p | Run interactive preview |
+| -i | Incremental builds |
+| -e | Build only English docs |
+| -z | Build only Chinese docs |
+
+## Generate configuration tables
+
+Configuration descriptions are auto generated from code. To trigger the generation you need to run:
+
+```
+mvn -Pgenerate-config-docs install
+```
+
+The resulting html files will be written to `_includes/generated`. Tables are regenerated each time the command is invoked.
+These tables can be directly included into the documentation:
+
+```
+{% include generated/file_name.html %}
+```
+
+# Contribute
+
+## Markdown
+
+The documentation pages are written in [Markdown](http://daringfireball.net/projects/markdown/syntax). It is possible to use [GitHub flavored syntax](http://github.github.com/github-flavored-markdown) and intermix plain html.
+
+## Front matter
+
+In addition to Markdown, every page contains a Jekyll front matter, which specifies the title of the page and the layout to use. The title is used as the top-level heading for the page. The default layout is `plain` (found in `_layouts`).
+
+ ---
+ title: "Title of the Page"
+ ---
+
+Furthermore, you can access variables found in `docs/_config.yml` as follows:
+
+ {{ site.NAME }}
+
+This will be replaced with the value of the variable called `NAME` when generating the docs.
+
+## Structure
+
+### Page
+
+#### Headings
+
+All documents are structured with headings. From these headings, you can automatically generate a page table of contents (see below).
+
+```
+# Level-1 Heading <- Used for the title of the page (don't use this)
+## Level-2 Heading <- Start with this one
+### Level-3 heading
+#### Level-4 heading
+##### Level-5 heading
+```
+
+Please stick to the "logical order" when using the headlines, e.g. start with level-2 headings and use level-3 headings for subsections, etc. Don't use a different ordering, because you don't like how a headline looks.
+
+#### Table of Contents
+
+ * This will be replaced by the TOC
+ {:toc}
+
+
+Add this markup (both lines) to the document in order to generate a table of contents for the page. Headings until level 3 headings are included.
+
+You can exclude a heading from the table of contents:
+
+ # Excluded heading
+ {:.no_toc}
+
+#### Back to Top
+
+ {% top %}
+
+This will be replaced by a default back to top link. It is recommended to use these links at least at the end of each level-2 section.
+
+#### Labels
+
+ {% info %}
+ {% warn %}
+
+These will be replaced by a info or warning label. You can change the text of the label by providing an argument:
+
+ {% info Recommendation %}
+
+### Documentation
+
+#### Navigation
+
+The navigation on the left side of the docs is automatically generated when building the docs. You can modify the markup in `_include/sidenav.html`.
+
+The structure of the navigation is determined by the front matter of all pages. The fields used to determine the structure are:
+
+- `nav-id` => ID of this page. Other pages can use this ID as their parent ID.
+- `nav-parent_id` => ID of the parent. This page will be listed under the page with id `nav-parent_id`.
+
+Level 0 is made up of all pages, which have nav-parent_id set to `root`. There is no limitation on how many levels you can nest.
+
+The `title` of the page is used as the default link text. You can override this via `nav-title`. The relative position per navigational level is determined by `nav-pos`.
+
+If you have a page with sub pages, the link target will be used to expand the sub level navigation. If you want to actually add a link to the page as well, you can add the `nav-show_overview: true` field to the front matter. This will then add an `Overview` sub page to the expanded list.
+
+The nesting is also used for the breadcrumbs like `Application Development > Libraries > Machine Learning > Optimization`.
diff --git a/docs/_config.yml b/docs/_config.yml
new file mode 100644
index 0000000..7d4dc7b
--- /dev/null
+++ b/docs/_config.yml
@@ -0,0 +1,110 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+#------------------------------------------------------------------------------
+# VARIABLES
+#------------------------------------------------------------------------------
+# Variables specified in this file can be used in the documentation via:
+# {{ site.CONFIG_KEY }}
+#------------------------------------------------------------------------------
+
+# This are the version referenced in the docs. Please only use these variables
+# to reference a specific Flink version, because this is the only place where
+# we change the version for the complete docs when forking of a release branch
+# etc.
+# The full version string as referenced in Maven (e.g. 1.2.1)
+version: "1.11-SNAPSHOT"
+# For stable releases, leave the bugfix version out (e.g. 1.2). For snapshot
+# release this should be the same as the regular version
+version_title: "1.11-SNAPSHOT"
+# Branch on Github for this version
+github_branch: "master"
+
+# Plain Scala version is needed for e.g. the Gradle quickstart.
+scala_version: "2.11"
+# This suffix is appended to the Scala-dependent Maven artifact names
+scala_version_suffix: "_2.11"
+
+# Plain flink-shaded version is needed for e.g. the hive connector.
+# Please update the shaded_version once new flink-shaded is released.
+shaded_version: "8.0"
+
+# Some commonly linked pages (this was more important to have as a variable
+# during incubator; by now it should also be fine to hardcode these.)
+website_url: "https://flink.apache.org"
+jira_url: "https://issues.apache.org/jira/browse/FLINK"
+github_url: "https://github.com/apache/flink"
+download_url: "https://flink.apache.org/downloads.html"
+
+# please use a protocol relative URL here
+baseurl: //ci.apache.org/projects/flink/flink-docs-master
+stable_baseurl: //ci.apache.org/projects/flink/flink-docs-stable
+
+javadocs_baseurl: //ci.apache.org/projects/flink/flink-docs-master
+pythondocs_baseurl: //ci.apache.org/projects/flink/flink-docs-master
+
+# Flag whether this is a stable version or not. Used for the quickstart page.
+is_stable: false
+
+# Flag to indicate whether an outdated warning should be shown.
+show_outdated_warning: false
+
+previous_docs:
+ 1.10: http://ci.apache.org/projects/flink/flink-docs-release-1.10
+ 1.9: http://ci.apache.org/projects/flink/flink-docs-release-1.9
+ 1.8: http://ci.apache.org/projects/flink/flink-docs-release-1.8
+ 1.7: http://ci.apache.org/projects/flink/flink-docs-release-1.7
+ 1.6: http://ci.apache.org/projects/flink/flink-docs-release-1.6
+ 1.5: http://ci.apache.org/projects/flink/flink-docs-release-1.5
+ 1.4: http://ci.apache.org/projects/flink/flink-docs-release-1.4
+ 1.3: http://ci.apache.org/projects/flink/flink-docs-release-1.3
+ 1.2: http://ci.apache.org/projects/flink/flink-docs-release-1.2
+ 1.1: http://ci.apache.org/projects/flink/flink-docs-release-1.1
+ 1.0: http://ci.apache.org/projects/flink/flink-docs-release-1.0
+
+#------------------------------------------------------------------------------
+# BUILD CONFIG
+#------------------------------------------------------------------------------
+# These variables configure the jekyll build (./build_docs.sh). You don't need
+# to change anything here.
+#------------------------------------------------------------------------------
+
+exclude:
+ - "build_docs.sh"
+ - "build_docs.bat"
+ - "check_links.sh"
+
+# Used in some documents to initialize arrays. Don't delete.
+array: []
+
+defaults:
+ -
+ scope:
+ path: ""
+ values:
+ layout: plain
+ nav-pos: 99999 # Move to end if no pos specified
+
+host: 0.0.0.0
+
+kramdown:
+ toc_levels: 1..3 # Include h1-h3 for ToC
+
+# The all languages used
+languages: ['en', 'zh']
+
+plugins: ['jekyll-paginate', 'jekyll-multiple-languages']
diff --git a/docs/_config_dev_en.yml b/docs/_config_dev_en.yml
new file mode 100644
index 0000000..a7ca0d0
--- /dev/null
+++ b/docs/_config_dev_en.yml
@@ -0,0 +1,25 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License
+
+exclude:
+ - "*.zh.md"
+ - "build_docs.sh"
+ - "build_docs.bat"
+ - "check_links.sh"
+ - "content"
+ - "content_en"
+ - "content_zh"
diff --git a/docs/_config_dev_zh.yml b/docs/_config_dev_zh.yml
new file mode 100644
index 0000000..813a636
--- /dev/null
+++ b/docs/_config_dev_zh.yml
@@ -0,0 +1,28 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License
+
+exclude:
+ - "*.md"
+ - "build_docs.sh"
+ - "build_docs.bat"
+ - "check_links.sh"
+ - "content"
+ - "content_en"
+ - "content_zh"
+
+include:
+ - "*.zh.md"
diff --git a/docs/_includes/generated/akka_configuration.html b/docs/_includes/generated/akka_configuration.html
new file mode 100644
index 0000000..2baeb6f
--- /dev/null
+++ b/docs/_includes/generated/akka_configuration.html
@@ -0,0 +1,156 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>akka.ask.callstack</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>If true, call stack for asynchronous asks are captured. That way, when an ask fails (for example times out), you get a proper exception, describing to the original method call and call site. Note that in case of having millions of concurrent RPC calls, this may add to the memory footprint.</td>
+ </tr>
+ <tr>
+ <td><h5>akka.ask.timeout</h5></td>
+ <td style="word-wrap: break-word;">"10 s"</td>
+ <td>String</td>
+ <td>Timeout used for all futures and blocking Akka calls. If Flink fails due to timeouts then you should try to increase this value. Timeouts can be caused by slow machines or a congested network. The timeout value requires a time-unit specifier (ms/s/min/h/d).</td>
+ </tr>
+ <tr>
+ <td><h5>akka.client-socket-worker-pool.pool-size-factor</h5></td>
+ <td style="word-wrap: break-word;">1.0</td>
+ <td>Double</td>
+ <td>The pool size factor is used to determine thread pool size using the following formula: ceil(available processors * factor). Resulting size is then bounded by the pool-size-min and pool-size-max values.</td>
+ </tr>
+ <tr>
+ <td><h5>akka.client-socket-worker-pool.pool-size-max</h5></td>
+ <td style="word-wrap: break-word;">2</td>
+ <td>Integer</td>
+ <td>Max number of threads to cap factor-based number to.</td>
+ </tr>
+ <tr>
+ <td><h5>akka.client-socket-worker-pool.pool-size-min</h5></td>
+ <td style="word-wrap: break-word;">1</td>
+ <td>Integer</td>
+ <td>Min number of threads to cap factor-based number to.</td>
+ </tr>
+ <tr>
+ <td><h5>akka.client.timeout</h5></td>
+ <td style="word-wrap: break-word;">"60 s"</td>
+ <td>String</td>
+ <td>Timeout for all blocking calls on the client side.</td>
+ </tr>
+ <tr>
+ <td><h5>akka.fork-join-executor.parallelism-factor</h5></td>
+ <td style="word-wrap: break-word;">2.0</td>
+ <td>Double</td>
+ <td>The parallelism factor is used to determine thread pool size using the following formula: ceil(available processors * factor). Resulting size is then bounded by the parallelism-min and parallelism-max values.</td>
+ </tr>
+ <tr>
+ <td><h5>akka.fork-join-executor.parallelism-max</h5></td>
+ <td style="word-wrap: break-word;">64</td>
+ <td>Integer</td>
+ <td>Max number of threads to cap factor-based parallelism number to.</td>
+ </tr>
+ <tr>
+ <td><h5>akka.fork-join-executor.parallelism-min</h5></td>
+ <td style="word-wrap: break-word;">8</td>
+ <td>Integer</td>
+ <td>Min number of threads to cap factor-based parallelism number to.</td>
+ </tr>
+ <tr>
+ <td><h5>akka.framesize</h5></td>
+ <td style="word-wrap: break-word;">"10485760b"</td>
+ <td>String</td>
+ <td>Maximum size of messages which are sent between the JobManager and the TaskManagers. If Flink fails because messages exceed this limit, then you should increase it. The message size requires a size-unit specifier.</td>
+ </tr>
+ <tr>
+ <td><h5>akka.jvm-exit-on-fatal-error</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>Exit JVM on fatal Akka errors.</td>
+ </tr>
+ <tr>
+ <td><h5>akka.log.lifecycle.events</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Turns on the Akka’s remote logging of events. Set this value to 'true' in case of debugging.</td>
+ </tr>
+ <tr>
+ <td><h5>akka.lookup.timeout</h5></td>
+ <td style="word-wrap: break-word;">"10 s"</td>
+ <td>String</td>
+ <td>Timeout used for the lookup of the JobManager. The timeout value has to contain a time-unit specifier (ms/s/min/h/d).</td>
+ </tr>
+ <tr>
+ <td><h5>akka.retry-gate-closed-for</h5></td>
+ <td style="word-wrap: break-word;">50</td>
+ <td>Long</td>
+ <td>Milliseconds a gate should be closed for after a remote connection was disconnected.</td>
+ </tr>
+ <tr>
+ <td><h5>akka.server-socket-worker-pool.pool-size-factor</h5></td>
+ <td style="word-wrap: break-word;">1.0</td>
+ <td>Double</td>
+ <td>The pool size factor is used to determine thread pool size using the following formula: ceil(available processors * factor). Resulting size is then bounded by the pool-size-min and pool-size-max values.</td>
+ </tr>
+ <tr>
+ <td><h5>akka.server-socket-worker-pool.pool-size-max</h5></td>
+ <td style="word-wrap: break-word;">2</td>
+ <td>Integer</td>
+ <td>Max number of threads to cap factor-based number to.</td>
+ </tr>
+ <tr>
+ <td><h5>akka.server-socket-worker-pool.pool-size-min</h5></td>
+ <td style="word-wrap: break-word;">1</td>
+ <td>Integer</td>
+ <td>Min number of threads to cap factor-based number to.</td>
+ </tr>
+ <tr>
+ <td><h5>akka.ssl.enabled</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>Turns on SSL for Akka’s remote communication. This is applicable only when the global ssl flag security.ssl.enabled is set to true.</td>
+ </tr>
+ <tr>
+ <td><h5>akka.startup-timeout</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Timeout after which the startup of a remote component is considered being failed.</td>
+ </tr>
+ <tr>
+ <td><h5>akka.tcp.timeout</h5></td>
+ <td style="word-wrap: break-word;">"20 s"</td>
+ <td>String</td>
+ <td>Timeout for all outbound connections. If you should experience problems with connecting to a TaskManager due to a slow network, you should increase this value.</td>
+ </tr>
+ <tr>
+ <td><h5>akka.throughput</h5></td>
+ <td style="word-wrap: break-word;">15</td>
+ <td>Integer</td>
+ <td>Number of messages that are processed in a batch before returning the thread to the pool. Low values denote a fair scheduling whereas high values can increase the performance at the cost of unfairness.</td>
+ </tr>
+ <tr>
+ <td><h5>akka.transport.heartbeat.interval</h5></td>
+ <td style="word-wrap: break-word;">"1000 s"</td>
+ <td>String</td>
+ <td>Heartbeat interval for Akka’s transport failure detector. Since Flink uses TCP, the detector is not necessary. Therefore, the detector is disabled by setting the interval to a very high value. In case you should need the transport failure detector, set the interval to some reasonable value. The interval value requires a time-unit specifier (ms/s/min/h/d).</td>
+ </tr>
+ <tr>
+ <td><h5>akka.transport.heartbeat.pause</h5></td>
+ <td style="word-wrap: break-word;">"6000 s"</td>
+ <td>String</td>
+ <td>Acceptable heartbeat pause for Akka’s transport failure detector. Since Flink uses TCP, the detector is not necessary. Therefore, the detector is disabled by setting the pause to a very high value. In case you should need the transport failure detector, set the pause to some reasonable value. The pause value requires a time-unit specifier (ms/s/min/h/d).</td>
+ </tr>
+ <tr>
+ <td><h5>akka.transport.threshold</h5></td>
+ <td style="word-wrap: break-word;">300.0</td>
+ <td>Double</td>
+ <td>Threshold for the transport failure detector. Since Flink uses TCP, the detector is not necessary and, thus, the threshold is set to a high value.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/algorithm_configuration.html b/docs/_includes/generated/algorithm_configuration.html
new file mode 100644
index 0000000..967e9d6
--- /dev/null
+++ b/docs/_includes/generated/algorithm_configuration.html
@@ -0,0 +1,30 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>taskmanager.runtime.hashjoin-bloom-filters</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Flag to activate/deactivate bloom filters in the hybrid hash join implementation. In cases where the hash join needs to spill to disk (datasets larger than the reserved fraction of memory), these bloom filters can greatly reduce the number of spilled records, at the cost some CPU cycles.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.runtime.max-fan</h5></td>
+ <td style="word-wrap: break-word;">128</td>
+ <td>Integer</td>
+ <td>The maximal fan-in for external merge joins and fan-out for spilling hash tables. Limits the number of file handles per operator, but may cause intermediate merging/partitioning, if set too small.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.runtime.sort-spilling-threshold</h5></td>
+ <td style="word-wrap: break-word;">0.8</td>
+ <td>Float</td>
+ <td>A sort operation starts spilling when this fraction of its memory budget is full.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/all_jobmanager_section.html b/docs/_includes/generated/all_jobmanager_section.html
new file mode 100644
index 0000000..ab01a85
--- /dev/null
+++ b/docs/_includes/generated/all_jobmanager_section.html
@@ -0,0 +1,66 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>jobmanager.archive.fs.dir</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Dictionary for JobManager to store the archives of completed jobs.</td>
+ </tr>
+ <tr>
+ <td><h5>jobmanager.execution.attempts-history-size</h5></td>
+ <td style="word-wrap: break-word;">16</td>
+ <td>Integer</td>
+ <td>The maximum number of prior execution attempts kept in history.</td>
+ </tr>
+ <tr>
+ <td><h5>jobmanager.execution.failover-strategy</h5></td>
+ <td style="word-wrap: break-word;">region</td>
+ <td>String</td>
+ <td>This option specifies how the job computation recovers from task failures. Accepted values are:<ul><li>'full': Restarts all tasks to recover the job.</li><li>'region': Restarts all tasks that could be affected by the task failure. More details can be found <a href="../dev/task_failure_recovery.html#restart-pipelined-region-failover-strategy">here</a>.</li></ul></td>
+ </tr>
+ <tr>
+ <td><h5>jobmanager.heap.size</h5></td>
+ <td style="word-wrap: break-word;">"1024m"</td>
+ <td>String</td>
+ <td>JVM heap size for the JobManager.</td>
+ </tr>
+ <tr>
+ <td><h5>jobmanager.rpc.address</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The config parameter defining the network address to connect to for communication with the job manager. This value is only interpreted in setups where a single JobManager with static name or address exists (simple standalone setups, or container setups with dynamic service name resolution). It is not used in many high-availability setups, when a leader-election service (like ZooKeeper) is used to elect and discover the JobManager leader from potentially multiple standby J [...]
+ </tr>
+ <tr>
+ <td><h5>jobmanager.rpc.port</h5></td>
+ <td style="word-wrap: break-word;">6123</td>
+ <td>Integer</td>
+ <td>The config parameter defining the network port to connect to for communication with the job manager. Like jobmanager.rpc.address, this value is only interpreted in setups where a single JobManager with static name/address and port exists (simple standalone setups, or container setups with dynamic service name resolution). This config option is not used in many high-availability setups, when a leader-election service (like ZooKeeper) is used to elect and discover the JobMa [...]
+ </tr>
+ <tr>
+ <td><h5>jobstore.cache-size</h5></td>
+ <td style="word-wrap: break-word;">52428800</td>
+ <td>Long</td>
+ <td>The job store cache size in bytes which is used to keep completed jobs in memory.</td>
+ </tr>
+ <tr>
+ <td><h5>jobstore.expiration-time</h5></td>
+ <td style="word-wrap: break-word;">3600</td>
+ <td>Long</td>
+ <td>The time in seconds after which a completed job expires and is purged from the job store.</td>
+ </tr>
+ <tr>
+ <td><h5>jobstore.max-capacity</h5></td>
+ <td style="word-wrap: break-word;">2147483647</td>
+ <td>Integer</td>
+ <td>The max number of completed jobs that can be kept in the job store.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/all_taskmanager_network_section.html b/docs/_includes/generated/all_taskmanager_network_section.html
new file mode 100644
index 0000000..04a8566
--- /dev/null
+++ b/docs/_includes/generated/all_taskmanager_network_section.html
@@ -0,0 +1,96 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>taskmanager.network.blocking-shuffle.compression.enabled</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Boolean flag indicating whether the shuffle data will be compressed for blocking shuffle mode. Note that data is compressed per buffer and compression can incur extra CPU overhead, so it is more effective for IO bounded scenario when data compression ratio is high. Currently, shuffle data compression is an experimental feature and the config option can be changed in the future.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.blocking-shuffle.type</h5></td>
+ <td style="word-wrap: break-word;">"file"</td>
+ <td>String</td>
+ <td>The blocking shuffle type, either "mmap" or "file". The "auto" means selecting the property type automatically based on system memory architecture (64 bit for mmap and 32 bit for file). Note that the memory usage of mmap is not accounted by configured memory limits, but some resource frameworks like yarn would track this memory usage and kill the container once memory exceeding some threshold. Also note that this option is experimental and might be changed future.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.detailed-metrics</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Boolean flag to enable/disable more detailed metrics about inbound/outbound network queue lengths.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.memory.buffers-per-channel</h5></td>
+ <td style="word-wrap: break-word;">2</td>
+ <td>Integer</td>
+ <td>Maximum number of network buffers to use for each outgoing/incoming channel (subpartition/input channel).In credit-based flow control mode, this indicates how many credits are exclusive in each input channel. It should be configured at least 2 for good performance. 1 buffer is for receiving in-flight data in the subpartition and 1 buffer is for parallel serialization.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.memory.floating-buffers-per-gate</h5></td>
+ <td style="word-wrap: break-word;">8</td>
+ <td>Integer</td>
+ <td>Number of extra network buffers to use for each outgoing/incoming gate (result partition/input gate). In credit-based flow control mode, this indicates how many floating credits are shared among all the input channels. The floating buffers are distributed based on backlog (real-time output buffers in the subpartition) feedback, and can help relieve back-pressure caused by unbalanced data distribution among the subpartitions. This value should be increased in case of highe [...]
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.netty.client.connectTimeoutSec</h5></td>
+ <td style="word-wrap: break-word;">120</td>
+ <td>Integer</td>
+ <td>The Netty client connection timeout.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.netty.client.numThreads</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>The number of Netty client threads.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.netty.num-arenas</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>The number of Netty arenas.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.netty.sendReceiveBufferSize</h5></td>
+ <td style="word-wrap: break-word;">0</td>
+ <td>Integer</td>
+ <td>The Netty send and receive buffer size. This defaults to the system buffer size (cat /proc/sys/net/ipv4/tcp_[rw]mem) and is 4 MiB in modern Linux.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.netty.server.backlog</h5></td>
+ <td style="word-wrap: break-word;">0</td>
+ <td>Integer</td>
+ <td>The netty server connection backlog.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.netty.server.numThreads</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>The number of Netty server threads.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.netty.transport</h5></td>
+ <td style="word-wrap: break-word;">"auto"</td>
+ <td>String</td>
+ <td>The Netty transport type, either "nio" or "epoll". The "auto" means selecting the property mode automatically based on the platform. Note that the "epoll" mode can get better performance, less GC and have more advanced features which are only available on modern Linux.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.request-backoff.initial</h5></td>
+ <td style="word-wrap: break-word;">100</td>
+ <td>Integer</td>
+ <td>Minimum backoff in milliseconds for partition requests of input channels.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.request-backoff.max</h5></td>
+ <td style="word-wrap: break-word;">10000</td>
+ <td>Integer</td>
+ <td>Maximum backoff in milliseconds for partition requests of input channels.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/all_taskmanager_section.html b/docs/_includes/generated/all_taskmanager_section.html
new file mode 100644
index 0000000..692c38b
--- /dev/null
+++ b/docs/_includes/generated/all_taskmanager_section.html
@@ -0,0 +1,115 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>task.cancellation.interval</h5></td>
+ <td style="word-wrap: break-word;">30000</td>
+ <td>Long</td>
+ <td>Time interval between two successive task cancellation attempts in milliseconds.</td>
+ </tr>
+ <tr>
+ <td><h5>task.cancellation.timeout</h5></td>
+ <td style="word-wrap: break-word;">180000</td>
+ <td>Long</td>
+ <td>Timeout in milliseconds after which a task cancellation times out and leads to a fatal TaskManager error. A value of 0 deactivates the watch dog.</td>
+ </tr>
+ <tr>
+ <td><h5>task.cancellation.timers.timeout</h5></td>
+ <td style="word-wrap: break-word;">7500</td>
+ <td>Long</td>
+ <td>Time we wait for the timers in milliseconds to finish all pending timer threads when the stream task is cancelled.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.data.port</h5></td>
+ <td style="word-wrap: break-word;">0</td>
+ <td>Integer</td>
+ <td>The task manager’s port used for data exchange operations.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.data.ssl.enabled</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>Enable SSL support for the taskmanager data transport. This is applicable only when the global flag for internal SSL (security.ssl.internal.enabled) is set to true</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.debug.memory.log</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Flag indicating whether to start a thread, which repeatedly logs the memory usage of the JVM.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.debug.memory.log-interval</h5></td>
+ <td style="word-wrap: break-word;">5000</td>
+ <td>Long</td>
+ <td>The interval (in ms) for the log thread to log the current memory usage.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.host</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The address of the network interface that the TaskManager binds to. This option can be used to define explicitly a binding address. Because different TaskManagers need different values for this option, usually it is specified in an additional non-shared TaskManager-specific config file.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.jvm-exit-on-oom</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Whether to kill the TaskManager when the task thread throws an OutOfMemoryError.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.segment-size</h5></td>
+ <td style="word-wrap: break-word;">32 kb</td>
+ <td>MemorySize</td>
+ <td>Size of memory buffers used by the network stack and the memory manager.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.bind-policy</h5></td>
+ <td style="word-wrap: break-word;">"ip"</td>
+ <td>String</td>
+ <td>The automatic address binding policy used by the TaskManager if "taskmanager.host" is not set. The value should be one of the following:
+<ul><li>"name" - uses hostname as binding address</li><li>"ip" - uses host's ip address as binding address</li></ul></td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.numberOfTaskSlots</h5></td>
+ <td style="word-wrap: break-word;">1</td>
+ <td>Integer</td>
+ <td>The number of parallel operator or user function instances that a single TaskManager can run. If this value is larger than 1, a single TaskManager takes multiple instances of a function or operator. That way, the TaskManager can utilize multiple CPU cores, but at the same time, the available memory is divided between the different operator or function instances. This value is typically proportional to the number of physical CPU cores that the TaskManager's machine has (e. [...]
+ </tr>
+ <tr>
+ <td><h5>taskmanager.registration.initial-backoff</h5></td>
+ <td style="word-wrap: break-word;">500 ms</td>
+ <td>Duration</td>
+ <td>The initial registration backoff between two consecutive registration attempts. The backoff is doubled for each new registration attempt until it reaches the maximum registration backoff.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.registration.max-backoff</h5></td>
+ <td style="word-wrap: break-word;">30 s</td>
+ <td>Duration</td>
+ <td>The maximum registration backoff between two consecutive registration attempts. The max registration backoff requires a time unit specifier (ms/s/min/h/d).</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.registration.refused-backoff</h5></td>
+ <td style="word-wrap: break-word;">10 s</td>
+ <td>Duration</td>
+ <td>The backoff after a registration has been refused by the job manager before retrying to connect.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.registration.timeout</h5></td>
+ <td style="word-wrap: break-word;">5 min</td>
+ <td>Duration</td>
+ <td>Defines the timeout for the TaskManager registration. If the duration is exceeded without a successful registration, then the TaskManager terminates.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.rpc.port</h5></td>
+ <td style="word-wrap: break-word;">"0"</td>
+ <td>String</td>
+ <td>The task manager’s IPC port. Accepts a list of ports (“50100,50101”), ranges (“50100-50200”) or a combination of both. It is recommended to set a range of ports to avoid collisions when multiple TaskManagers are running on the same machine.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/blob_server_configuration.html b/docs/_includes/generated/blob_server_configuration.html
new file mode 100644
index 0000000..ee5620a
--- /dev/null
+++ b/docs/_includes/generated/blob_server_configuration.html
@@ -0,0 +1,72 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>blob.client.connect.timeout</h5></td>
+ <td style="word-wrap: break-word;">0</td>
+ <td>Integer</td>
+ <td>The connection timeout in milliseconds for the blob client.</td>
+ </tr>
+ <tr>
+ <td><h5>blob.client.socket.timeout</h5></td>
+ <td style="word-wrap: break-word;">300000</td>
+ <td>Integer</td>
+ <td>The socket timeout in milliseconds for the blob client.</td>
+ </tr>
+ <tr>
+ <td><h5>blob.fetch.backlog</h5></td>
+ <td style="word-wrap: break-word;">1000</td>
+ <td>Integer</td>
+ <td>The config parameter defining the backlog of BLOB fetches on the JobManager.</td>
+ </tr>
+ <tr>
+ <td><h5>blob.fetch.num-concurrent</h5></td>
+ <td style="word-wrap: break-word;">50</td>
+ <td>Integer</td>
+ <td>The config parameter defining the maximum number of concurrent BLOB fetches that the JobManager serves.</td>
+ </tr>
+ <tr>
+ <td><h5>blob.fetch.retries</h5></td>
+ <td style="word-wrap: break-word;">5</td>
+ <td>Integer</td>
+ <td>The config parameter defining number of retires for failed BLOB fetches.</td>
+ </tr>
+ <tr>
+ <td><h5>blob.offload.minsize</h5></td>
+ <td style="word-wrap: break-word;">1048576</td>
+ <td>Integer</td>
+ <td>The minimum size for messages to be offloaded to the BlobServer.</td>
+ </tr>
+ <tr>
+ <td><h5>blob.server.port</h5></td>
+ <td style="word-wrap: break-word;">"0"</td>
+ <td>String</td>
+ <td>The config parameter defining the server port of the blob service.</td>
+ </tr>
+ <tr>
+ <td><h5>blob.service.cleanup.interval</h5></td>
+ <td style="word-wrap: break-word;">3600</td>
+ <td>Long</td>
+ <td>Cleanup interval of the blob caches at the task managers (in seconds).</td>
+ </tr>
+ <tr>
+ <td><h5>blob.service.ssl.enabled</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>Flag to override ssl support for the blob service transport.</td>
+ </tr>
+ <tr>
+ <td><h5>blob.storage.directory</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The config parameter defining the storage directory to be used by the blob server.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/checkpointing_configuration.html b/docs/_includes/generated/checkpointing_configuration.html
new file mode 100644
index 0000000..a80a67b
--- /dev/null
+++ b/docs/_includes/generated/checkpointing_configuration.html
@@ -0,0 +1,72 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>state.backend</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The state backend to be used to store and checkpoint state.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.async</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>Option whether the state backend should use an asynchronous snapshot method where possible and configurable. Some state backends may not support asynchronous snapshots, or only support asynchronous snapshots, and ignore this option.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.fs.memory-threshold</h5></td>
+ <td style="word-wrap: break-word;">1024</td>
+ <td>Integer</td>
+ <td>The minimum size of state data files. All state chunks smaller than that are stored inline in the root checkpoint metadata file.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.fs.write-buffer-size</h5></td>
+ <td style="word-wrap: break-word;">4096</td>
+ <td>Integer</td>
+ <td>The default size of the write buffer for the checkpoint streams that write to file systems. The actual write buffer size is determined to be the maximum of the value of this option and option 'state.backend.fs.memory-threshold'.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.incremental</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Option whether the state backend should create incremental checkpoints, if possible. For an incremental checkpoint, only a diff from the previous checkpoint is stored, rather than the complete checkpoint state. Some state backends may not support incremental checkpoints and ignore this option.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.local-recovery</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>This option configures local recovery for this state backend. By default, local recovery is deactivated. Local recovery currently only covers keyed state backends. Currently, MemoryStateBackend does not support local recovery and ignore this option.</td>
+ </tr>
+ <tr>
+ <td><h5>state.checkpoints.dir</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The default directory used for storing the data files and meta data of checkpoints in a Flink supported filesystem. The storage path must be accessible from all participating processes/nodes(i.e. all TaskManagers and JobManagers).</td>
+ </tr>
+ <tr>
+ <td><h5>state.checkpoints.num-retained</h5></td>
+ <td style="word-wrap: break-word;">1</td>
+ <td>Integer</td>
+ <td>The maximum number of completed checkpoints to retain.</td>
+ </tr>
+ <tr>
+ <td><h5>state.savepoints.dir</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The default directory for savepoints. Used by the state backends that write savepoints to file systems (MemoryStateBackend, FsStateBackend, RocksDBStateBackend).</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.state.local.root-dirs</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The config parameter defining the root directories for storing file-based state for local recovery. Local recovery currently only covers keyed state backends. Currently, MemoryStateBackend does not support local recovery and ignore this option</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/cluster_configuration.html b/docs/_includes/generated/cluster_configuration.html
new file mode 100644
index 0000000..2379c9a
--- /dev/null
+++ b/docs/_includes/generated/cluster_configuration.html
@@ -0,0 +1,48 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>cluster.evenly-spread-out-slots</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Enable the slot spread out allocation strategy. This strategy tries to spread out the slots evenly across all available <span markdown="span">`TaskExecutors`</span>.</td>
+ </tr>
+ <tr>
+ <td><h5>cluster.registration.error-delay</h5></td>
+ <td style="word-wrap: break-word;">10000</td>
+ <td>Long</td>
+ <td>The pause made after an registration attempt caused an exception (other than timeout) in milliseconds.</td>
+ </tr>
+ <tr>
+ <td><h5>cluster.registration.initial-timeout</h5></td>
+ <td style="word-wrap: break-word;">100</td>
+ <td>Long</td>
+ <td>Initial registration timeout between cluster components in milliseconds.</td>
+ </tr>
+ <tr>
+ <td><h5>cluster.registration.max-timeout</h5></td>
+ <td style="word-wrap: break-word;">30000</td>
+ <td>Long</td>
+ <td>Maximum registration timeout between cluster components in milliseconds.</td>
+ </tr>
+ <tr>
+ <td><h5>cluster.registration.refused-registration-delay</h5></td>
+ <td style="word-wrap: break-word;">30000</td>
+ <td>Long</td>
+ <td>The pause made after the registration attempt was refused in milliseconds.</td>
+ </tr>
+ <tr>
+ <td><h5>cluster.services.shutdown-timeout</h5></td>
+ <td style="word-wrap: break-word;">30000</td>
+ <td>Long</td>
+ <td>The shutdown timeout for cluster services like executors in milliseconds.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/common_high_availability_section.html b/docs/_includes/generated/common_high_availability_section.html
new file mode 100644
index 0000000..4c06ca7
--- /dev/null
+++ b/docs/_includes/generated/common_high_availability_section.html
@@ -0,0 +1,30 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>high-availability</h5></td>
+ <td style="word-wrap: break-word;">"NONE"</td>
+ <td>String</td>
+ <td>Defines high-availability mode used for the cluster execution. To enable high-availability, set this mode to "ZOOKEEPER" or specify FQN of factory class.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.cluster-id</h5></td>
+ <td style="word-wrap: break-word;">"/default"</td>
+ <td>String</td>
+ <td>The ID of the Flink cluster, used to separate multiple Flink clusters from each other. Needs to be set for standalone clusters but is automatically inferred in YARN and Mesos.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.storageDir</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>File system path (URI) where Flink persists metadata in high-availability setups.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/common_high_availability_zk_section.html b/docs/_includes/generated/common_high_availability_zk_section.html
new file mode 100644
index 0000000..18175fb
--- /dev/null
+++ b/docs/_includes/generated/common_high_availability_zk_section.html
@@ -0,0 +1,24 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.root</h5></td>
+ <td style="word-wrap: break-word;">"/flink"</td>
+ <td>String</td>
+ <td>The root path under which Flink stores its entries in ZooKeeper.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.quorum</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The ZooKeeper quorum to use, when running Flink in a high-availability mode with ZooKeeper.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/common_host_port_section.html b/docs/_includes/generated/common_host_port_section.html
new file mode 100644
index 0000000..5deb71e
--- /dev/null
+++ b/docs/_includes/generated/common_host_port_section.html
@@ -0,0 +1,72 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>jobmanager.rpc.address</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The config parameter defining the network address to connect to for communication with the job manager. This value is only interpreted in setups where a single JobManager with static name or address exists (simple standalone setups, or container setups with dynamic service name resolution). It is not used in many high-availability setups, when a leader-election service (like ZooKeeper) is used to elect and discover the JobManager leader from potentially multiple standby J [...]
+ </tr>
+ <tr>
+ <td><h5>jobmanager.rpc.port</h5></td>
+ <td style="word-wrap: break-word;">6123</td>
+ <td>Integer</td>
+ <td>The config parameter defining the network port to connect to for communication with the job manager. Like jobmanager.rpc.address, this value is only interpreted in setups where a single JobManager with static name/address and port exists (simple standalone setups, or container setups with dynamic service name resolution). This config option is not used in many high-availability setups, when a leader-election service (like ZooKeeper) is used to elect and discover the JobMa [...]
+ </tr>
+ <tr>
+ <td><h5>metrics.internal.query-service.port</h5></td>
+ <td style="word-wrap: break-word;">"0"</td>
+ <td>String</td>
+ <td>The port range used for Flink's internal metric query service. Accepts a list of ports (“50100,50101”), ranges(“50100-50200”) or a combination of both. It is recommended to set a range of ports to avoid collisions when multiple Flink components are running on the same machine. Per default Flink will pick a random port.</td>
+ </tr>
+ <tr>
+ <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>
+ </tr>
+ <tr>
+ <td><h5>rest.bind-address</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The address that the server binds itself.</td>
+ </tr>
+ <tr>
+ <td><h5>rest.bind-port</h5></td>
+ <td style="word-wrap: break-word;">"8081"</td>
+ <td>String</td>
+ <td>The port that the server binds itself. Accepts a list of ports (“50100,50101”), ranges (“50100-50200”) or a combination of both. It is recommended to set a range of ports to avoid collisions when multiple Rest servers are running on the same machine.</td>
+ </tr>
+ <tr>
+ <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>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.data.port</h5></td>
+ <td style="word-wrap: break-word;">0</td>
+ <td>Integer</td>
+ <td>The task manager’s port used for data exchange operations.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.host</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The address of the network interface that the TaskManager binds to. This option can be used to define explicitly a binding address. Because different TaskManagers need different values for this option, usually it is specified in an additional non-shared TaskManager-specific config file.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.rpc.port</h5></td>
+ <td style="word-wrap: break-word;">"0"</td>
+ <td>String</td>
+ <td>The task manager’s IPC port. Accepts a list of ports (“50100,50101”), ranges (“50100-50200”) or a combination of both. It is recommended to set a range of ports to avoid collisions when multiple TaskManagers are running on the same machine.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/common_memory_section.html b/docs/_includes/generated/common_memory_section.html
new file mode 100644
index 0000000..329916f
--- /dev/null
+++ b/docs/_includes/generated/common_memory_section.html
@@ -0,0 +1,102 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>taskmanager.memory.flink.size</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>MemorySize</td>
+ <td>Total Flink Memory size for the TaskExecutors. This includes all the memory that a TaskExecutor consumes, except for JVM Metaspace and JVM Overhead. It consists of Framework Heap Memory, Task Heap Memory, Task Off-Heap Memory, Managed Memory, and Network Memory. See also 'taskmanager.memory.process.size' for total process memory size configuration.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.framework.heap.size</h5></td>
+ <td style="word-wrap: break-word;">128 mb</td>
+ <td>MemorySize</td>
+ <td>Framework Heap Memory size for TaskExecutors. This is the size of JVM heap memory reserved for TaskExecutor framework, which will not be allocated to task slots.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.framework.off-heap.size</h5></td>
+ <td style="word-wrap: break-word;">128 mb</td>
+ <td>MemorySize</td>
+ <td>Framework Off-Heap Memory size for TaskExecutors. This is the size of off-heap memory (JVM direct memory and native memory) reserved for TaskExecutor framework, which will not be allocated to task slots. The configured value will be fully counted when Flink calculates the JVM max direct memory size parameter.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.jvm-metaspace.size</h5></td>
+ <td style="word-wrap: break-word;">256 mb</td>
+ <td>MemorySize</td>
+ <td>JVM Metaspace Size for the TaskExecutors.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.jvm-overhead.fraction</h5></td>
+ <td style="word-wrap: break-word;">0.1</td>
+ <td>Float</td>
+ <td>Fraction of Total Process Memory to be reserved for JVM Overhead. This is off-heap memory reserved for JVM overhead, such as thread stack space, compile cache, etc. This includes native memory but not direct memory, and will not be counted when Flink calculates JVM max direct memory size parameter. The size of JVM Overhead is derived to make up the configured fraction of the Total Process Memory. If the derived size is less/greater than the configured min/max size, the mi [...]
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.jvm-overhead.max</h5></td>
+ <td style="word-wrap: break-word;">1 gb</td>
+ <td>MemorySize</td>
+ <td>Max JVM Overhead size for the TaskExecutors. This is off-heap memory reserved for JVM overhead, such as thread stack space, compile cache, etc. This includes native memory but not direct memory, and will not be counted when Flink calculates JVM max direct memory size parameter. The size of JVM Overhead is derived to make up the configured fraction of the Total Process Memory. If the derived size is less/greater than the configured min/max size, the min/max size will be us [...]
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.jvm-overhead.min</h5></td>
+ <td style="word-wrap: break-word;">192 mb</td>
+ <td>MemorySize</td>
+ <td>Min JVM Overhead size for the TaskExecutors. This is off-heap memory reserved for JVM overhead, such as thread stack space, compile cache, etc. This includes native memory but not direct memory, and will not be counted when Flink calculates JVM max direct memory size parameter. The size of JVM Overhead is derived to make up the configured fraction of the Total Process Memory. If the derived size is less/greater than the configured min/max size, the min/max size will be us [...]
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.managed.fraction</h5></td>
+ <td style="word-wrap: break-word;">0.4</td>
+ <td>Float</td>
+ <td>Fraction of Total Flink Memory to be used as Managed Memory, if Managed Memory size is not explicitly specified.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.managed.size</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>MemorySize</td>
+ <td>Managed Memory size for TaskExecutors. This is the size of off-heap memory managed by the memory manager, reserved for sorting, hash tables, caching of intermediate results and RocksDB state backend. Memory consumers can either allocate memory from the memory manager in the form of MemorySegments, or reserve bytes from the memory manager and keep their memory usage within that boundary. If unspecified, it will be derived to make up the configured fraction of the Total Fli [...]
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.network.fraction</h5></td>
+ <td style="word-wrap: break-word;">0.1</td>
+ <td>Float</td>
+ <td>Fraction of Total Flink Memory to be used as Network Memory. Network Memory is off-heap memory reserved for ShuffleEnvironment (e.g., network buffers). Network Memory size is derived to make up the configured fraction of the Total Flink Memory. If the derived size is less/greater than the configured min/max size, the min/max size will be used. The exact size of Network Memory can be explicitly specified by setting the min/max size to the same value.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.network.max</h5></td>
+ <td style="word-wrap: break-word;">1 gb</td>
+ <td>MemorySize</td>
+ <td>Max Network Memory size for TaskExecutors. Network Memory is off-heap memory reserved for ShuffleEnvironment (e.g., network buffers). Network Memory size is derived to make up the configured fraction of the Total Flink Memory. If the derived size is less/greater than the configured min/max size, the min/max size will be used. The exact size of Network Memory can be explicitly specified by setting the min/max to the same value.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.network.min</h5></td>
+ <td style="word-wrap: break-word;">64 mb</td>
+ <td>MemorySize</td>
+ <td>Min Network Memory size for TaskExecutors. Network Memory is off-heap memory reserved for ShuffleEnvironment (e.g., network buffers). Network Memory size is derived to make up the configured fraction of the Total Flink Memory. If the derived size is less/greater than the configured min/max size, the min/max size will be used. The exact size of Network Memory can be explicitly specified by setting the min/max to the same value.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.process.size</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>MemorySize</td>
+ <td>Total Process Memory size for the TaskExecutors. This includes all the memory that a TaskExecutor consumes, consisting of Total Flink Memory, JVM Metaspace, and JVM Overhead. On containerized setups, this should be set to the container memory. See also 'taskmanager.memory.flink.size' for total Flink memory size configuration.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.task.heap.size</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>MemorySize</td>
+ <td>Task Heap Memory size for TaskExecutors. This is the size of JVM heap memory reserved for tasks. If not specified, it will be derived as Total Flink Memory minus Framework Heap Memory, Task Off-Heap Memory, Managed Memory and Network Memory.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.task.off-heap.size</h5></td>
+ <td style="word-wrap: break-word;">0 bytes</td>
+ <td>MemorySize</td>
+ <td>Task Off-Heap Memory size for TaskExecutors. This is the size of off heap memory (JVM direct memory and native memory) reserved for tasks. The configured value will be fully counted when Flink calculates the JVM max direct memory size parameter.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/common_miscellaneous_section.html b/docs/_includes/generated/common_miscellaneous_section.html
new file mode 100644
index 0000000..547a05b
--- /dev/null
+++ b/docs/_includes/generated/common_miscellaneous_section.html
@@ -0,0 +1,30 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>fs.allowed-fallback-filesystems</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>A (semicolon-separated) list of file schemes, for which Hadoop can be used instead of an appropriate Flink plugin. (example: s3;wasb)</td>
+ </tr>
+ <tr>
+ <td><h5>fs.default-scheme</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The default filesystem scheme, used for paths that do not declare a scheme explicitly. May contain an authority, e.g. host:port in case of an HDFS NameNode.</td>
+ </tr>
+ <tr>
+ <td><h5>io.tmp.dirs</h5></td>
+ <td style="word-wrap: break-word;">'LOCAL_DIRS' on Yarn. '_FLINK_TMP_DIR' on Mesos. System.getProperty("java.io.tmpdir") in standalone.</td>
+ <td>String</td>
+ <td>Directories for temporary files, separated by",", "|", or the system's java.io.File.pathSeparator.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/common_state_backends_section.html b/docs/_includes/generated/common_state_backends_section.html
new file mode 100644
index 0000000..0df38e9
--- /dev/null
+++ b/docs/_includes/generated/common_state_backends_section.html
@@ -0,0 +1,54 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>state.backend</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The state backend to be used to store and checkpoint state.</td>
+ </tr>
+ <tr>
+ <td><h5>state.checkpoints.dir</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The default directory used for storing the data files and meta data of checkpoints in a Flink supported filesystem. The storage path must be accessible from all participating processes/nodes(i.e. all TaskManagers and JobManagers).</td>
+ </tr>
+ <tr>
+ <td><h5>state.savepoints.dir</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The default directory for savepoints. Used by the state backends that write savepoints to file systems (MemoryStateBackend, FsStateBackend, RocksDBStateBackend).</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.incremental</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Option whether the state backend should create incremental checkpoints, if possible. For an incremental checkpoint, only a diff from the previous checkpoint is stored, rather than the complete checkpoint state. Some state backends may not support incremental checkpoints and ignore this option.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.local-recovery</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>This option configures local recovery for this state backend. By default, local recovery is deactivated. Local recovery currently only covers keyed state backends. Currently, MemoryStateBackend does not support local recovery and ignore this option.</td>
+ </tr>
+ <tr>
+ <td><h5>state.checkpoints.num-retained</h5></td>
+ <td style="word-wrap: break-word;">1</td>
+ <td>Integer</td>
+ <td>The maximum number of completed checkpoints to retain.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.state.local.root-dirs</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The config parameter defining the root directories for storing file-based state for local recovery. Local recovery currently only covers keyed state backends. Currently, MemoryStateBackend does not support local recovery and ignore this option</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/core_configuration.html b/docs/_includes/generated/core_configuration.html
new file mode 100644
index 0000000..a9e7a7d
--- /dev/null
+++ b/docs/_includes/generated/core_configuration.html
@@ -0,0 +1,66 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>classloader.parent-first-patterns.additional</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>A (semicolon-separated) list of patterns that specifies which classes should always be resolved through the parent ClassLoader first. A pattern is a simple prefix that is checked against the fully qualified class name. These patterns are appended to "classloader.parent-first-patterns.default".</td>
+ </tr>
+ <tr>
+ <td><h5>classloader.parent-first-patterns.default</h5></td>
+ <td style="word-wrap: break-word;">"java.;<wbr>scala.;<wbr>org.apache.flink.;<wbr>com.esotericsoftware.kryo;<wbr>org.apache.hadoop.;<wbr>javax.annotation.;<wbr>org.slf4j;<wbr>org.apache.log4j;<wbr>org.apache.logging;<wbr>org.apache.commons.logging;<wbr>ch.qos.logback;<wbr>org.xml;<wbr>javax.xml;<wbr>org.apache.xerces;<wbr>org.w3c"</td>
+ <td>String</td>
+ <td>A (semicolon-separated) list of patterns that specifies which classes should always be resolved through the parent ClassLoader first. A pattern is a simple prefix that is checked against the fully qualified class name. This setting should generally not be modified. To add another pattern we recommend to use "classloader.parent-first-patterns.additional" instead.</td>
+ </tr>
+ <tr>
+ <td><h5>classloader.resolve-order</h5></td>
+ <td style="word-wrap: break-word;">"child-first"</td>
+ <td>String</td>
+ <td>Defines the class resolution strategy when loading classes from user code, meaning whether to first check the user code jar ("child-first") or the application classpath ("parent-first"). The default settings indicate to load classes first from the user code jar, which means that user code jars can include and load different dependencies than Flink uses (transitively).</td>
+ </tr>
+ <tr>
+ <td><h5>fs.allowed-fallback-filesystems</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>A (semicolon-separated) list of file schemes, for which Hadoop can be used instead of an appropriate Flink plugin. (example: s3;wasb)</td>
+ </tr>
+ <tr>
+ <td><h5>fs.default-scheme</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The default filesystem scheme, used for paths that do not declare a scheme explicitly. May contain an authority, e.g. host:port in case of an HDFS NameNode.</td>
+ </tr>
+ <tr>
+ <td><h5>fs.output.always-create-directory</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>File writers running with a parallelism larger than one create a directory for the output file path and put the different result files (one per parallel writer task) into that directory. If this option is set to "true", writers with a parallelism of 1 will also create a directory and place a single result file into it. If the option is set to "false", the writer will directly create the file directly at the output path, without creating a containing directory.</td>
+ </tr>
+ <tr>
+ <td><h5>fs.overwrite-files</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Specifies whether file output writers should overwrite existing files by default. Set to "true" to overwrite by default,"false" otherwise.</td>
+ </tr>
+ <tr>
+ <td><h5>io.tmp.dirs</h5></td>
+ <td style="word-wrap: break-word;">'LOCAL_DIRS' on Yarn. '_FLINK_TMP_DIR' on Mesos. System.getProperty("java.io.tmpdir") in standalone.</td>
+ <td>String</td>
+ <td>Directories for temporary files, separated by",", "|", or the system's java.io.File.pathSeparator.</td>
+ </tr>
+ <tr>
+ <td><h5>parallelism.default</h5></td>
+ <td style="word-wrap: break-word;">1</td>
+ <td>Integer</td>
+ <td>Default parallelism for jobs.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/deployment_configuration.html b/docs/_includes/generated/deployment_configuration.html
new file mode 100644
index 0000000..325dc98
--- /dev/null
+++ b/docs/_includes/generated/deployment_configuration.html
@@ -0,0 +1,30 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>execution.attached</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Specifies if the pipeline is submitted in attached or detached mode.</td>
+ </tr>
+ <tr>
+ <td><h5>execution.shutdown-on-attached-exit</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>If the job is submitted in attached mode, perform a best-effort cluster shutdown when the CLI is terminated abruptly, e.g., in response to a user interrupt, such as typing Ctrl + C.</td>
+ </tr>
+ <tr>
+ <td><h5>execution.target</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The deployment target for the execution, e.g. "local" for local execution.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/deprecated_file_sinks_section.html b/docs/_includes/generated/deprecated_file_sinks_section.html
new file mode 100644
index 0000000..26e3d53
--- /dev/null
+++ b/docs/_includes/generated/deprecated_file_sinks_section.html
@@ -0,0 +1,24 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>fs.output.always-create-directory</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>File writers running with a parallelism larger than one create a directory for the output file path and put the different result files (one per parallel writer task) into that directory. If this option is set to "true", writers with a parallelism of 1 will also create a directory and place a single result file into it. If the option is set to "false", the writer will directly create the file directly at the output path, without creating a containing directory.</td>
+ </tr>
+ <tr>
+ <td><h5>fs.overwrite-files</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Specifies whether file output writers should overwrite existing files by default. Set to "true" to overwrite by default,"false" otherwise.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/environment_configuration.html b/docs/_includes/generated/environment_configuration.html
new file mode 100644
index 0000000..32b4139
--- /dev/null
+++ b/docs/_includes/generated/environment_configuration.html
@@ -0,0 +1,66 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>env.hadoop.conf.dir</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Path to hadoop configuration directory. It is required to read HDFS and/or YARN configuration. You can also set it via environment variable.</td>
+ </tr>
+ <tr>
+ <td><h5>env.java.opts</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Java options to start the JVM of all Flink processes with.</td>
+ </tr>
+ <tr>
+ <td><h5>env.java.opts.historyserver</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Java options to start the JVM of the HistoryServer with.</td>
+ </tr>
+ <tr>
+ <td><h5>env.java.opts.jobmanager</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Java options to start the JVM of the JobManager with.</td>
+ </tr>
+ <tr>
+ <td><h5>env.java.opts.taskmanager</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Java options to start the JVM of the TaskManager with.</td>
+ </tr>
+ <tr>
+ <td><h5>env.log.dir</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Defines the directory where the Flink logs are saved. It has to be an absolute path. (Defaults to the log directory under Flink’s home)</td>
+ </tr>
+ <tr>
+ <td><h5>env.log.max</h5></td>
+ <td style="word-wrap: break-word;">5</td>
+ <td>Integer</td>
+ <td>The maximum number of old log files to keep.</td>
+ </tr>
+ <tr>
+ <td><h5>env.ssh.opts</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Additional command line options passed to SSH clients when starting or stopping JobManager, TaskManager, and Zookeeper services (start-cluster.sh, stop-cluster.sh, start-zookeeper-quorum.sh, stop-zookeeper-quorum.sh).</td>
+ </tr>
+ <tr>
+ <td><h5>env.yarn.conf.dir</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Path to yarn configuration directory. It is required to run flink on YARN. You can also set it via environment variable.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/execution_checkpointing_configuration.html b/docs/_includes/generated/execution_checkpointing_configuration.html
new file mode 100644
index 0000000..59a84f4
--- /dev/null
+++ b/docs/_includes/generated/execution_checkpointing_configuration.html
@@ -0,0 +1,60 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>execution.checkpointing.externalized-checkpoint-retention</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td><p>Enum</p>Possible values: [DELETE_ON_CANCELLATION, RETAIN_ON_CANCELLATION]</td>
+ <td>Externalized checkpoints write their meta data out to persistent storage and are not automatically cleaned up when the owning job fails or is suspended (terminating with job status <span markdown="span">`JobStatus#FAILED`</span> or <span markdown="span">`JobStatus#SUSPENDED`</span>. In this case, you have to manually clean up the checkpoint state, both the meta data and actual program state.<br /><br />The mode defines how an externalized checkpoint should be cleaned up o [...]
+ </tr>
+ <tr>
+ <td><h5>execution.checkpointing.interval</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>Duration</td>
+ <td>Gets the interval in which checkpoints are periodically scheduled.<br /><br />This setting defines the base interval. Checkpoint triggering may be delayed by the settings <span markdown="span">`execution.checkpointing.max-concurrent-checkpoints`</span> and <span markdown="span">`execution.checkpointing.min-pause`</span></td>
+ </tr>
+ <tr>
+ <td><h5>execution.checkpointing.max-concurrent-checkpoints</h5></td>
+ <td style="word-wrap: break-word;">1</td>
+ <td>Integer</td>
+ <td>The maximum number of checkpoint attempts that may be in progress at the same time. If this value is n, then no checkpoints will be triggered while n checkpoint attempts are currently in flight. For the next checkpoint to be triggered, one checkpoint attempt would need to finish or expire.</td>
+ </tr>
+ <tr>
+ <td><h5>execution.checkpointing.min-pause</h5></td>
+ <td style="word-wrap: break-word;">0 ms</td>
+ <td>Duration</td>
+ <td>The minimal pause between checkpointing attempts. This setting defines how soon thecheckpoint coordinator may trigger another checkpoint after it becomes possible to triggeranother checkpoint with respect to the maximum number of concurrent checkpoints(see <span markdown="span">`execution.checkpointing.max-concurrent-checkpoints`</span>).<br /><br />If the maximum number of concurrent checkpoints is set to one, this setting makes effectively sure that a minimum amount of [...]
+ </tr>
+ <tr>
+ <td><h5>execution.checkpointing.mode</h5></td>
+ <td style="word-wrap: break-word;">EXACTLY_ONCE</td>
+ <td><p>Enum</p>Possible values: [EXACTLY_ONCE, AT_LEAST_ONCE]</td>
+ <td>The checkpointing mode (exactly-once vs. at-least-once).</td>
+ </tr>
+ <tr>
+ <td><h5>execution.checkpointing.prefer-checkpoint-for-recovery</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>If enabled, a job recovery should fallback to checkpoint when there is a more recent savepoint.</td>
+ </tr>
+ <tr>
+ <td><h5>execution.checkpointing.timeout</h5></td>
+ <td style="word-wrap: break-word;">10 min</td>
+ <td>Duration</td>
+ <td>The maximum time that a checkpoint may take before being discarded.</td>
+ </tr>
+ <tr>
+ <td><h5>execution.checkpointing.tolerable-failed-checkpoints</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>Integer</td>
+ <td>The tolerable checkpoint failure number. If set to 0, that meanswe do not tolerance any checkpoint failure.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/execution_config_configuration.html b/docs/_includes/generated/execution_config_configuration.html
new file mode 100644
index 0000000..6dcc484
--- /dev/null
+++ b/docs/_includes/generated/execution_config_configuration.html
@@ -0,0 +1,106 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>table.exec.async-lookup.buffer-capacity</h5><br> <span class="label label-primary">Batch</span> <span class="label label-primary">Streaming</span></td>
+ <td style="word-wrap: break-word;">100</td>
+ <td>Integer</td>
+ <td>The max number of async i/o operation that the async lookup join can trigger.</td>
+ </tr>
+ <tr>
+ <td><h5>table.exec.async-lookup.timeout</h5><br> <span class="label label-primary">Batch</span> <span class="label label-primary">Streaming</span></td>
+ <td style="word-wrap: break-word;">"3 min"</td>
+ <td>String</td>
+ <td>The async timeout for the asynchronous operation to complete.</td>
+ </tr>
+ <tr>
+ <td><h5>table.exec.disabled-operators</h5><br> <span class="label label-primary">Batch</span></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Mainly for testing. A comma-separated list of operator names, each name represents a kind of disabled operator.
+Operators that can be disabled include "NestedLoopJoin", "ShuffleHashJoin", "BroadcastHashJoin", "SortMergeJoin", "HashAgg", "SortAgg".
+By default no operator is disabled.</td>
+ </tr>
+ <tr>
+ <td><h5>table.exec.mini-batch.allow-latency</h5><br> <span class="label label-primary">Streaming</span></td>
+ <td style="word-wrap: break-word;">"-1 ms"</td>
+ <td>String</td>
+ <td>The maximum latency can be used for MiniBatch to buffer input records. MiniBatch is an optimization to buffer input records to reduce state access. MiniBatch is triggered with the allowed latency interval and when the maximum number of buffered records reached. NOTE: If table.exec.mini-batch.enabled is set true, its value must be greater than zero.</td>
+ </tr>
+ <tr>
+ <td><h5>table.exec.mini-batch.enabled</h5><br> <span class="label label-primary">Streaming</span></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Specifies whether to enable MiniBatch optimization. MiniBatch is an optimization to buffer input records to reduce state access. This is disabled by default. To enable this, users should set this config to true. NOTE: If mini-batch is enabled, 'table.exec.mini-batch.allow-latency' and 'table.exec.mini-batch.size' must be set.</td>
+ </tr>
+ <tr>
+ <td><h5>table.exec.mini-batch.size</h5><br> <span class="label label-primary">Streaming</span></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Long</td>
+ <td>The maximum number of input records can be buffered for MiniBatch. MiniBatch is an optimization to buffer input records to reduce state access. MiniBatch is triggered with the allowed latency interval and when the maximum number of buffered records reached. NOTE: MiniBatch only works for non-windowed aggregations currently. If table.exec.mini-batch.enabled is set true, its value must be positive.</td>
+ </tr>
+ <tr>
+ <td><h5>table.exec.resource.default-parallelism</h5><br> <span class="label label-primary">Batch</span> <span class="label label-primary">Streaming</span></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>Sets default parallelism for all operators (such as aggregate, join, filter) to run with parallel instances. This config has a higher priority than parallelism of StreamExecutionEnvironment (actually, this config overrides the parallelism of StreamExecutionEnvironment). A value of -1 indicates that no default parallelism is set, then it will fallback to use the parallelism of StreamExecutionEnvironment.</td>
+ </tr>
+ <tr>
+ <td><h5>table.exec.shuffle-mode</h5><br> <span class="label label-primary">Batch</span></td>
+ <td style="word-wrap: break-word;">"batch"</td>
+ <td>String</td>
+ <td>Sets exec shuffle mode. Only batch or pipelined can be set.
+batch: the job will run stage by stage.
+pipelined: the job will run in streaming mode, but it may cause resource deadlock that receiver waits for resource to start when the sender holds resource to wait to send data to the receiver.</td>
+ </tr>
+ <tr>
+ <td><h5>table.exec.sort.async-merge-enabled</h5><br> <span class="label label-primary">Batch</span></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>Whether to asynchronously merge sorted spill files.</td>
+ </tr>
+ <tr>
+ <td><h5>table.exec.sort.default-limit</h5><br> <span class="label label-primary">Batch</span></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>Default limit when user don't set a limit after order by. -1 indicates that this configuration is ignored.</td>
+ </tr>
+ <tr>
+ <td><h5>table.exec.sort.max-num-file-handles</h5><br> <span class="label label-primary">Batch</span></td>
+ <td style="word-wrap: break-word;">128</td>
+ <td>Integer</td>
+ <td>The maximal fan-in for external merge sort. It limits the number of file handles per operator. If it is too small, may cause intermediate merging. But if it is too large, it will cause too many files opened at the same time, consume memory and lead to random reading.</td>
+ </tr>
+ <tr>
+ <td><h5>table.exec.source.idle-timeout</h5><br> <span class="label label-primary">Streaming</span></td>
+ <td style="word-wrap: break-word;">"-1 ms"</td>
+ <td>String</td>
+ <td>When a source do not receive any elements for the timeout time, it will be marked as temporarily idle. This allows downstream tasks to advance their watermarks without the need to wait for watermarks from this source while it is idle.</td>
+ </tr>
+ <tr>
+ <td><h5>table.exec.spill-compression.block-size</h5><br> <span class="label label-primary">Batch</span></td>
+ <td style="word-wrap: break-word;">"64 kb"</td>
+ <td>String</td>
+ <td>The memory size used to do compress when spilling data. The larger the memory, the higher the compression ratio, but more memory resource will be consumed by the job.</td>
+ </tr>
+ <tr>
+ <td><h5>table.exec.spill-compression.enabled</h5><br> <span class="label label-primary">Batch</span></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>Whether to compress spilled data. Currently we only support compress spilled data for sort and hash-agg and hash-join operators.</td>
+ </tr>
+ <tr>
+ <td><h5>table.exec.window-agg.buffer-size-limit</h5><br> <span class="label label-primary">Batch</span></td>
+ <td style="word-wrap: break-word;">100000</td>
+ <td>Integer</td>
+ <td>Sets the window elements buffer size limit used in group window agg operator.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/execution_configuration.html b/docs/_includes/generated/execution_configuration.html
new file mode 100644
index 0000000..037960c
--- /dev/null
+++ b/docs/_includes/generated/execution_configuration.html
@@ -0,0 +1,24 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>execution.buffer-timeout</h5></td>
+ <td style="word-wrap: break-word;">100 ms</td>
+ <td>Duration</td>
+ <td>The maximum time frequency (milliseconds) for the flushing of the output buffers. By default the output buffers flush frequently to provide low latency and to aid smooth developer experience. Setting the parameter can result in three logical modes:<ul><li>A positive value triggers flushing periodically by that interval</li><li>0 triggers flushing after every record thus minimizing latency</li><li>-1 ms triggers flushing only when the output buffer is full thus maximizing [...]
+ </tr>
+ <tr>
+ <td><h5>execution.checkpointing.snapshot-compression</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Tells if we should use compression for the state snapshot data or not</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/expert_class_loading_section.html b/docs/_includes/generated/expert_class_loading_section.html
new file mode 100644
index 0000000..1732e84
--- /dev/null
+++ b/docs/_includes/generated/expert_class_loading_section.html
@@ -0,0 +1,30 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>classloader.parent-first-patterns.additional</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>A (semicolon-separated) list of patterns that specifies which classes should always be resolved through the parent ClassLoader first. A pattern is a simple prefix that is checked against the fully qualified class name. These patterns are appended to "classloader.parent-first-patterns.default".</td>
+ </tr>
+ <tr>
+ <td><h5>classloader.parent-first-patterns.default</h5></td>
+ <td style="word-wrap: break-word;">"java.;<wbr>scala.;<wbr>org.apache.flink.;<wbr>com.esotericsoftware.kryo;<wbr>org.apache.hadoop.;<wbr>javax.annotation.;<wbr>org.slf4j;<wbr>org.apache.log4j;<wbr>org.apache.logging;<wbr>org.apache.commons.logging;<wbr>ch.qos.logback;<wbr>org.xml;<wbr>javax.xml;<wbr>org.apache.xerces;<wbr>org.w3c"</td>
+ <td>String</td>
+ <td>A (semicolon-separated) list of patterns that specifies which classes should always be resolved through the parent ClassLoader first. A pattern is a simple prefix that is checked against the fully qualified class name. This setting should generally not be modified. To add another pattern we recommend to use "classloader.parent-first-patterns.additional" instead.</td>
+ </tr>
+ <tr>
+ <td><h5>classloader.resolve-order</h5></td>
+ <td style="word-wrap: break-word;">"child-first"</td>
+ <td>String</td>
+ <td>Defines the class resolution strategy when loading classes from user code, meaning whether to first check the user code jar ("child-first") or the application classpath ("parent-first"). The default settings indicate to load classes first from the user code jar, which means that user code jars can include and load different dependencies than Flink uses (transitively).</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/expert_fault_tolerance_section.html b/docs/_includes/generated/expert_fault_tolerance_section.html
new file mode 100644
index 0000000..520717b
--- /dev/null
+++ b/docs/_includes/generated/expert_fault_tolerance_section.html
@@ -0,0 +1,60 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>cluster.registration.error-delay</h5></td>
+ <td style="word-wrap: break-word;">10000</td>
+ <td>Long</td>
+ <td>The pause made after an registration attempt caused an exception (other than timeout) in milliseconds.</td>
+ </tr>
+ <tr>
+ <td><h5>cluster.registration.initial-timeout</h5></td>
+ <td style="word-wrap: break-word;">100</td>
+ <td>Long</td>
+ <td>Initial registration timeout between cluster components in milliseconds.</td>
+ </tr>
+ <tr>
+ <td><h5>cluster.registration.max-timeout</h5></td>
+ <td style="word-wrap: break-word;">30000</td>
+ <td>Long</td>
+ <td>Maximum registration timeout between cluster components in milliseconds.</td>
+ </tr>
+ <tr>
+ <td><h5>cluster.registration.refused-registration-delay</h5></td>
+ <td style="word-wrap: break-word;">30000</td>
+ <td>Long</td>
+ <td>The pause made after the registration attempt was refused in milliseconds.</td>
+ </tr>
+ <tr>
+ <td><h5>cluster.services.shutdown-timeout</h5></td>
+ <td style="word-wrap: break-word;">30000</td>
+ <td>Long</td>
+ <td>The shutdown timeout for cluster services like executors in milliseconds.</td>
+ </tr>
+ <tr>
+ <td><h5>heartbeat.interval</h5></td>
+ <td style="word-wrap: break-word;">10000</td>
+ <td>Long</td>
+ <td>Time interval for requesting heartbeat from sender side.</td>
+ </tr>
+ <tr>
+ <td><h5>heartbeat.timeout</h5></td>
+ <td style="word-wrap: break-word;">50000</td>
+ <td>Long</td>
+ <td>Timeout for requesting and receiving heartbeat for both sender and receiver sides.</td>
+ </tr>
+ <tr>
+ <td><h5>jobmanager.execution.failover-strategy</h5></td>
+ <td style="word-wrap: break-word;">region</td>
+ <td>String</td>
+ <td>This option specifies how the job computation recovers from task failures. Accepted values are:<ul><li>'full': Restarts all tasks to recover the job.</li><li>'region': Restarts all tasks that could be affected by the task failure. More details can be found <a href="../dev/task_failure_recovery.html#restart-pipelined-region-failover-strategy">here</a>.</li></ul></td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/expert_high_availability_section.html b/docs/_includes/generated/expert_high_availability_section.html
new file mode 100644
index 0000000..4a571e7
--- /dev/null
+++ b/docs/_includes/generated/expert_high_availability_section.html
@@ -0,0 +1,18 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>high-availability.jobmanager.port</h5></td>
+ <td style="word-wrap: break-word;">"0"</td>
+ <td>String</td>
+ <td>The port (range) used by the Flink Master for its RPC connections in highly-available setups. In highly-available setups, this value is used instead of 'jobmanager.rpc.port'.A value of '0' means that a random free port is chosen. TaskManagers discover this port through the high-availability services (leader election), so a random port or a port range works without requiring any additional means of service discovery.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/expert_high_availability_zk_section.html b/docs/_includes/generated/expert_high_availability_zk_section.html
new file mode 100644
index 0000000..d7774e2
--- /dev/null
+++ b/docs/_includes/generated/expert_high_availability_zk_section.html
@@ -0,0 +1,84 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>high-availability.zookeeper.client.acl</h5></td>
+ <td style="word-wrap: break-word;">"open"</td>
+ <td>String</td>
+ <td>Defines the ACL (open|creator) to be configured on ZK node. The configuration value can be set to “creator” if the ZooKeeper server configuration has the “authProvider” property mapped to use SASLAuthenticationProvider and the cluster is configured to run in secure mode (Kerberos).</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.client.connection-timeout</h5></td>
+ <td style="word-wrap: break-word;">15000</td>
+ <td>Integer</td>
+ <td>Defines the connection timeout for ZooKeeper in ms.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.client.max-retry-attempts</h5></td>
+ <td style="word-wrap: break-word;">3</td>
+ <td>Integer</td>
+ <td>Defines the number of connection retries before the client gives up.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.client.retry-wait</h5></td>
+ <td style="word-wrap: break-word;">5000</td>
+ <td>Integer</td>
+ <td>Defines the pause between consecutive retries in ms.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.client.session-timeout</h5></td>
+ <td style="word-wrap: break-word;">60000</td>
+ <td>Integer</td>
+ <td>Defines the session timeout for the ZooKeeper session in ms.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.checkpoint-counter</h5></td>
+ <td style="word-wrap: break-word;">"/checkpoint-counter"</td>
+ <td>String</td>
+ <td>ZooKeeper root path (ZNode) for checkpoint counters.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.checkpoints</h5></td>
+ <td style="word-wrap: break-word;">"/checkpoints"</td>
+ <td>String</td>
+ <td>ZooKeeper root path (ZNode) for completed checkpoints.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.jobgraphs</h5></td>
+ <td style="word-wrap: break-word;">"/jobgraphs"</td>
+ <td>String</td>
+ <td>ZooKeeper root path (ZNode) for job graphs</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.latch</h5></td>
+ <td style="word-wrap: break-word;">"/leaderlatch"</td>
+ <td>String</td>
+ <td>Defines the znode of the leader latch which is used to elect the leader.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.leader</h5></td>
+ <td style="word-wrap: break-word;">"/leader"</td>
+ <td>String</td>
+ <td>Defines the znode of the leader which contains the URL to the leader and the current leader session ID.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.mesos-workers</h5></td>
+ <td style="word-wrap: break-word;">"/mesos-workers"</td>
+ <td>String</td>
+ <td>The ZooKeeper root path for persisting the Mesos worker information.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.running-registry</h5></td>
+ <td style="word-wrap: break-word;">"/running_job_registry/"</td>
+ <td>String</td>
+ <td></td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/expert_rest_section.html b/docs/_includes/generated/expert_rest_section.html
new file mode 100644
index 0000000..ab1a70c
--- /dev/null
+++ b/docs/_includes/generated/expert_rest_section.html
@@ -0,0 +1,66 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>rest.await-leader-timeout</h5></td>
+ <td style="word-wrap: break-word;">30000</td>
+ <td>Long</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.client.max-content-length</h5></td>
+ <td style="word-wrap: break-word;">104857600</td>
+ <td>Integer</td>
+ <td>The maximum content length in bytes that the client will handle.</td>
+ </tr>
+ <tr>
+ <td><h5>rest.connection-timeout</h5></td>
+ <td style="word-wrap: break-word;">15000</td>
+ <td>Long</td>
+ <td>The maximum time in ms for the client to establish a TCP connection.</td>
+ </tr>
+ <tr>
+ <td><h5>rest.idleness-timeout</h5></td>
+ <td style="word-wrap: break-word;">300000</td>
+ <td>Long</td>
+ <td>The maximum time in ms for a connection to stay idle before failing.</td>
+ </tr>
+ <tr>
+ <td><h5>rest.retry.delay</h5></td>
+ <td style="word-wrap: break-word;">3000</td>
+ <td>Long</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 style="word-wrap: break-word;">20</td>
+ <td>Integer</td>
+ <td>The number of retries the client will attempt if a retryable operations fails.</td>
+ </tr>
+ <tr>
+ <td><h5>rest.server.max-content-length</h5></td>
+ <td style="word-wrap: break-word;">104857600</td>
+ <td>Integer</td>
+ <td>The maximum content length in bytes that the server will handle.</td>
+ </tr>
+ <tr>
+ <td><h5>rest.server.numThreads</h5></td>
+ <td style="word-wrap: break-word;">4</td>
+ <td>Integer</td>
+ <td>The number of threads for the asynchronous processing of requests.</td>
+ </tr>
+ <tr>
+ <td><h5>rest.server.thread-priority</h5></td>
+ <td style="word-wrap: break-word;">5</td>
+ <td>Integer</td>
+ <td>Thread priority of the REST server's executor for processing asynchronous requests. Lowering the thread priority will give Flink's main components more CPU time whereas increasing will allocate more time for the REST server's processing.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/expert_rocksdb_section.html b/docs/_includes/generated/expert_rocksdb_section.html
new file mode 100644
index 0000000..d3cbfe1
--- /dev/null
+++ b/docs/_includes/generated/expert_rocksdb_section.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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>state.backend.rocksdb.checkpoint.transfer.thread.num</h5></td>
+ <td style="word-wrap: break-word;">1</td>
+ <td>Integer</td>
+ <td>The number of threads (per stateful operator) used to transfer (download and upload) files in RocksDBStateBackend.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.localdir</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The local directory (on the TaskManager) where RocksDB puts its files.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.options-factory</h5></td>
+ <td style="word-wrap: break-word;">"org.apache.flink.contrib.streaming.state.DefaultConfigurableOptionsFactory"</td>
+ <td>String</td>
+ <td>The options factory class for RocksDB to create DBOptions and ColumnFamilyOptions. The default options factory is org.apache.flink.contrib.streaming.state.DefaultConfigurableOptionsFactory, and it would read the configured options which provided in 'RocksDBConfigurableOptions'.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.predefined-options</h5></td>
+ <td style="word-wrap: break-word;">"DEFAULT"</td>
+ <td>String</td>
+ <td>The predefined settings for RocksDB DBOptions and ColumnFamilyOptions by Flink community. Current supported candidate predefined-options are DEFAULT, SPINNING_DISK_OPTIMIZED, SPINNING_DISK_OPTIMIZED_HIGH_MEM or FLASH_SSD_OPTIMIZED. Note that user customized options and options from the OptionsFactory are applied on top of these predefined ones.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/expert_scheduling_section.html b/docs/_includes/generated/expert_scheduling_section.html
new file mode 100644
index 0000000..a29ad69
--- /dev/null
+++ b/docs/_includes/generated/expert_scheduling_section.html
@@ -0,0 +1,30 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>cluster.evenly-spread-out-slots</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Enable the slot spread out allocation strategy. This strategy tries to spread out the slots evenly across all available <span markdown="span">`TaskExecutors`</span>.</td>
+ </tr>
+ <tr>
+ <td><h5>slot.idle.timeout</h5></td>
+ <td style="word-wrap: break-word;">50000</td>
+ <td>Long</td>
+ <td>The timeout in milliseconds for a idle slot in Slot Pool.</td>
+ </tr>
+ <tr>
+ <td><h5>slot.request.timeout</h5></td>
+ <td style="word-wrap: break-word;">300000</td>
+ <td>Long</td>
+ <td>The timeout in milliseconds for requesting a slot from Slot Pool.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/expert_security_ssl_section.html b/docs/_includes/generated/expert_security_ssl_section.html
new file mode 100644
index 0000000..9e5af5f
--- /dev/null
+++ b/docs/_includes/generated/expert_security_ssl_section.html
@@ -0,0 +1,42 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>security.ssl.internal.close-notify-flush-timeout</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>The timeout (in ms) for flushing the `close_notify` that was triggered by closing a channel. If the `close_notify` was not flushed in the given timeout the channel will be closed forcibly. (-1 = use system default)</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.internal.handshake-timeout</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>The timeout (in ms) during SSL handshake. (-1 = use system default)</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.internal.session-cache-size</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>The size of the cache used for storing SSL session objects. According to https://github.com/netty/netty/issues/832, you should always set this to an appropriate number to not run into a bug with stalling IO threads during garbage collection. (-1 = use system default).</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.internal.session-timeout</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>The timeout (in ms) for the cached SSL session objects. (-1 = use system default)</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.provider</h5></td>
+ <td style="word-wrap: break-word;">"JDK"</td>
+ <td>String</td>
+ <td>The SSL engine provider to use for the ssl transport:<ul><li><span markdown="span">`JDK`</span>: default Java-based SSL engine</li><li><span markdown="span">`OPENSSL`</span>: openSSL-based SSL engine using system libraries</li></ul><span markdown="span">`OPENSSL`</span> is based on <a href="http://netty.io/wiki/forked-tomcat-native.html#wiki-h2-4">netty-tcnative</a> and comes in two flavours:<ul><li>dynamically linked: This will use your system's openSSL libraries (if com [...]
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/expert_state_backends_section.html b/docs/_includes/generated/expert_state_backends_section.html
new file mode 100644
index 0000000..9d50be1
--- /dev/null
+++ b/docs/_includes/generated/expert_state_backends_section.html
@@ -0,0 +1,30 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>state.backend.async</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>Option whether the state backend should use an asynchronous snapshot method where possible and configurable. Some state backends may not support asynchronous snapshots, or only support asynchronous snapshots, and ignore this option.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.fs.memory-threshold</h5></td>
+ <td style="word-wrap: break-word;">1024</td>
+ <td>Integer</td>
+ <td>The minimum size of state data files. All state chunks smaller than that are stored inline in the root checkpoint metadata file.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.fs.write-buffer-size</h5></td>
+ <td style="word-wrap: break-word;">4096</td>
+ <td>Integer</td>
+ <td>The default size of the write buffer for the checkpoint streams that write to file systems. The actual write buffer size is determined to be the maximum of the value of this option and option 'state.backend.fs.memory-threshold'.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/failure_rate_restart_strategy_configuration.html b/docs/_includes/generated/failure_rate_restart_strategy_configuration.html
new file mode 100644
index 0000000..93bcd22
--- /dev/null
+++ b/docs/_includes/generated/failure_rate_restart_strategy_configuration.html
@@ -0,0 +1,30 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>restart-strategy.failure-rate.delay</h5></td>
+ <td style="word-wrap: break-word;">1 s</td>
+ <td>Duration</td>
+ <td>Delay between two consecutive restart attempts if <span markdown="span">`restart-strategy`</span> has been set to <span markdown="span">`failure-rate`</span>. It can be specified using notation: "1 min", "20 s"</td>
+ </tr>
+ <tr>
+ <td><h5>restart-strategy.failure-rate.failure-rate-interval</h5></td>
+ <td style="word-wrap: break-word;">1 min</td>
+ <td>Duration</td>
+ <td>Time interval for measuring failure rate if <span markdown="span">`restart-strategy`</span> has been set to <span markdown="span">`failure-rate`</span>. It can be specified using notation: "1 min", "20 s"</td>
+ </tr>
+ <tr>
+ <td><h5>restart-strategy.failure-rate.max-failures-per-interval</h5></td>
+ <td style="word-wrap: break-word;">1</td>
+ <td>Integer</td>
+ <td>Maximum number of restarts in given time interval before failing a job if <span markdown="span">`restart-strategy`</span> has been set to <span markdown="span">`failure-rate`</span>.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/file_system_configuration.html b/docs/_includes/generated/file_system_configuration.html
new file mode 100644
index 0000000..055b1e8
--- /dev/null
+++ b/docs/_includes/generated/file_system_configuration.html
@@ -0,0 +1,30 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>fs.default-scheme</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The default filesystem scheme, used for paths that do not declare a scheme explicitly. May contain an authority, e.g. host:port in case of an HDFS NameNode.</td>
+ </tr>
+ <tr>
+ <td><h5>fs.output.always-create-directory</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>File writers running with a parallelism larger than one create a directory for the output file path and put the different result files (one per parallel writer task) into that directory. If this option is set to "true", writers with a parallelism of 1 will also create a directory and place a single result file into it. If the option is set to "false", the writer will directly create the file directly at the output path, without creating a containing directory.</td>
+ </tr>
+ <tr>
+ <td><h5>fs.overwrite-files</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Specifies whether file output writers should overwrite existing files by default. Set to "true" to overwrite by default,"false" otherwise.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/fixed_delay_restart_strategy_configuration.html b/docs/_includes/generated/fixed_delay_restart_strategy_configuration.html
new file mode 100644
index 0000000..d4d74fe
--- /dev/null
+++ b/docs/_includes/generated/fixed_delay_restart_strategy_configuration.html
@@ -0,0 +1,24 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>restart-strategy.fixed-delay.attempts</h5></td>
+ <td style="word-wrap: break-word;">1</td>
+ <td>Integer</td>
+ <td>The number of times that Flink retries the execution before the job is declared as failed if <span markdown="span">`restart-strategy`</span> has been set to <span markdown="span">`fixed-delay`</span>.</td>
+ </tr>
+ <tr>
+ <td><h5>restart-strategy.fixed-delay.delay</h5></td>
+ <td style="word-wrap: break-word;">1 s</td>
+ <td>Duration</td>
+ <td>Delay between two consecutive restart attempts if <span markdown="span">`restart-strategy`</span> has been set to <span markdown="span">`fixed-delay`</span>. Delaying the retries can be helpful when the program interacts with external systems where for example connections or pending transactions should reach a timeout before re-execution is attempted. It can be specified using notation: "1 min", "20 s"</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/heartbeat_manager_configuration.html b/docs/_includes/generated/heartbeat_manager_configuration.html
new file mode 100644
index 0000000..4e6fde6
--- /dev/null
+++ b/docs/_includes/generated/heartbeat_manager_configuration.html
@@ -0,0 +1,24 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>heartbeat.interval</h5></td>
+ <td style="word-wrap: break-word;">10000</td>
+ <td>Long</td>
+ <td>Time interval for requesting heartbeat from sender side.</td>
+ </tr>
+ <tr>
+ <td><h5>heartbeat.timeout</h5></td>
+ <td style="word-wrap: break-word;">50000</td>
+ <td>Long</td>
+ <td>Timeout for requesting and receiving heartbeat for both sender and receiver sides.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/high_availability_configuration.html b/docs/_includes/generated/high_availability_configuration.html
new file mode 100644
index 0000000..cf61274
--- /dev/null
+++ b/docs/_includes/generated/high_availability_configuration.html
@@ -0,0 +1,120 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>high-availability</h5></td>
+ <td style="word-wrap: break-word;">"NONE"</td>
+ <td>String</td>
+ <td>Defines high-availability mode used for the cluster execution. To enable high-availability, set this mode to "ZOOKEEPER" or specify FQN of factory class.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.cluster-id</h5></td>
+ <td style="word-wrap: break-word;">"/default"</td>
+ <td>String</td>
+ <td>The ID of the Flink cluster, used to separate multiple Flink clusters from each other. Needs to be set for standalone clusters but is automatically inferred in YARN and Mesos.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.jobmanager.port</h5></td>
+ <td style="word-wrap: break-word;">"0"</td>
+ <td>String</td>
+ <td>The port (range) used by the Flink Master for its RPC connections in highly-available setups. In highly-available setups, this value is used instead of 'jobmanager.rpc.port'.A value of '0' means that a random free port is chosen. TaskManagers discover this port through the high-availability services (leader election), so a random port or a port range works without requiring any additional means of service discovery.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.storageDir</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>File system path (URI) where Flink persists metadata in high-availability setups.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.client.acl</h5></td>
+ <td style="word-wrap: break-word;">"open"</td>
+ <td>String</td>
+ <td>Defines the ACL (open|creator) to be configured on ZK node. The configuration value can be set to “creator” if the ZooKeeper server configuration has the “authProvider” property mapped to use SASLAuthenticationProvider and the cluster is configured to run in secure mode (Kerberos).</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.client.connection-timeout</h5></td>
+ <td style="word-wrap: break-word;">15000</td>
+ <td>Integer</td>
+ <td>Defines the connection timeout for ZooKeeper in ms.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.client.max-retry-attempts</h5></td>
+ <td style="word-wrap: break-word;">3</td>
+ <td>Integer</td>
+ <td>Defines the number of connection retries before the client gives up.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.client.retry-wait</h5></td>
+ <td style="word-wrap: break-word;">5000</td>
+ <td>Integer</td>
+ <td>Defines the pause between consecutive retries in ms.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.client.session-timeout</h5></td>
+ <td style="word-wrap: break-word;">60000</td>
+ <td>Integer</td>
+ <td>Defines the session timeout for the ZooKeeper session in ms.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.checkpoint-counter</h5></td>
+ <td style="word-wrap: break-word;">"/checkpoint-counter"</td>
+ <td>String</td>
+ <td>ZooKeeper root path (ZNode) for checkpoint counters.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.checkpoints</h5></td>
+ <td style="word-wrap: break-word;">"/checkpoints"</td>
+ <td>String</td>
+ <td>ZooKeeper root path (ZNode) for completed checkpoints.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.jobgraphs</h5></td>
+ <td style="word-wrap: break-word;">"/jobgraphs"</td>
+ <td>String</td>
+ <td>ZooKeeper root path (ZNode) for job graphs</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.latch</h5></td>
+ <td style="word-wrap: break-word;">"/leaderlatch"</td>
+ <td>String</td>
+ <td>Defines the znode of the leader latch which is used to elect the leader.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.leader</h5></td>
+ <td style="word-wrap: break-word;">"/leader"</td>
+ <td>String</td>
+ <td>Defines the znode of the leader which contains the URL to the leader and the current leader session ID.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.mesos-workers</h5></td>
+ <td style="word-wrap: break-word;">"/mesos-workers"</td>
+ <td>String</td>
+ <td>The ZooKeeper root path for persisting the Mesos worker information.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.root</h5></td>
+ <td style="word-wrap: break-word;">"/flink"</td>
+ <td>String</td>
+ <td>The root path under which Flink stores its entries in ZooKeeper.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.running-registry</h5></td>
+ <td style="word-wrap: break-word;">"/running_job_registry/"</td>
+ <td>String</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.quorum</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The ZooKeeper quorum to use, when running Flink in a high-availability mode with ZooKeeper.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/high_availability_zookeeper_configuration.html b/docs/_includes/generated/high_availability_zookeeper_configuration.html
new file mode 100644
index 0000000..75a7b82
--- /dev/null
+++ b/docs/_includes/generated/high_availability_zookeeper_configuration.html
@@ -0,0 +1,96 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>high-availability.zookeeper.client.acl</h5></td>
+ <td style="word-wrap: break-word;">"open"</td>
+ <td>String</td>
+ <td>Defines the ACL (open|creator) to be configured on ZK node. The configuration value can be set to “creator” if the ZooKeeper server configuration has the “authProvider” property mapped to use SASLAuthenticationProvider and the cluster is configured to run in secure mode (Kerberos).</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.client.connection-timeout</h5></td>
+ <td style="word-wrap: break-word;">15000</td>
+ <td>Integer</td>
+ <td>Defines the connection timeout for ZooKeeper in ms.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.client.max-retry-attempts</h5></td>
+ <td style="word-wrap: break-word;">3</td>
+ <td>Integer</td>
+ <td>Defines the number of connection retries before the client gives up.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.client.retry-wait</h5></td>
+ <td style="word-wrap: break-word;">5000</td>
+ <td>Integer</td>
+ <td>Defines the pause between consecutive retries in ms.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.client.session-timeout</h5></td>
+ <td style="word-wrap: break-word;">60000</td>
+ <td>Integer</td>
+ <td>Defines the session timeout for the ZooKeeper session in ms.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.checkpoint-counter</h5></td>
+ <td style="word-wrap: break-word;">"/checkpoint-counter"</td>
+ <td>String</td>
+ <td>ZooKeeper root path (ZNode) for checkpoint counters.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.checkpoints</h5></td>
+ <td style="word-wrap: break-word;">"/checkpoints"</td>
+ <td>String</td>
+ <td>ZooKeeper root path (ZNode) for completed checkpoints.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.jobgraphs</h5></td>
+ <td style="word-wrap: break-word;">"/jobgraphs"</td>
+ <td>String</td>
+ <td>ZooKeeper root path (ZNode) for job graphs</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.latch</h5></td>
+ <td style="word-wrap: break-word;">"/leaderlatch"</td>
+ <td>String</td>
+ <td>Defines the znode of the leader latch which is used to elect the leader.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.leader</h5></td>
+ <td style="word-wrap: break-word;">"/leader"</td>
+ <td>String</td>
+ <td>Defines the znode of the leader which contains the URL to the leader and the current leader session ID.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.mesos-workers</h5></td>
+ <td style="word-wrap: break-word;">"/mesos-workers"</td>
+ <td>String</td>
+ <td>The ZooKeeper root path for persisting the Mesos worker information.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.root</h5></td>
+ <td style="word-wrap: break-word;">"/flink"</td>
+ <td>String</td>
+ <td>The root path under which Flink stores its entries in ZooKeeper.</td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.path.running-registry</h5></td>
+ <td style="word-wrap: break-word;">"/running_job_registry/"</td>
+ <td>String</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><h5>high-availability.zookeeper.quorum</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The ZooKeeper quorum to use, when running Flink in a high-availability mode with ZooKeeper.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/history_server_configuration.html b/docs/_includes/generated/history_server_configuration.html
new file mode 100644
index 0000000..b74abcd
--- /dev/null
+++ b/docs/_includes/generated/history_server_configuration.html
@@ -0,0 +1,60 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>historyserver.archive.clean-expired-jobs</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Whether HistoryServer should cleanup jobs that are no longer present `historyserver.archive.fs.dir`.</td>
+ </tr>
+ <tr>
+ <td><h5>historyserver.archive.fs.dir</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Comma separated list of directories to fetch archived jobs from. The history server will monitor these directories for archived jobs. You can configure the JobManager to archive jobs to a directory via `jobmanager.archive.fs.dir`.</td>
+ </tr>
+ <tr>
+ <td><h5>historyserver.archive.fs.refresh-interval</h5></td>
+ <td style="word-wrap: break-word;">10000</td>
+ <td>Long</td>
+ <td>Interval in milliseconds for refreshing the archived job directories.</td>
+ </tr>
+ <tr>
+ <td><h5>historyserver.web.address</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Address of the HistoryServer's web interface.</td>
+ </tr>
+ <tr>
+ <td><h5>historyserver.web.port</h5></td>
+ <td style="word-wrap: break-word;">8082</td>
+ <td>Integer</td>
+ <td>Port of the HistoryServers's web interface.</td>
+ </tr>
+ <tr>
+ <td><h5>historyserver.web.refresh-interval</h5></td>
+ <td style="word-wrap: break-word;">10000</td>
+ <td>Long</td>
+ <td>The refresh interval for the HistoryServer web-frontend in milliseconds.</td>
+ </tr>
+ <tr>
+ <td><h5>historyserver.web.ssl.enabled</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Enable HTTPs access to the HistoryServer web frontend. This is applicable only when the global SSL flag security.ssl.enabled is set to true.</td>
+ </tr>
+ <tr>
+ <td><h5>historyserver.web.tmpdir</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>This configuration parameter allows defining the Flink web directory to be used by the history server web interface. The web interface will copy its static files into the directory.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/influxdb_reporter_configuration.html b/docs/_includes/generated/influxdb_reporter_configuration.html
new file mode 100644
index 0000000..cb678f7
--- /dev/null
+++ b/docs/_includes/generated/influxdb_reporter_configuration.html
@@ -0,0 +1,66 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>connectTimeout</h5></td>
+ <td style="word-wrap: break-word;">10000</td>
+ <td>Integer</td>
+ <td>(optional) the InfluxDB connect timeout for metrics</td>
+ </tr>
+ <tr>
+ <td><h5>consistency</h5></td>
+ <td style="word-wrap: break-word;">ONE</td>
+ <td><p>Enum</p>Possible values: [ALL, ANY, ONE, QUORUM]</td>
+ <td>(optional) the InfluxDB consistency level for metrics</td>
+ </tr>
+ <tr>
+ <td><h5>db</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>the InfluxDB database to store metrics</td>
+ </tr>
+ <tr>
+ <td><h5>host</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>the InfluxDB server host</td>
+ </tr>
+ <tr>
+ <td><h5>password</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>(optional) InfluxDB username's password used for authentication</td>
+ </tr>
+ <tr>
+ <td><h5>port</h5></td>
+ <td style="word-wrap: break-word;">8086</td>
+ <td>Integer</td>
+ <td>the InfluxDB server port</td>
+ </tr>
+ <tr>
+ <td><h5>retentionPolicy</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>(optional) the InfluxDB retention policy for metrics</td>
+ </tr>
+ <tr>
+ <td><h5>username</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>(optional) InfluxDB username used for authentication</td>
+ </tr>
+ <tr>
+ <td><h5>writeTimeout</h5></td>
+ <td style="word-wrap: break-word;">10000</td>
+ <td>Integer</td>
+ <td>(optional) the InfluxDB write timeout for metrics</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/job_manager_configuration.html b/docs/_includes/generated/job_manager_configuration.html
new file mode 100644
index 0000000..ef9c565
--- /dev/null
+++ b/docs/_includes/generated/job_manager_configuration.html
@@ -0,0 +1,78 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>jobmanager.archive.fs.dir</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Dictionary for JobManager to store the archives of completed jobs.</td>
+ </tr>
+ <tr>
+ <td><h5>jobmanager.execution.attempts-history-size</h5></td>
+ <td style="word-wrap: break-word;">16</td>
+ <td>Integer</td>
+ <td>The maximum number of prior execution attempts kept in history.</td>
+ </tr>
+ <tr>
+ <td><h5>jobmanager.execution.failover-strategy</h5></td>
+ <td style="word-wrap: break-word;">region</td>
+ <td>String</td>
+ <td>This option specifies how the job computation recovers from task failures. Accepted values are:<ul><li>'full': Restarts all tasks to recover the job.</li><li>'region': Restarts all tasks that could be affected by the task failure. More details can be found <a href="../dev/task_failure_recovery.html#restart-pipelined-region-failover-strategy">here</a>.</li></ul></td>
+ </tr>
+ <tr>
+ <td><h5>jobmanager.heap.size</h5></td>
+ <td style="word-wrap: break-word;">"1024m"</td>
+ <td>String</td>
+ <td>JVM heap size for the JobManager.</td>
+ </tr>
+ <tr>
+ <td><h5>jobmanager.rpc.address</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The config parameter defining the network address to connect to for communication with the job manager. This value is only interpreted in setups where a single JobManager with static name or address exists (simple standalone setups, or container setups with dynamic service name resolution). It is not used in many high-availability setups, when a leader-election service (like ZooKeeper) is used to elect and discover the JobManager leader from potentially multiple standby J [...]
+ </tr>
+ <tr>
+ <td><h5>jobmanager.rpc.port</h5></td>
+ <td style="word-wrap: break-word;">6123</td>
+ <td>Integer</td>
+ <td>The config parameter defining the network port to connect to for communication with the job manager. Like jobmanager.rpc.address, this value is only interpreted in setups where a single JobManager with static name/address and port exists (simple standalone setups, or container setups with dynamic service name resolution). This config option is not used in many high-availability setups, when a leader-election service (like ZooKeeper) is used to elect and discover the JobMa [...]
+ </tr>
+ <tr>
+ <td><h5>jobstore.cache-size</h5></td>
+ <td style="word-wrap: break-word;">52428800</td>
+ <td>Long</td>
+ <td>The job store cache size in bytes which is used to keep completed jobs in memory.</td>
+ </tr>
+ <tr>
+ <td><h5>jobstore.expiration-time</h5></td>
+ <td style="word-wrap: break-word;">3600</td>
+ <td>Long</td>
+ <td>The time in seconds after which a completed job expires and is purged from the job store.</td>
+ </tr>
+ <tr>
+ <td><h5>jobstore.max-capacity</h5></td>
+ <td style="word-wrap: break-word;">2147483647</td>
+ <td>Integer</td>
+ <td>The max number of completed jobs that can be kept in the job store.</td>
+ </tr>
+ <tr>
+ <td><h5>slot.idle.timeout</h5></td>
+ <td style="word-wrap: break-word;">50000</td>
+ <td>Long</td>
+ <td>The timeout in milliseconds for a idle slot in Slot Pool.</td>
+ </tr>
+ <tr>
+ <td><h5>slot.request.timeout</h5></td>
+ <td style="word-wrap: break-word;">300000</td>
+ <td>Long</td>
+ <td>The timeout in milliseconds for requesting a slot from Slot Pool.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/kerberos_configuration.html b/docs/_includes/generated/kerberos_configuration.html
new file mode 100644
index 0000000..cf27917
--- /dev/null
+++ b/docs/_includes/generated/kerberos_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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>security.kerberos.login.contexts</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>A comma-separated list of login contexts to provide the Kerberos credentials to (for example, `Client,KafkaClient` to use the credentials for ZooKeeper authentication and for Kafka authentication)</td>
+ </tr>
+ <tr>
+ <td><h5>security.kerberos.login.keytab</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Absolute path to a Kerberos keytab file that contains the user credentials.</td>
+ </tr>
+ <tr>
+ <td><h5>security.kerberos.login.principal</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Kerberos principal name associated with the keytab.</td>
+ </tr>
+ <tr>
+ <td><h5>security.kerberos.login.use-ticket-cache</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>Indicates whether to read from your Kerberos ticket cache.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/kubernetes_config_configuration.html b/docs/_includes/generated/kubernetes_config_configuration.html
new file mode 100644
index 0000000..6fa57f2
--- /dev/null
+++ b/docs/_includes/generated/kubernetes_config_configuration.html
@@ -0,0 +1,114 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>kubernetes.cluster-id</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The cluster id used for identifying the unique flink cluster. If it's not set, the client will generate a random UUID name.</td>
+ </tr>
+ <tr>
+ <td><h5>kubernetes.config.file</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The kubernetes config file will be used to create the client. The default is located at ~/.kube/config</td>
+ </tr>
+ <tr>
+ <td><h5>kubernetes.container-start-command-template</h5></td>
+ <td style="word-wrap: break-word;">"%java% %classpath% %jvmmem% %jvmopts% %logging% %class% %args% %redirects%"</td>
+ <td>String</td>
+ <td>Template for the kubernetes jobmanager and taskmanager container start invocation.</td>
+ </tr>
+ <tr>
+ <td><h5>kubernetes.container.image</h5></td>
+ <td style="word-wrap: break-word;">"flink:latest"</td>
+ <td>String</td>
+ <td>Image to use for Flink containers.</td>
+ </tr>
+ <tr>
+ <td><h5>kubernetes.container.image.pull-policy</h5></td>
+ <td style="word-wrap: break-word;">IfNotPresent</td>
+ <td><p>Enum</p>Possible values: [IfNotPresent, Always, Never]</td>
+ <td>The Kubernetes container image pull policy (IfNotPresent or Always or Never). The default policy is IfNotPresent to avoid putting pressure to image repository.</td>
+ </tr>
+ <tr>
+ <td><h5>kubernetes.container.image.pull-secrets</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>List<String></td>
+ <td>A semicolon-separated list of the Kubernetes secrets used to access private image registries.</td>
+ </tr>
+ <tr>
+ <td><h5>kubernetes.context</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The desired context from your Kubernetes config file used to configure the Kubernetes client for interacting with the cluster. This could be helpful if one has multiple contexts configured and wants to administrate different Flink clusters on different Kubernetes clusters/contexts.</td>
+ </tr>
+ <tr>
+ <td><h5>kubernetes.entry.path</h5></td>
+ <td style="word-wrap: break-word;">"/opt/flink/bin/kubernetes-entry.sh"</td>
+ <td>String</td>
+ <td>The entrypoint script of kubernetes in the image. It will be used as command for jobmanager and taskmanager container.</td>
+ </tr>
+ <tr>
+ <td><h5>kubernetes.flink.conf.dir</h5></td>
+ <td style="word-wrap: break-word;">"/opt/flink/conf"</td>
+ <td>String</td>
+ <td>The flink conf directory that will be mounted in pod. The flink-conf.yaml, log4j.properties, logback.xml in this path will be overwritten from config map.</td>
+ </tr>
+ <tr>
+ <td><h5>kubernetes.flink.log.dir</h5></td>
+ <td style="word-wrap: break-word;">"/opt/flink/log"</td>
+ <td>String</td>
+ <td>The directory that logs of jobmanager and taskmanager be saved in the pod.</td>
+ </tr>
+ <tr>
+ <td><h5>kubernetes.hadoop.conf.config-map.name</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Specify the name of an existing ConfigMap that contains custom Hadoop configuration to be mounted on the JobManager(s) and TaskManagers.</td>
+ </tr>
+ <tr>
+ <td><h5>kubernetes.jobmanager.cpu</h5></td>
+ <td style="word-wrap: break-word;">1.0</td>
+ <td>Double</td>
+ <td>The number of cpu used by job manager</td>
+ </tr>
+ <tr>
+ <td><h5>kubernetes.jobmanager.service-account</h5></td>
+ <td style="word-wrap: break-word;">"default"</td>
+ <td>String</td>
+ <td>Service account that is used by jobmanager within kubernetes cluster. The job manager uses this service account when requesting taskmanager pods from the API server.</td>
+ </tr>
+ <tr>
+ <td><h5>kubernetes.namespace</h5></td>
+ <td style="word-wrap: break-word;">"default"</td>
+ <td>String</td>
+ <td>The namespace that will be used for running the jobmanager and taskmanager pods.</td>
+ </tr>
+ <tr>
+ <td><h5>kubernetes.rest-service.exposed.type</h5></td>
+ <td style="word-wrap: break-word;">LoadBalancer</td>
+ <td><p>Enum</p>Possible values: [ClusterIP, NodePort, LoadBalancer]</td>
+ <td>The type of the rest service (ClusterIP or NodePort or LoadBalancer). When set to ClusterIP, the rest service will not be created.</td>
+ </tr>
+ <tr>
+ <td><h5>kubernetes.service.create-timeout</h5></td>
+ <td style="word-wrap: break-word;">"1 min"</td>
+ <td>String</td>
+ <td>Timeout used for creating the service. The timeout value requires a time-unit specifier (ms/s/min/h/d).</td>
+ </tr>
+ <tr>
+ <td><h5>kubernetes.taskmanager.cpu</h5></td>
+ <td style="word-wrap: break-word;">-1.0</td>
+ <td>Double</td>
+ <td>The number of cpu used by task manager. By default, the cpu is set to the number of slots per TaskManager</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/mesos_configuration.html b/docs/_includes/generated/mesos_configuration.html
new file mode 100644
index 0000000..db8c6f4
--- /dev/null
+++ b/docs/_includes/generated/mesos_configuration.html
@@ -0,0 +1,84 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>mesos.failover-timeout</h5></td>
+ <td style="word-wrap: break-word;">604800</td>
+ <td>Integer</td>
+ <td>The failover timeout in seconds for the Mesos scheduler, after which running tasks are automatically shut down.</td>
+ </tr>
+ <tr>
+ <td><h5>mesos.master</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The Mesos master URL. The value should be in one of the following forms: <ul><li>host:port</li><li>zk://host1:port1,host2:port2,.../path</li><li>zk://username:password@host1:port1,host2:port2,.../path</li><li>file:///path/to/file</li></ul></td>
+ </tr>
+ <tr>
+ <td><h5>mesos.resourcemanager.artifactserver.port</h5></td>
+ <td style="word-wrap: break-word;">0</td>
+ <td>Integer</td>
+ <td>The config parameter defining the Mesos artifact server port to use. Setting the port to 0 will let the OS choose an available port.</td>
+ </tr>
+ <tr>
+ <td><h5>mesos.resourcemanager.artifactserver.ssl.enabled</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>Enables SSL for the Flink artifact server. Note that security.ssl.enabled also needs to be set to true encryption to enable encryption.</td>
+ </tr>
+ <tr>
+ <td><h5>mesos.resourcemanager.declined-offer-refuse-duration</h5></td>
+ <td style="word-wrap: break-word;">5000</td>
+ <td>Long</td>
+ <td>Amount of time to ask the Mesos master to not resend a declined resource offer again. This ensures a declined resource offer isn't resent immediately after being declined</td>
+ </tr>
+ <tr>
+ <td><h5>mesos.resourcemanager.framework.name</h5></td>
+ <td style="word-wrap: break-word;">"Flink"</td>
+ <td>String</td>
+ <td>Mesos framework name</td>
+ </tr>
+ <tr>
+ <td><h5>mesos.resourcemanager.framework.principal</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Mesos framework principal</td>
+ </tr>
+ <tr>
+ <td><h5>mesos.resourcemanager.framework.role</h5></td>
+ <td style="word-wrap: break-word;">"*"</td>
+ <td>String</td>
+ <td>Mesos framework role definition</td>
+ </tr>
+ <tr>
+ <td><h5>mesos.resourcemanager.framework.secret</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Mesos framework secret</td>
+ </tr>
+ <tr>
+ <td><h5>mesos.resourcemanager.framework.user</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Mesos framework user</td>
+ </tr>
+ <tr>
+ <td><h5>mesos.resourcemanager.tasks.port-assignments</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Comma-separated list of configuration keys which represent a configurable port. All port keys will dynamically get a port assigned through Mesos.</td>
+ </tr>
+ <tr>
+ <td><h5>mesos.resourcemanager.unused-offer-expiration</h5></td>
+ <td style="word-wrap: break-word;">120000</td>
+ <td>Long</td>
+ <td>Amount of time to wait for unused expired offers before declining them. This ensures your scheduler will not hoard unuseful offers.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/mesos_task_manager_configuration.html b/docs/_includes/generated/mesos_task_manager_configuration.html
new file mode 100644
index 0000000..aa24d11
--- /dev/null
+++ b/docs/_includes/generated/mesos_task_manager_configuration.html
@@ -0,0 +1,96 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>mesos.constraints.hard.hostattribute</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Constraints for task placement on Mesos based on agent attributes. Takes a comma-separated list of key:value pairs corresponding to the attributes exposed by the target mesos agents. Example: az:eu-west-1a,series:t2</td>
+ </tr>
+ <tr>
+ <td><h5>mesos.resourcemanager.tasks.bootstrap-cmd</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>A command which is executed before the TaskManager is started.</td>
+ </tr>
+ <tr>
+ <td><h5>mesos.resourcemanager.tasks.container.docker.force-pull-image</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Instruct the docker containerizer to forcefully pull the image rather than reuse a cached version.</td>
+ </tr>
+ <tr>
+ <td><h5>mesos.resourcemanager.tasks.container.docker.parameters</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Custom parameters to be passed into docker run command when using the docker containerizer. Comma separated list of "key=value" pairs. The "value" may contain '='.</td>
+ </tr>
+ <tr>
+ <td><h5>mesos.resourcemanager.tasks.container.image.name</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Image name to use for the container.</td>
+ </tr>
+ <tr>
+ <td><h5>mesos.resourcemanager.tasks.container.type</h5></td>
+ <td style="word-wrap: break-word;">"mesos"</td>
+ <td>String</td>
+ <td>Type of the containerization used: “mesos” or “docker”.</td>
+ </tr>
+ <tr>
+ <td><h5>mesos.resourcemanager.tasks.container.volumes</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>A comma separated list of [host_path:]container_path[:RO|RW]. This allows for mounting additional volumes into your container.</td>
+ </tr>
+ <tr>
+ <td><h5>mesos.resourcemanager.tasks.cpus</h5></td>
+ <td style="word-wrap: break-word;">0.0</td>
+ <td>Double</td>
+ <td>CPUs to assign to the Mesos workers.</td>
+ </tr>
+ <tr>
+ <td><h5>mesos.resourcemanager.tasks.disk</h5></td>
+ <td style="word-wrap: break-word;">0</td>
+ <td>Integer</td>
+ <td>Disk space to assign to the Mesos workers in MB.</td>
+ </tr>
+ <tr>
+ <td><h5>mesos.resourcemanager.tasks.gpus</h5></td>
+ <td style="word-wrap: break-word;">0</td>
+ <td>Integer</td>
+ <td>GPUs to assign to the Mesos workers.</td>
+ </tr>
+ <tr>
+ <td><h5>mesos.resourcemanager.tasks.hostname</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Optional value to define the TaskManager’s hostname. The pattern _TASK_ is replaced by the actual id of the Mesos task. This can be used to configure the TaskManager to use Mesos DNS (e.g. _TASK_.flink-service.mesos) for name lookups.</td>
+ </tr>
+ <tr>
+ <td><h5>mesos.resourcemanager.tasks.taskmanager-cmd</h5></td>
+ <td style="word-wrap: break-word;">"$FLINK_HOME/bin/mesos-taskmanager.sh"</td>
+ <td>String</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><h5>mesos.resourcemanager.tasks.uris</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>A comma separated list of URIs of custom artifacts to be downloaded into the sandbox of Mesos workers.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.numberOfTaskSlots</h5></td>
+ <td style="word-wrap: break-word;">1</td>
+ <td>Integer</td>
+ <td>The number of parallel operator or user function instances that a single TaskManager can run. If this value is larger than 1, a single TaskManager takes multiple instances of a function or operator. That way, the TaskManager can utilize multiple CPU cores, but at the same time, the available memory is divided between the different operator or function instances. This value is typically proportional to the number of physical CPU cores that the TaskManager's machine has (e. [...]
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/metric_configuration.html b/docs/_includes/generated/metric_configuration.html
new file mode 100644
index 0000000..e9b6920
--- /dev/null
+++ b/docs/_includes/generated/metric_configuration.html
@@ -0,0 +1,126 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>metrics.fetcher.update-interval</h5></td>
+ <td style="word-wrap: break-word;">10000</td>
+ <td>Long</td>
+ <td>Update interval for the metric fetcher used by the web UI in milliseconds. Decrease this value for faster updating metrics. Increase this value if the metric fetcher causes too much load. Setting this value to 0 disables the metric fetching completely.</td>
+ </tr>
+ <tr>
+ <td><h5>metrics.internal.query-service.port</h5></td>
+ <td style="word-wrap: break-word;">"0"</td>
+ <td>String</td>
+ <td>The port range used for Flink's internal metric query service. Accepts a list of ports (“50100,50101”), ranges(“50100-50200”) or a combination of both. It is recommended to set a range of ports to avoid collisions when multiple Flink components are running on the same machine. Per default Flink will pick a random port.</td>
+ </tr>
+ <tr>
+ <td><h5>metrics.internal.query-service.thread-priority</h5></td>
+ <td style="word-wrap: break-word;">1</td>
+ <td>Integer</td>
+ <td>The thread priority used for Flink's internal metric query service. The thread is created by Akka's thread pool executor. The range of the priority is from 1 (MIN_PRIORITY) to 10 (MAX_PRIORITY). Warning, increasing this value may bring the main Flink components down.</td>
+ </tr>
+ <tr>
+ <td><h5>metrics.latency.granularity</h5></td>
+ <td style="word-wrap: break-word;">"operator"</td>
+ <td>String</td>
+ <td>Defines the granularity of latency metrics. Accepted values are:<ul><li>single - Track latency without differentiating between sources and subtasks.</li><li>operator - Track latency while differentiating between sources, but not subtasks.</li><li>subtask - Track latency while differentiating between sources and subtasks.</li></ul></td>
+ </tr>
+ <tr>
+ <td><h5>metrics.latency.history-size</h5></td>
+ <td style="word-wrap: break-word;">128</td>
+ <td>Integer</td>
+ <td>Defines the number of measured latencies to maintain at each operator.</td>
+ </tr>
+ <tr>
+ <td><h5>metrics.latency.interval</h5></td>
+ <td style="word-wrap: break-word;">0</td>
+ <td>Long</td>
+ <td>Defines the interval at which latency tracking marks are emitted from the sources. Disables latency tracking if set to 0 or a negative value. Enabling this feature can significantly impact the performance of the cluster.</td>
+ </tr>
+ <tr>
+ <td><h5>metrics.reporter.<name>.<parameter></h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Configures the parameter <parameter> for the reporter named <name>.</td>
+ </tr>
+ <tr>
+ <td><h5>metrics.reporter.<name>.class</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The reporter class to use for the reporter named <name>.</td>
+ </tr>
+ <tr>
+ <td><h5>metrics.reporter.<name>.interval</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The reporter interval to use for the reporter named <name>.</td>
+ </tr>
+ <tr>
+ <td><h5>metrics.reporters</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>An optional list of reporter names. If configured, only reporters whose name matches any of the names in the list will be started. Otherwise, all reporters that could be found in the configuration will be started.</td>
+ </tr>
+ <tr>
+ <td><h5>metrics.scope.delimiter</h5></td>
+ <td style="word-wrap: break-word;">"."</td>
+ <td>String</td>
+ <td>Delimiter used to assemble the metric identifier.</td>
+ </tr>
+ <tr>
+ <td><h5>metrics.scope.jm</h5></td>
+ <td style="word-wrap: break-word;">"<host>.jobmanager"</td>
+ <td>String</td>
+ <td>Defines the scope format string that is applied to all metrics scoped to a JobManager.</td>
+ </tr>
+ <tr>
+ <td><h5>metrics.scope.jm.job</h5></td>
+ <td style="word-wrap: break-word;">"<host>.jobmanager.<job_name>"</td>
+ <td>String</td>
+ <td>Defines the scope format string that is applied to all metrics scoped to a job on a JobManager.</td>
+ </tr>
+ <tr>
+ <td><h5>metrics.scope.operator</h5></td>
+ <td style="word-wrap: break-word;">"<host>.taskmanager.<tm_id>.<job_name>.<operator_name>.<subtask_index>"</td>
+ <td>String</td>
+ <td>Defines the scope format string that is applied to all metrics scoped to an operator.</td>
+ </tr>
+ <tr>
+ <td><h5>metrics.scope.task</h5></td>
+ <td style="word-wrap: break-word;">"<host>.taskmanager.<tm_id>.<job_name>.<task_name>.<subtask_index>"</td>
+ <td>String</td>
+ <td>Defines the scope format string that is applied to all metrics scoped to a task.</td>
+ </tr>
+ <tr>
+ <td><h5>metrics.scope.tm</h5></td>
+ <td style="word-wrap: break-word;">"<host>.taskmanager.<tm_id>"</td>
+ <td>String</td>
+ <td>Defines the scope format string that is applied to all metrics scoped to a TaskManager.</td>
+ </tr>
+ <tr>
+ <td><h5>metrics.scope.tm.job</h5></td>
+ <td style="word-wrap: break-word;">"<host>.taskmanager.<tm_id>.<job_name>"</td>
+ <td>String</td>
+ <td>Defines the scope format string that is applied to all metrics scoped to a job on a TaskManager.</td>
+ </tr>
+ <tr>
+ <td><h5>metrics.system-resource</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Flag indicating whether Flink should report system resource metrics such as machine's CPU, memory or network usage.</td>
+ </tr>
+ <tr>
+ <td><h5>metrics.system-resource-probing-interval</h5></td>
+ <td style="word-wrap: break-word;">5000</td>
+ <td>Long</td>
+ <td>Interval between probing of system resource metrics specified in milliseconds. Has an effect only when 'metrics.system-resource' is enabled.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/netty_shuffle_environment_configuration.html b/docs/_includes/generated/netty_shuffle_environment_configuration.html
new file mode 100644
index 0000000..901a40b
--- /dev/null
+++ b/docs/_includes/generated/netty_shuffle_environment_configuration.html
@@ -0,0 +1,108 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>taskmanager.data.port</h5></td>
+ <td style="word-wrap: break-word;">0</td>
+ <td>Integer</td>
+ <td>The task manager’s port used for data exchange operations.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.data.ssl.enabled</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>Enable SSL support for the taskmanager data transport. This is applicable only when the global flag for internal SSL (security.ssl.internal.enabled) is set to true</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.blocking-shuffle.compression.enabled</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Boolean flag indicating whether the shuffle data will be compressed for blocking shuffle mode. Note that data is compressed per buffer and compression can incur extra CPU overhead, so it is more effective for IO bounded scenario when data compression ratio is high. Currently, shuffle data compression is an experimental feature and the config option can be changed in the future.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.blocking-shuffle.type</h5></td>
+ <td style="word-wrap: break-word;">"file"</td>
+ <td>String</td>
+ <td>The blocking shuffle type, either "mmap" or "file". The "auto" means selecting the property type automatically based on system memory architecture (64 bit for mmap and 32 bit for file). Note that the memory usage of mmap is not accounted by configured memory limits, but some resource frameworks like yarn would track this memory usage and kill the container once memory exceeding some threshold. Also note that this option is experimental and might be changed future.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.detailed-metrics</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Boolean flag to enable/disable more detailed metrics about inbound/outbound network queue lengths.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.memory.buffers-per-channel</h5></td>
+ <td style="word-wrap: break-word;">2</td>
+ <td>Integer</td>
+ <td>Maximum number of network buffers to use for each outgoing/incoming channel (subpartition/input channel).In credit-based flow control mode, this indicates how many credits are exclusive in each input channel. It should be configured at least 2 for good performance. 1 buffer is for receiving in-flight data in the subpartition and 1 buffer is for parallel serialization.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.memory.floating-buffers-per-gate</h5></td>
+ <td style="word-wrap: break-word;">8</td>
+ <td>Integer</td>
+ <td>Number of extra network buffers to use for each outgoing/incoming gate (result partition/input gate). In credit-based flow control mode, this indicates how many floating credits are shared among all the input channels. The floating buffers are distributed based on backlog (real-time output buffers in the subpartition) feedback, and can help relieve back-pressure caused by unbalanced data distribution among the subpartitions. This value should be increased in case of highe [...]
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.netty.client.connectTimeoutSec</h5></td>
+ <td style="word-wrap: break-word;">120</td>
+ <td>Integer</td>
+ <td>The Netty client connection timeout.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.netty.client.numThreads</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>The number of Netty client threads.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.netty.num-arenas</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>The number of Netty arenas.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.netty.sendReceiveBufferSize</h5></td>
+ <td style="word-wrap: break-word;">0</td>
+ <td>Integer</td>
+ <td>The Netty send and receive buffer size. This defaults to the system buffer size (cat /proc/sys/net/ipv4/tcp_[rw]mem) and is 4 MiB in modern Linux.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.netty.server.backlog</h5></td>
+ <td style="word-wrap: break-word;">0</td>
+ <td>Integer</td>
+ <td>The netty server connection backlog.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.netty.server.numThreads</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>The number of Netty server threads.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.netty.transport</h5></td>
+ <td style="word-wrap: break-word;">"auto"</td>
+ <td>String</td>
+ <td>The Netty transport type, either "nio" or "epoll". The "auto" means selecting the property mode automatically based on the platform. Note that the "epoll" mode can get better performance, less GC and have more advanced features which are only available on modern Linux.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.request-backoff.initial</h5></td>
+ <td style="word-wrap: break-word;">100</td>
+ <td>Integer</td>
+ <td>Minimum backoff in milliseconds for partition requests of input channels.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.request-backoff.max</h5></td>
+ <td style="word-wrap: break-word;">10000</td>
+ <td>Integer</td>
+ <td>Maximum backoff in milliseconds for partition requests of input channels.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/network_netty_configuration.html b/docs/_includes/generated/network_netty_configuration.html
new file mode 100644
index 0000000..3950b56
--- /dev/null
+++ b/docs/_includes/generated/network_netty_configuration.html
@@ -0,0 +1,54 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>taskmanager.network.netty.client.connectTimeoutSec</h5></td>
+ <td style="word-wrap: break-word;">120</td>
+ <td>Integer</td>
+ <td>The Netty client connection timeout.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.netty.client.numThreads</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>The number of Netty client threads.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.netty.num-arenas</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>The number of Netty arenas.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.netty.sendReceiveBufferSize</h5></td>
+ <td style="word-wrap: break-word;">0</td>
+ <td>Integer</td>
+ <td>The Netty send and receive buffer size. This defaults to the system buffer size (cat /proc/sys/net/ipv4/tcp_[rw]mem) and is 4 MiB in modern Linux.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.netty.server.backlog</h5></td>
+ <td style="word-wrap: break-word;">0</td>
+ <td>Integer</td>
+ <td>The netty server connection backlog.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.netty.server.numThreads</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>The number of Netty server threads.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.netty.transport</h5></td>
+ <td style="word-wrap: break-word;">"auto"</td>
+ <td>String</td>
+ <td>The Netty transport type, either "nio" or "epoll". The "auto" means selecting the property mode automatically based on the platform. Note that the "epoll" mode can get better performance, less GC and have more advanced features which are only available on modern Linux.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/optimizer_config_configuration.html b/docs/_includes/generated/optimizer_config_configuration.html
new file mode 100644
index 0000000..7eb0ccd
--- /dev/null
+++ b/docs/_includes/generated/optimizer_config_configuration.html
@@ -0,0 +1,63 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>table.optimizer.agg-phase-strategy</h5><br> <span class="label label-primary">Batch</span> <span class="label label-primary">Streaming</span></td>
+ <td style="word-wrap: break-word;">"AUTO"</td>
+ <td>String</td>
+ <td>Strategy for aggregate phase. Only AUTO, TWO_PHASE or ONE_PHASE can be set.
+AUTO: No special enforcer for aggregate stage. Whether to choose two stage aggregate or one stage aggregate depends on cost.
+TWO_PHASE: Enforce to use two stage aggregate which has localAggregate and globalAggregate. Note that if aggregate call does not support optimize into two phase, we will still use one stage aggregate.
+ONE_PHASE: Enforce to use one stage aggregate which only has CompleteGlobalAggregate.</td>
+ </tr>
+ <tr>
+ <td><h5>table.optimizer.distinct-agg.split.bucket-num</h5><br> <span class="label label-primary">Streaming</span></td>
+ <td style="word-wrap: break-word;">1024</td>
+ <td>Integer</td>
+ <td>Configure the number of buckets when splitting distinct aggregation. The number is used in the first level aggregation to calculate a bucket key 'hash_code(distinct_key) % BUCKET_NUM' which is used as an additional group key after splitting.</td>
+ </tr>
+ <tr>
+ <td><h5>table.optimizer.distinct-agg.split.enabled</h5><br> <span class="label label-primary">Streaming</span></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Tells the optimizer whether to split distinct aggregation (e.g. COUNT(DISTINCT col), SUM(DISTINCT col)) into two level. The first aggregation is shuffled by an additional key which is calculated using the hashcode of distinct_key and number of buckets. This optimization is very useful when there is data skew in distinct aggregation and gives the ability to scale-up the job. Default is false.</td>
+ </tr>
+ <tr>
+ <td><h5>table.optimizer.join-reorder-enabled</h5><br> <span class="label label-primary">Batch</span> <span class="label label-primary">Streaming</span></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Enables join reorder in optimizer. Default is disabled.</td>
+ </tr>
+ <tr>
+ <td><h5>table.optimizer.join.broadcast-threshold</h5><br> <span class="label label-primary">Batch</span></td>
+ <td style="word-wrap: break-word;">1048576</td>
+ <td>Long</td>
+ <td>Configures the maximum size in bytes for a table that will be broadcast to all worker nodes when performing a join. By setting this value to -1 to disable broadcasting.</td>
+ </tr>
+ <tr>
+ <td><h5>table.optimizer.reuse-source-enabled</h5><br> <span class="label label-primary">Batch</span> <span class="label label-primary">Streaming</span></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>When it is true, the optimizer will try to find out duplicated table sources and reuse them. This works only when table.optimizer.reuse-sub-plan-enabled is true.</td>
+ </tr>
+ <tr>
+ <td><h5>table.optimizer.reuse-sub-plan-enabled</h5><br> <span class="label label-primary">Batch</span> <span class="label label-primary">Streaming</span></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>When it is true, the optimizer will try to find out duplicated sub-plans and reuse them.</td>
+ </tr>
+ <tr>
+ <td><h5>table.optimizer.source.predicate-pushdown-enabled</h5><br> <span class="label label-primary">Batch</span> <span class="label label-primary">Streaming</span></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>When it is true, the optimizer will push down predicates into the FilterableTableSource. Default value is true.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/optimizer_configuration.html b/docs/_includes/generated/optimizer_configuration.html
new file mode 100644
index 0000000..3b49f01
--- /dev/null
+++ b/docs/_includes/generated/optimizer_configuration.html
@@ -0,0 +1,30 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>compiler.delimited-informat.max-line-samples</h5></td>
+ <td style="word-wrap: break-word;">10</td>
+ <td>Integer</td>
+ <td>he maximum number of line samples taken by the compiler for delimited inputs. The samples are used to estimate the number of records. This value can be overridden for a specific input with the input format’s parameters.</td>
+ </tr>
+ <tr>
+ <td><h5>compiler.delimited-informat.max-sample-len</h5></td>
+ <td style="word-wrap: break-word;">2097152</td>
+ <td>Integer</td>
+ <td>The maximal length of a line sample that the compiler takes for delimited inputs. If the length of a single sample exceeds this value (possible because of misconfiguration of the parser), the sampling aborts. This value can be overridden for a specific input with the input format’s parameters.</td>
+ </tr>
+ <tr>
+ <td><h5>compiler.delimited-informat.min-line-samples</h5></td>
+ <td style="word-wrap: break-word;">2</td>
+ <td>Integer</td>
+ <td>The minimum number of line samples taken by the compiler for delimited inputs. The samples are used to estimate the number of records. This value can be overridden for a specific input with the input format’s parameters</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/pipeline_configuration.html b/docs/_includes/generated/pipeline_configuration.html
new file mode 100644
index 0000000..f3fc216
--- /dev/null
+++ b/docs/_includes/generated/pipeline_configuration.html
@@ -0,0 +1,114 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>pipeline.auto-generate-uids</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>When auto-generated UIDs are disabled, users are forced to manually specify UIDs on DataStream applications.<br /><br />It is highly recommended that users specify UIDs before deploying to production since they are used to match state in savepoints to operators in a job. Because auto-generated ID's are likely to change when modifying a job, specifying custom IDs allow an application to evolve over time without discarding state.</td>
+ </tr>
+ <tr>
+ <td><h5>pipeline.auto-type-registration</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>Controls whether Flink is automatically registering all types in the user programs with Kryo.</td>
+ </tr>
+ <tr>
+ <td><h5>pipeline.auto-watermark-interval</h5></td>
+ <td style="word-wrap: break-word;">0 ms</td>
+ <td>Duration</td>
+ <td>The interval of the automatic watermark emission. Watermarks are used throughout the streaming system to keep track of the progress of time. They are used, for example, for time based windowing.</td>
+ </tr>
+ <tr>
+ <td><h5>pipeline.cached-files</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>List<String></td>
+ <td>Files to be registered at the distributed cache under the given name. The files will be accessible from any user-defined function in the (distributed) runtime under a local path. Files may be local files (which will be distributed via BlobServer), or files in a distributed file system. The runtime will copy the files temporarily to a local cache, if needed.<br /><br />Example:<br /><span markdown="span">`name:file1,path:`file:///tmp/file1`;name:file2,path:`hdfs:///tmp/fil [...]
+ </tr>
+ <tr>
+ <td><h5>pipeline.classpaths</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>List<String></td>
+ <td>A semicolon-separated list of the classpaths to package with the job jars to be sent to the cluster. These have to be valid URLs.</td>
+ </tr>
+ <tr>
+ <td><h5>pipeline.closure-cleaner-level</h5></td>
+ <td style="word-wrap: break-word;">RECURSIVE</td>
+ <td><p>Enum</p>Possible values: [NONE, TOP_LEVEL, RECURSIVE]</td>
+ <td>Configures the mode in which the closure cleaner works<ul><li><span markdown="span">`NONE`</span> - disables the closure cleaner completely</li><li><span markdown="span">`TOP_LEVEL`</span> - cleans only the top-level class without recursing into fields</li><li><span markdown="span">`RECURSIVE`</span> - cleans all the fields recursively</li></ul></td>
+ </tr>
+ <tr>
+ <td><h5>pipeline.default-kryo-serializers</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>List<String></td>
+ <td>Semicolon separated list of pairs of class names and Kryo serializers class names to be used as Kryo default serializers<br /><br />Example:<br /><span markdown="span">`class:org.example.ExampleClass,serializer:org.example.ExampleSerializer1; class:org.example.ExampleClass2,serializer:org.example.ExampleSerializer2`</span></td>
+ </tr>
+ <tr>
+ <td><h5>pipeline.force-avro</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Forces Flink to use the Apache Avro serializer for POJOs.<br /><br />Important: Make sure to include the <span markdown="span">`flink-avro`</span> module.</td>
+ </tr>
+ <tr>
+ <td><h5>pipeline.force-kryo</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>If enabled, forces TypeExtractor to use Kryo serializer for POJOS even though we could analyze as POJO. In some cases this might be preferable. For example, when using interfaces with subclasses that cannot be analyzed as POJO.</td>
+ </tr>
+ <tr>
+ <td><h5>pipeline.generic-types</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>If the use of generic types is disabled, Flink will throw an <span markdown="span">`UnsupportedOperationException`</span> whenever it encounters a data type that would go through Kryo for serialization.<br /><br />Disabling generic types can be helpful to eagerly find and eliminate the use of types that would go through Kryo serialization during runtime. Rather than checking types individually, using this option will throw exceptions eagerly in the places where generic ty [...]
+ </tr>
+ <tr>
+ <td><h5>pipeline.global-job-parameters</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>Map</td>
+ <td>Register a custom, serializable user configuration object. The configuration can be accessed in operators</td>
+ </tr>
+ <tr>
+ <td><h5>pipeline.jars</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>List<String></td>
+ <td>A semicolon-separated list of the jars to package with the job jars to be sent to the cluster. These have to be valid paths.</td>
+ </tr>
+ <tr>
+ <td><h5>pipeline.max-parallelism</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>The program-wide maximum parallelism used for operators which haven't specified a maximum parallelism. The maximum parallelism specifies the upper limit for dynamic scaling and the number of key groups used for partitioned state.</td>
+ </tr>
+ <tr>
+ <td><h5>pipeline.object-reuse</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>When enabled objects that Flink internally uses for deserialization and passing data to user-code functions will be reused. Keep in mind that this can lead to bugs when the user-code function of an operation is not aware of this behaviour.</td>
+ </tr>
+ <tr>
+ <td><h5>pipeline.operator-chaining</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>Operator chaining allows non-shuffle operations to be co-located in the same thread fully avoiding serialization and de-serialization.</td>
+ </tr>
+ <tr>
+ <td><h5>pipeline.registered-kryo-types</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>List<String></td>
+ <td>Semicolon separated list of types to be registered with the serialization stack. If the type is eventually serialized as a POJO, then the type is registered with the POJO serializer. If the type ends up being serialized with Kryo, then it will be registered at Kryo to make sure that only tags are written.</td>
+ </tr>
+ <tr>
+ <td><h5>pipeline.registered-pojo-types</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>List<String></td>
+ <td>Semicolon separated list of types to be registered with the serialization stack. If the type is eventually serialized as a POJO, then the type is registered with the POJO serializer. If the type ends up being serialized with Kryo, then it will be registered at Kryo to make sure that only tags are written.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/prometheus_push_gateway_reporter_configuration.html b/docs/_includes/generated/prometheus_push_gateway_reporter_configuration.html
new file mode 100644
index 0000000..8128bf8
--- /dev/null
+++ b/docs/_includes/generated/prometheus_push_gateway_reporter_configuration.html
@@ -0,0 +1,54 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>deleteOnShutdown</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>Specifies whether to delete metrics from the PushGateway on shutdown.</td>
+ </tr>
+ <tr>
+ <td><h5>filterLabelValueCharacters</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>Specifies whether to filter label value characters. If enabled, all characters not matching [a-zA-Z0-9:_] will be removed, otherwise no characters will be removed. Before disabling this option please ensure that your label values meet the <a href="https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels">Prometheus requirements</a>.</td>
+ </tr>
+ <tr>
+ <td><h5>groupingKey</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Specifies the grouping key which is the group and global labels of all metrics. The label name and value are separated by '=', and labels are separated by ';', e.g., <span markdown="span">`k1=v1;k2=v2`</span>. Please ensure that your grouping key meets the <a href="https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels">Prometheus requirements</a>.</td>
+ </tr>
+ <tr>
+ <td><h5>host</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The PushGateway server host.</td>
+ </tr>
+ <tr>
+ <td><h5>jobName</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The job name under which metrics will be pushed</td>
+ </tr>
+ <tr>
+ <td><h5>port</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>The PushGateway server port.</td>
+ </tr>
+ <tr>
+ <td><h5>randomJobNameSuffix</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>Specifies whether a random suffix should be appended to the job name.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/python_configuration.html b/docs/_includes/generated/python_configuration.html
new file mode 100644
index 0000000..212cec2
--- /dev/null
+++ b/docs/_includes/generated/python_configuration.html
@@ -0,0 +1,42 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>python.fn-execution.arrow.batch.size</h5></td>
+ <td style="word-wrap: break-word;">1000</td>
+ <td>Integer</td>
+ <td>The maximum number of elements to include in an arrow batch for Python user-defined function execution. The arrow batch size should not exceed the bundle size. Otherwise, the bundle size will be used as the arrow batch size.</td>
+ </tr>
+ <tr>
+ <td><h5>python.fn-execution.buffer.memory.size</h5></td>
+ <td style="word-wrap: break-word;">"15mb"</td>
+ <td>String</td>
+ <td>The amount of memory to be allocated by the input buffer and output buffer of a Python worker. The memory will be accounted as managed memory if the actual memory allocated to an operator is no less than the total memory of a Python worker. Otherwise, this configuration takes no effect.</td>
+ </tr>
+ <tr>
+ <td><h5>python.fn-execution.bundle.size</h5></td>
+ <td style="word-wrap: break-word;">1000</td>
+ <td>Integer</td>
+ <td>The maximum number of elements to include in a bundle for Python user-defined function execution. The elements are processed asynchronously. One bundle of elements are processed before processing the next bundle of elements. A larger value can improve the throughput, but at the cost of more memory usage and higher latency.</td>
+ </tr>
+ <tr>
+ <td><h5>python.fn-execution.bundle.time</h5></td>
+ <td style="word-wrap: break-word;">1000</td>
+ <td>Long</td>
+ <td>Sets the waiting timeout(in milliseconds) before processing a bundle for Python user-defined function execution. The timeout defines how long the elements of a bundle will be buffered before being processed. Lower timeouts lead to lower tail latencies, but may affect throughput.</td>
+ </tr>
+ <tr>
+ <td><h5>python.fn-execution.framework.memory.size</h5></td>
+ <td style="word-wrap: break-word;">"64mb"</td>
+ <td>String</td>
+ <td>The amount of memory to be allocated by the Python framework. The sum of the value of this configuration and "python.fn-execution.buffer.memory.size" represents the total memory of a Python worker. The memory will be accounted as managed memory if the actual memory allocated to an operator is no less than the total memory of a Python worker. Otherwise, this configuration takes no effect.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/queryable_state_configuration.html b/docs/_includes/generated/queryable_state_configuration.html
new file mode 100644
index 0000000..b0e7dc5
--- /dev/null
+++ b/docs/_includes/generated/queryable_state_configuration.html
@@ -0,0 +1,60 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>queryable-state.client.network-threads</h5></td>
+ <td style="word-wrap: break-word;">0</td>
+ <td>Integer</td>
+ <td>Number of network (Netty's event loop) Threads for queryable state client.</td>
+ </tr>
+ <tr>
+ <td><h5>queryable-state.enable</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</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>Integer</td>
+ <td>Number of network (Netty's event loop) Threads for queryable state proxy.</td>
+ </tr>
+ <tr>
+ <td><h5>queryable-state.proxy.ports</h5></td>
+ <td style="word-wrap: break-word;">"9069"</td>
+ <td>String</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>queryable-state.proxy.query-threads</h5></td>
+ <td style="word-wrap: break-word;">0</td>
+ <td>Integer</td>
+ <td>Number of query Threads for queryable state proxy. Uses the number of slots if set to 0.</td>
+ </tr>
+ <tr>
+ <td><h5>queryable-state.server.network-threads</h5></td>
+ <td style="word-wrap: break-word;">0</td>
+ <td>Integer</td>
+ <td>Number of network (Netty's event loop) Threads for queryable state server.</td>
+ </tr>
+ <tr>
+ <td><h5>queryable-state.server.ports</h5></td>
+ <td style="word-wrap: break-word;">"9067"</td>
+ <td>String</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>queryable-state.server.query-threads</h5></td>
+ <td style="word-wrap: break-word;">0</td>
+ <td>Integer</td>
+ <td>Number of query Threads for queryable state server. Uses the number of slots if set to 0.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/resource_manager_configuration.html b/docs/_includes/generated/resource_manager_configuration.html
new file mode 100644
index 0000000..c1955f8
--- /dev/null
+++ b/docs/_includes/generated/resource_manager_configuration.html
@@ -0,0 +1,48 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>containerized.heap-cutoff-min</h5></td>
+ <td style="word-wrap: break-word;">600</td>
+ <td>Integer</td>
+ <td>Minimum amount of heap memory to remove in Job Master containers, as a safety margin.</td>
+ </tr>
+ <tr>
+ <td><h5>containerized.heap-cutoff-ratio</h5></td>
+ <td style="word-wrap: break-word;">0.25</td>
+ <td>Float</td>
+ <td>Percentage of heap space to remove from Job Master containers (YARN / Mesos / Kubernetes), to compensate for other JVM memory usage.</td>
+ </tr>
+ <tr>
+ <td><h5>resourcemanager.job.timeout</h5></td>
+ <td style="word-wrap: break-word;">"5 minutes"</td>
+ <td>String</td>
+ <td>Timeout for jobs which don't have a job manager as leader assigned.</td>
+ </tr>
+ <tr>
+ <td><h5>resourcemanager.rpc.port</h5></td>
+ <td style="word-wrap: break-word;">0</td>
+ <td>Integer</td>
+ <td>Defines the network port to connect to for communication with the resource manager. By default, the port of the JobManager, because the same ActorSystem is used. Its not possible to use this configuration key to define port ranges.</td>
+ </tr>
+ <tr>
+ <td><h5>resourcemanager.standalone.start-up-time</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Long</td>
+ <td>Time in milliseconds of the start-up period of a standalone cluster. During this time, resource manager of the standalone cluster expects new task executors to be registered, and will not fail slot requests that can not be satisfied by any current registered slots. After this time, it will fail pending and new coming requests immediately that can not be satisfied by registered slots. If not set, 'slotmanager.request-timeout' will be used by default.</td>
+ </tr>
+ <tr>
+ <td><h5>resourcemanager.taskmanager-timeout</h5></td>
+ <td style="word-wrap: break-word;">30000</td>
+ <td>Long</td>
+ <td>The timeout for an idle task manager to be released.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/rest_configuration.html b/docs/_includes/generated/rest_configuration.html
new file mode 100644
index 0000000..c2191db
--- /dev/null
+++ b/docs/_includes/generated/rest_configuration.html
@@ -0,0 +1,90 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <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>
+ </tr>
+ <tr>
+ <td><h5>rest.await-leader-timeout</h5></td>
+ <td style="word-wrap: break-word;">30000</td>
+ <td>Long</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.bind-address</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The address that the server binds itself.</td>
+ </tr>
+ <tr>
+ <td><h5>rest.bind-port</h5></td>
+ <td style="word-wrap: break-word;">"8081"</td>
+ <td>String</td>
+ <td>The port that the server binds itself. Accepts a list of ports (“50100,50101”), ranges (“50100-50200”) or a combination of both. It is recommended to set a range of ports to avoid collisions when multiple Rest servers are running on the same machine.</td>
+ </tr>
+ <tr>
+ <td><h5>rest.client.max-content-length</h5></td>
+ <td style="word-wrap: break-word;">104857600</td>
+ <td>Integer</td>
+ <td>The maximum content length in bytes that the client will handle.</td>
+ </tr>
+ <tr>
+ <td><h5>rest.connection-timeout</h5></td>
+ <td style="word-wrap: break-word;">15000</td>
+ <td>Long</td>
+ <td>The maximum time in ms for the client to establish a TCP connection.</td>
+ </tr>
+ <tr>
+ <td><h5>rest.idleness-timeout</h5></td>
+ <td style="word-wrap: break-word;">300000</td>
+ <td>Long</td>
+ <td>The maximum time in ms for a connection to stay idle before failing.</td>
+ </tr>
+ <tr>
+ <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>
+ </tr>
+ <tr>
+ <td><h5>rest.retry.delay</h5></td>
+ <td style="word-wrap: break-word;">3000</td>
+ <td>Long</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 style="word-wrap: break-word;">20</td>
+ <td>Integer</td>
+ <td>The number of retries the client will attempt if a retryable operations fails.</td>
+ </tr>
+ <tr>
+ <td><h5>rest.server.max-content-length</h5></td>
+ <td style="word-wrap: break-word;">104857600</td>
+ <td>Integer</td>
+ <td>The maximum content length in bytes that the server will handle.</td>
+ </tr>
+ <tr>
+ <td><h5>rest.server.numThreads</h5></td>
+ <td style="word-wrap: break-word;">4</td>
+ <td>Integer</td>
+ <td>The number of threads for the asynchronous processing of requests.</td>
+ </tr>
+ <tr>
+ <td><h5>rest.server.thread-priority</h5></td>
+ <td style="word-wrap: break-word;">5</td>
+ <td>Integer</td>
+ <td>Thread priority of the REST server's executor for processing asynchronous requests. Lowering the thread priority will give Flink's main components more CPU time whereas increasing will allocate more time for the REST server's processing.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/rest_v1_dispatcher.html b/docs/_includes/generated/rest_v1_dispatcher.html
new file mode 100644
index 0000000..79c1ba4
--- /dev/null
+++ b/docs/_includes/generated/rest_v1_dispatcher.html
@@ -0,0 +1,4196 @@
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/cluster</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>DELETE</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Shuts down the cluster</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1674237828">Request</button>
+ <div id="-1674237828" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1489255004">Response</button>
+ <div id="-1489255004" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/config</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns the configuration of the WebUI.</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1131337549">Request</button>
+ <div id="1131337549" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1846075211">Response</button>
+ <div id="1846075211" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:DashboardConfiguration",
+ "properties" : {
+ "features" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:DashboardConfiguration:Features",
+ "properties" : {
+ "web-submit" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "flink-revision" : {
+ "type" : "string"
+ },
+ "flink-version" : {
+ "type" : "string"
+ },
+ "refresh-interval" : {
+ "type" : "integer"
+ },
+ "timezone-name" : {
+ "type" : "string"
+ },
+ "timezone-offset" : {
+ "type" : "integer"
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jars</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns a list of all jars previously uploaded via '/jars/upload'.</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-525177469">Request</button>
+ <div id="-525177469" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1669843955">Response</button>
+ <div id="-1669843955" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarListInfo",
+ "properties" : {
+ "address" : {
+ "type" : "string"
+ },
+ "files" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarListInfo:JarFileInfo",
+ "properties" : {
+ "entry" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarListInfo:JarEntryInfo",
+ "properties" : {
+ "description" : {
+ "type" : "string"
+ },
+ "name" : {
+ "type" : "string"
+ }
+ }
+ }
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "uploaded" : {
+ "type" : "integer"
+ }
+ }
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jars/upload</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>POST</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Uploads a jar to the cluster. The jar must be sent as multi-part data. Make sure that the "Content-Type" header is set to "application/x-java-archive", as some http libraries do not add the header by default.
+Using 'curl' you can upload a jar via 'curl -X POST -H "Expect:" -F "jarfile=@path/to/flink-job.jar" http://hostname:port/jars/upload'.</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1290030289">Request</button>
+ <div id="-1290030289" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1132420209">Response</button>
+ <div id="1132420209" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarUploadResponseBody",
+ "properties" : {
+ "filename" : {
+ "type" : "string"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "success" ]
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jars/:jarid</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>DELETE</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Deletes a jar previously uploaded via '/jars/upload'.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jarid</code> - String value that identifies a jar. When uploading the jar a path is returned, where the filename is the ID. This value is equivalent to the `id` field in the list of uploaded jars (/jars).</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-974639435">Request</button>
+ <div id="-974639435" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-789656611">Response</button>
+ <div id="-789656611" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jars/:jarid/plan</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns the dataflow plan of a job contained in a jar previously uploaded via '/jars/upload'. Program arguments can be passed both via the JSON request (recommended) or query parameters.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jarid</code> - String value that identifies a jar. When uploading the jar a path is returned, where the filename is the ID. This value is equivalent to the `id` field in the list of uploaded jars (/jars).</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">Query parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>program-args</code> (optional): Deprecated, please use 'programArg' instead. String value that specifies the arguments for the program or plan</li>
+<li><code>programArg</code> (optional): Comma-separated list of program arguments.</li>
+<li><code>entry-class</code> (optional): String value that specifies the fully qualified name of the entry point class. Overrides the class defined in the jar file manifest.</li>
+<li><code>parallelism</code> (optional): Positive integer value that specifies the desired parallelism for the job.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#550027726">Request</button>
+ <div id="550027726" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarPlanRequestBody",
+ "properties" : {
+ "entryClass" : {
+ "type" : "string"
+ },
+ "jobId" : {
+ "type" : "any"
+ },
+ "parallelism" : {
+ "type" : "integer"
+ },
+ "programArgs" : {
+ "type" : "string"
+ },
+ "programArgsList" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1311035100">Response</button>
+ <div id="1311035100" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPlanInfo",
+ "properties" : {
+ "plan" : {
+ "type" : "any"
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jars/:jarid/plan</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns the dataflow plan of a job contained in a jar previously uploaded via '/jars/upload'. Program arguments can be passed both via the JSON request (recommended) or query parameters.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jarid</code> - String value that identifies a jar. When uploading the jar a path is returned, where the filename is the ID. This value is equivalent to the `id` field in the list of uploaded jars (/jars).</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">Query parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>program-args</code> (optional): Deprecated, please use 'programArg' instead. String value that specifies the arguments for the program or plan</li>
+<li><code>programArg</code> (optional): Comma-separated list of program arguments.</li>
+<li><code>entry-class</code> (optional): String value that specifies the fully qualified name of the entry point class. Overrides the class defined in the jar file manifest.</li>
+<li><code>parallelism</code> (optional): Positive integer value that specifies the desired parallelism for the job.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#550027726">Request</button>
+ <div id="550027726" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarPlanRequestBody",
+ "properties" : {
+ "entryClass" : {
+ "type" : "string"
+ },
+ "jobId" : {
+ "type" : "any"
+ },
+ "parallelism" : {
+ "type" : "integer"
+ },
+ "programArgs" : {
+ "type" : "string"
+ },
+ "programArgsList" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1311035100">Response</button>
+ <div id="1311035100" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPlanInfo",
+ "properties" : {
+ "plan" : {
+ "type" : "any"
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jars/:jarid/run</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>POST</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Submits a job by running a jar previously uploaded via '/jars/upload'. Program arguments can be passed both via the JSON request (recommended) or query parameters.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jarid</code> - String value that identifies a jar. When uploading the jar a path is returned, where the filename is the ID. This value is equivalent to the `id` field in the list of uploaded jars (/jars).</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">Query parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>allowNonRestoredState</code> (optional): Boolean value that specifies whether the job submission should be rejected if the savepoint contains state that cannot be mapped back to the job.</li>
+<li><code>savepointPath</code> (optional): String value that specifies the path of the savepoint to restore the job from.</li>
+<li><code>program-args</code> (optional): Deprecated, please use 'programArg' instead. String value that specifies the arguments for the program or plan</li>
+<li><code>programArg</code> (optional): Comma-separated list of program arguments.</li>
+<li><code>entry-class</code> (optional): String value that specifies the fully qualified name of the entry point class. Overrides the class defined in the jar file manifest.</li>
+<li><code>parallelism</code> (optional): Positive integer value that specifies the desired parallelism for the job.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#315035146">Request</button>
+ <div id="315035146" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarRunRequestBody",
+ "properties" : {
+ "allowNonRestoredState" : {
+ "type" : "boolean"
+ },
+ "entryClass" : {
+ "type" : "string"
+ },
+ "jobId" : {
+ "type" : "any"
+ },
+ "parallelism" : {
+ "type" : "integer"
+ },
+ "programArgs" : {
+ "type" : "string"
+ },
+ "programArgsList" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ },
+ "savepointPath" : {
+ "type" : "string"
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-914083094">Response</button>
+ <div id="-914083094" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:webmonitor:handlers:JarRunResponseBody",
+ "properties" : {
+ "jobid" : {
+ "type" : "any"
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobmanager/config</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns the cluster configuration.</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1135512494">Request</button>
+ <div id="1135512494" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#816073812">Response</button>
+ <div id="816073812" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:ClusterConfigurationInfoEntry",
+ "properties" : {
+ "key" : {
+ "type" : "string"
+ },
+ "value" : {
+ "type" : "string"
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobmanager/metrics</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Provides access to job manager metrics.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Query parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>get</code> (optional): Comma-separated list of string values to select specific metrics.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#821119119">Request</button>
+ <div id="821119119" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1131847480">Response</button>
+ <div id="1131847480" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "any"
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns an overview over all jobs and their current state.</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-525164511">Request</button>
+ <div id="-525164511" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-176199833">Response</button>
+ <div id="-176199833" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:JobIdsWithStatusOverview",
+ "properties" : {
+ "jobs" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:JobIdsWithStatusOverview:JobIdWithStatus",
+ "properties" : {
+ "id" : {
+ "type" : "any"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "CREATED", "RUNNING", "FAILING", "FAILED", "CANCELLING", "CANCELED", "FINISHED", "RESTARTING", "SUSPENDED", "RECONCILING" ]
+ }
+ }
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>POST</code></td>
+ <td class="text-left">Response code: <code>202 Accepted</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Submits a job. This call is primarily intended to be used by the Flink client. This call expects a multipart/form-data request that consists of file uploads for the serialized JobGraph, jars and distributed cache artifacts and an attribute named "request" for the JSON payload.</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#972993332">Request</button>
+ <div id="972993332" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobSubmitRequestBody",
+ "properties" : {
+ "jobArtifactFileNames" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobSubmitRequestBody:DistributedCacheFile",
+ "properties" : {
+ "entryName" : {
+ "type" : "string"
+ },
+ "fileName" : {
+ "type" : "string"
+ }
+ }
+ }
+ },
+ "jobGraphFileName" : {
+ "type" : "string"
+ },
+ "jobJarFileNames" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1213670870">Response</button>
+ <div id="-1213670870" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobSubmitResponseBody",
+ "properties" : {
+ "jobUrl" : {
+ "type" : "string"
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/metrics</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Provides access to aggregated job metrics.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Query parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>get</code> (optional): Comma-separated list of string values to select specific metrics.</li>
+<li><code>agg</code> (optional): Comma-separated list of aggregation modes which should be calculated. Available aggregations are: "min, max, sum, avg".</li>
+<li><code>jobs</code> (optional): Comma-separated list of 32-character hexadecimal strings to select specific jobs.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-790902571">Request</button>
+ <div id="-790902571" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#128306770">Response</button>
+ <div id="128306770" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "any"
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/overview</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns an overview over all jobs.</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-2103612833">Request</button>
+ <div id="-2103612833" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#2114114357">Response</button>
+ <div id="2114114357" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:messages:webmonitor:MultipleJobsDetails",
+ "properties" : {
+ "jobs" : {
+ "type" : "array",
+ "items" : {
+ "type" : "any"
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns details of a job.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1706240260">Request</button>
+ <div id="1706240260" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#481009572">Response</button>
+ <div id="481009572" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobDetailsInfo",
+ "properties" : {
+ "duration" : {
+ "type" : "integer"
+ },
+ "end-time" : {
+ "type" : "integer"
+ },
+ "isStoppable" : {
+ "type" : "boolean"
+ },
+ "jid" : {
+ "type" : "any"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "now" : {
+ "type" : "integer"
+ },
+ "plan" : {
+ "type" : "string"
+ },
+ "start-time" : {
+ "type" : "integer"
+ },
+ "state" : {
+ "type" : "string",
+ "enum" : [ "CREATED", "RUNNING", "FAILING", "FAILED", "CANCELLING", "CANCELED", "FINISHED", "RESTARTING", "SUSPENDED", "RECONCILING" ]
+ },
+ "status-counts" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "integer"
+ }
+ },
+ "timestamps" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "integer"
+ }
+ },
+ "vertices" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobDetailsInfo:JobVertexDetailsInfo",
+ "properties" : {
+ "duration" : {
+ "type" : "integer"
+ },
+ "end-time" : {
+ "type" : "integer"
+ },
+ "id" : {
+ "type" : "any"
+ },
+ "metrics" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo",
+ "properties" : {
+ "read-bytes" : {
+ "type" : "integer"
+ },
+ "read-bytes-complete" : {
+ "type" : "boolean"
+ },
+ "read-records" : {
+ "type" : "integer"
+ },
+ "read-records-complete" : {
+ "type" : "boolean"
+ },
+ "write-bytes" : {
+ "type" : "integer"
+ },
+ "write-bytes-complete" : {
+ "type" : "boolean"
+ },
+ "write-records" : {
+ "type" : "integer"
+ },
+ "write-records-complete" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "parallelism" : {
+ "type" : "integer"
+ },
+ "start-time" : {
+ "type" : "integer"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ]
+ },
+ "tasks" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "integer"
+ }
+ }
+ }
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>PATCH</code></td>
+ <td class="text-left">Response code: <code>202 Accepted</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Terminates a job.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">Query parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>mode</code> (optional): String value that specifies the termination mode. The only supported value is: "cancel".</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1782070774">Request</button>
+ <div id="1782070774" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1967053598">Response</button>
+ <div id="1967053598" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/accumulators</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns the accumulators for all tasks of a job, aggregated across the respective subtasks.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">Query parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>includeSerializedValue</code> (optional): Boolean value that specifies whether serialized user task accumulators should be included in the response.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1713172624">Request</button>
+ <div id="1713172624" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#2033336224">Response</button>
+ <div id="2033336224" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobAccumulatorsInfo",
+ "properties" : {
+ "job-accumulators" : {
+ "type" : "array",
+ "items" : {
+ "type" : "any"
+ }
+ },
+ "serialized-user-task-accumulators" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "any"
+ }
+ },
+ "user-task-accumulators" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobAccumulatorsInfo:UserTaskAccumulator",
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "value" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/checkpoints</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns checkpointing statistics for a job.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1935063712">Request</button>
+ <div id="-1935063712" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1368158030">Response</button>
+ <div id="-1368158030" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics",
+ "properties" : {
+ "counts" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:Counts",
+ "properties" : {
+ "completed" : {
+ "type" : "integer"
+ },
+ "failed" : {
+ "type" : "integer"
+ },
+ "in_progress" : {
+ "type" : "integer"
+ },
+ "restored" : {
+ "type" : "integer"
+ },
+ "total" : {
+ "type" : "integer"
+ }
+ }
+ },
+ "history" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics",
+ "properties" : {
+ "alignment_buffered" : {
+ "type" : "integer"
+ },
+ "end_to_end_duration" : {
+ "type" : "integer"
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "is_savepoint" : {
+ "type" : "boolean"
+ },
+ "latest_ack_timestamp" : {
+ "type" : "integer"
+ },
+ "num_acknowledged_subtasks" : {
+ "type" : "integer"
+ },
+ "num_subtasks" : {
+ "type" : "integer"
+ },
+ "state_size" : {
+ "type" : "integer"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
+ },
+ "tasks" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object",
+ "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics"
+ }
+ },
+ "trigger_timestamp" : {
+ "type" : "integer"
+ }
+ }
+ }
+ },
+ "latest" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:LatestCheckpoints",
+ "properties" : {
+ "completed" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics:CompletedCheckpointStatistics",
+ "properties" : {
+ "alignment_buffered" : {
+ "type" : "integer"
+ },
+ "discarded" : {
+ "type" : "boolean"
+ },
+ "end_to_end_duration" : {
+ "type" : "integer"
+ },
+ "external_path" : {
+ "type" : "string"
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "is_savepoint" : {
+ "type" : "boolean"
+ },
+ "latest_ack_timestamp" : {
+ "type" : "integer"
+ },
+ "num_acknowledged_subtasks" : {
+ "type" : "integer"
+ },
+ "num_subtasks" : {
+ "type" : "integer"
+ },
+ "state_size" : {
+ "type" : "integer"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
+ },
+ "tasks" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics",
+ "properties" : {
+ "alignment_buffered" : {
+ "type" : "integer"
+ },
+ "end_to_end_duration" : {
+ "type" : "integer"
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "latest_ack_timestamp" : {
+ "type" : "integer"
+ },
+ "num_acknowledged_subtasks" : {
+ "type" : "integer"
+ },
+ "num_subtasks" : {
+ "type" : "integer"
+ },
+ "state_size" : {
+ "type" : "integer"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
+ }
+ }
+ }
+ },
+ "trigger_timestamp" : {
+ "type" : "integer"
+ }
+ }
+ },
+ "failed" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics:FailedCheckpointStatistics",
+ "properties" : {
+ "alignment_buffered" : {
+ "type" : "integer"
+ },
+ "end_to_end_duration" : {
+ "type" : "integer"
+ },
+ "failure_message" : {
+ "type" : "string"
+ },
+ "failure_timestamp" : {
+ "type" : "integer"
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "is_savepoint" : {
+ "type" : "boolean"
+ },
+ "latest_ack_timestamp" : {
+ "type" : "integer"
+ },
+ "num_acknowledged_subtasks" : {
+ "type" : "integer"
+ },
+ "num_subtasks" : {
+ "type" : "integer"
+ },
+ "state_size" : {
+ "type" : "integer"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
+ },
+ "tasks" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object",
+ "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics"
+ }
+ },
+ "trigger_timestamp" : {
+ "type" : "integer"
+ }
+ }
+ },
+ "restored" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:RestoredCheckpointStatistics",
+ "properties" : {
+ "external_path" : {
+ "type" : "string"
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "is_savepoint" : {
+ "type" : "boolean"
+ },
+ "restore_timestamp" : {
+ "type" : "integer"
+ }
+ }
+ },
+ "savepoint" : {
+ "type" : "object",
+ "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics:CompletedCheckpointStatistics"
+ }
+ }
+ },
+ "summary" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointingStatistics:Summary",
+ "properties" : {
+ "alignment_buffered" : {
+ "type" : "object",
+ "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics"
+ },
+ "end_to_end_duration" : {
+ "type" : "object",
+ "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics"
+ },
+ "state_size" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics",
+ "properties" : {
+ "avg" : {
+ "type" : "integer"
+ },
+ "max" : {
+ "type" : "integer"
+ },
+ "min" : {
+ "type" : "integer"
+ }
+ }
+ }
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/checkpoints/config</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns the checkpointing configuration.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1905242249">Request</button>
+ <div id="1905242249" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#808099872">Response</button>
+ <div id="808099872" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointConfigInfo",
+ "properties" : {
+ "externalization" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointConfigInfo:ExternalizedCheckpointInfo",
+ "properties" : {
+ "delete_on_cancellation" : {
+ "type" : "boolean"
+ },
+ "enabled" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "interval" : {
+ "type" : "integer"
+ },
+ "max_concurrent" : {
+ "type" : "integer"
+ },
+ "min_pause" : {
+ "type" : "integer"
+ },
+ "mode" : {
+ "type" : "any"
+ },
+ "state_backend" : {
+ "type" : "string"
+ },
+ "timeout" : {
+ "type" : "integer"
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/checkpoints/details/:checkpointid</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns details for a checkpoint.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+<li><code>checkpointid</code> - Long value that identifies a checkpoint.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#2082812513">Request</button>
+ <div id="2082812513" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#59893771">Response</button>
+ <div id="59893771" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:CheckpointStatistics",
+ "properties" : {
+ "alignment_buffered" : {
+ "type" : "integer"
+ },
+ "end_to_end_duration" : {
+ "type" : "integer"
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "is_savepoint" : {
+ "type" : "boolean"
+ },
+ "latest_ack_timestamp" : {
+ "type" : "integer"
+ },
+ "num_acknowledged_subtasks" : {
+ "type" : "integer"
+ },
+ "num_subtasks" : {
+ "type" : "integer"
+ },
+ "state_size" : {
+ "type" : "integer"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
+ },
+ "tasks" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatistics",
+ "properties" : {
+ "alignment_buffered" : {
+ "type" : "integer"
+ },
+ "end_to_end_duration" : {
+ "type" : "integer"
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "latest_ack_timestamp" : {
+ "type" : "integer"
+ },
+ "num_acknowledged_subtasks" : {
+ "type" : "integer"
+ },
+ "num_subtasks" : {
+ "type" : "integer"
+ },
+ "state_size" : {
+ "type" : "integer"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
+ }
+ }
+ }
+ },
+ "trigger_timestamp" : {
+ "type" : "integer"
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/checkpoints/details/:checkpointid/subtasks/:vertexid</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns checkpoint statistics for a task and its subtasks.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+<li><code>checkpointid</code> - Long value that identifies a checkpoint.</li>
+<li><code>vertexid</code> - 32-character hexadecimal string value that identifies a job vertex.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#206551710">Request</button>
+ <div id="206551710" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#147094768">Response</button>
+ <div id="147094768" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails",
+ "properties" : {
+ "alignment_buffered" : {
+ "type" : "integer"
+ },
+ "end_to_end_duration" : {
+ "type" : "integer"
+ },
+ "id" : {
+ "type" : "integer"
+ },
+ "latest_ack_timestamp" : {
+ "type" : "integer"
+ },
+ "num_acknowledged_subtasks" : {
+ "type" : "integer"
+ },
+ "num_subtasks" : {
+ "type" : "integer"
+ },
+ "state_size" : {
+ "type" : "integer"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "IN_PROGRESS", "COMPLETED", "FAILED" ]
+ },
+ "subtasks" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:SubtaskCheckpointStatistics",
+ "properties" : {
+ "index" : {
+ "type" : "integer"
+ },
+ "status" : {
+ "type" : "string"
+ }
+ }
+ }
+ },
+ "summary" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails:Summary",
+ "properties" : {
+ "alignment" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails:CheckpointAlignment",
+ "properties" : {
+ "buffered" : {
+ "type" : "object",
+ "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics"
+ },
+ "duration" : {
+ "type" : "object",
+ "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics"
+ }
+ }
+ },
+ "checkpoint_duration" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:TaskCheckpointStatisticsWithSubtaskDetails:CheckpointDuration",
+ "properties" : {
+ "async" : {
+ "type" : "object",
+ "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics"
+ },
+ "sync" : {
+ "type" : "object",
+ "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics"
+ }
+ }
+ },
+ "end_to_end_duration" : {
+ "type" : "object",
+ "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics"
+ },
+ "start_delay" : {
+ "type" : "object",
+ "$ref" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics"
+ },
+ "state_size" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:checkpoints:MinMaxAvgStatistics",
+ "properties" : {
+ "avg" : {
+ "type" : "integer"
+ },
+ "max" : {
+ "type" : "integer"
+ },
+ "min" : {
+ "type" : "integer"
+ }
+ }
+ }
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/config</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns the configuration of a job.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1131490405">Request</button>
+ <div id="1131490405" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1732781110">Response</button>
+ <div id="-1732781110" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "any"
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/exceptions</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns the non-recoverable exceptions that have been observed by the job. The truncated flag defines whether more exceptions occurred, but are not listed, because the response would otherwise get too big.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">Query parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>maxExceptions</code> (optional): Comma-separated list of integer values that specifies the upper limit of exceptions to return.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1011644505">Request</button>
+ <div id="-1011644505" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1982519474">Response</button>
+ <div id="-1982519474" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobExceptionsInfo",
+ "properties" : {
+ "all-exceptions" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobExceptionsInfo:ExecutionExceptionInfo",
+ "properties" : {
+ "exception" : {
+ "type" : "string"
+ },
+ "location" : {
+ "type" : "string"
+ },
+ "task" : {
+ "type" : "string"
+ },
+ "timestamp" : {
+ "type" : "integer"
+ }
+ }
+ }
+ },
+ "root-exception" : {
+ "type" : "string"
+ },
+ "timestamp" : {
+ "type" : "integer"
+ },
+ "truncated" : {
+ "type" : "boolean"
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/execution-result</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns the result of a job execution. Gives access to the execution time of the job and to all accumulators created by this job.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1658976043">Request</button>
+ <div id="-1658976043" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1929690333">Response</button>
+ <div id="1929690333" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:JobExecutionResultResponseBody",
+ "properties" : {
+ "job-execution-result" : {
+ "type" : "any"
+ },
+ "status" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus",
+ "required" : true,
+ "properties" : {
+ "id" : {
+ "type" : "string",
+ "required" : true,
+ "enum" : [ "IN_PROGRESS", "COMPLETED" ]
+ }
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/metrics</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Provides access to job metrics.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">Query parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>get</code> (optional): Comma-separated list of string values to select specific metrics.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#696434360">Request</button>
+ <div id="696434360" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1007162721">Response</button>
+ <div id="1007162721" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "any"
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/plan</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns the dataflow plan of a job.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1593444876">Request</button>
+ <div id="1593444876" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1208792936">Response</button>
+ <div id="-1208792936" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobPlanInfo",
+ "properties" : {
+ "plan" : {
+ "type" : "any"
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/rescaling</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>PATCH</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Triggers the rescaling of a job. This async operation would return a 'triggerid' for further query identifier.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">Query parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>parallelism</code> (mandatory): Positive integer value that specifies the desired parallelism.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1066262171">Request</button>
+ <div id="1066262171" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#436242360">Response</button>
+ <div id="436242360" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:TriggerResponse",
+ "properties" : {
+ "request-id" : {
+ "type" : "any"
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/rescaling/:triggerid</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns the status of a rescaling operation.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+<li><code>triggerid</code> - 32-character hexadecimal string that identifies an asynchronous operation trigger ID. The ID was returned then the operation was triggered.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#879212983">Request</button>
+ <div id="879212983" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-953870153">Response</button>
+ <div id="-953870153" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationResult",
+ "properties" : {
+ "operation" : {
+ "type" : "any"
+ },
+ "status" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus",
+ "properties" : {
+ "id" : {
+ "type" : "string",
+ "required" : true,
+ "enum" : [ "IN_PROGRESS", "COMPLETED" ]
+ }
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/savepoints</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>POST</code></td>
+ <td class="text-left">Response code: <code>202 Accepted</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Triggers a savepoint, and optionally cancels the job afterwards. This async operation would return a 'triggerid' for further query identifier.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1876528584">Request</button>
+ <div id="-1876528584" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:savepoints:SavepointTriggerRequestBody",
+ "properties" : {
+ "cancel-job" : {
+ "type" : "boolean"
+ },
+ "target-directory" : {
+ "type" : "string"
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1570291914">Response</button>
+ <div id="1570291914" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:TriggerResponse",
+ "properties" : {
+ "request-id" : {
+ "type" : "any"
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/savepoints/:triggerid</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns the status of a savepoint operation.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+<li><code>triggerid</code> - 32-character hexadecimal string that identifies an asynchronous operation trigger ID. The ID was returned then the operation was triggered.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1196792611">Request</button>
+ <div id="-1196792611" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1265091549">Response</button>
+ <div id="1265091549" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationResult",
+ "properties" : {
+ "operation" : {
+ "type" : "any"
+ },
+ "status" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus",
+ "properties" : {
+ "id" : {
+ "type" : "string",
+ "required" : true,
+ "enum" : [ "IN_PROGRESS", "COMPLETED" ]
+ }
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/stop</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>POST</code></td>
+ <td class="text-left">Response code: <code>202 Accepted</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Stops a job with a savepoint. Optionally, it can also emit a MAX_WATERMARK before taking the savepoint to flush out any state waiting for timers to fire. This async operation would return a 'triggerid' for further query identifier.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1146617568">Request</button>
+ <div id="1146617568" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:savepoints:stop:StopWithSavepointRequestBody",
+ "properties" : {
+ "drain" : {
+ "type" : "boolean"
+ },
+ "targetDirectory" : {
+ "type" : "string"
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#965913964">Response</button>
+ <div id="965913964" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:TriggerResponse",
+ "properties" : {
+ "request-id" : {
+ "type" : "any"
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns details for a task, with a summary for each of its subtasks.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+<li><code>vertexid</code> - 32-character hexadecimal string value that identifies a job vertex.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-361288698">Request</button>
+ <div id="-361288698" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1698651823">Response</button>
+ <div id="-1698651823" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexDetailsInfo",
+ "properties" : {
+ "id" : {
+ "type" : "any"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "now" : {
+ "type" : "integer"
+ },
+ "parallelism" : {
+ "type" : "integer"
+ },
+ "subtasks" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptDetailsInfo",
+ "properties" : {
+ "attempt" : {
+ "type" : "integer"
+ },
+ "duration" : {
+ "type" : "integer"
+ },
+ "end-time" : {
+ "type" : "integer"
+ },
+ "host" : {
+ "type" : "string"
+ },
+ "metrics" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo",
+ "properties" : {
+ "read-bytes" : {
+ "type" : "integer"
+ },
+ "read-bytes-complete" : {
+ "type" : "boolean"
+ },
+ "read-records" : {
+ "type" : "integer"
+ },
+ "read-records-complete" : {
+ "type" : "boolean"
+ },
+ "write-bytes" : {
+ "type" : "integer"
+ },
+ "write-bytes-complete" : {
+ "type" : "boolean"
+ },
+ "write-records" : {
+ "type" : "integer"
+ },
+ "write-records-complete" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "start-time" : {
+ "type" : "integer"
+ },
+ "start_time" : {
+ "type" : "integer"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ]
+ },
+ "subtask" : {
+ "type" : "integer"
+ },
+ "taskmanager-id" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/accumulators</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns user-defined accumulators of a task, aggregated across all subtasks.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+<li><code>vertexid</code> - 32-character hexadecimal string value that identifies a job vertex.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#485581006">Request</button>
+ <div id="485581006" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1070353054">Response</button>
+ <div id="-1070353054" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexAccumulatorsInfo",
+ "properties" : {
+ "id" : {
+ "type" : "string"
+ },
+ "user-accumulators" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:UserAccumulator",
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "value" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/backpressure</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns back-pressure information for a job, and may initiate back-pressure sampling if necessary.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+<li><code>vertexid</code> - 32-character hexadecimal string value that identifies a job vertex.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1104577459">Request</button>
+ <div id="-1104577459" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#870803712">Response</button>
+ <div id="870803712" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexBackPressureInfo",
+ "properties" : {
+ "backpressure-level" : {
+ "type" : "string",
+ "enum" : [ "ok", "low", "high" ]
+ },
+ "end-timestamp" : {
+ "type" : "integer"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "deprecated", "ok" ]
+ },
+ "subtasks" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexBackPressureInfo:SubtaskBackPressureInfo",
+ "properties" : {
+ "backpressure-level" : {
+ "type" : "string",
+ "enum" : [ "ok", "low", "high" ]
+ },
+ "ratio" : {
+ "type" : "number"
+ },
+ "subtask" : {
+ "type" : "integer"
+ }
+ }
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/metrics</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Provides access to task metrics.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+<li><code>vertexid</code> - 32-character hexadecimal string value that identifies a job vertex.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">Query parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>get</code> (optional): Comma-separated list of string values to select specific metrics.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1608736838">Request</button>
+ <div id="-1608736838" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1298008477">Response</button>
+ <div id="-1298008477" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "any"
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/subtasks/accumulators</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns all user-defined accumulators for all subtasks of a task.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+<li><code>vertexid</code> - 32-character hexadecimal string value that identifies a job vertex.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-886388859">Request</button>
+ <div id="-886388859" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#112317594">Response</button>
+ <div id="112317594" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtasksAllAccumulatorsInfo",
+ "properties" : {
+ "id" : {
+ "type" : "any"
+ },
+ "parallelism" : {
+ "type" : "integer"
+ },
+ "subtasks" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtasksAllAccumulatorsInfo:SubtaskAccumulatorsInfo",
+ "properties" : {
+ "attempt" : {
+ "type" : "integer"
+ },
+ "host" : {
+ "type" : "string"
+ },
+ "subtask" : {
+ "type" : "integer"
+ },
+ "user-accumulators" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:UserAccumulator",
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "value" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/subtasks/metrics</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Provides access to aggregated subtask metrics.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+<li><code>vertexid</code> - 32-character hexadecimal string value that identifies a job vertex.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">Query parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>get</code> (optional): Comma-separated list of string values to select specific metrics.</li>
+<li><code>agg</code> (optional): Comma-separated list of aggregation modes which should be calculated. Available aggregations are: "min, max, sum, avg".</li>
+<li><code>subtasks</code> (optional): Comma-separated list of integer ranges (e.g. "1,3,5-9") to select specific subtasks.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#265134755">Request</button>
+ <div id="265134755" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1184344096">Response</button>
+ <div id="1184344096" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "any"
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns details of the current or latest execution attempt of a subtask.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+<li><code>vertexid</code> - 32-character hexadecimal string value that identifies a job vertex.</li>
+<li><code>subtaskindex</code> - Positive integer value that identifies a subtask.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-2021515193">Request</button>
+ <div id="-2021515193" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#254718090">Response</button>
+ <div id="254718090" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptDetailsInfo",
+ "properties" : {
+ "attempt" : {
+ "type" : "integer"
+ },
+ "duration" : {
+ "type" : "integer"
+ },
+ "end-time" : {
+ "type" : "integer"
+ },
+ "host" : {
+ "type" : "string"
+ },
+ "metrics" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo",
+ "properties" : {
+ "read-bytes" : {
+ "type" : "integer"
+ },
+ "read-bytes-complete" : {
+ "type" : "boolean"
+ },
+ "read-records" : {
+ "type" : "integer"
+ },
+ "read-records-complete" : {
+ "type" : "boolean"
+ },
+ "write-bytes" : {
+ "type" : "integer"
+ },
+ "write-bytes-complete" : {
+ "type" : "boolean"
+ },
+ "write-records" : {
+ "type" : "integer"
+ },
+ "write-records-complete" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "start-time" : {
+ "type" : "integer"
+ },
+ "start_time" : {
+ "type" : "integer"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ]
+ },
+ "subtask" : {
+ "type" : "integer"
+ },
+ "taskmanager-id" : {
+ "type" : "string"
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/attempts/:attempt</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns details of an execution attempt of a subtask. Multiple execution attempts happen in case of failure/recovery.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+<li><code>vertexid</code> - 32-character hexadecimal string value that identifies a job vertex.</li>
+<li><code>subtaskindex</code> - Positive integer value that identifies a subtask.</li>
+<li><code>attempt</code> - Positive integer value that identifies an execution attempt.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#168850740">Request</button>
+ <div id="168850740" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1849883273">Response</button>
+ <div id="-1849883273" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptDetailsInfo",
+ "properties" : {
+ "attempt" : {
+ "type" : "integer"
+ },
+ "duration" : {
+ "type" : "integer"
+ },
+ "end-time" : {
+ "type" : "integer"
+ },
+ "host" : {
+ "type" : "string"
+ },
+ "metrics" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo",
+ "properties" : {
+ "read-bytes" : {
+ "type" : "integer"
+ },
+ "read-bytes-complete" : {
+ "type" : "boolean"
+ },
+ "read-records" : {
+ "type" : "integer"
+ },
+ "read-records-complete" : {
+ "type" : "boolean"
+ },
+ "write-bytes" : {
+ "type" : "integer"
+ },
+ "write-bytes-complete" : {
+ "type" : "boolean"
+ },
+ "write-records" : {
+ "type" : "integer"
+ },
+ "write-records-complete" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "start-time" : {
+ "type" : "integer"
+ },
+ "start_time" : {
+ "type" : "integer"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ]
+ },
+ "subtask" : {
+ "type" : "integer"
+ },
+ "taskmanager-id" : {
+ "type" : "string"
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/attempts/:attempt/accumulators</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns the accumulators of an execution attempt of a subtask. Multiple execution attempts happen in case of failure/recovery.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+<li><code>vertexid</code> - 32-character hexadecimal string value that identifies a job vertex.</li>
+<li><code>subtaskindex</code> - Positive integer value that identifies a subtask.</li>
+<li><code>attempt</code> - Positive integer value that identifies an execution attempt.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1303317920">Request</button>
+ <div id="-1303317920" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1455274244">Response</button>
+ <div id="-1455274244" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:SubtaskExecutionAttemptAccumulatorsInfo",
+ "properties" : {
+ "attempt" : {
+ "type" : "integer"
+ },
+ "id" : {
+ "type" : "string"
+ },
+ "subtask" : {
+ "type" : "integer"
+ },
+ "user-accumulators" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:UserAccumulator",
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ },
+ "value" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/subtasks/:subtaskindex/metrics</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Provides access to subtask metrics.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+<li><code>vertexid</code> - 32-character hexadecimal string value that identifies a job vertex.</li>
+<li><code>subtaskindex</code> - Positive integer value that identifies a subtask.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">Query parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>get</code> (optional): Comma-separated list of string values to select specific metrics.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1918092027">Request</button>
+ <div id="1918092027" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-2066146908">Response</button>
+ <div id="-2066146908" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "any"
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/subtasktimes</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns time-related information for all subtasks of a task.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+<li><code>vertexid</code> - 32-character hexadecimal string value that identifies a job vertex.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1307377346">Request</button>
+ <div id="1307377346" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#285340640">Response</button>
+ <div id="285340640" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:SubtasksTimesInfo",
+ "properties" : {
+ "id" : {
+ "type" : "string"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "now" : {
+ "type" : "integer"
+ },
+ "subtasks" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:SubtasksTimesInfo:SubtaskTimeInfo",
+ "properties" : {
+ "duration" : {
+ "type" : "integer"
+ },
+ "host" : {
+ "type" : "string"
+ },
+ "subtask" : {
+ "type" : "integer"
+ },
+ "timestamps" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "integer"
+ }
+ }
+ }
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/taskmanagers</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns task information aggregated by task manager.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+<li><code>vertexid</code> - 32-character hexadecimal string value that identifies a job vertex.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-525795572">Request</button>
+ <div id="-525795572" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1406727934">Response</button>
+ <div id="1406727934" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexTaskManagersInfo",
+ "properties" : {
+ "id" : {
+ "type" : "any"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "now" : {
+ "type" : "integer"
+ },
+ "taskmanagers" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:JobVertexTaskManagersInfo:TaskManagersInfo",
+ "properties" : {
+ "duration" : {
+ "type" : "integer"
+ },
+ "end-time" : {
+ "type" : "integer"
+ },
+ "host" : {
+ "type" : "string"
+ },
+ "metrics" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:metrics:IOMetricsInfo",
+ "properties" : {
+ "read-bytes" : {
+ "type" : "integer"
+ },
+ "read-bytes-complete" : {
+ "type" : "boolean"
+ },
+ "read-records" : {
+ "type" : "integer"
+ },
+ "read-records-complete" : {
+ "type" : "boolean"
+ },
+ "write-bytes" : {
+ "type" : "integer"
+ },
+ "write-bytes-complete" : {
+ "type" : "boolean"
+ },
+ "write-records" : {
+ "type" : "integer"
+ },
+ "write-records-complete" : {
+ "type" : "boolean"
+ }
+ }
+ },
+ "start-time" : {
+ "type" : "integer"
+ },
+ "status" : {
+ "type" : "string",
+ "enum" : [ "CREATED", "SCHEDULED", "DEPLOYING", "RUNNING", "FINISHED", "CANCELING", "CANCELED", "FAILED", "RECONCILING" ]
+ },
+ "status-counts" : {
+ "type" : "object",
+ "additionalProperties" : {
+ "type" : "integer"
+ }
+ },
+ "taskmanager-id" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/jobs/:jobid/vertices/:vertexid/watermarks</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns the watermarks for all subtasks of a task.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>jobid</code> - 32-character hexadecimal string value that identifies a job.</li>
+<li><code>vertexid</code> - 32-character hexadecimal string value that identifies a job vertex.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1153325552">Request</button>
+ <div id="1153325552" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1464053913">Response</button>
+ <div id="1464053913" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "any"
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/overview</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns an overview over the Flink cluster.</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#907264452">Request</button>
+ <div id="907264452" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1156936926">Response</button>
+ <div id="1156936926" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:legacy:messages:ClusterOverviewWithVersion",
+ "properties" : {
+ "flink-commit" : {
+ "type" : "string"
+ },
+ "flink-version" : {
+ "type" : "string"
+ },
+ "jobs-cancelled" : {
+ "type" : "integer"
+ },
+ "jobs-failed" : {
+ "type" : "integer"
+ },
+ "jobs-finished" : {
+ "type" : "integer"
+ },
+ "jobs-running" : {
+ "type" : "integer"
+ },
+ "slots-available" : {
+ "type" : "integer"
+ },
+ "slots-total" : {
+ "type" : "integer"
+ },
+ "taskmanagers" : {
+ "type" : "integer"
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/savepoint-disposal</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>POST</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Triggers the desposal of a savepoint. This async operation would return a 'triggerid' for further query identifier.</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#969125696">Request</button>
+ <div id="969125696" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:job:savepoints:SavepointDisposalRequest",
+ "properties" : {
+ "savepoint-path" : {
+ "type" : "string"
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-171672547">Response</button>
+ <div id="-171672547" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:TriggerResponse",
+ "properties" : {
+ "request-id" : {
+ "type" : "any"
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/savepoint-disposal/:triggerid</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns the status of a savepoint disposal operation.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>triggerid</code> - 32-character hexadecimal string that identifies an asynchronous operation trigger ID. The ID was returned then the operation was triggered.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#704931754">Request</button>
+ <div id="704931754" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-1128151382">Response</button>
+ <div id="-1128151382" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:handler:async:AsynchronousOperationResult",
+ "properties" : {
+ "operation" : {
+ "type" : "any"
+ },
+ "status" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:queue:QueueStatus",
+ "properties" : {
+ "id" : {
+ "type" : "string",
+ "required" : true,
+ "enum" : [ "IN_PROGRESS", "COMPLETED" ]
+ }
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/taskmanagers</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns an overview over all task managers.</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1276144566">Request</button>
+ <div id="1276144566" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-112101263">Response</button>
+ <div id="-112101263" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagersInfo",
+ "properties" : {
+ "taskmanagers" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerInfo",
+ "properties" : {
+ "dataPort" : {
+ "type" : "integer"
+ },
+ "freeSlots" : {
+ "type" : "integer"
+ },
+ "hardware" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:instance:HardwareDescription",
+ "properties" : {
+ "cpuCores" : {
+ "type" : "integer"
+ },
+ "freeMemory" : {
+ "type" : "integer"
+ },
+ "managedMemory" : {
+ "type" : "integer"
+ },
+ "physicalMemory" : {
+ "type" : "integer"
+ }
+ }
+ },
+ "id" : {
+ "type" : "any"
+ },
+ "path" : {
+ "type" : "string"
+ },
+ "slotsNumber" : {
+ "type" : "integer"
+ },
+ "timeSinceLastHeartbeat" : {
+ "type" : "integer"
+ }
+ }
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/taskmanagers/metrics</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Provides access to aggregated task manager metrics.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Query parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>get</code> (optional): Comma-separated list of string values to select specific metrics.</li>
+<li><code>agg</code> (optional): Comma-separated list of aggregation modes which should be calculated. Available aggregations are: "min, max, sum, avg".</li>
+<li><code>taskmanagers</code> (optional): Comma-separated list of 32-character hexadecimal strings to select specific task managers.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#521351018">Request</button>
+ <div id="521351018" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1440560359">Response</button>
+ <div id="1440560359" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "any"
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/taskmanagers/:taskmanagerid</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns details for a task manager.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>taskmanagerid</code> - 32-character hexadecimal string that identifies a task manager.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1279146202">Request</button>
+ <div id="1279146202" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#761739204">Response</button>
+ <div id="761739204" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerDetailsInfo",
+ "properties" : {
+ "dataPort" : {
+ "type" : "integer"
+ },
+ "freeSlots" : {
+ "type" : "integer"
+ },
+ "hardware" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:instance:HardwareDescription",
+ "properties" : {
+ "cpuCores" : {
+ "type" : "integer"
+ },
+ "freeMemory" : {
+ "type" : "integer"
+ },
+ "managedMemory" : {
+ "type" : "integer"
+ },
+ "physicalMemory" : {
+ "type" : "integer"
+ }
+ }
+ },
+ "id" : {
+ "type" : "any"
+ },
+ "metrics" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerMetricsInfo",
+ "properties" : {
+ "directCount" : {
+ "type" : "integer"
+ },
+ "directMax" : {
+ "type" : "integer"
+ },
+ "directUsed" : {
+ "type" : "integer"
+ },
+ "garbageCollectors" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:TaskManagerMetricsInfo:GarbageCollectorInfo",
+ "properties" : {
+ "count" : {
+ "type" : "integer"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "time" : {
+ "type" : "integer"
+ }
+ }
+ }
+ },
+ "heapCommitted" : {
+ "type" : "integer"
+ },
+ "heapMax" : {
+ "type" : "integer"
+ },
+ "heapUsed" : {
+ "type" : "integer"
+ },
+ "mappedCount" : {
+ "type" : "integer"
+ },
+ "mappedMax" : {
+ "type" : "integer"
+ },
+ "mappedUsed" : {
+ "type" : "integer"
+ },
+ "memorySegmentsAvailable" : {
+ "type" : "integer"
+ },
+ "memorySegmentsTotal" : {
+ "type" : "integer"
+ },
+ "nonHeapCommitted" : {
+ "type" : "integer"
+ },
+ "nonHeapMax" : {
+ "type" : "integer"
+ },
+ "nonHeapUsed" : {
+ "type" : "integer"
+ }
+ }
+ },
+ "path" : {
+ "type" : "string"
+ },
+ "slotsNumber" : {
+ "type" : "integer"
+ },
+ "timeSinceLastHeartbeat" : {
+ "type" : "integer"
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/taskmanagers/:taskmanagerid/logs</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Returns the list of log files on a TaskManager.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>taskmanagerid</code> - 32-character hexadecimal string that identifies a task manager.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#-584340868">Request</button>
+ <div id="-584340868" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#30156062">Response</button>
+ <div id="30156062" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:LogListInfo",
+ "properties" : {
+ "logs" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "id" : "urn:jsonschema:org:apache:flink:runtime:rest:messages:taskmanager:LogInfo",
+ "properties" : {
+ "name" : {
+ "type" : "string"
+ },
+ "size" : {
+ "type" : "integer"
+ }
+ }
+ }
+ }
+ }
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+<table class="table table-bordered">
+ <tbody>
+ <tr>
+ <td class="text-left" colspan="2"><h5><strong>/taskmanagers/:taskmanagerid/metrics</strong></h5></td>
+ </tr>
+ <tr>
+ <td class="text-left" style="width: 20%">Verb: <code>GET</code></td>
+ <td class="text-left">Response code: <code>200 OK</code></td>
+ </tr>
+ <tr>
+ <td colspan="2">Provides access to task manager metrics.</td>
+ </tr>
+ <tr>
+ <td colspan="2">Path parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>taskmanagerid</code> - 32-character hexadecimal string that identifies a task manager.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">Query parameters</td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <ul>
+<li><code>get</code> (optional): Comma-separated list of string values to select specific metrics.</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1220778126">Request</button>
+ <div id="1220778126" class="collapse">
+ <pre>
+ <code>
+{} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <button data-toggle="collapse" data-target="#1531506487">Response</button>
+ <div id="1531506487" class="collapse">
+ <pre>
+ <code>
+{
+ "type" : "any"
+} </code>
+ </pre>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/restart_strategy_configuration.html b/docs/_includes/generated/restart_strategy_configuration.html
new file mode 100644
index 0000000..f8a0748
--- /dev/null
+++ b/docs/_includes/generated/restart_strategy_configuration.html
@@ -0,0 +1,18 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>restart-strategy</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Defines the restart strategy to use in case of job failures.<br />Accepted values are:<ul><li><span markdown="span">`none`</span>, <span markdown="span">`off`</span>, <span markdown="span">`disable`</span>: No restart strategy.</li><li><span markdown="span">`fixeddelay`</span>, <span markdown="span">`fixed-delay`</span>: Fixed delay restart strategy. More details can be found <a href="../dev/task_failure_recovery.html#fixed-delay-restart-strategy">here</a>.</li><li><span [...]
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/rocks_db_configurable_configuration.html b/docs/_includes/generated/rocks_db_configurable_configuration.html
new file mode 100644
index 0000000..518ce35
--- /dev/null
+++ b/docs/_includes/generated/rocks_db_configurable_configuration.html
@@ -0,0 +1,84 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>state.backend.rocksdb.block.blocksize</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>MemorySize</td>
+ <td>The approximate size (in bytes) of user data packed per block. RocksDB has default blocksize as '4KB'.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.block.cache-size</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>MemorySize</td>
+ <td>The amount of the cache for data blocks in RocksDB. RocksDB has default block-cache size as '8MB'.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.compaction.level.max-size-level-base</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>MemorySize</td>
+ <td>The upper-bound of the total size of level base files in bytes. RocksDB has default configuration as '256MB'.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.compaction.level.target-file-size-base</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>MemorySize</td>
+ <td>The target file size for compaction, which determines a level-1 file size. RocksDB has default configuration as '64MB'.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.compaction.level.use-dynamic-size</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>Boolean</td>
+ <td>If true, RocksDB will pick target size of each level dynamically. From an empty DB, RocksDB would make last level the base level, which means merging L0 data into the last level, until it exceeds max_bytes_for_level_base. And then repeat this process for second last level and so on. RocksDB has default configuration as 'false'. For more information, please refer to <a href="https://github.com/facebook/rocksdb/wiki/Leveled-Compaction#level_compaction_dynamic_level_bytes-is [...]
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.compaction.style</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td><p>Enum</p>Possible values: [LEVEL, UNIVERSAL, FIFO]</td>
+ <td>The specified compaction style for DB. Candidate compaction style is LEVEL, FIFO or UNIVERSAL, and RocksDB choose 'LEVEL' as default style.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.files.open</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>Integer</td>
+ <td>The maximum number of open files (per TaskManager) that can be used by the DB, '-1' means no limit. RocksDB has default configuration as '-1'.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.thread.num</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>Integer</td>
+ <td>The maximum number of concurrent background flush and compaction jobs (per TaskManager). RocksDB has default configuration as '1'.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.write-batch-size</h5></td>
+ <td style="word-wrap: break-word;">2 mb</td>
+ <td>MemorySize</td>
+ <td>The max size of the consumed memory for RocksDB batch write, will flush just based on item count if this config set to 0.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.writebuffer.count</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>Integer</td>
+ <td>Tne maximum number of write buffers that are built up in memory. RocksDB has default configuration as '2'.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.writebuffer.number-to-merge</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>Integer</td>
+ <td>The minimum number of write buffers that will be merged together before writing to storage. RocksDB has default configuration as '1'.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.writebuffer.size</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>MemorySize</td>
+ <td>The amount of data built up in memory (backed by an unsorted log on disk) before converting to a sorted on-disk files. RocksDB has default writebuffer size as '64MB'.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/rocks_db_configuration.html b/docs/_includes/generated/rocks_db_configuration.html
new file mode 100644
index 0000000..3ce04c7
--- /dev/null
+++ b/docs/_includes/generated/rocks_db_configuration.html
@@ -0,0 +1,66 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>state.backend.rocksdb.checkpoint.transfer.thread.num</h5></td>
+ <td style="word-wrap: break-word;">1</td>
+ <td>Integer</td>
+ <td>The number of threads (per stateful operator) used to transfer (download and upload) files in RocksDBStateBackend.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.localdir</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The local directory (on the TaskManager) where RocksDB puts its files.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.memory.fixed-per-slot</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>MemorySize</td>
+ <td>The fixed total amount of memory, shared among all RocksDB instances per slot. This option overrides the 'state.backend.rocksdb.memory.managed' option when configured. If neither this option, nor the 'state.backend.rocksdb.memory.managed' optionare set, then each RocksDB column family state has its own memory caches (as controlled by the column family options).</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.memory.high-prio-pool-ratio</h5></td>
+ <td style="word-wrap: break-word;">0.1</td>
+ <td>Double</td>
+ <td>The fraction of cache memory that is reserved for high-priority data like index, filter, and compression dictionary blocks. This option only has an effect when 'state.backend.rocksdb.memory.managed' or 'state.backend.rocksdb.memory.fixed-per-slot' are configured.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.memory.managed</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>If set, the RocksDB state backend will automatically configure itself to use the managed memory budget of the task slot, and divide the memory over write buffers, indexes, block caches, etc. That way, the three major uses of memory of RocksDB will be capped.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.memory.write-buffer-ratio</h5></td>
+ <td style="word-wrap: break-word;">0.5</td>
+ <td>Double</td>
+ <td>The maximum amount of memory that write buffers may take, as a fraction of the total shared memory. This option only has an effect when 'state.backend.rocksdb.memory.managed' or 'state.backend.rocksdb.memory.fixed-per-slot' are configured.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.options-factory</h5></td>
+ <td style="word-wrap: break-word;">"org.apache.flink.contrib.streaming.state.DefaultConfigurableOptionsFactory"</td>
+ <td>String</td>
+ <td>The options factory class for RocksDB to create DBOptions and ColumnFamilyOptions. The default options factory is org.apache.flink.contrib.streaming.state.DefaultConfigurableOptionsFactory, and it would read the configured options which provided in 'RocksDBConfigurableOptions'.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.predefined-options</h5></td>
+ <td style="word-wrap: break-word;">"DEFAULT"</td>
+ <td>String</td>
+ <td>The predefined settings for RocksDB DBOptions and ColumnFamilyOptions by Flink community. Current supported candidate predefined-options are DEFAULT, SPINNING_DISK_OPTIMIZED, SPINNING_DISK_OPTIMIZED_HIGH_MEM or FLASH_SSD_OPTIMIZED. Note that user customized options and options from the OptionsFactory are applied on top of these predefined ones.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.timer-service.factory</h5></td>
+ <td style="word-wrap: break-word;">"ROCKSDB"</td>
+ <td>String</td>
+ <td>This determines the factory for timer service state implementation. Options are either HEAP (heap-based, default) or ROCKSDB for an implementation based on RocksDB .</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/rocks_db_native_metric_configuration.html b/docs/_includes/generated/rocks_db_native_metric_configuration.html
new file mode 100644
index 0000000..82c5738
--- /dev/null
+++ b/docs/_includes/generated/rocks_db_native_metric_configuration.html
@@ -0,0 +1,168 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.actual-delayed-write-rate</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the current actual delayed write rate. 0 means no delay.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.background-errors</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the number of background errors in RocksDB.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.block-cache-capacity</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor block cache capacity.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.block-cache-pinned-usage</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the memory size for the entries being pinned in block cache.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.block-cache-usage</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the memory size for the entries residing in block cache.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.column-family-as-variable</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Whether to expose the column family as a variable.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.compaction-pending</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Track pending compactions in RocksDB. Returns 1 if a compaction is pending, 0 otherwise.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.cur-size-active-mem-table</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the approximate size of the active memtable in bytes.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.cur-size-all-mem-tables</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the approximate size of the active and unflushed immutable memtables in bytes.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.estimate-live-data-size</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Estimate of the amount of live data in bytes.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.estimate-num-keys</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Estimate the number of keys in RocksDB.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.estimate-pending-compaction-bytes</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Estimated total number of bytes compaction needs to rewrite to get all levels down to under target size. Not valid for other compactions than level-based.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.estimate-table-readers-mem</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Estimate the memory used for reading SST tables, excluding memory used in block cache (e.g.,filter and index blocks) in bytes.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.is-write-stopped</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Track whether write has been stopped in RocksDB. Returns 1 if write has been stopped, 0 otherwise.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.mem-table-flush-pending</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the number of pending memtable flushes in RocksDB.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.num-deletes-active-mem-table</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the total number of delete entries in the active memtable.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.num-deletes-imm-mem-tables</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the total number of delete entries in the unflushed immutable memtables.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.num-entries-active-mem-table</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the total number of entries in the active memtable.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.num-entries-imm-mem-tables</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the total number of entries in the unflushed immutable memtables.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.num-immutable-mem-table</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the number of immutable memtables in RocksDB.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.num-live-versions</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor number of live versions. Version is an internal data structure. See RocksDB file version_set.h for details. More live versions often mean more SST files are held from being deleted, by iterators or unfinished compactions.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.num-running-compactions</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the number of currently running compactions.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.num-running-flushes</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the number of currently running flushes.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.num-snapshots</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the number of unreleased snapshots of the database.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.size-all-mem-tables</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the approximate size of the active, unflushed immutable, and pinned immutable memtables in bytes.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.metrics.total-sst-files-size</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Monitor the total size (bytes) of all SST files.WARNING: may slow down online queries if there are too many files.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/savepoint_config_configuration.html b/docs/_includes/generated/savepoint_config_configuration.html
new file mode 100644
index 0000000..2f9b464
--- /dev/null
+++ b/docs/_includes/generated/savepoint_config_configuration.html
@@ -0,0 +1,24 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>execution.savepoint.ignore-unclaimed-state</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Allow to skip savepoint state that cannot be restored. Allow this if you removed an operator from your pipeline after the savepoint was triggered.</td>
+ </tr>
+ <tr>
+ <td><h5>execution.savepoint.path</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Path to a savepoint to restore the job from (for example hdfs:///flink/savepoint-1537).</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/security_auth_kerberos_section.html b/docs/_includes/generated/security_auth_kerberos_section.html
new file mode 100644
index 0000000..cf27917
--- /dev/null
+++ b/docs/_includes/generated/security_auth_kerberos_section.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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>security.kerberos.login.contexts</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>A comma-separated list of login contexts to provide the Kerberos credentials to (for example, `Client,KafkaClient` to use the credentials for ZooKeeper authentication and for Kafka authentication)</td>
+ </tr>
+ <tr>
+ <td><h5>security.kerberos.login.keytab</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Absolute path to a Kerberos keytab file that contains the user credentials.</td>
+ </tr>
+ <tr>
+ <td><h5>security.kerberos.login.principal</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Kerberos principal name associated with the keytab.</td>
+ </tr>
+ <tr>
+ <td><h5>security.kerberos.login.use-ticket-cache</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>Indicates whether to read from your Kerberos ticket cache.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/security_auth_zk_section.html b/docs/_includes/generated/security_auth_zk_section.html
new file mode 100644
index 0000000..7aaaaff
--- /dev/null
+++ b/docs/_includes/generated/security_auth_zk_section.html
@@ -0,0 +1,30 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>zookeeper.sasl.disable</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><h5>zookeeper.sasl.login-context-name</h5></td>
+ <td style="word-wrap: break-word;">"Client"</td>
+ <td>String</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><h5>zookeeper.sasl.service-name</h5></td>
+ <td style="word-wrap: break-word;">"zookeeper"</td>
+ <td>String</td>
+ <td></td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/security_configuration.html b/docs/_includes/generated/security_configuration.html
new file mode 100644
index 0000000..73d3c19
--- /dev/null
+++ b/docs/_includes/generated/security_configuration.html
@@ -0,0 +1,204 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>security.context.factory.classes</h5></td>
+ <td style="word-wrap: break-word;">"org.apache.flink.runtime.security.contexts.HadoopSecurityContextFactory";<wbr>"org.apache.flink.runtime.security.contexts.NoOpSecurityContextFactory"</td>
+ <td>List<String></td>
+ <td>List of factories that should be used to instantiate a security context. If multiple are configured, Flink will use the first compatible factory. You should have a NoOpSecurityContextFactory in this list as a fallback.</td>
+ </tr>
+ <tr>
+ <td><h5>security.kerberos.login.contexts</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>A comma-separated list of login contexts to provide the Kerberos credentials to (for example, `Client,KafkaClient` to use the credentials for ZooKeeper authentication and for Kafka authentication)</td>
+ </tr>
+ <tr>
+ <td><h5>security.kerberos.login.keytab</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Absolute path to a Kerberos keytab file that contains the user credentials.</td>
+ </tr>
+ <tr>
+ <td><h5>security.kerberos.login.principal</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Kerberos principal name associated with the keytab.</td>
+ </tr>
+ <tr>
+ <td><h5>security.kerberos.login.use-ticket-cache</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>Indicates whether to read from your Kerberos ticket cache.</td>
+ </tr>
+ <tr>
+ <td><h5>security.module.factory.classes</h5></td>
+ <td style="word-wrap: break-word;">"org.apache.flink.runtime.security.modules.HadoopModuleFactory";<wbr>"org.apache.flink.runtime.security.modules.JaasModuleFactory";<wbr>"org.apache.flink.runtime.security.modules.ZookeeperModuleFactory"</td>
+ <td>List<String></td>
+ <td>List of factories that should be used to instantiate security modules. All listed modules will be installed. Keep in mind that the configured security context might rely on some modules being present.</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.algorithms</h5></td>
+ <td style="word-wrap: break-word;">"TLS_RSA_WITH_AES_128_CBC_SHA"</td>
+ <td>String</td>
+ <td>The comma separated list of standard SSL algorithms to be supported. Read more <a href="http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites">here</a></td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.internal.cert.fingerprint</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The sha1 fingerprint of the internal certificate. This further protects the internal communication to present the exact certificate used by Flink.This is necessary where one cannot use private CA(self signed) or there is internal firm wide CA is required</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.internal.close-notify-flush-timeout</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>The timeout (in ms) for flushing the `close_notify` that was triggered by closing a channel. If the `close_notify` was not flushed in the given timeout the channel will be closed forcibly. (-1 = use system default)</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.internal.enabled</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Turns on SSL for internal network communication. Optionally, specific components may override this through their own settings (rpc, data transport, REST, etc).</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.internal.handshake-timeout</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>The timeout (in ms) during SSL handshake. (-1 = use system default)</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.internal.key-password</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The secret to decrypt the key in the keystore for Flink's internal endpoints (rpc, data transport, blob server).</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.internal.keystore</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The Java keystore file with SSL Key and Certificate, to be used Flink's internal endpoints (rpc, data transport, blob server).</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.internal.keystore-password</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The secret to decrypt the keystore file for Flink's for Flink's internal endpoints (rpc, data transport, blob server).</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.internal.session-cache-size</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>The size of the cache used for storing SSL session objects. According to https://github.com/netty/netty/issues/832, you should always set this to an appropriate number to not run into a bug with stalling IO threads during garbage collection. (-1 = use system default).</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.internal.session-timeout</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>The timeout (in ms) for the cached SSL session objects. (-1 = use system default)</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.internal.truststore</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The truststore file containing the public CA certificates to verify the peer for Flink's internal endpoints (rpc, data transport, blob server).</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.internal.truststore-password</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The password to decrypt the truststore for Flink's internal endpoints (rpc, data transport, blob server).</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.protocol</h5></td>
+ <td style="word-wrap: break-word;">"TLSv1.2"</td>
+ <td>String</td>
+ <td>The SSL protocol version to be supported for the ssl transport. Note that it doesn’t support comma separated list.</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.provider</h5></td>
+ <td style="word-wrap: break-word;">"JDK"</td>
+ <td>String</td>
+ <td>The SSL engine provider to use for the ssl transport:<ul><li><span markdown="span">`JDK`</span>: default Java-based SSL engine</li><li><span markdown="span">`OPENSSL`</span>: openSSL-based SSL engine using system libraries</li></ul><span markdown="span">`OPENSSL`</span> is based on <a href="http://netty.io/wiki/forked-tomcat-native.html#wiki-h2-4">netty-tcnative</a> and comes in two flavours:<ul><li>dynamically linked: This will use your system's openSSL libraries (if com [...]
+ </tr>
+ <tr>
+ <td><h5>security.ssl.rest.authentication-enabled</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Turns on mutual SSL authentication for external communication via the REST endpoints.</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.rest.cert.fingerprint</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The sha1 fingerprint of the rest certificate. This further protects the rest REST endpoints to present certificate which is only used by proxy serverThis is necessary where once uses public CA or internal firm wide CA</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.rest.enabled</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Turns on SSL for external communication via the REST endpoints.</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.rest.key-password</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The secret to decrypt the key in the keystore for Flink's external REST endpoints.</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.rest.keystore</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The Java keystore file with SSL Key and Certificate, to be used Flink's external REST endpoints.</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.rest.keystore-password</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The secret to decrypt the keystore file for Flink's for Flink's external REST endpoints.</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.rest.truststore</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The truststore file containing the public CA certificates to verify the peer for Flink's external REST endpoints.</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.rest.truststore-password</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The password to decrypt the truststore for Flink's external REST endpoints.</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.verify-hostname</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>Flag to enable peer’s hostname verification during ssl handshake.</td>
+ </tr>
+ <tr>
+ <td><h5>zookeeper.sasl.disable</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><h5>zookeeper.sasl.login-context-name</h5></td>
+ <td style="word-wrap: break-word;">"Client"</td>
+ <td>String</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><h5>zookeeper.sasl.service-name</h5></td>
+ <td style="word-wrap: break-word;">"zookeeper"</td>
+ <td>String</td>
+ <td></td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/security_ssl_section.html b/docs/_includes/generated/security_ssl_section.html
new file mode 100644
index 0000000..ae345d8
--- /dev/null
+++ b/docs/_includes/generated/security_ssl_section.html
@@ -0,0 +1,120 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>security.ssl.algorithms</h5></td>
+ <td style="word-wrap: break-word;">"TLS_RSA_WITH_AES_128_CBC_SHA"</td>
+ <td>String</td>
+ <td>The comma separated list of standard SSL algorithms to be supported. Read more <a href="http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#ciphersuites">here</a></td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.internal.cert.fingerprint</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The sha1 fingerprint of the internal certificate. This further protects the internal communication to present the exact certificate used by Flink.This is necessary where one cannot use private CA(self signed) or there is internal firm wide CA is required</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.internal.enabled</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Turns on SSL for internal network communication. Optionally, specific components may override this through their own settings (rpc, data transport, REST, etc).</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.internal.key-password</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The secret to decrypt the key in the keystore for Flink's internal endpoints (rpc, data transport, blob server).</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.internal.keystore</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The Java keystore file with SSL Key and Certificate, to be used Flink's internal endpoints (rpc, data transport, blob server).</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.internal.keystore-password</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The secret to decrypt the keystore file for Flink's for Flink's internal endpoints (rpc, data transport, blob server).</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.internal.truststore</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The truststore file containing the public CA certificates to verify the peer for Flink's internal endpoints (rpc, data transport, blob server).</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.internal.truststore-password</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The password to decrypt the truststore for Flink's internal endpoints (rpc, data transport, blob server).</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.protocol</h5></td>
+ <td style="word-wrap: break-word;">"TLSv1.2"</td>
+ <td>String</td>
+ <td>The SSL protocol version to be supported for the ssl transport. Note that it doesn’t support comma separated list.</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.rest.authentication-enabled</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Turns on mutual SSL authentication for external communication via the REST endpoints.</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.rest.cert.fingerprint</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The sha1 fingerprint of the rest certificate. This further protects the rest REST endpoints to present certificate which is only used by proxy serverThis is necessary where once uses public CA or internal firm wide CA</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.rest.enabled</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Turns on SSL for external communication via the REST endpoints.</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.rest.key-password</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The secret to decrypt the key in the keystore for Flink's external REST endpoints.</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.rest.keystore</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The Java keystore file with SSL Key and Certificate, to be used Flink's external REST endpoints.</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.rest.keystore-password</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The secret to decrypt the keystore file for Flink's for Flink's external REST endpoints.</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.rest.truststore</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The truststore file containing the public CA certificates to verify the peer for Flink's external REST endpoints.</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.rest.truststore-password</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The password to decrypt the truststore for Flink's external REST endpoints.</td>
+ </tr>
+ <tr>
+ <td><h5>security.ssl.verify-hostname</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>Flag to enable peer’s hostname verification during ssl handshake.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/shuffle_service_configuration.html b/docs/_includes/generated/shuffle_service_configuration.html
new file mode 100644
index 0000000..bf7d0bb
--- /dev/null
+++ b/docs/_includes/generated/shuffle_service_configuration.html
@@ -0,0 +1,18 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>shuffle-service-factory.class</h5></td>
+ <td style="word-wrap: break-word;">"org.apache.flink.runtime.io.network.NettyShuffleServiceFactory"</td>
+ <td>String</td>
+ <td>The full class name of the shuffle service factory implementation to be used by the cluster. The default implementation uses Netty for network communication and local memory as well disk space to store results on a TaskExecutor.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/state_backend_rocksdb_section.html b/docs/_includes/generated/state_backend_rocksdb_section.html
new file mode 100644
index 0000000..974c5c1
--- /dev/null
+++ b/docs/_includes/generated/state_backend_rocksdb_section.html
@@ -0,0 +1,42 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>state.backend.rocksdb.memory.fixed-per-slot</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>MemorySize</td>
+ <td>The fixed total amount of memory, shared among all RocksDB instances per slot. This option overrides the 'state.backend.rocksdb.memory.managed' option when configured. If neither this option, nor the 'state.backend.rocksdb.memory.managed' optionare set, then each RocksDB column family state has its own memory caches (as controlled by the column family options).</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.memory.high-prio-pool-ratio</h5></td>
+ <td style="word-wrap: break-word;">0.1</td>
+ <td>Double</td>
+ <td>The fraction of cache memory that is reserved for high-priority data like index, filter, and compression dictionary blocks. This option only has an effect when 'state.backend.rocksdb.memory.managed' or 'state.backend.rocksdb.memory.fixed-per-slot' are configured.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.memory.managed</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>If set, the RocksDB state backend will automatically configure itself to use the managed memory budget of the task slot, and divide the memory over write buffers, indexes, block caches, etc. That way, the three major uses of memory of RocksDB will be capped.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.memory.write-buffer-ratio</h5></td>
+ <td style="word-wrap: break-word;">0.5</td>
+ <td>Double</td>
+ <td>The maximum amount of memory that write buffers may take, as a fraction of the total shared memory. This option only has an effect when 'state.backend.rocksdb.memory.managed' or 'state.backend.rocksdb.memory.fixed-per-slot' are configured.</td>
+ </tr>
+ <tr>
+ <td><h5>state.backend.rocksdb.timer-service.factory</h5></td>
+ <td style="word-wrap: break-word;">"ROCKSDB"</td>
+ <td>String</td>
+ <td>This determines the factory for timer service state implementation. Options are either HEAP (heap-based, default) or ROCKSDB for an implementation based on RocksDB .</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/stream_pipeline_configuration.html b/docs/_includes/generated/stream_pipeline_configuration.html
new file mode 100644
index 0000000..0fdefe9
--- /dev/null
+++ b/docs/_includes/generated/stream_pipeline_configuration.html
@@ -0,0 +1,18 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>pipeline.time-characteristic</h5></td>
+ <td style="word-wrap: break-word;">ProcessingTime</td>
+ <td><p>Enum</p>Possible values: [ProcessingTime, IngestionTime, EventTime]</td>
+ <td>The time characteristic for all created streams, e.g., processingtime, event time, or ingestion time.<br /><br />If you set the characteristic to IngestionTime or EventTime this will set a default watermark update interval of 200 ms. If this is not applicable for your application you should change it using <span markdown="span">`pipeline.auto-watermark-interval`</span>.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/task_manager_configuration.html b/docs/_includes/generated/task_manager_configuration.html
new file mode 100644
index 0000000..db02dee
--- /dev/null
+++ b/docs/_includes/generated/task_manager_configuration.html
@@ -0,0 +1,97 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>task.cancellation.interval</h5></td>
+ <td style="word-wrap: break-word;">30000</td>
+ <td>Long</td>
+ <td>Time interval between two successive task cancellation attempts in milliseconds.</td>
+ </tr>
+ <tr>
+ <td><h5>task.cancellation.timeout</h5></td>
+ <td style="word-wrap: break-word;">180000</td>
+ <td>Long</td>
+ <td>Timeout in milliseconds after which a task cancellation times out and leads to a fatal TaskManager error. A value of 0 deactivates the watch dog.</td>
+ </tr>
+ <tr>
+ <td><h5>task.cancellation.timers.timeout</h5></td>
+ <td style="word-wrap: break-word;">7500</td>
+ <td>Long</td>
+ <td>Time we wait for the timers in milliseconds to finish all pending timer threads when the stream task is cancelled.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.debug.memory.log</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Flag indicating whether to start a thread, which repeatedly logs the memory usage of the JVM.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.debug.memory.log-interval</h5></td>
+ <td style="word-wrap: break-word;">5000</td>
+ <td>Long</td>
+ <td>The interval (in ms) for the log thread to log the current memory usage.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.host</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The address of the network interface that the TaskManager binds to. This option can be used to define explicitly a binding address. Because different TaskManagers need different values for this option, usually it is specified in an additional non-shared TaskManager-specific config file.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.jvm-exit-on-oom</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td>Whether to kill the TaskManager when the task thread throws an OutOfMemoryError.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.network.bind-policy</h5></td>
+ <td style="word-wrap: break-word;">"ip"</td>
+ <td>String</td>
+ <td>The automatic address binding policy used by the TaskManager if "taskmanager.host" is not set. The value should be one of the following:
+<ul><li>"name" - uses hostname as binding address</li><li>"ip" - uses host's ip address as binding address</li></ul></td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.numberOfTaskSlots</h5></td>
+ <td style="word-wrap: break-word;">1</td>
+ <td>Integer</td>
+ <td>The number of parallel operator or user function instances that a single TaskManager can run. If this value is larger than 1, a single TaskManager takes multiple instances of a function or operator. That way, the TaskManager can utilize multiple CPU cores, but at the same time, the available memory is divided between the different operator or function instances. This value is typically proportional to the number of physical CPU cores that the TaskManager's machine has (e. [...]
+ </tr>
+ <tr>
+ <td><h5>taskmanager.registration.initial-backoff</h5></td>
+ <td style="word-wrap: break-word;">500 ms</td>
+ <td>Duration</td>
+ <td>The initial registration backoff between two consecutive registration attempts. The backoff is doubled for each new registration attempt until it reaches the maximum registration backoff.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.registration.max-backoff</h5></td>
+ <td style="word-wrap: break-word;">30 s</td>
+ <td>Duration</td>
+ <td>The maximum registration backoff between two consecutive registration attempts. The max registration backoff requires a time unit specifier (ms/s/min/h/d).</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.registration.refused-backoff</h5></td>
+ <td style="word-wrap: break-word;">10 s</td>
+ <td>Duration</td>
+ <td>The backoff after a registration has been refused by the job manager before retrying to connect.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.registration.timeout</h5></td>
+ <td style="word-wrap: break-word;">5 min</td>
+ <td>Duration</td>
+ <td>Defines the timeout for the TaskManager registration. If the duration is exceeded without a successful registration, then the TaskManager terminates.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.rpc.port</h5></td>
+ <td style="word-wrap: break-word;">"0"</td>
+ <td>String</td>
+ <td>The task manager’s IPC port. Accepts a list of ports (“50100,50101”), ranges (“50100-50200”) or a combination of both. It is recommended to set a range of ports to avoid collisions when multiple TaskManagers are running on the same machine.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/task_manager_memory_configuration.html b/docs/_includes/generated/task_manager_memory_configuration.html
new file mode 100644
index 0000000..3a25b14
--- /dev/null
+++ b/docs/_includes/generated/task_manager_memory_configuration.html
@@ -0,0 +1,108 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>taskmanager.memory.flink.size</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>MemorySize</td>
+ <td>Total Flink Memory size for the TaskExecutors. This includes all the memory that a TaskExecutor consumes, except for JVM Metaspace and JVM Overhead. It consists of Framework Heap Memory, Task Heap Memory, Task Off-Heap Memory, Managed Memory, and Network Memory. See also 'taskmanager.memory.process.size' for total process memory size configuration.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.framework.heap.size</h5></td>
+ <td style="word-wrap: break-word;">128 mb</td>
+ <td>MemorySize</td>
+ <td>Framework Heap Memory size for TaskExecutors. This is the size of JVM heap memory reserved for TaskExecutor framework, which will not be allocated to task slots.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.framework.off-heap.size</h5></td>
+ <td style="word-wrap: break-word;">128 mb</td>
+ <td>MemorySize</td>
+ <td>Framework Off-Heap Memory size for TaskExecutors. This is the size of off-heap memory (JVM direct memory and native memory) reserved for TaskExecutor framework, which will not be allocated to task slots. The configured value will be fully counted when Flink calculates the JVM max direct memory size parameter.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.jvm-metaspace.size</h5></td>
+ <td style="word-wrap: break-word;">256 mb</td>
+ <td>MemorySize</td>
+ <td>JVM Metaspace Size for the TaskExecutors.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.jvm-overhead.fraction</h5></td>
+ <td style="word-wrap: break-word;">0.1</td>
+ <td>Float</td>
+ <td>Fraction of Total Process Memory to be reserved for JVM Overhead. This is off-heap memory reserved for JVM overhead, such as thread stack space, compile cache, etc. This includes native memory but not direct memory, and will not be counted when Flink calculates JVM max direct memory size parameter. The size of JVM Overhead is derived to make up the configured fraction of the Total Process Memory. If the derived size is less/greater than the configured min/max size, the mi [...]
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.jvm-overhead.max</h5></td>
+ <td style="word-wrap: break-word;">1 gb</td>
+ <td>MemorySize</td>
+ <td>Max JVM Overhead size for the TaskExecutors. This is off-heap memory reserved for JVM overhead, such as thread stack space, compile cache, etc. This includes native memory but not direct memory, and will not be counted when Flink calculates JVM max direct memory size parameter. The size of JVM Overhead is derived to make up the configured fraction of the Total Process Memory. If the derived size is less/greater than the configured min/max size, the min/max size will be us [...]
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.jvm-overhead.min</h5></td>
+ <td style="word-wrap: break-word;">192 mb</td>
+ <td>MemorySize</td>
+ <td>Min JVM Overhead size for the TaskExecutors. This is off-heap memory reserved for JVM overhead, such as thread stack space, compile cache, etc. This includes native memory but not direct memory, and will not be counted when Flink calculates JVM max direct memory size parameter. The size of JVM Overhead is derived to make up the configured fraction of the Total Process Memory. If the derived size is less/greater than the configured min/max size, the min/max size will be us [...]
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.managed.fraction</h5></td>
+ <td style="word-wrap: break-word;">0.4</td>
+ <td>Float</td>
+ <td>Fraction of Total Flink Memory to be used as Managed Memory, if Managed Memory size is not explicitly specified.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.managed.size</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>MemorySize</td>
+ <td>Managed Memory size for TaskExecutors. This is the size of off-heap memory managed by the memory manager, reserved for sorting, hash tables, caching of intermediate results and RocksDB state backend. Memory consumers can either allocate memory from the memory manager in the form of MemorySegments, or reserve bytes from the memory manager and keep their memory usage within that boundary. If unspecified, it will be derived to make up the configured fraction of the Total Fli [...]
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.network.fraction</h5></td>
+ <td style="word-wrap: break-word;">0.1</td>
+ <td>Float</td>
+ <td>Fraction of Total Flink Memory to be used as Network Memory. Network Memory is off-heap memory reserved for ShuffleEnvironment (e.g., network buffers). Network Memory size is derived to make up the configured fraction of the Total Flink Memory. If the derived size is less/greater than the configured min/max size, the min/max size will be used. The exact size of Network Memory can be explicitly specified by setting the min/max size to the same value.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.network.max</h5></td>
+ <td style="word-wrap: break-word;">1 gb</td>
+ <td>MemorySize</td>
+ <td>Max Network Memory size for TaskExecutors. Network Memory is off-heap memory reserved for ShuffleEnvironment (e.g., network buffers). Network Memory size is derived to make up the configured fraction of the Total Flink Memory. If the derived size is less/greater than the configured min/max size, the min/max size will be used. The exact size of Network Memory can be explicitly specified by setting the min/max to the same value.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.network.min</h5></td>
+ <td style="word-wrap: break-word;">64 mb</td>
+ <td>MemorySize</td>
+ <td>Min Network Memory size for TaskExecutors. Network Memory is off-heap memory reserved for ShuffleEnvironment (e.g., network buffers). Network Memory size is derived to make up the configured fraction of the Total Flink Memory. If the derived size is less/greater than the configured min/max size, the min/max size will be used. The exact size of Network Memory can be explicitly specified by setting the min/max to the same value.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.process.size</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>MemorySize</td>
+ <td>Total Process Memory size for the TaskExecutors. This includes all the memory that a TaskExecutor consumes, consisting of Total Flink Memory, JVM Metaspace, and JVM Overhead. On containerized setups, this should be set to the container memory. See also 'taskmanager.memory.flink.size' for total Flink memory size configuration.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.segment-size</h5></td>
+ <td style="word-wrap: break-word;">32 kb</td>
+ <td>MemorySize</td>
+ <td>Size of memory buffers used by the network stack and the memory manager.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.task.heap.size</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>MemorySize</td>
+ <td>Task Heap Memory size for TaskExecutors. This is the size of JVM heap memory reserved for tasks. If not specified, it will be derived as Total Flink Memory minus Framework Heap Memory, Task Off-Heap Memory, Managed Memory and Network Memory.</td>
+ </tr>
+ <tr>
+ <td><h5>taskmanager.memory.task.off-heap.size</h5></td>
+ <td style="word-wrap: break-word;">0 bytes</td>
+ <td>MemorySize</td>
+ <td>Task Off-Heap Memory size for TaskExecutors. This is the size of off heap memory (JVM direct memory and native memory) reserved for tasks. The configured value will be fully counted when Flink calculates the JVM max direct memory size parameter.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/web_configuration.html b/docs/_includes/generated/web_configuration.html
new file mode 100644
index 0000000..f377f51
--- /dev/null
+++ b/docs/_includes/generated/web_configuration.html
@@ -0,0 +1,90 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>web.access-control-allow-origin</h5></td>
+ <td style="word-wrap: break-word;">"*"</td>
+ <td>String</td>
+ <td>Access-Control-Allow-Origin header for all responses from the web-frontend.</td>
+ </tr>
+ <tr>
+ <td><h5>web.backpressure.cleanup-interval</h5></td>
+ <td style="word-wrap: break-word;">600000</td>
+ <td>Integer</td>
+ <td>Time, in milliseconds, after which cached stats are cleaned up if not accessed.</td>
+ </tr>
+ <tr>
+ <td><h5>web.backpressure.delay-between-samples</h5></td>
+ <td style="word-wrap: break-word;">50</td>
+ <td>Integer</td>
+ <td>Delay between samples to determine back pressure in milliseconds.</td>
+ </tr>
+ <tr>
+ <td><h5>web.backpressure.num-samples</h5></td>
+ <td style="word-wrap: break-word;">100</td>
+ <td>Integer</td>
+ <td>Number of samples to take to determine back pressure.</td>
+ </tr>
+ <tr>
+ <td><h5>web.backpressure.refresh-interval</h5></td>
+ <td style="word-wrap: break-word;">60000</td>
+ <td>Integer</td>
+ <td>Time, in milliseconds, after which available stats are deprecated and need to be refreshed (by resampling).</td>
+ </tr>
+ <tr>
+ <td><h5>web.checkpoints.history</h5></td>
+ <td style="word-wrap: break-word;">10</td>
+ <td>Integer</td>
+ <td>Number of checkpoints to remember for recent history.</td>
+ </tr>
+ <tr>
+ <td><h5>web.history</h5></td>
+ <td style="word-wrap: break-word;">5</td>
+ <td>Integer</td>
+ <td>Number of archived jobs for the JobManager.</td>
+ </tr>
+ <tr>
+ <td><h5>web.log.path</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Path to the log file (may be in /log for standalone but under log directory when using YARN).</td>
+ </tr>
+ <tr>
+ <td><h5>web.refresh-interval</h5></td>
+ <td style="word-wrap: break-word;">3000</td>
+ <td>Long</td>
+ <td>Refresh interval for the web-frontend in milliseconds.</td>
+ </tr>
+ <tr>
+ <td><h5>web.submit.enable</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>Flag indicating whether jobs can be uploaded and run from the web-frontend.</td>
+ </tr>
+ <tr>
+ <td><h5>web.timeout</h5></td>
+ <td style="word-wrap: break-word;">10000</td>
+ <td>Long</td>
+ <td>Timeout for asynchronous operations by the web monitor in milliseconds.</td>
+ </tr>
+ <tr>
+ <td><h5>web.tmpdir</h5></td>
+ <td style="word-wrap: break-word;">System.getProperty("java.io.tmpdir")</td>
+ <td>String</td>
+ <td>Flink web directory which is used by the webmonitor.</td>
+ </tr>
+ <tr>
+ <td><h5>web.upload.dir</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Directory for uploading the job jars. If not specified a dynamic directory will be used under the directory specified by JOB_MANAGER_WEB_TMPDIR_KEY.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/yarn_config_configuration.html b/docs/_includes/generated/yarn_config_configuration.html
new file mode 100644
index 0000000..bdc83bb
--- /dev/null
+++ b/docs/_includes/generated/yarn_config_configuration.html
@@ -0,0 +1,138 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>yarn.application-attempt-failures-validity-interval</h5></td>
+ <td style="word-wrap: break-word;">10000</td>
+ <td>Long</td>
+ <td>Time window in milliseconds which defines the number of application attempt failures when restarting the AM. Failures which fall outside of this window are not being considered. Set this value to -1 in order to count globally. See <a href="https://hortonworks.com/blog/apache-hadoop-yarn-hdp-2-2-fault-tolerance-features-long-running-services/">here</a> for more information.</td>
+ </tr>
+ <tr>
+ <td><h5>yarn.application-attempts</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Number of ApplicationMaster restarts. Note that that the entire Flink cluster will restart and the YARN Client will loose the connection. Also, the JobManager address will change and you’ll need to set the JM host:port manually. It is recommended to leave this option at 1.</td>
+ </tr>
+ <tr>
+ <td><h5>yarn.application-master.port</h5></td>
+ <td style="word-wrap: break-word;">"0"</td>
+ <td>String</td>
+ <td>With this configuration option, users can specify a port, a range of ports or a list of ports for the Application Master (and JobManager) RPC port. By default we recommend using the default value (0) to let the operating system choose an appropriate port. In particular when multiple AMs are running on the same physical host, fixed port assignments prevent the AM from starting. For example when running Flink on YARN on an environment with a restrictive firewall, this optio [...]
+ </tr>
+ <tr>
+ <td><h5>yarn.application.id</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The YARN application id of the running yarn cluster. This is the YARN cluster where the pipeline is going to be executed.</td>
+ </tr>
+ <tr>
+ <td><h5>yarn.application.name</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>A custom name for your YARN application.</td>
+ </tr>
+ <tr>
+ <td><h5>yarn.application.node-label</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>Specify YARN node label for the YARN application.</td>
+ </tr>
+ <tr>
+ <td><h5>yarn.application.priority</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>A non-negative integer indicating the priority for submitting a Flink YARN application. It will only take effect if YARN priority scheduling setting is enabled. Larger integer corresponds with higher priority. If priority is negative or set to '-1'(default), Flink will unset yarn priority setting and use cluster default priority. Please refer to YARN's official documentation for specific settings required to enable priority scheduling for the targeted YARN version.</td>
+ </tr>
+ <tr>
+ <td><h5>yarn.application.queue</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The YARN queue on which to put the current pipeline.</td>
+ </tr>
+ <tr>
+ <td><h5>yarn.application.type</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>A custom type for your YARN application..</td>
+ </tr>
+ <tr>
+ <td><h5>yarn.appmaster.vcores</h5></td>
+ <td style="word-wrap: break-word;">1</td>
+ <td>Integer</td>
+ <td>The number of virtual cores (vcores) used by YARN application master.</td>
+ </tr>
+ <tr>
+ <td><h5>yarn.containers.vcores</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>The number of virtual cores (vcores) per YARN container. By default, the number of vcores is set to the number of slots per TaskManager, if set, or to 1, otherwise. In order for this parameter to be used your cluster must have CPU scheduling enabled. You can do this by setting the <span markdown="span">`org.apache.hadoop.yarn.server.resourcemanager.scheduler.fair.FairScheduler`</span>.</td>
+ </tr>
+ <tr>
+ <td><h5>yarn.file-replication</h5></td>
+ <td style="word-wrap: break-word;">-1</td>
+ <td>Integer</td>
+ <td>Number of file replication of each local resource file. If it is not configured, Flink will use the default replication value in hadoop configuration.</td>
+ </tr>
+ <tr>
+ <td><h5>yarn.flink-dist-jar</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>The location of the Flink dist jar.</td>
+ </tr>
+ <tr>
+ <td><h5>yarn.heartbeat.container-request-interval</h5></td>
+ <td style="word-wrap: break-word;">500</td>
+ <td>Integer</td>
+ <td>Time between heartbeats with the ResourceManager in milliseconds if Flink requests containers:<ul><li>The lower this value is, the faster Flink will get notified about container allocations since requests and allocations are transmitted via heartbeats.</li><li>The lower this value is, the more excessive containers might get allocated which will eventually be released but put pressure on Yarn.</li></ul>If you observe too many container allocations on the ResourceManager, t [...]
+ </tr>
+ <tr>
+ <td><h5>yarn.heartbeat.interval</h5></td>
+ <td style="word-wrap: break-word;">5</td>
+ <td>Integer</td>
+ <td>Time between heartbeats with the ResourceManager in seconds.</td>
+ </tr>
+ <tr>
+ <td><h5>yarn.per-job-cluster.include-user-jar</h5></td>
+ <td style="word-wrap: break-word;">"ORDER"</td>
+ <td>String</td>
+ <td>Defines whether user-jars are included in the system class path for per-job-clusters as well as their positioning in the path. They can be positioned at the beginning ("FIRST"), at the end ("LAST"), or be positioned based on their name ("ORDER"). "DISABLED" means the user-jars are excluded from the system class path.</td>
+ </tr>
+ <tr>
+ <td><h5>yarn.properties-file.location</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>When a Flink job is submitted to YARN, the JobManager’s host and the number of available processing slots is written into a properties file, so that the Flink client is able to pick those details up. This configuration parameter allows changing the default location of that file (for example for environments sharing a Flink installation between users).</td>
+ </tr>
+ <tr>
+ <td><h5>yarn.security.kerberos.localized-keytab-path</h5></td>
+ <td style="word-wrap: break-word;">"krb5.keytab"</td>
+ <td>String</td>
+ <td>Local (on NodeManager) path where kerberos keytab file will be localized to. If yarn.security.kerberos.ship-local-keytab set to true, Flink willl ship the keytab file as a YARN local resource. In this case, the path is relative to the local resource directory. If set to false, Flink will try to directly locate the keytab from the path itself.</td>
+ </tr>
+ <tr>
+ <td><h5>yarn.security.kerberos.ship-local-keytab</h5></td>
+ <td style="word-wrap: break-word;">true</td>
+ <td>Boolean</td>
+ <td>When this is true Flink will ship the keytab file configured via security.kerberos.login.keytab as a localized YARN resource.</td>
+ </tr>
+ <tr>
+ <td><h5>yarn.ship-directories</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>List<String></td>
+ <td>A semicolon-separated list of directories to be shipped to the YARN cluster.</td>
+ </tr>
+ <tr>
+ <td><h5>yarn.tags</h5></td>
+ <td style="word-wrap: break-word;">(none)</td>
+ <td>String</td>
+ <td>A comma-separated list of tags to apply to the Flink YARN application.</td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/generated/zoo_keeper_configuration.html b/docs/_includes/generated/zoo_keeper_configuration.html
new file mode 100644
index 0000000..7aaaaff
--- /dev/null
+++ b/docs/_includes/generated/zoo_keeper_configuration.html
@@ -0,0 +1,30 @@
+<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: 10%">Type</th>
+ <th class="text-left" style="width: 55%">Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><h5>zookeeper.sasl.disable</h5></td>
+ <td style="word-wrap: break-word;">false</td>
+ <td>Boolean</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><h5>zookeeper.sasl.login-context-name</h5></td>
+ <td style="word-wrap: break-word;">"Client"</td>
+ <td>String</td>
+ <td></td>
+ </tr>
+ <tr>
+ <td><h5>zookeeper.sasl.service-name</h5></td>
+ <td style="word-wrap: break-word;">"zookeeper"</td>
+ <td>String</td>
+ <td></td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/_includes/latex_commands.html b/docs/_includes/latex_commands.html
new file mode 100644
index 0000000..b2f8f08
--- /dev/null
+++ b/docs/_includes/latex_commands.html
@@ -0,0 +1,38 @@
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<!--Some of the Latex math notation has been adapted from Apache Spark MLlib's documentation-->
+$$
+\newcommand{\R}{\mathbb{R}}
+\newcommand{\E}{\mathbb{E}}
+\newcommand{\x}{\mathbf{x}}
+\newcommand{\y}{\mathbf{y}}
+\newcommand{\wv}{\mathbf{w}}
+\newcommand{\av}{\mathbf{\alpha}}
+\newcommand{\bv}{\mathbf{b}}
+\newcommand{\N}{\mathbb{N}}
+\newcommand{\id}{\mathbf{I}}
+\newcommand{\ind}{\mathbf{1}}
... 5070 lines suppressed ...