[MESOS-7368] Documentation of framework role(s) in proto definition is confusing

• Type: Bug
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.2.0
• Fix Version/s: 1.2.1
• Epic Link: multi-role frameworks (phase 1)
• Assignee: Benjamin Mahler
• Reporter: Benjamin Bannier
• Created: 07/Apr/17 12:48
• Updated: 19/Apr/17 22:45
• Resolved: 19/Apr/17 22:45

Description

The documentation for role-related fields in FrameworkInfo is confusing: the role field is marked as deprecated while the roles field is marked as EXPERIMENTAL and has an additional NOTE advising to not use this field.

This leaves users confused what field they should use in their code. Depending on how the proto definition is used deprecated might even produce (fatal) errors, while roles seems strongly discouraged.

We should clean this up to make sure users always know which field they should use.