This is an automated email from the ASF dual-hosted git repository.
chia7712 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/yunikorn-site.git
The following commit(s) were added to refs/heads/master by this push:
new 0f84c8356f [YUNIKORN-2267] add docs of using BinaryData to configure
scheduler (#393)
0f84c8356f is described below
commit 0f84c8356f480f6307c7002f6e57df65149c7efc
Author: PoAn Yang <[email protected]>
AuthorDate: Wed Feb 7 14:53:22 2024 +0800
[YUNIKORN-2267] add docs of using BinaryData to configure scheduler (#393)
Closes: #393
Signed-off-by: Chia-Ping Tsai <[email protected]>
---
docs/user_guide/service_config.md | 34 ++++++++++++++++++++++++++++++++++
1 file changed, 34 insertions(+)
diff --git a/docs/user_guide/service_config.md
b/docs/user_guide/service_config.md
index 274d3d6775..2703ad12b7 100644
--- a/docs/user_guide/service_config.md
+++ b/docs/user_guide/service_config.md
@@ -977,6 +977,40 @@ Example:
admissionController.accessControl.externalGroups: "^sales$,^marketing$,^admin-"
```
+### Using compressed values
+
+The data in ConfigMap cannot exceed 1 MiB. YuniKorn supports the gzip
algorithm to decompress data in the `binaryData` field.
+If a key ends with `.gz`. YuniKorn will treat the value as gzip-compressed
data and decompress it automatically. The base64 encoding is automatically.
+If a value is set in both the `data` and `binaryData` sections, the value in
the `binaryData` section will be used.
+
+Example:
+
+Users can run the command to get the value.
+
+```bash
+echo "
+partitions:
+ - name: default
+ queues:
+ - name: root
+ submitacl: '*'
+ parent: true
+ queues:
+ - name: parent
+ submitacl: '*'" | gzip | base64
+```
+
+Set the result in the `binaryData` field.
+
+```yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+ name: yunikorn-configs
+binaryData:
+ queues.yaml.gz:
"H4sIAMyHs2UAA2WMSQ6AIBAE77yibyQmfoDfoI4JCYvCzP/FjWDsY3Wl1GYzO3YpFqOAEdEGMlhoteK5EmAXErrec6+RU+IHAUWm4NjO3kAPuuHapsgGnIUa/Ob65K13xy98AFwE9HmuAAAA"
+```
+
### Deprecated settings
#### service.operatorPlugins
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
