[YARN-5734] OrgQueue for easy CapacityScheduler queue configuration management

• Type: New Feature
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 2.9.0, 3.0.0

Release Note

<!-- markdown -->

The OrgQueue extension to the capacity scheduler provides a programmatic way to change configurations by providing a REST API that users can call to modify queue configurations. This enables automation of queue configuration management by administrators in the queue's `administer_queue` ACL.

• Assignee: Min Shen
• Reporter: Min Shen
• Created: 14/Oct/16 00:01
• Updated: 20/Aug/18 12:06
• Resolved: 10/Oct/17 17:44

Description

The current xml based configuration mechanism in CapacityScheduler makes it very inconvenient to apply any changes to the queue configurations. We saw 2 main drawbacks in the file based configuration mechanism:

1. This makes it very inconvenient to automate queue configuration updates. For example, in our cluster setup, we leverage the queue mapping feature from YARN-2411 to route users to their dedicated organization queues. It could be extremely cumbersome to keep updating the config file to manage the very dynamic mapping between users to organizations.
2. Even a user has the admin permission on one specific queue, that user is unable to make any queue configuration changes to resize the subqueues, changing queue ACLs, or creating new queues. All these operations need to be performed in a centralized manner by the cluster administrators.

With these current limitations, we realized the need of a more flexible configuration mechanism that allows queue configurations to be stored and managed more dynamically. We developed the feature internally at LinkedIn which introduces the concept of MutableConfigurationProvider. What it essentially does is to provide a set of configuration mutation APIs that allows queue configurations to be updated externally with a set of REST APIs. When performing the queue configuration changes, the queue ACLs will be honored, which means only queue administrators can make configuration changes to a given queue. MutableConfigurationProvider is implemented as a pluggable interface, and we have one implementation of this interface which is based on Derby embedded database.

This feature has been deployed at LinkedIn's Hadoop cluster for a year now, and have gone through several iterations of gathering feedbacks from users and improving accordingly. With this feature, cluster administrators are able to automate lots of thequeue configuration management tasks, such as setting the queue capacities to adjust cluster resources between queues based on established resource consumption patterns, or managing updating the user to queue mappings. We have attached our design documentation with this ticket and would like to receive feedbacks from the community regarding how to best integrate it with the latest version of YARN.

Issue Links

• is related to: YARN-8677 Queue Management API - no errors thrown for wrong properties
• is related to: YARN-8678 Queue Management API - rephrase error messages
• is related to: YARN-8686 Queue Management API - not returning JSON or XML response data when passing Accept header
• is related to: YARN-2411 [Capacity Scheduler] support simple user and group mappings to queues
• is related to: YARN-5724 [Umbrella] Better Queue Management in YARN
• relates to: YARN-7567 Make sure that OrgQueue works in secure ZK environment

Sub-Tasks

• Support for adding and removing queue mappings: Patch Available
• Queue Management API - no errors thrown for wrong properties: Open
• Queue Management API - GET /scheduler-conf API returns 500 Internal Server Error: Open
• Periodically sync backend scheduler configuration changes to capacity-scheduler.xml: Open