[BEAM-8232] Document LOOPBACK environment type

• Type: Improvement
• Status: Resolved
• Priority: P2
• Resolution: Fixed
• Fix Version/s: Not applicable
• Component/s: sdk-py-harness, website
• Assignee: Kyle Weaver
• Reporter: Kyle Weaver
• Created: 13/Sep/19 17:04
• Updated: 16/May/20 14:10
• Resolved: 24/Sep/19 00:29

Description

• Right now, LOOPBACK is not mentioned as a possible option for environment_type [1]. It seems that it was intended for testing [2], but it's useful for getting started on Beam and debugging as well, so it's worth a mention.
• The meaning of each environment type should be documented somewhere, such as on the runner pipeline options tables on the website.

 

[1] https://github.com/apache/beam/blob/master/sdks/python/apache_beam/options/pipeline_options.py#L818-L819

 [2] https://github.com/apache/beam/blob/master/runners/core-construction-java/src/main/java/org/apache/beam/runners/core/construction/Environments.java#L82

Issue Links

• relates to: BEAM-8233 Separate loopback and docker modes on Flink runner guide