[GitHub] [incubator-yunikorn-site] kingamarton commented on a change in pull request #29: [YUNIKORN-405] Document config update API

[GitBox <gi...@apache.org>]

kingamarton commented on a change in pull request #29:
URL: https://github.com/apache/incubator-yunikorn-site/pull/29#discussion_r504615362



##########
File path: docs/api/scheduler.md
##########
@@ -434,6 +434,76 @@ Reponse
 }
 ```
 
+## Configuration update
+
+Endpoint to override scheduler configuration. 
+
+**URL** : `/ws/v1/config`
+
+**Method** : `PUT`
+
+**Auth required** : NO
+
+### Success response
+
+**Code** : `200 OK`
+
+**Content example**
+
+```yaml
+partitions:
+  -
+    name: default
+    placementrules:
+      - name: tag
+        value: namespace
+        create: true
+    queues:
+      - name: root
+        submitacl: '*'
+        properties:
+          application.sort.policy: stateaware
+checksum: [173,7,83,162,71,12,24,54,61,72,195,227,207,95,85,14,128,101,107,7,112,214,125,208,136,131,212,118,44,191,90,222]
+```
+**Note:** the checksum is the base configuration checksum on top of what we want to make the changes.
+If the provisioned checksum differs from the actual scheduler checksum, the configuration update will fail.
+
+### Failure response
+
+The configuration update can fail due to different reasons such as: 
+- invalid configuration, 
+- outdated base checksum, 
+- failure while saving the configuration to the scheduler. 

Review comment:
       While saving the scheduler configuration it may fail due to some unexpected errors while updating the partitions, since if the validation passed, it should be OK in most of the cases, but in any case the response message will have the exact error message.
   @yangwwei do you want me to remove this line, or how can it be formulated in a more explicit way?




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org