[MESOS-5215] Update the documentation for '/reserve' and '/create-volumes'

• Type: Documentation
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 0.28.1
• Fix Version/s: 1.0.0
• Component/s: documentation
• Labels: documentation mesosphere
• Sprint: Mesosphere Sprint 35
• Story Points: 1
• Assignee: Greg Mann
• Reporter: Greg Mann
• Shepherd: Bernd Mathiske
• Created: 13/Apr/16 22:05
• Updated: 31/May/16 02:11
• Resolved: 27/May/16 12:20

Description

There are a couple issues related to the principal field in DiskInfo and ReservationInfo (see linked JIRAs) that should be better documented. We need to help users understand the purpose of these fields and how they interact with the principal provided in the HTTP authentication header. See linked tickets for background.

Issue Links

• is duplicated by: MESOS-5004 Clarify docs on '/reserve' and '/create-volumes' without authentication
• is related to: MESOS-5005 Enforce that DiskInfo principal is equal to framework/operator principal
• is related to: MESOS-4382 Change the `principal` in `ReservationInfo` to optional
• is related to: MESOS-5212 Allow any principal in ReservationInfo when HTTP authentication is off