yangwwei commented on a change in pull request #29:
URL:
https://github.com/apache/incubator-yunikorn-site/pull/29#discussion_r504808597
##########
File path: docs/api/scheduler.md
##########
@@ -433,6 +433,141 @@ Reponse
"reason": "yaml: unmarshal errors:\n line 7: cannot unmarshal !!str
`wrong_text` into configs.PartitionConfig"
}
```
+## Configuration
+
+Endpoint to retrieve the current scheduler configuration
+
+**URL** : `/ws/v1/config`
+
+**Method** : `GET`
+
+**Auth required** : NO
+
+### Success response
+
+**Code** : `200 OK`
+
+**Content example**
+
+```json
+partitions:
+- name: default
+ queues:
+ - name: root
+ parent: true
+ submitacl: '*'
+ placementrules:
+ - name: tag
+ create: true
+ value: namespace
+checksum:
+- 186
+- 179
+- 215
+- 100
+- 2
+- 130
+- 126
+- 171
+- 230
+- 47
+- 167
+- 228
+- 198
+- 188
+- 244
+- 216
+- 221
+- 149
+- 82
+- 131
+- 69
+- 97
+- 182
+- 182
+- 96
+- 239
+- 55
+- 254
+- 217
+- 41
+- 151
+- 145
+
+sha256 checksum:
BAB3D76402827EABE62FA7E4C6BCF4D8DD9552834561B6B660EF37FED9299791
Review comment:
is this correct? Why there is a multi-line checksum?
##########
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:
When it fails to save the configs, that means something is invalid in
the config, so it falls to the `invalid configuration`. I guess we can just
remove this line, that might be less confusing if I am a user.
----------------------------------------------------------------
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:
[email protected]
