procedures: Add CLI Activity Tracker configuration documentation - #3180
procedures: Add CLI Activity Tracker configuration documentation#3180tolusha wants to merge 1 commit into
Conversation
Add a new administration guide article for configuring the CLI Activity Tracker at the cluster level via CheCluster CR. Update the existing end-user guide article to cross-reference the new admin configuration. Related: eclipse-che/che-operator#2170 Signed-off-by: che-ai-assistant <che-ai-assistant@noreply.github.com> Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Anatolii Bazko <abazko@redhat.com>
|
Click here to review and test in web IDE: |
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
|
🎊 Navigate the preview: https://6a746c6ac16a1e98554db1bb--eclipse-che-docs-pr.netlify.app 🎊 |
| The CLI Watcher periodically checks for running processes that match the commands you specify. When it detects an active watched command, it resets the workspace idle timer. This configuration works entirely in user space and does not require administrator privileges. | ||
| The CLI Activity Tracker periodically checks for running processes that match the commands you specify. When it detects an active watched command, it resets the workspace idle timer. This configuration works entirely in user space and does not require administrator privileges. | ||
|
|
||
| NOTE: An administrator can enable and configure the CLI Activity Tracker at the cluster level. See xref:administration-guide:configuring-cli-activity-tracker.adoc[]. |
There was a problem hiding this comment.
This change is not really enough. The following information with a .noidle config example, the description for the properties, etc. doesn't reflect the breaking change we've added: the use of enabled: true in .noidle is deprecated, so users won't be able to enable/disable the CLI Activity Tracker - the only admins can enable or disable it.
Also the timing values that users can configure in .noidle config now are limited with the ones configured by the ones set by admins, f.i. if admins sets checkPeriodSeconds: 60 ([seconds] in spec or in custom user settings ConfigMap) and, at the same time, user tries setting the same parameter to 120 seconds - the user's value won't be accepted and the admin's one will be effective. User can make these values to be more strict, but never relax them.
2 participants
What does this pull request change?
Adds a new administration guide article documenting how to configure the CLI Activity Tracker at the cluster level via the CheCluster custom resource. The CLI Activity Tracker monitors running CLI processes in workspace containers and prevents workspace idling while those processes are active.
The new article covers:
spec.devEnvironments.cliActivityTrackersecondsOfCheckPeriod,secondsOfActivityWindow,secondsOfGracePeriod,secondsOfMaxProcessAge)Also updates the existing end-user guide article ("Prevent workspace idling for long-running commands") to cross-reference the new admin-level configuration.
Source PR: eclipse-che/che-operator#2170
Related: eclipse-che/che-machine-exec#376
What issues does this pull request fix or reference?
Specify the version of the product this pull request applies to
next
Pull Request checklist
The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.
Validate language on files added or modifiedstep reports no vale warnings.