aljoscha commented on a change in pull request #10982: [FLINK-15683][docs] Restructure Configuration page URL: https://github.com/apache/flink/pull/10982#discussion_r373411687
########## File path: docs/ops/config.md ########## @@ -23,213 +23,407 @@ specific language governing permissions and limitations under the License. --> -**For single-node setups Flink is ready to go out of the box and you don't need to change the default configuration to get started.** +All configuration is done in `conf/flink-conf.yaml`, which is expected to be a flat collection of [YAML key value pairs](http://www.yaml.org/spec/1.2/spec.html) with format `key: value`. + +The configuration is parsed and evaluated when the Flink processes are started. Changes to the configuration file require restarting the relevant processes. The out of the box configuration will use your default Java installation. You can manually set the environment variable `JAVA_HOME` or the configuration key `env.java.home` in `conf/flink-conf.yaml` if you want to manually override the Java runtime to use. -This page lists the most common options that are typically needed to set up a well performing (distributed) installation. In addition a full list of all available configuration parameters is listed here. +* This will be replaced by the TOC +{:toc} -All configuration is done in `conf/flink-conf.yaml`, which is expected to be a flat collection of [YAML key value pairs](http://www.yaml.org/spec/1.2/spec.html) with format `key: value`. +# Basic Setup -The system and run scripts parse the config at startup time. Changes to the configuration file require restarting the Flink JobManager and TaskManagers. +The default configuration supports starting a single-node Flink session cluster without any changes. +The options in this section are the ones most commonly needed for a basic distributed Flink setup. -The configuration files for the TaskManagers can be different, Flink does not assume uniform machines in the cluster. +**Hostnames / Ports** -* This will be replaced by the TOC -{:toc} +These options are only necessary for a *standalone* application- or session deployments ([simple standalone]({{site.baseurl}}/ops/deployment/cluster_setup.html) or [Kubernetes]({{site.baseurl}}/ops/deployment/kubernetes.html)). -## Common Options +If you use Flink with [Yarn]({{site.baseurl}}/ops/deployment/yarn_setup.html), [Mesos]({{site.baseurl}}/ops/deployment/mesos.html), or the [*active* Kubernetes integration]({{site.baseurl}}/ops/deployment/native_kubernetes.html), the hostnames and ports get automatically configured are automatically discovered. Review comment: ```suggestion If you use Flink with [Yarn]({{site.baseurl}}/ops/deployment/yarn_setup.html), [Mesos]({{site.baseurl}}/ops/deployment/mesos.html), or the [*active* Kubernetes integration]({{site.baseurl}}/ops/deployment/native_kubernetes.html), the hostnames and ports are automatically discovered. ``` ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
