[MESOS-3566] Add a section to the Scheduler HTTP API docs around RecordIO specification

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 0.26.0
• Component/s: documentation
• Labels: docathon mesosphere
• Target Version/s: 0.26.0
• Epic Link: Scheduler API v1 improvements
• Assignee: Marco Massenzio
• Reporter: Anand Mazumdar
• Shepherd: Vinod Kone
• Created: 01/Oct/15 03:47
• Updated: 26/Nov/18 12:21
• Resolved: 26/Nov/18 12:21

Description

Since the RecordIO format is not that widely used, searching for it online does not offer much help.

• It would be good if we can add to the docs, a small section on its specification for framework developers.
• Also, add details on why RecordIO format is being used and why just using vanilla ChunkedEncoding and encode one event per chunk won't suffice from here
• Add info about the rationale behind using the RecordIO format and not just relying on encoding an event per chunk.
• Bonus points, if we can have a simple code snippet in C++/Java on reading a RecordIO response to help developers.

Issue Links

• is related to: MESOS-3562 Anomalous bytes in stream from HTTPI Api
• is related to: MESOS-3601 Formalize all headers and metadata for HTTP API Event Stream