Improve the usage documentation of "kcp workload sync" around the following points:
Is it possible to be more verbose about the description "Manages KCP sync targets" of the command kubectl kcp workload -h as this is not clear for a user to figure out what is a workload, how it is related to a sync target, what is a sync target, etc ?
The command k kcp workload sync -h reports as flag --burst Burst to use when talking to API servers. which is described nowhere. What is the purpose of this parameter (to sync resources every x seconds, ...) ?
The command k kcp workload sync -h reports as flag --qps float32 QPS to use when talking to API servers.. What is also the purpose of the QPS parameter (Query per second, ...) ?
Can you provide an example about how to pass the resources using --resources strings Resources to synchronize with kcp. ?
mjudeikis
commented
1 year ago
Suggestion
Improve the usage documentation of "kcp workload sync" around the following points:
kubectl kcp workload -has this is not clear for a user to figure out what is a workload, how it is related to a sync target, what is a sync target, etc ?k kcp workload sync -hreports as flag--burst Burst to use when talking to API servers.which is described nowhere. What is the purpose of this parameter (to sync resources every x seconds, ...) ?k kcp workload sync -hreports as flag--qps float32 QPS to use when talking to API servers.. What is also the purpose of the QPS parameter (Query per second, ...) ?--resources strings Resources to synchronize with kcp.?