You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
After adding to the "info" command new values, there were a few suggestions on how to improve it:
Group values together. The first approach is to group them close to each other, e.g.:
List of available workspaces: /var/reanaDefault workspace: /var/reanaList of supported compute backends: kubernetesDefault timeout for Kubernetes jobs: 604800Maximum timeout for Kubernetes jobs: 1209600Default memory limit for Kubernetes jobs: 4GiMaximum allowed memory limit for Kubernetes jobs: NoneMaximum retention period in days for workspace files: None
The second approach can be to group them by categories:
It is not nice that when, for example, the retention period doesn't exist (we keep files forever), the info command will show None. I suppose the user can deduce what it means but still better to make it explicit. Example:
Maximum retention period in days for workspace files: None
vs
Maximum retention period in days for workspace files: keep forever
But you cannot programmatically deduce the value "keep forever" so maybe, it makes sense for each config to have values. One is programmatic, another one is message/explanation.
Adding new values causes schema change, meaning changes need to be propagated to reana-client-go (modify Go code), reana-commons (update OpenAPI), and, technically, reana-client (although Python does not respect OpenAPI sometimes). Adding new values should not require so many changes in the schema. Below is the part of the current OpenAPI schema.
Originated in #540 (review) and #540 (comment)
After adding to the "info" command new values, there were a few suggestions on how to improve it:
The second approach can be to group them by categories:
None
. I suppose the user can deduce what it means but still better to make it explicit. Example:But you cannot programmatically deduce the value "keep forever" so maybe, it makes sense for each config to have values. One is programmatic, another one is message/explanation.
reana-client-go
(modify Go code),reana-commons
(update OpenAPI), and, technically,reana-client
(although Python does not respect OpenAPI sometimes). Adding new values should not require so many changes in the schema. Below is the part of the current OpenAPI schema.note: In the current server implementation,
Dict
in Python doesn't guarantee an order. Which is relevant to the point number1
.Maybe we can modify the spec to
List
instead ofDict
. In this case, adding a new config value will not need to change in multiple places.What do you think about those suggestions? Suggestions 1-3 are interconnected and can be seen as one issue.
The text was updated successfully, but these errors were encountered: