[FLINK-20341] Rework Deployment / Coordination Documentation

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.13.0
• Component/s: Documentation, Runtime / Coordination
• Assignee: Robert Metzger
• Reporter: Robert Metzger
• Created: 25/Nov/20 09:42
• Updated: 27/Apr/21 18:03
• Resolved: 14/Jan/21 09:27

Description

Problems:

• Clusters & Deployment pages are very inhomogeneous
• Overview page has good intentions, but is a huge wall of text
• Native K8s and YARN have a “Background / Internals” page
• difference between Local Cluster and Standalone Cluster is unclear

Goals:

• Deploying a Flink cluster is one of the first tasks when getting to know Flink. We need proper guidance for making these steps a success
• We need a proper separation between general concepts (HA, session/perjob mode) and implementations of them (ZK HA, K8s HA, YARN session, …). Also orthogonal aspects such as FileSystems, Plugins, Security etc.

Related work:
https://cwiki.apache.org/confluence/display/FLINK/FLIP-42%3A+Rework+Flink+Documentation (see “Deployment Section”)

Issue Links

• mentioned in: Page Loading...

Sub-Tasks

• Revisit page structure in documentation: Closed
• Add overview / reference architecture documentation page: Closed
• Rework YARN deployment documentation page: Closed
• Rework command line interface documentation page: Closed
• Rework logging documentation page: Closed
• Rework standalone deployment documentation page: Closed
• Rework K8s deployment documentation page: Closed
• Rework Mesos deployment documentation page: Closed
• Rework HA documentation page: Closed
• Rework PyFlink CLI documentation: Closed